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