442fd7badd7a417e3d4b82d1647c1a9f8ad4987a
[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 "CDMSession.h"
33 #include "Event.h"
34 #include "GenericEventQueue.h"
35 #include "MediaKeyError.h"
36 #include "MediaKeyMessageEvent.h"
37 #include "MediaKeys.h"
38
39 namespace WebCore {
40
41 PassRefPtr<MediaKeySession> MediaKeySession::create(ScriptExecutionContext* context, MediaKeys* keys, const String& keySystem)
42 {
43     return adoptRef(new MediaKeySession(context, keys, keySystem));
44 }
45
46 MediaKeySession::MediaKeySession(ScriptExecutionContext* context, MediaKeys* keys, const String& keySystem)
47     : ContextDestructionObserver(context)
48     , m_keys(keys)
49     , m_keySystem(keySystem)
50     , m_asyncEventQueue(*this)
51     , m_session(keys->cdm()->createSession())
52     , m_keyRequestTimer(this, &MediaKeySession::keyRequestTimerFired)
53     , m_addKeyTimer(this, &MediaKeySession::addKeyTimerFired)
54 {
55 }
56
57 MediaKeySession::~MediaKeySession()
58 {
59     close();
60 }
61
62 void MediaKeySession::setError(MediaKeyError* error)
63 {
64     m_error = error;
65 }
66
67 void MediaKeySession::close()
68 {
69     if (m_session)
70         m_session->releaseKeys();
71     m_session = 0;
72     m_asyncEventQueue.cancelAllEvents();
73 }
74
75 const String& MediaKeySession::sessionId() const
76 {
77     return m_session->sessionId();
78 }
79
80 void MediaKeySession::generateKeyRequest(const String& mimeType, Uint8Array* initData)
81 {
82     m_pendingKeyRequests.append(PendingKeyRequest(mimeType, initData));
83     m_keyRequestTimer.startOneShot(0);
84 }
85
86 void MediaKeySession::keyRequestTimerFired(Timer<MediaKeySession>&)
87 {
88     ASSERT(m_pendingKeyRequests.size());
89     if (!m_session)
90         return;
91
92     while (!m_pendingKeyRequests.isEmpty()) {
93         PendingKeyRequest request = m_pendingKeyRequests.takeFirst();
94
95         // NOTE: Continued from step 5 in MediaKeys::createSession().
96         // The user agent will asynchronously execute the following steps in the task:
97
98         // 1. Let cdm be the cdm loaded in the MediaKeys constructor.
99         // 2. Let destinationURL be null.
100         String destinationURL;
101         MediaKeyError::Code errorCode = 0;
102         unsigned long systemCode = 0;
103
104         // 3. Use cdm to generate a key request and follow the steps for the first matching condition from the following list:
105
106         RefPtr<Uint8Array> keyRequest = m_session->generateKeyRequest(request.mimeType, request.initData.get(), destinationURL, errorCode, systemCode);
107
108         // Otherwise [if a request is not successfully generated]:
109         if (!keyRequest) {
110             // 3.1. Create a new MediaKeyError object with the following attributes:
111             //      code = the appropriate MediaKeyError code
112             //      systemCode = a Key System-specific value, if provided, and 0 otherwise
113             RefPtr<MediaKeyError> error = MediaKeyError::create(errorCode, systemCode).get();
114
115             // 3.2. Set the MediaKeySession object's error attribute to the error object created in the previous step.
116             setError(error.get());
117
118             // 3.3. queue a task to fire a simple event named keyerror at the MediaKeySession object.
119             RefPtr<Event> event = Event::create(eventNames().webkitkeyerrorEvent, false, false);
120             event->setTarget(this);
121             m_asyncEventQueue.enqueueEvent(event.release());
122
123             // 3.4. Abort the task.
124             continue;
125         }
126
127         // 4. queue a task to fire a simple event named keymessage at the new object
128         //    The event is of type MediaKeyMessageEvent and has:
129         //    message = key request
130         //    destinationURL = destinationURL
131         MediaKeyMessageEventInit init;
132         init.bubbles = false;
133         init.cancelable = false;
134         init.message = keyRequest;
135         init.destinationURL = destinationURL;
136         RefPtr<MediaKeyMessageEvent> event = MediaKeyMessageEvent::create(eventNames().webkitkeymessageEvent, init);
137         event->setTarget(this);
138         m_asyncEventQueue.enqueueEvent(event.release());
139     }
140 }
141
142 void MediaKeySession::update(Uint8Array* key, ExceptionCode& ec)
143 {
144     // From <http://dvcs.w3.org/hg/html-media/raw-file/tip/encrypted-media/encrypted-media.html#dom-addkey>:
145     // The addKey(key) method must run the following steps:
146     // 1. If the first or second argument [sic] is null or an empty array, throw an INVALID_ACCESS_ERR.
147     // NOTE: the reference to a "second argument" is a spec bug.
148     if (!key || !key->length()) {
149         ec = INVALID_ACCESS_ERR;
150         return;
151     }
152
153     // 2. Schedule a task to handle the call, providing key.
154     m_pendingKeys.append(key);
155     m_addKeyTimer.startOneShot(0);
156 }
157
158 void MediaKeySession::addKeyTimerFired(Timer<MediaKeySession>&)
159 {
160     ASSERT(m_pendingKeys.size());
161     if (!m_session)
162         return;
163
164     while (!m_pendingKeys.isEmpty()) {
165         RefPtr<Uint8Array> pendingKey = m_pendingKeys.takeFirst();
166         unsigned short errorCode = 0;
167         unsigned long systemCode = 0;
168
169         // NOTE: Continued from step 2. of MediaKeySession::update()
170         // 2.1. Let cdm be the cdm loaded in the MediaKeys constructor.
171         // NOTE: This is m_session.
172         // 2.2. Let 'did store key' be false.
173         bool didStoreKey = false;
174         // 2.3. Let 'next message' be null.
175         RefPtr<Uint8Array> nextMessage;
176         // 2.4. Use cdm to handle key.
177         didStoreKey = m_session->update(pendingKey.get(), nextMessage, errorCode, systemCode);
178         // 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.
179         // TODO: Find and restart the media element
180
181         // 2.6. If next message is not null, queue a task to fire a simple event named keymessage at the MediaKeySession object.
182         //      The event is of type MediaKeyMessageEvent and has:
183         //      message = next message
184         //      destinationURL = null
185         if (nextMessage) {
186             MediaKeyMessageEventInit init;
187             init.bubbles = false;
188             init.cancelable = false;
189             init.message = nextMessage;
190             RefPtr<MediaKeyMessageEvent> event = MediaKeyMessageEvent::create(eventNames().webkitkeymessageEvent, init);
191             event->setTarget(this);
192             m_asyncEventQueue.enqueueEvent(event.release());
193         }
194
195         // 2.7. If did store key is true, queue a task to fire a simple event named keyadded at the MediaKeySession object.
196         if (didStoreKey) {
197             RefPtr<Event> keyaddedEvent = Event::create(eventNames().webkitkeyaddedEvent, false, false);
198             keyaddedEvent->setTarget(this);
199             m_asyncEventQueue.enqueueEvent(keyaddedEvent.release());
200         }
201
202         // 2.8. If any of the preceding steps in the task failed
203         if (errorCode) {
204             // 2.8.1. Create a new MediaKeyError object with the following attributes:
205             //        code = the appropriate MediaKeyError code
206             //        systemCode = a Key System-specific value, if provided, and 0 otherwise
207             RefPtr<MediaKeyError> error = MediaKeyError::create(errorCode, systemCode).get();
208
209             // 2.8.2. Set the MediaKeySession object's error attribute to the error object created in the previous step.
210             setError(error.get());
211
212             // 2.8.3. queue a task to fire a simple event named keyerror at the MediaKeySession object.
213             RefPtr<Event> keyerrorEvent = Event::create(eventNames().webkitkeyerrorEvent, false, false);
214             keyerrorEvent->setTarget(this);
215             m_asyncEventQueue.enqueueEvent(keyerrorEvent.release());
216             
217             // 2.8.4. Abort the task.
218             // NOTE: no-op
219         }
220     }
221 }
222
223 }
224
225 #endif