[MSE] Make MediaSourcePrivate, SourceBufferPrivate classes RefCounted.
[WebKit-https.git] / Source / WebCore / Modules / mediasource / MediaSourceBase.cpp
1 /*
2  * Copyright (C) 2013 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "MediaSourceBase.h"
33
34 #if ENABLE(MEDIA_SOURCE)
35
36 #include "Event.h"
37 #include "ExceptionCode.h"
38 #include "ExceptionCodePlaceholder.h"
39 #include "GenericEventQueue.h"
40 #include "Logging.h"
41 #include "MediaSourceRegistry.h"
42 #include "SourceBufferPrivate.h"
43 #include <wtf/text/CString.h>
44 #include <wtf/text/WTFString.h>
45
46 namespace WebCore {
47
48 MediaSourceBase::MediaSourceBase(ScriptExecutionContext* context)
49     : ActiveDOMObject(context)
50     , m_readyState(closedKeyword())
51     , m_asyncEventQueue(*this)
52     , m_attached(false)
53 {
54 }
55
56 MediaSourceBase::~MediaSourceBase()
57 {
58 }
59
60 const AtomicString& MediaSourceBase::openKeyword()
61 {
62     DEFINE_STATIC_LOCAL(const AtomicString, open, ("open", AtomicString::ConstructFromLiteral));
63     return open;
64 }
65
66 const AtomicString& MediaSourceBase::closedKeyword()
67 {
68     DEFINE_STATIC_LOCAL(const AtomicString, closed, ("closed", AtomicString::ConstructFromLiteral));
69     return closed;
70 }
71
72 const AtomicString& MediaSourceBase::endedKeyword()
73 {
74     DEFINE_STATIC_LOCAL(const AtomicString, ended, ("ended", AtomicString::ConstructFromLiteral));
75     return ended;
76 }
77
78 void MediaSourceBase::setPrivateAndOpen(PassRef<MediaSourcePrivate> mediaSourcePrivate)
79 {
80     ASSERT(!m_private);
81     ASSERT(m_attached);
82     m_private = std::move(mediaSourcePrivate);
83     setReadyState(openKeyword());
84 }
85
86 void MediaSourceBase::addedToRegistry()
87 {
88     setPendingActivity(this);
89 }
90
91 void MediaSourceBase::removedFromRegistry()
92 {
93     unsetPendingActivity(this);
94 }
95
96 double MediaSourceBase::duration() const
97 {
98     return isClosed() ? std::numeric_limits<float>::quiet_NaN() : m_private->duration();
99 }
100
101 PassRefPtr<TimeRanges> MediaSourceBase::buffered() const
102 {
103     // Implements MediaSource algorithm for HTMLMediaElement.buffered.
104     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#htmlmediaelement-extensions
105     Vector<RefPtr<TimeRanges>> ranges = activeRanges();
106
107     // 1. If activeSourceBuffers.length equals 0 then return an empty TimeRanges object and abort these steps.
108     if (ranges.isEmpty())
109         return TimeRanges::create();
110
111     // 2. Let active ranges be the ranges returned by buffered for each SourceBuffer object in activeSourceBuffers.
112     // 3. Let highest end time be the largest range end time in the active ranges.
113     double highestEndTime = -1;
114     for (size_t i = 0; i < ranges.size(); ++i) {
115         unsigned length = ranges[i]->length();
116         if (length)
117             highestEndTime = std::max(highestEndTime, ranges[i]->end(length - 1, ASSERT_NO_EXCEPTION));
118     }
119
120     // Return an empty range if all ranges are empty.
121     if (highestEndTime < 0)
122         return TimeRanges::create();
123
124     // 4. Let intersection ranges equal a TimeRange object containing a single range from 0 to highest end time.
125     RefPtr<TimeRanges> intersectionRanges = TimeRanges::create(0, highestEndTime);
126
127     // 5. For each SourceBuffer object in activeSourceBuffers run the following steps:
128     bool ended = readyState() == endedKeyword();
129     for (size_t i = 0; i < ranges.size(); ++i) {
130         // 5.1 Let source ranges equal the ranges returned by the buffered attribute on the current SourceBuffer.
131         TimeRanges* sourceRanges = ranges[i].get();
132
133         // 5.2 If readyState is "ended", then set the end time on the last range in source ranges to highest end time.
134         if (ended && sourceRanges->length())
135             sourceRanges->add(sourceRanges->start(sourceRanges->length() - 1, ASSERT_NO_EXCEPTION), highestEndTime);
136
137         // 5.3 Let new intersection ranges equal the the intersection between the intersection ranges and the source ranges.
138         // 5.4 Replace the ranges in intersection ranges with the new intersection ranges.
139         intersectionRanges->intersectWith(sourceRanges);
140     }
141
142     return intersectionRanges.release();
143 }
144
145 void MediaSourceBase::setDuration(double duration, ExceptionCode& ec)
146 {
147     if (duration < 0.0 || std::isnan(duration)) {
148         ec = INVALID_ACCESS_ERR;
149         return;
150     }
151     if (!isOpen()) {
152         ec = INVALID_STATE_ERR;
153         return;
154     }
155     m_private->setDuration(duration);
156 }
157
158
159 void MediaSourceBase::setReadyState(const AtomicString& state)
160 {
161     ASSERT(state == openKeyword() || state == closedKeyword() || state == endedKeyword());
162
163     AtomicString oldState = readyState();
164     LOG(Media, "MediaSourceBase::setReadyState() %p : %s -> %s", this, oldState.string().ascii().data(), state.string().ascii().data());
165
166     if (state == closedKeyword()) {
167         m_private.clear();
168         m_attached = false;
169     }
170
171     if (oldState == state)
172         return;
173
174     m_readyState = state;
175
176     onReadyStateChange(oldState, state);
177 }
178
179 void MediaSourceBase::endOfStream(const AtomicString& error, ExceptionCode& ec)
180 {
181     DEFINE_STATIC_LOCAL(const AtomicString, network, ("network", AtomicString::ConstructFromLiteral));
182     DEFINE_STATIC_LOCAL(const AtomicString, decode, ("decode", AtomicString::ConstructFromLiteral));
183
184     // 3.1 http://dvcs.w3.org/hg/html-media/raw-file/tip/media-source/media-source.html#dom-endofstream
185     // 1. If the readyState attribute is not in the "open" state then throw an
186     // INVALID_STATE_ERR exception and abort these steps.
187     if (!isOpen()) {
188         ec = INVALID_STATE_ERR;
189         return;
190     }
191
192     MediaSourcePrivate::EndOfStreamStatus eosStatus = MediaSourcePrivate::EosNoError;
193
194     if (error.isNull() || error.isEmpty())
195         eosStatus = MediaSourcePrivate::EosNoError;
196     else if (error == network)
197         eosStatus = MediaSourcePrivate::EosNetworkError;
198     else if (error == decode)
199         eosStatus = MediaSourcePrivate::EosDecodeError;
200     else {
201         ec = INVALID_ACCESS_ERR;
202         return;
203     }
204
205     // 2. Change the readyState attribute value to "ended".
206     setReadyState(endedKeyword());
207     m_private->markEndOfStream(eosStatus);
208 }
209
210 bool MediaSourceBase::isOpen() const
211 {
212     return readyState() == openKeyword();
213 }
214
215 bool MediaSourceBase::isClosed() const
216 {
217     return readyState() == closedKeyword();
218 }
219
220 void MediaSourceBase::close()
221 {
222     setReadyState(closedKeyword());
223 }
224
225 bool MediaSourceBase::attachToElement()
226 {
227     if (m_attached)
228         return false;
229
230     ASSERT(isClosed());
231
232     m_attached = true;
233     return true;
234 }
235
236 void MediaSourceBase::openIfInEndedState()
237 {
238     if (m_readyState != endedKeyword())
239         return;
240
241     setReadyState(openKeyword());
242     m_private->unmarkEndOfStream();
243 }
244
245 bool MediaSourceBase::hasPendingActivity() const
246 {
247     return m_private || m_asyncEventQueue.hasPendingEvents()
248         || ActiveDOMObject::hasPendingActivity();
249 }
250
251 void MediaSourceBase::stop()
252 {
253     m_asyncEventQueue.close();
254     if (!isClosed())
255         setReadyState(closedKeyword());
256     m_private.clear();
257 }
258
259 RefPtr<SourceBufferPrivate> MediaSourceBase::createSourceBufferPrivate(const ContentType& type, ExceptionCode& ec)
260 {
261     RefPtr<SourceBufferPrivate> sourceBufferPrivate;
262     switch (m_private->addSourceBuffer(type, sourceBufferPrivate)) {
263     case MediaSourcePrivate::Ok: {
264         return sourceBufferPrivate;
265     }
266     case MediaSourcePrivate::NotSupported:
267         // 2.2 https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-MediaSource-addSourceBuffer-SourceBuffer-DOMString-type
268         // Step 2: If type contains a MIME type ... that is not supported with the types
269         // specified for the other SourceBuffer objects in sourceBuffers, then throw
270         // a NOT_SUPPORTED_ERR exception and abort these steps.
271         ec = NOT_SUPPORTED_ERR;
272         return nullptr;
273     case MediaSourcePrivate::ReachedIdLimit:
274         // 2.2 https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-MediaSource-addSourceBuffer-SourceBuffer-DOMString-type
275         // Step 3: If the user agent can't handle any more SourceBuffer objects then throw
276         // a QUOTA_EXCEEDED_ERR exception and abort these steps.
277         ec = QUOTA_EXCEEDED_ERR;
278         return nullptr;
279     }
280
281     ASSERT_NOT_REACHED();
282     return nullptr;
283 }
284
285 void MediaSourceBase::scheduleEvent(const AtomicString& eventName)
286 {
287     RefPtr<Event> event = Event::create(eventName, false, false);
288     event->setTarget(this);
289
290     m_asyncEventQueue.enqueueEvent(event.release());
291 }
292
293 ScriptExecutionContext* MediaSourceBase::scriptExecutionContext() const
294 {
295     return ActiveDOMObject::scriptExecutionContext();
296 }
297
298 URLRegistry& MediaSourceBase::registry() const
299 {
300     return MediaSourceRegistry::registry();
301 }
302
303 }
304
305 #endif