a4b62359d48337964483cee12a9850151263c57b
[WebKit-https.git] / Source / WebCore / Modules / encryptedmedia / MediaKeySession.cpp
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "MediaKeySession.h"
28
29 #if ENABLE(ENCRYPTED_MEDIA_V2)
30
31 #include "CDM.h"
32 #include "Event.h"
33 #include "GenericEventQueue.h"
34 #include "MediaKeyError.h"
35 #include "MediaKeyMessageEvent.h"
36 #include "MediaKeys.h"
37
38 namespace WebCore {
39
40 PassRefPtr<MediaKeySession> MediaKeySession::create(ScriptExecutionContext* context, MediaKeys* keys, const String& keySystem)
41 {
42     return adoptRef(new MediaKeySession(context, keys, keySystem));
43 }
44
45 MediaKeySession::MediaKeySession(ScriptExecutionContext* context, MediaKeys* keys, const String& keySystem)
46     : ContextDestructionObserver(context)
47     , m_keys(keys)
48     , m_keySystem(keySystem)
49     , m_asyncEventQueue(*this)
50     , m_session(keys->cdm()->createSession())
51     , m_keyRequestTimer(this, &MediaKeySession::keyRequestTimerFired)
52     , m_addKeyTimer(this, &MediaKeySession::addKeyTimerFired)
53 {
54 }
55
56 MediaKeySession::~MediaKeySession()
57 {
58     close();
59 }
60
61 void MediaKeySession::setError(MediaKeyError* error)
62 {
63     m_error = error;
64 }
65
66 void MediaKeySession::close()
67 {
68     if (m_session)
69         m_session->releaseKeys();
70     m_session = 0;
71     m_asyncEventQueue.cancelAllEvents();
72 }
73
74 const String& MediaKeySession::sessionId() const
75 {
76     return m_session->sessionId();
77 }
78
79 void MediaKeySession::generateKeyRequest(const String& mimeType, Uint8Array* initData)
80 {
81     m_pendingKeyRequests.append(PendingKeyRequest(mimeType, initData));
82     m_keyRequestTimer.startOneShot(0);
83 }
84
85 void MediaKeySession::keyRequestTimerFired(Timer<MediaKeySession>*)
86 {
87     ASSERT(m_pendingKeyRequests.size());
88     if (!m_session)
89         return;
90
91     while (!m_pendingKeyRequests.isEmpty()) {
92         PendingKeyRequest request = m_pendingKeyRequests.takeFirst();
93
94         // NOTE: Continued from step 5 in MediaKeys::createSession().
95         // The user agent will asynchronously execute the following steps in the task:
96
97         // 1. Let cdm be the cdm loaded in the MediaKeys constructor.
98         // 2. Let destinationURL be null.
99         String destinationURL;
100         MediaKeyError::Code errorCode = 0;
101         unsigned long systemCode = 0;
102
103         // 3. Use cdm to generate a key request and follow the steps for the first matching condition from the following list:
104
105         RefPtr<Uint8Array> keyRequest = m_session->generateKeyRequest(request.mimeType, request.initData.get(), destinationURL, errorCode, systemCode);
106
107         // Otherwise [if a request is not successfully generated]:
108         if (!keyRequest) {
109             // 3.1. Create a new MediaKeyError object with the following attributes:
110             //      code = the appropriate MediaKeyError code
111             //      systemCode = a Key System-specific value, if provided, and 0 otherwise
112             RefPtr<MediaKeyError> error = MediaKeyError::create(errorCode, systemCode).get();
113
114             // 3.2. Set the MediaKeySession object's error attribute to the error object created in the previous step.
115             setError(error.get());
116
117             // 3.3. queue a task to fire a simple event named keyerror at the MediaKeySession object.
118             RefPtr<Event> event = Event::create(eventNames().webkitkeyerrorEvent, false, false);
119             event->setTarget(this);
120             m_asyncEventQueue.enqueueEvent(event.release());
121
122             // 3.4. Abort the task.
123             continue;
124         }
125
126         // 4. queue a task to fire a simple event named keymessage at the new object
127         //    The event is of type MediaKeyMessageEvent and has:
128         //    message = key request
129         //    destinationURL = destinationURL
130         MediaKeyMessageEventInit init;
131         init.bubbles = false;
132         init.cancelable = false;
133         init.message = keyRequest;
134         init.destinationURL = destinationURL;
135         RefPtr<MediaKeyMessageEvent> event = MediaKeyMessageEvent::create(eventNames().webkitkeymessageEvent, init);
136         event->setTarget(this);
137         m_asyncEventQueue.enqueueEvent(event.release());
138     }
139 }
140
141 void MediaKeySession::update(Uint8Array* key, ExceptionCode& ec)
142 {
143     // From <http://dvcs.w3.org/hg/html-media/raw-file/tip/encrypted-media/encrypted-media.html#dom-addkey>:
144     // The addKey(key) method must run the following steps:
145     // 1. If the first or second argument [sic] is null or an empty array, throw an INVALID_ACCESS_ERR.
146     // NOTE: the reference to a "second argument" is a spec bug.
147     if (!key || !key->length()) {
148         ec = INVALID_ACCESS_ERR;
149         return;
150     }
151
152     // 2. Schedule a task to handle the call, providing key.
153     m_pendingKeys.append(key);
154     m_addKeyTimer.startOneShot(0);
155 }
156
157 void MediaKeySession::addKeyTimerFired(Timer<MediaKeySession>*)
158 {
159     ASSERT(m_pendingKeys.size());
160     if (!m_session)
161         return;
162
163     while (!m_pendingKeys.isEmpty()) {
164         RefPtr<Uint8Array> pendingKey = m_pendingKeys.takeFirst();
165         unsigned short errorCode = 0;
166         unsigned long systemCode = 0;
167
168         // NOTE: Continued from step 2. of MediaKeySession::update()
169         // 2.1. Let cdm be the cdm loaded in the MediaKeys constructor.
170         // NOTE: This is m_session.
171         // 2.2. Let 'did store key' be false.
172         bool didStoreKey = false;
173         // 2.3. Let 'next message' be null.
174         RefPtr<Uint8Array> nextMessage;
175         // 2.4. Use cdm to handle key.
176         didStoreKey = m_session->update(pendingKey.get(), nextMessage, errorCode, systemCode);
177         // 2.5. If did store key is true and the media element is waiting for a key, queue a task to attempt to resume playback.
178         // TODO: Find and restart the media element
179
180         // 2.6. If next message is not null, queue a task to fire a simple event named keymessage at the MediaKeySession object.
181         //      The event is of type MediaKeyMessageEvent and has:
182         //      message = next message
183         //      destinationURL = null
184         if (nextMessage) {
185             MediaKeyMessageEventInit init;
186             init.bubbles = false;
187             init.cancelable = false;
188             init.message = nextMessage;
189             RefPtr<MediaKeyMessageEvent> event = MediaKeyMessageEvent::create(eventNames().webkitkeymessageEvent, init);
190             event->setTarget(this);
191             m_asyncEventQueue.enqueueEvent(event.release());
192         }
193
194         // 2.7. If did store key is true, queue a task to fire a simple event named keyadded at the MediaKeySession object.
195         if (didStoreKey) {
196             RefPtr<Event> keyaddedEvent = Event::create(eventNames().webkitkeyaddedEvent, false, false);
197             keyaddedEvent->setTarget(this);
198             m_asyncEventQueue.enqueueEvent(keyaddedEvent.release());
199         }
200
201         // 2.8. If any of the preceding steps in the task failed
202         if (!didStoreKey) {
203             // 2.8.1. Create a new MediaKeyError object with the following attributes:
204             //        code = the appropriate MediaKeyError code
205             //        systemCode = a Key System-specific value, if provided, and 0 otherwise
206             RefPtr<MediaKeyError> error = MediaKeyError::create(errorCode, systemCode).get();
207
208             // 2.8.2. Set the MediaKeySession object's error attribute to the error object created in the previous step.
209             setError(error.get());
210
211             // 2.8.3. queue a task to fire a simple event named keyerror at the MediaKeySession object.
212             RefPtr<Event> keyerrorEvent = Event::create(eventNames().webkitkeyerrorEvent, false, false);
213             keyerrorEvent->setTarget(this);
214             m_asyncEventQueue.enqueueEvent(keyerrorEvent.release());
215             
216             // 2.8.4. Abort the task.
217             // NOTE: no-op
218         }
219     }
220 }
221
222 }
223
224 #endif