[MSE] Implement Append Error algorithm.
[WebKit-https.git] / Source / WebCore / Modules / mediasource / SourceBuffer.cpp
1 /*
2  * Copyright (C) 2013 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2014 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "SourceBuffer.h"
34
35 #if ENABLE(MEDIA_SOURCE)
36
37 #include "AudioTrackList.h"
38 #include "Event.h"
39 #include "ExceptionCodePlaceholder.h"
40 #include "GenericEventQueue.h"
41 #include "HTMLMediaElement.h"
42 #include "InbandTextTrack.h"
43 #include "Logging.h"
44 #include "MediaDescription.h"
45 #include "MediaSample.h"
46 #include "MediaSource.h"
47 #include "SampleMap.h"
48 #include "SourceBufferPrivate.h"
49 #include "TextTrackList.h"
50 #include "TimeRanges.h"
51 #include "VideoTrackList.h"
52 #include <limits>
53 #include <map>
54 #include <runtime/JSCInlines.h>
55 #include <runtime/JSLock.h>
56 #include <runtime/VM.h>
57 #include <wtf/CurrentTime.h>
58 #include <wtf/NeverDestroyed.h>
59 #if !LOG_DISABLED
60 #include <wtf/text/StringBuilder.h>
61 #endif
62
63 namespace WebCore {
64
65 static double ExponentialMovingAverageCoefficient = 0.1;
66
67 // Allow hasCurrentTime() to be off by as much as the length of a 24fps video frame
68 static const MediaTime& currentTimeFudgeFactor()
69 {
70     static NeverDestroyed<MediaTime> fudgeFactor(1, 24);
71     return fudgeFactor;
72 }
73
74 const AtomicString& SourceBuffer::segmentsKeyword()
75 {
76     static NeverDestroyed<AtomicString> segments("segments");
77     return segments.get();
78 }
79
80 const AtomicString& SourceBuffer::sequenceKeyword()
81 {
82     static NeverDestroyed<AtomicString> segments("sequence");
83     return segments.get();
84 }
85
86 struct SourceBuffer::TrackBuffer {
87     MediaTime lastDecodeTimestamp;
88     MediaTime lastFrameDuration;
89     MediaTime highestPresentationTimestamp;
90     MediaTime lastEnqueuedPresentationTime;
91     MediaTime lastEnqueuedDecodeEndTime;
92     bool needRandomAccessFlag;
93     bool enabled;
94     bool needsReenqueueing;
95     SampleMap samples;
96     DecodeOrderSampleMap::MapType decodeQueue;
97     RefPtr<MediaDescription> description;
98
99     TrackBuffer()
100         : lastDecodeTimestamp(MediaTime::invalidTime())
101         , lastFrameDuration(MediaTime::invalidTime())
102         , highestPresentationTimestamp(MediaTime::invalidTime())
103         , lastEnqueuedPresentationTime(MediaTime::invalidTime())
104         , lastEnqueuedDecodeEndTime(MediaTime::invalidTime())
105         , needRandomAccessFlag(true)
106         , enabled(false)
107         , needsReenqueueing(false)
108     {
109     }
110 };
111
112 Ref<SourceBuffer> SourceBuffer::create(Ref<SourceBufferPrivate>&& sourceBufferPrivate, MediaSource* source)
113 {
114     RefPtr<SourceBuffer> sourceBuffer(adoptRef(new SourceBuffer(WTF::move(sourceBufferPrivate), source)));
115     sourceBuffer->suspendIfNeeded();
116     return sourceBuffer.releaseNonNull();
117 }
118
119 SourceBuffer::SourceBuffer(Ref<SourceBufferPrivate>&& sourceBufferPrivate, MediaSource* source)
120     : ActiveDOMObject(source->scriptExecutionContext())
121     , m_private(WTF::move(sourceBufferPrivate))
122     , m_source(source)
123     , m_asyncEventQueue(*this)
124     , m_mode(segmentsKeyword())
125     , m_appendBufferTimer(*this, &SourceBuffer::appendBufferTimerFired)
126     , m_appendWindowStart(MediaTime::zeroTime())
127     , m_appendWindowEnd(MediaTime::positiveInfiniteTime())
128     , m_groupStartTimestamp(MediaTime::invalidTime())
129     , m_groupEndTimestamp(MediaTime::zeroTime())
130     , m_buffered(TimeRanges::create())
131     , m_appendState(WaitingForSegment)
132     , m_timeOfBufferingMonitor(monotonicallyIncreasingTime())
133     , m_bufferedSinceLastMonitor(0)
134     , m_averageBufferRate(0)
135     , m_reportedExtraMemoryCost(0)
136     , m_pendingRemoveStart(MediaTime::invalidTime())
137     , m_pendingRemoveEnd(MediaTime::invalidTime())
138     , m_removeTimer(*this, &SourceBuffer::removeTimerFired)
139     , m_updating(false)
140     , m_receivedFirstInitializationSegment(false)
141     , m_active(false)
142     , m_bufferFull(false)
143     , m_shouldGenerateTimestamps(false)
144 {
145     ASSERT(m_source);
146
147     m_private->setClient(this);
148 }
149
150 SourceBuffer::~SourceBuffer()
151 {
152     ASSERT(isRemoved());
153
154     m_private->setClient(0);
155 }
156
157 PassRefPtr<TimeRanges> SourceBuffer::buffered(ExceptionCode& ec) const
158 {
159     // Section 3.1 buffered attribute steps.
160     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#attributes-1
161     // 1. If this object has been removed from the sourceBuffers attribute of the parent media source then throw an
162     //    INVALID_STATE_ERR exception and abort these steps.
163     if (isRemoved()) {
164         ec = INVALID_STATE_ERR;
165         return nullptr;
166     }
167
168     // 2. Return a new static normalized TimeRanges object for the media segments buffered.
169     return m_buffered->copy();
170 }
171
172 const RefPtr<TimeRanges>& SourceBuffer::buffered() const
173 {
174     return m_buffered;
175 }
176
177 double SourceBuffer::timestampOffset() const
178 {
179     return m_timestampOffset.toDouble();
180 }
181
182 void SourceBuffer::setTimestampOffset(double offset, ExceptionCode& ec)
183 {
184     // Section 3.1 timestampOffset attribute setter steps.
185     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#attributes-1
186     // 1. Let new timestamp offset equal the new value being assigned to this attribute.
187     // 2. If this object has been removed from the sourceBuffers attribute of the parent media source, then throw an
188     //    INVALID_STATE_ERR exception and abort these steps.
189     // 3. If the updating attribute equals true, then throw an INVALID_STATE_ERR exception and abort these steps.
190     if (isRemoved() || m_updating) {
191         ec = INVALID_STATE_ERR;
192         return;
193     }
194
195     // 4. If the readyState attribute of the parent media source is in the "ended" state then run the following steps:
196     // 4.1 Set the readyState attribute of the parent media source to "open"
197     // 4.2 Queue a task to fire a simple event named sourceopen at the parent media source.
198     m_source->openIfInEndedState();
199
200     // 5. If the append state equals PARSING_MEDIA_SEGMENT, then throw an INVALID_STATE_ERR and abort these steps.
201     if (m_appendState == ParsingMediaSegment) {
202         ec = INVALID_STATE_ERR;
203         return;
204     }
205
206     MediaTime newTimestampOffset = MediaTime::createWithDouble(offset);
207
208     // 6. If the mode attribute equals "sequence", then set the group start timestamp to new timestamp offset.
209     if (m_mode == sequenceKeyword())
210         m_groupStartTimestamp = newTimestampOffset;
211
212     // 7. Update the attribute to the new value.
213     m_timestampOffset = newTimestampOffset;
214 }
215
216 double SourceBuffer::appendWindowStart() const
217 {
218     return m_appendWindowStart.toDouble();
219 };
220
221 void SourceBuffer::setAppendWindowStart(double newValue, ExceptionCode& ec)
222 {
223     // Section 3.1 appendWindowStart attribute setter steps.
224     // http://www.w3.org/TR/media-source/#widl-SourceBuffer-appendWindowStart
225     // 1. If this object has been removed from the sourceBuffers attribute of the parent media source,
226     //    then throw an INVALID_STATE_ERR exception and abort these steps.
227     // 2. If the updating attribute equals true, then throw an INVALID_STATE_ERR exception and abort these steps.
228     if (isRemoved() || m_updating) {
229         ec = INVALID_STATE_ERR;
230         return;
231     }
232
233     // 3. If the new value is less than 0 or greater than or equal to appendWindowEnd then
234     //    throw an INVALID_ACCESS_ERR exception and abort these steps.
235     if (newValue < 0 || newValue >= m_appendWindowEnd.toDouble()) {
236         ec = INVALID_ACCESS_ERR;
237         return;
238     }
239
240     // 4. Update the attribute to the new value.
241     m_appendWindowStart = MediaTime::createWithDouble(newValue);
242 }
243
244 double SourceBuffer::appendWindowEnd() const
245 {
246     return m_appendWindowEnd.toDouble();
247 };
248
249 void SourceBuffer::setAppendWindowEnd(double newValue, ExceptionCode& ec)
250 {
251     // Section 3.1 appendWindowEnd attribute setter steps.
252     // http://www.w3.org/TR/media-source/#widl-SourceBuffer-appendWindowEnd
253     // 1. If this object has been removed from the sourceBuffers attribute of the parent media source,
254     //    then throw an INVALID_STATE_ERR exception and abort these steps.
255     // 2. If the updating attribute equals true, then throw an INVALID_STATE_ERR exception and abort these steps.
256     if (isRemoved() || m_updating) {
257         ec = INVALID_STATE_ERR;
258         return;
259     }
260
261     // 3. If the new value equals NaN, then throw an INVALID_ACCESS_ERR and abort these steps.
262     // 4. If the new value is less than or equal to appendWindowStart then throw an INVALID_ACCESS_ERR exception
263     //    and abort these steps.
264     if (std::isnan(newValue) || newValue <= m_appendWindowStart.toDouble()) {
265         ec = INVALID_ACCESS_ERR;
266         return;
267     }
268
269     // 5.. Update the attribute to the new value.
270     m_appendWindowEnd = MediaTime::createWithDouble(newValue);
271 }
272
273
274 void SourceBuffer::appendBuffer(PassRefPtr<ArrayBuffer> data, ExceptionCode& ec)
275 {
276     // Section 3.2 appendBuffer()
277     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-SourceBuffer-appendBuffer-void-ArrayBufferView-data
278     // 1. If data is null then throw an INVALID_ACCESS_ERR exception and abort these steps.
279     if (!data) {
280         ec = INVALID_ACCESS_ERR;
281         return;
282     }
283
284     appendBufferInternal(static_cast<unsigned char*>(data->data()), data->byteLength(), ec);
285 }
286
287 void SourceBuffer::appendBuffer(PassRefPtr<ArrayBufferView> data, ExceptionCode& ec)
288 {
289     // Section 3.2 appendBuffer()
290     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-SourceBuffer-appendBuffer-void-ArrayBufferView-data
291     // 1. If data is null then throw an INVALID_ACCESS_ERR exception and abort these steps.
292     if (!data) {
293         ec = INVALID_ACCESS_ERR;
294         return;
295     }
296
297     appendBufferInternal(static_cast<unsigned char*>(data->baseAddress()), data->byteLength(), ec);
298 }
299
300 void SourceBuffer::resetParserState()
301 {
302     // Section 3.5.2 Reset Parser State algorithm steps.
303     // http://www.w3.org/TR/2014/CR-media-source-20140717/#sourcebuffer-reset-parser-state
304     // 1. If the append state equals PARSING_MEDIA_SEGMENT and the input buffer contains some complete coded frames,
305     //    then run the coded frame processing algorithm until all of these complete coded frames have been processed.
306     // FIXME: If any implementation will work in pulling mode (instead of async push to SourceBufferPrivate, and forget)
307     //     this should be handled somehow either here, or in m_private->abort();
308
309     // 2. Unset the last decode timestamp on all track buffers.
310     // 3. Unset the last frame duration on all track buffers.
311     // 4. Unset the highest presentation timestamp on all track buffers.
312     // 5. Set the need random access point flag on all track buffers to true.
313     for (auto& trackBufferPair : m_trackBufferMap.values()) {
314         trackBufferPair.lastDecodeTimestamp = MediaTime::invalidTime();
315         trackBufferPair.lastFrameDuration = MediaTime::invalidTime();
316         trackBufferPair.highestPresentationTimestamp = MediaTime::invalidTime();
317         trackBufferPair.needRandomAccessFlag = true;
318     }
319     // 6. Remove all bytes from the input buffer.
320     // Note: this is handled by abortIfUpdating()
321     // 7. Set append state to WAITING_FOR_SEGMENT.
322     m_appendState = WaitingForSegment;
323
324     m_private->abort();
325 }
326
327 void SourceBuffer::abort(ExceptionCode& ec)
328 {
329     // Section 3.2 abort() method steps.
330     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-SourceBuffer-abort-void
331     // 1. If this object has been removed from the sourceBuffers attribute of the parent media source
332     //    then throw an INVALID_STATE_ERR exception and abort these steps.
333     // 2. If the readyState attribute of the parent media source is not in the "open" state
334     //    then throw an INVALID_STATE_ERR exception and abort these steps.
335     if (isRemoved() || !m_source->isOpen()) {
336         ec = INVALID_STATE_ERR;
337         return;
338     }
339
340     // 3. If the sourceBuffer.updating attribute equals true, then run the following steps: ...
341     abortIfUpdating();
342
343     // 4. Run the reset parser state algorithm.
344     resetParserState();
345
346     // 5. Set appendWindowStart to the presentation start time.
347     m_appendWindowStart = MediaTime::zeroTime();
348
349     // 6. Set appendWindowEnd to positive Infinity.
350     m_appendWindowEnd = MediaTime::positiveInfiniteTime();
351 }
352
353 void SourceBuffer::remove(double start, double end, ExceptionCode& ec)
354 {
355     remove(MediaTime::createWithDouble(start), MediaTime::createWithDouble(end), ec);
356 }
357
358 void SourceBuffer::remove(const MediaTime& start, const MediaTime& end, ExceptionCode& ec)
359 {
360     LOG(MediaSource, "SourceBuffer::remove(%p) - start(%lf), end(%lf)", this, start.toDouble(), end.toDouble());
361
362     // Section 3.2 remove() method steps.
363     // 1. If duration equals NaN, then throw an InvalidAccessError exception and abort these steps.
364     // 2. If start is negative or greater than duration, then throw an InvalidAccessError exception and abort these steps.
365     // 3. If end is less than or equal to start, then throw an InvalidAccessError exception and abort these steps.
366
367     // FIXME: reorder/revisit this section once <https://www.w3.org/Bugs/Public/show_bug.cgi?id=27857> got resolved
368     // as it seems wrong to check mediaSource duration before checking isRemoved().
369     if ((m_source && m_source->duration().isInvalid())
370         || start < MediaTime::zeroTime() || (m_source && start > m_source->duration())
371         || end <= start) {
372         ec = INVALID_ACCESS_ERR;
373         return;
374     }
375
376     // 4. If this object has been removed from the sourceBuffers attribute of the parent media source then throw an
377     //    InvalidStateError exception and abort these steps.
378     // 5. If the updating attribute equals true, then throw an InvalidStateError exception and abort these steps.
379     if (isRemoved() || m_updating) {
380         ec = INVALID_STATE_ERR;
381         return;
382     }
383
384     // 6. If the readyState attribute of the parent media source is in the "ended" state then run the following steps:
385     // 6.1. Set the readyState attribute of the parent media source to "open"
386     // 6.2. Queue a task to fire a simple event named sourceopen at the parent media source .
387     m_source->openIfInEndedState();
388
389     // 7. Run the range removal algorithm with start and end as the start and end of the removal range.
390     rangeRemoval(start, end);
391 }
392
393 void SourceBuffer::rangeRemoval(const MediaTime& start, const MediaTime& end)
394 {
395     // 3.5.7 Range Removal
396     // https://rawgit.com/w3c/media-source/7bbe4aa33c61ec025bc7acbd80354110f6a000f9/media-source.html#sourcebuffer-range-removal
397     // 1. Let start equal the starting presentation timestamp for the removal range.
398     // 2. Let end equal the end presentation timestamp for the removal range.
399     // 3. Set the updating attribute to true.
400     m_updating = true;
401
402     // 4. Queue a task to fire a simple event named updatestart at this SourceBuffer object.
403     scheduleEvent(eventNames().updatestartEvent);
404
405     // 5. Return control to the caller and run the rest of the steps asynchronously.
406     m_pendingRemoveStart = start;
407     m_pendingRemoveEnd = end;
408     m_removeTimer.startOneShot(0);
409 }
410
411 void SourceBuffer::abortIfUpdating()
412 {
413     // Section 3.2 abort() method step 3 substeps.
414     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-SourceBuffer-abort-void
415
416     if (!m_updating)
417         return;
418
419     // 3.1. Abort the buffer append and stream append loop algorithms if they are running.
420     m_appendBufferTimer.stop();
421     m_pendingAppendData.clear();
422
423     m_removeTimer.stop();
424     m_pendingRemoveStart = MediaTime::invalidTime();
425     m_pendingRemoveEnd = MediaTime::invalidTime();
426
427     // 3.2. Set the updating attribute to false.
428     m_updating = false;
429
430     // 3.3. Queue a task to fire a simple event named abort at this SourceBuffer object.
431     scheduleEvent(eventNames().abortEvent);
432
433     // 3.4. Queue a task to fire a simple event named updateend at this SourceBuffer object.
434     scheduleEvent(eventNames().updateendEvent);
435 }
436
437 void SourceBuffer::removedFromMediaSource()
438 {
439     if (isRemoved())
440         return;
441
442     abortIfUpdating();
443
444     for (auto& trackBufferPair : m_trackBufferMap.values()) {
445         trackBufferPair.samples.clear();
446         trackBufferPair.decodeQueue.clear();
447     }
448
449     m_private->removedFromMediaSource();
450     m_source = 0;
451 }
452
453 void SourceBuffer::seekToTime(const MediaTime& time)
454 {
455     LOG(MediaSource, "SourceBuffer::seekToTime(%p) - time(%s)", this, toString(time).utf8().data());
456
457     for (auto& trackBufferPair : m_trackBufferMap) {
458         TrackBuffer& trackBuffer = trackBufferPair.value;
459         const AtomicString& trackID = trackBufferPair.key;
460
461         trackBuffer.needsReenqueueing = true;
462         reenqueueMediaForTime(trackBuffer, trackID, time);
463     }
464 }
465
466 MediaTime SourceBuffer::sourceBufferPrivateFastSeekTimeForMediaTime(SourceBufferPrivate*, const MediaTime& targetTime, const MediaTime& negativeThreshold, const MediaTime& positiveThreshold)
467 {
468     MediaTime seekTime = targetTime;
469     MediaTime lowerBoundTime = targetTime - negativeThreshold;
470     MediaTime upperBoundTime = targetTime + positiveThreshold;
471
472     for (auto& trackBuffer : m_trackBufferMap.values()) {
473         // Find the sample which contains the target time time.
474         auto futureSyncSampleIterator = trackBuffer.samples.decodeOrder().findSyncSampleAfterPresentationTime(targetTime, positiveThreshold);
475         auto pastSyncSampleIterator = trackBuffer.samples.decodeOrder().findSyncSamplePriorToPresentationTime(targetTime, negativeThreshold);
476         auto upperBound = trackBuffer.samples.decodeOrder().end();
477         auto lowerBound = trackBuffer.samples.decodeOrder().rend();
478
479         if (futureSyncSampleIterator == upperBound && pastSyncSampleIterator == lowerBound)
480             continue;
481
482         MediaTime futureSeekTime = MediaTime::positiveInfiniteTime();
483         if (futureSyncSampleIterator != upperBound) {
484             RefPtr<MediaSample>& sample = futureSyncSampleIterator->second;
485             futureSeekTime = sample->presentationTime();
486         }
487
488         MediaTime pastSeekTime = MediaTime::negativeInfiniteTime();
489         if (pastSyncSampleIterator != lowerBound) {
490             RefPtr<MediaSample>& sample = pastSyncSampleIterator->second;
491             pastSeekTime = sample->presentationTime();
492         }
493
494         MediaTime trackSeekTime = abs(targetTime - futureSeekTime) < abs(targetTime - pastSeekTime) ? futureSeekTime : pastSeekTime;
495         if (abs(targetTime - trackSeekTime) > abs(targetTime - seekTime))
496             seekTime = trackSeekTime;
497     }
498
499     return seekTime;
500 }
501
502 bool SourceBuffer::hasPendingActivity() const
503 {
504     return m_source || m_asyncEventQueue.hasPendingEvents();
505 }
506
507 void SourceBuffer::stop()
508 {
509     m_appendBufferTimer.stop();
510     m_removeTimer.stop();
511 }
512
513 bool SourceBuffer::isRemoved() const
514 {
515     return !m_source;
516 }
517
518 void SourceBuffer::scheduleEvent(const AtomicString& eventName)
519 {
520     RefPtr<Event> event = Event::create(eventName, false, false);
521     event->setTarget(this);
522
523     m_asyncEventQueue.enqueueEvent(event.release());
524 }
525
526 void SourceBuffer::appendBufferInternal(unsigned char* data, unsigned size, ExceptionCode& ec)
527 {
528     // Section 3.2 appendBuffer()
529     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#widl-SourceBuffer-appendBuffer-void-ArrayBufferView-data
530
531     // Step 1 is enforced by the caller.
532     // 2. Run the prepare append algorithm.
533     // Section 3.5.4 Prepare AppendAlgorithm
534
535     // 1. If the SourceBuffer has been removed from the sourceBuffers attribute of the parent media source
536     // then throw an INVALID_STATE_ERR exception and abort these steps.
537     // 2. If the updating attribute equals true, then throw an INVALID_STATE_ERR exception and abort these steps.
538     if (isRemoved() || m_updating) {
539         ec = INVALID_STATE_ERR;
540         return;
541     }
542
543     // 3. If the readyState attribute of the parent media source is in the "ended" state then run the following steps:
544     // 3.1. Set the readyState attribute of the parent media source to "open"
545     // 3.2. Queue a task to fire a simple event named sourceopen at the parent media source .
546     m_source->openIfInEndedState();
547
548     // 4. Run the coded frame eviction algorithm.
549     evictCodedFrames(size);
550
551     // FIXME: enable this code when MSE libraries have been updated to support it.
552 #if 0
553     // 5. If the buffer full flag equals true, then throw a QUOTA_EXCEEDED_ERR exception and abort these step.
554     if (m_bufferFull) {
555         LOG(MediaSource, "SourceBuffer::appendBufferInternal(%p) -  buffer full, failing with QUOTA_EXCEEDED_ERR error", this);
556         ec = QUOTA_EXCEEDED_ERR;
557         return;
558     }
559 #endif
560
561     // NOTE: Return to 3.2 appendBuffer()
562     // 3. Add data to the end of the input buffer.
563     m_pendingAppendData.append(data, size);
564
565     // 4. Set the updating attribute to true.
566     m_updating = true;
567
568     // 5. Queue a task to fire a simple event named updatestart at this SourceBuffer object.
569     scheduleEvent(eventNames().updatestartEvent);
570
571     // 6. Asynchronously run the buffer append algorithm.
572     m_appendBufferTimer.startOneShot(0);
573
574     reportExtraMemoryCost();
575 }
576
577 void SourceBuffer::appendBufferTimerFired()
578 {
579     if (isRemoved())
580         return;
581
582     ASSERT(m_updating);
583
584     // Section 3.5.5 Buffer Append Algorithm
585     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#sourcebuffer-buffer-append
586
587     // 1. Run the segment parser loop algorithm.
588     size_t appendSize = m_pendingAppendData.size();
589     if (!appendSize) {
590         // Resize buffer for 0 byte appends so we always have a valid pointer.
591         // We need to convey all appends, even 0 byte ones to |m_private| so
592         // that it can clear its end of stream state if necessary.
593         m_pendingAppendData.resize(1);
594     }
595
596     // Section 3.5.1 Segment Parser Loop
597     // https://dvcs.w3.org/hg/html-media/raw-file/tip/media-source/media-source.html#sourcebuffer-segment-parser-loop
598     // When the segment parser loop algorithm is invoked, run the following steps:
599
600     // 1. Loop Top: If the input buffer is empty, then jump to the need more data step below.
601     if (!m_pendingAppendData.size()) {
602         sourceBufferPrivateAppendComplete(&m_private.get(), AppendSucceeded);
603         return;
604     }
605
606     m_private->append(m_pendingAppendData.data(), appendSize);
607     m_pendingAppendData.clear();
608 }
609
610 void SourceBuffer::sourceBufferPrivateAppendComplete(SourceBufferPrivate*, AppendResult result)
611 {
612     if (isRemoved())
613         return;
614
615     // Section 3.5.5 Buffer Append Algorithm, ctd.
616     // https://dvcs.w3.org/hg/html-media/raw-file/default/media-source/media-source.html#sourcebuffer-buffer-append
617
618     // 2. If the input buffer contains bytes that violate the SourceBuffer byte stream format specification,
619     // then run the append error algorithm with the decode error parameter set to true and abort this algorithm.
620     if (result == ParsingFailed) {
621         LOG(MediaSource, "SourceBuffer::sourceBufferPrivateAppendComplete(%p) - result = ParsingFailed", this);
622         appendError(true);
623         return;
624     }
625
626     // NOTE: Steps 3 - 6 enforced by sourceBufferPrivateDidReceiveInitializationSegment() and
627     // sourceBufferPrivateDidReceiveSample below.
628
629     // 7. Need more data: Return control to the calling algorithm.
630
631     // NOTE: return to Section 3.5.5
632     // 2.If the segment parser loop algorithm in the previous step was aborted, then abort this algorithm.
633     if (result != AppendSucceeded)
634         return;
635
636     // 3. Set the updating attribute to false.
637     m_updating = false;
638
639     // 4. Queue a task to fire a simple event named update at this SourceBuffer object.
640     scheduleEvent(eventNames().updateEvent);
641
642     // 5. Queue a task to fire a simple event named updateend at this SourceBuffer object.
643     scheduleEvent(eventNames().updateendEvent);
644
645     if (m_source)
646         m_source->monitorSourceBuffers();
647
648     MediaTime currentMediaTime = m_source->currentTime();
649     for (auto& trackBufferPair : m_trackBufferMap) {
650         TrackBuffer& trackBuffer = trackBufferPair.value;
651         const AtomicString& trackID = trackBufferPair.key;
652
653         if (trackBuffer.needsReenqueueing) {
654             LOG(MediaSource, "SourceBuffer::sourceBufferPrivateAppendComplete(%p) - reenqueuing at time (%s)", this, toString(currentMediaTime).utf8().data());
655             reenqueueMediaForTime(trackBuffer, trackID, currentMediaTime);
656         } else
657             provideMediaData(trackBuffer, trackID);
658     }
659
660     reportExtraMemoryCost();
661     if (extraMemoryCost() > this->maximumBufferSize())
662         m_bufferFull = true;
663
664     LOG(Media, "SourceBuffer::sourceBufferPrivateAppendComplete(%p) - buffered = %s", this, toString(m_buffered->ranges()).utf8().data());
665 }
666
667 void SourceBuffer::sourceBufferPrivateDidReceiveRenderingError(SourceBufferPrivate*, int error)
668 {
669 #if LOG_DISABLED
670     UNUSED_PARAM(error);
671 #endif
672
673     LOG(MediaSource, "SourceBuffer::sourceBufferPrivateDidReceiveRenderingError(%p) - result = %i", this, error);
674
675     if (!isRemoved())
676         m_source->streamEndedWithError(decodeError(), IgnorableExceptionCode());
677 }
678
679 static bool decodeTimeComparator(const PresentationOrderSampleMap::MapType::value_type& a, const PresentationOrderSampleMap::MapType::value_type& b)
680 {
681     return a.second->decodeTime() < b.second->decodeTime();
682 }
683
684 static PassRefPtr<TimeRanges> removeSamplesFromTrackBuffer(const DecodeOrderSampleMap::MapType& samples, SourceBuffer::TrackBuffer& trackBuffer, const SourceBuffer* buffer, const char* logPrefix)
685 {
686 #if !LOG_DISABLED
687     double earliestSample = std::numeric_limits<double>::infinity();
688     double latestSample = 0;
689     size_t bytesRemoved = 0;
690 #else
691     UNUSED_PARAM(logPrefix);
692     UNUSED_PARAM(buffer);
693 #endif
694
695     RefPtr<TimeRanges> erasedRanges = TimeRanges::create();
696     MediaTime microsecond(1, 1000000);
697     for (auto sampleIt : samples) {
698         const DecodeOrderSampleMap::KeyType& decodeKey = sampleIt.first;
699 #if !LOG_DISABLED
700         size_t startBufferSize = trackBuffer.samples.sizeInBytes();
701 #endif
702
703         RefPtr<MediaSample>& sample = sampleIt.second;
704         LOG(MediaSource, "SourceBuffer::%s(%p) - removing sample(%s)", logPrefix, buffer, toString(*sampleIt.second).utf8().data());
705
706         // Remove the erased samples from the TrackBuffer sample map.
707         trackBuffer.samples.removeSample(sample.get());
708
709         // Also remove the erased samples from the TrackBuffer decodeQueue.
710         trackBuffer.decodeQueue.erase(decodeKey);
711
712         double startTime = sample->presentationTime().toDouble();
713         double endTime = startTime + (sample->duration() + microsecond).toDouble();
714         erasedRanges->add(startTime, endTime);
715
716 #if !LOG_DISABLED
717         bytesRemoved += startBufferSize - trackBuffer.samples.sizeInBytes();
718         if (startTime < earliestSample)
719             earliestSample = startTime;
720         if (endTime > latestSample)
721             latestSample = endTime;
722 #endif
723     }
724
725 #if !LOG_DISABLED
726     if (bytesRemoved)
727         LOG(MediaSource, "SourceBuffer::%s(%p) removed %zu bytes, start(%lf), end(%lf)", logPrefix, buffer, bytesRemoved, earliestSample, latestSample);
728 #endif
729
730     return erasedRanges.release();
731 }
732
733 void SourceBuffer::removeCodedFrames(const MediaTime& start, const MediaTime& end)
734 {
735     LOG(MediaSource, "SourceBuffer::removeCodedFrames(%p) - start(%s), end(%s)", this, toString(start).utf8().data(), toString(end).utf8().data());
736
737     // 3.5.9 Coded Frame Removal Algorithm
738     // https://dvcs.w3.org/hg/html-media/raw-file/tip/media-source/media-source.html#sourcebuffer-coded-frame-removal
739
740     // 1. Let start be the starting presentation timestamp for the removal range.
741     MediaTime durationMediaTime = m_source->duration();
742     MediaTime currentMediaTime = m_source->currentTime();
743
744     // 2. Let end be the end presentation timestamp for the removal range.
745     // 3. For each track buffer in this source buffer, run the following steps:
746     for (auto& iter : m_trackBufferMap) {
747         TrackBuffer& trackBuffer = iter.value;
748
749         // 3.1. Let remove end timestamp be the current value of duration
750         // 3.2 If this track buffer has a random access point timestamp that is greater than or equal to end, then update
751         // remove end timestamp to that random access point timestamp.
752         // NOTE: findSyncSampleAfterPresentationTime will return the next sync sample on or after the presentation time
753         // or decodeOrder().end() if no sync sample exists after that presentation time.
754         DecodeOrderSampleMap::iterator removeDecodeEnd = trackBuffer.samples.decodeOrder().findSyncSampleAfterPresentationTime(end);
755         PresentationOrderSampleMap::iterator removePresentationEnd;
756         if (removeDecodeEnd == trackBuffer.samples.decodeOrder().end())
757             removePresentationEnd = trackBuffer.samples.presentationOrder().end();
758         else
759             removePresentationEnd = trackBuffer.samples.presentationOrder().findSampleWithPresentationTime(removeDecodeEnd->second->presentationTime());
760
761         PresentationOrderSampleMap::iterator removePresentationStart = trackBuffer.samples.presentationOrder().findSampleOnOrAfterPresentationTime(start);
762         if (removePresentationStart == removePresentationEnd)
763             continue;
764
765         // 3.3 Remove all media data, from this track buffer, that contain starting timestamps greater than or equal to
766         // start and less than the remove end timestamp.
767         // NOTE: frames must be removed in decode order, so that all dependant frames between the frame to be removed
768         // and the next sync sample frame are removed. But we must start from the first sample in decode order, not
769         // presentation order.
770         PresentationOrderSampleMap::iterator minDecodeTimeIter = std::min_element(removePresentationStart, removePresentationEnd, decodeTimeComparator);
771         DecodeOrderSampleMap::KeyType decodeKey(minDecodeTimeIter->second->decodeTime(), minDecodeTimeIter->second->presentationTime());
772         DecodeOrderSampleMap::iterator removeDecodeStart = trackBuffer.samples.decodeOrder().findSampleWithDecodeKey(decodeKey);
773
774         DecodeOrderSampleMap::MapType erasedSamples(removeDecodeStart, removeDecodeEnd);
775         RefPtr<TimeRanges> erasedRanges = removeSamplesFromTrackBuffer(erasedSamples, trackBuffer, this, "removeCodedFrames");
776
777         // Only force the TrackBuffer to re-enqueue if the removed ranges overlap with enqueued and possibly
778         // not yet displayed samples.
779         if (currentMediaTime < trackBuffer.lastEnqueuedPresentationTime) {
780             PlatformTimeRanges possiblyEnqueuedRanges(currentMediaTime, trackBuffer.lastEnqueuedPresentationTime);
781             possiblyEnqueuedRanges.intersectWith(erasedRanges->ranges());
782             if (possiblyEnqueuedRanges.length())
783                 trackBuffer.needsReenqueueing = true;
784         }
785
786         erasedRanges->invert();
787         m_buffered->intersectWith(*erasedRanges);
788
789         // 3.4 If this object is in activeSourceBuffers, the current playback position is greater than or equal to start
790         // and less than the remove end timestamp, and HTMLMediaElement.readyState is greater than HAVE_METADATA, then set
791         // the HTMLMediaElement.readyState attribute to HAVE_METADATA and stall playback.
792         if (m_active && currentMediaTime >= start && currentMediaTime < end && m_private->readyState() > MediaPlayer::HaveMetadata)
793             m_private->setReadyState(MediaPlayer::HaveMetadata);
794     }
795
796     // 4. If buffer full flag equals true and this object is ready to accept more bytes, then set the buffer full flag to false.
797     // No-op
798
799     LOG(Media, "SourceBuffer::removeCodedFrames(%p) - buffered = %s", this, toString(m_buffered->ranges()).utf8().data());
800 }
801
802 void SourceBuffer::removeTimerFired()
803 {
804     ASSERT(m_updating);
805     ASSERT(m_pendingRemoveStart.isValid());
806     ASSERT(m_pendingRemoveStart < m_pendingRemoveEnd);
807
808     // Section 3.5.7 Range Removal
809     // http://w3c.github.io/media-source/#sourcebuffer-range-removal
810
811     // 6. Run the coded frame removal algorithm with start and end as the start and end of the removal range.
812     removeCodedFrames(m_pendingRemoveStart, m_pendingRemoveEnd);
813
814     // 7. Set the updating attribute to false.
815     m_updating = false;
816     m_pendingRemoveStart = MediaTime::invalidTime();
817     m_pendingRemoveEnd = MediaTime::invalidTime();
818
819     // 8. Queue a task to fire a simple event named update at this SourceBuffer object.
820     scheduleEvent(eventNames().updateEvent);
821
822     // 9. Queue a task to fire a simple event named updateend at this SourceBuffer object.
823     scheduleEvent(eventNames().updateendEvent);
824 }
825
826 void SourceBuffer::evictCodedFrames(size_t newDataSize)
827 {
828     // 3.5.13 Coded Frame Eviction Algorithm
829     // http://www.w3.org/TR/media-source/#sourcebuffer-coded-frame-eviction
830
831     if (isRemoved())
832         return;
833
834     // This algorithm is run to free up space in this source buffer when new data is appended.
835     // 1. Let new data equal the data that is about to be appended to this SourceBuffer.
836     // 2. If the buffer full flag equals false, then abort these steps.
837     if (!m_bufferFull)
838         return;
839
840     size_t maximumBufferSize = this->maximumBufferSize();
841
842     // 3. Let removal ranges equal a list of presentation time ranges that can be evicted from
843     // the presentation to make room for the new data.
844
845     // NOTE: begin by removing data from the beginning of the buffered ranges, 30 seconds at
846     // a time, up to 30 seconds before currentTime.
847     MediaTime thirtySeconds = MediaTime(30, 1);
848     MediaTime currentTime = m_source->currentTime();
849     MediaTime maximumRangeEnd = currentTime - thirtySeconds;
850
851 #if !LOG_DISABLED
852     LOG(MediaSource, "SourceBuffer::evictCodedFrames(%p) - currentTime = %lf, require %zu bytes, maximum buffer size is %zu", this, m_source->currentTime().toDouble(), extraMemoryCost() + newDataSize, maximumBufferSize);
853     size_t initialBufferedSize = extraMemoryCost();
854 #endif
855
856     MediaTime rangeStart = MediaTime::zeroTime();
857     MediaTime rangeEnd = rangeStart + thirtySeconds;
858     while (rangeStart < maximumRangeEnd) {
859         // 4. For each range in removal ranges, run the coded frame removal algorithm with start and
860         // end equal to the removal range start and end timestamp respectively.
861         removeCodedFrames(rangeStart, std::min(rangeEnd, maximumRangeEnd));
862         if (extraMemoryCost() + newDataSize < maximumBufferSize) {
863             m_bufferFull = false;
864             break;
865         }
866
867         rangeStart += thirtySeconds;
868         rangeEnd += thirtySeconds;
869     }
870
871     if (!m_bufferFull) {
872         LOG(MediaSource, "SourceBuffer::evictCodedFrames(%p) - evicted %zu bytes", this, initialBufferedSize - extraMemoryCost());
873         return;
874     }
875
876     // If there still isn't enough free space and there buffers in time ranges after the current range (ie. there is a gap after
877     // the current buffered range), delete 30 seconds at a time from duration back to the current time range or 30 seconds after
878     // currenTime whichever we hit first.
879     auto buffered = m_buffered->ranges();
880     size_t currentTimeRange = buffered.find(currentTime);
881     if (currentTimeRange == notFound || currentTimeRange == buffered.length() - 1) {
882         LOG(MediaSource, "SourceBuffer::evictCodedFrames(%p) - evicted %zu bytes but FAILED to free enough", this, initialBufferedSize - extraMemoryCost());
883         return;
884     }
885
886     MediaTime minimumRangeStart = currentTime + thirtySeconds;
887
888     rangeEnd = m_source->duration();
889     rangeStart = rangeEnd - thirtySeconds;
890     while (rangeStart > minimumRangeStart) {
891
892         // Do not evict data from the time range that contains currentTime.
893         size_t startTimeRange = buffered.find(rangeStart);
894         if (startTimeRange == currentTimeRange) {
895             size_t endTimeRange = buffered.find(rangeEnd);
896             if (endTimeRange == currentTimeRange)
897                 break;
898
899             rangeEnd = buffered.start(endTimeRange);
900         }
901
902         // 4. For each range in removal ranges, run the coded frame removal algorithm with start and
903         // end equal to the removal range start and end timestamp respectively.
904         removeCodedFrames(std::max(minimumRangeStart, rangeStart), rangeEnd);
905         if (extraMemoryCost() + newDataSize < maximumBufferSize) {
906             m_bufferFull = false;
907             break;
908         }
909
910         rangeStart -= thirtySeconds;
911         rangeEnd -= thirtySeconds;
912     }
913
914     LOG(MediaSource, "SourceBuffer::evictCodedFrames(%p) - evicted %zu bytes%s", this, initialBufferedSize - extraMemoryCost(), m_bufferFull ? "" : " but FAILED to free enough");
915 }
916
917 size_t SourceBuffer::maximumBufferSize() const
918 {
919     if (isRemoved())
920         return 0;
921
922     HTMLMediaElement* element = m_source->mediaElement();
923     if (!element)
924         return 0;
925
926     return element->maximumSourceBufferSize(*this);
927 }
928
929 const AtomicString& SourceBuffer::decodeError()
930 {
931     static NeverDestroyed<AtomicString> decode("decode", AtomicString::ConstructFromLiteral);
932     return decode;
933 }
934
935 const AtomicString& SourceBuffer::networkError()
936 {
937     static NeverDestroyed<AtomicString> network("network", AtomicString::ConstructFromLiteral);
938     return network;
939 }
940
941 VideoTrackList* SourceBuffer::videoTracks()
942 {
943     if (!m_source || !m_source->mediaElement())
944         return nullptr;
945
946     if (!m_videoTracks)
947         m_videoTracks = VideoTrackList::create(m_source->mediaElement(), ActiveDOMObject::scriptExecutionContext());
948
949     return m_videoTracks.get();
950 }
951
952 AudioTrackList* SourceBuffer::audioTracks()
953 {
954     if (!m_source || !m_source->mediaElement())
955         return nullptr;
956
957     if (!m_audioTracks)
958         m_audioTracks = AudioTrackList::create(m_source->mediaElement(), ActiveDOMObject::scriptExecutionContext());
959
960     return m_audioTracks.get();
961 }
962
963 TextTrackList* SourceBuffer::textTracks()
964 {
965     if (!m_source || !m_source->mediaElement())
966         return nullptr;
967
968     if (!m_textTracks)
969         m_textTracks = TextTrackList::create(m_source->mediaElement(), ActiveDOMObject::scriptExecutionContext());
970
971     return m_textTracks.get();
972 }
973
974 void SourceBuffer::setActive(bool active)
975 {
976     if (m_active == active)
977         return;
978
979     m_active = active;
980     m_private->setActive(active);
981     if (!isRemoved())
982         m_source->sourceBufferDidChangeAcitveState(this, active);
983 }
984
985 void SourceBuffer::sourceBufferPrivateDidEndStream(SourceBufferPrivate*, const WTF::AtomicString& error)
986 {
987     LOG(MediaSource, "SourceBuffer::sourceBufferPrivateDidEndStream(%p) - result = %s", this, String(error).utf8().data());
988
989     if (!isRemoved())
990         m_source->streamEndedWithError(error, IgnorableExceptionCode());
991 }
992
993 void SourceBuffer::sourceBufferPrivateDidReceiveInitializationSegment(SourceBufferPrivate*, const InitializationSegment& segment)
994 {
995     if (isRemoved())
996         return;
997
998     LOG(MediaSource, "SourceBuffer::sourceBufferPrivateDidReceiveInitializationSegment(%p)", this);
999
1000     // 3.5.8 Initialization Segment Received (ctd)
1001     // https://rawgit.com/w3c/media-source/c3ad59c7a370d04430969ba73d18dc9bcde57a33/index.html#sourcebuffer-init-segment-received [Editor's Draft 09 January 2015]
1002
1003     // 1. Update the duration attribute if it currently equals NaN:
1004     if (m_source->duration().isInvalid()) {
1005         // ↳ If the initialization segment contains a duration:
1006         //   Run the duration change algorithm with new duration set to the duration in the initialization segment.
1007         // ↳ Otherwise:
1008         //   Run the duration change algorithm with new duration set to positive Infinity.
1009         MediaTime newDuration = segment.duration.isValid() ? segment.duration : MediaTime::positiveInfiniteTime();
1010         m_source->setDurationInternal(newDuration);
1011     }
1012
1013     // 2. If the initialization segment has no audio, video, or text tracks, then run the append error algorithm
1014     // with the decode error parameter set to true and abort these steps.
1015     if (!segment.audioTracks.size() && !segment.videoTracks.size() && !segment.textTracks.size())
1016         appendError(true);
1017
1018     // 3. If the first initialization segment flag is true, then run the following steps:
1019     if (m_receivedFirstInitializationSegment) {
1020
1021         // 3.1. Verify the following properties. If any of the checks fail then run the append error algorithm
1022         // with the decode error parameter set to true and abort these steps.
1023         if (!validateInitializationSegment(segment)) {
1024             appendError(true);
1025             return;
1026         }
1027         // 3.2 Add the appropriate track descriptions from this initialization segment to each of the track buffers.
1028         ASSERT(segment.audioTracks.size() == audioTracks()->length());
1029         for (auto& audioTrackInfo : segment.audioTracks) {
1030             if (audioTracks()->length() == 1) {
1031                 audioTracks()->item(0)->setPrivate(audioTrackInfo.track);
1032                 break;
1033             }
1034
1035             auto audioTrack = audioTracks()->getTrackById(audioTrackInfo.track->id());
1036             ASSERT(audioTrack);
1037             audioTrack->setPrivate(audioTrackInfo.track);
1038         }
1039
1040         ASSERT(segment.videoTracks.size() == videoTracks()->length());
1041         for (auto& videoTrackInfo : segment.videoTracks) {
1042             if (videoTracks()->length() == 1) {
1043                 videoTracks()->item(0)->setPrivate(videoTrackInfo.track);
1044                 break;
1045             }
1046
1047             auto videoTrack = videoTracks()->getTrackById(videoTrackInfo.track->id());
1048             ASSERT(videoTrack);
1049             videoTrack->setPrivate(videoTrackInfo.track);
1050         }
1051
1052         ASSERT(segment.textTracks.size() == textTracks()->length());
1053         for (auto& textTrackInfo : segment.textTracks) {
1054             if (textTracks()->length() == 1) {
1055                 downcast<InbandTextTrack>(*textTracks()->item(0)).setPrivate(textTrackInfo.track);
1056                 break;
1057             }
1058
1059             auto textTrack = textTracks()->getTrackById(textTrackInfo.track->id());
1060             ASSERT(textTrack);
1061             downcast<InbandTextTrack>(*textTrack).setPrivate(textTrackInfo.track);
1062         }
1063
1064         // 3.3 Set the need random access point flag on all track buffers to true.
1065         for (auto& trackBuffer : m_trackBufferMap.values())
1066             trackBuffer.needRandomAccessFlag = true;
1067     }
1068
1069     // 4. Let active track flag equal false.
1070     bool activeTrackFlag = false;
1071
1072     // 5. If the first initialization segment flag is false, then run the following steps:
1073     if (!m_receivedFirstInitializationSegment) {
1074         // 5.1 If the initialization segment contains tracks with codecs the user agent does not support,
1075         // then run the append error algorithm with the decode error parameter set to true and abort these steps.
1076         // NOTE: This check is the responsibility of the SourceBufferPrivate.
1077
1078         // 5.2 For each audio track in the initialization segment, run following steps:
1079         for (auto& audioTrackInfo : segment.audioTracks) {
1080             AudioTrackPrivate* audioTrackPrivate = audioTrackInfo.track.get();
1081
1082             // FIXME: Implement steps 5.2.1-5.2.8.1 as per Editor's Draft 09 January 2015, and reorder this
1083             // 5.2.1 Let new audio track be a new AudioTrack object.
1084             // 5.2.2 Generate a unique ID and assign it to the id property on new video track.
1085             RefPtr<AudioTrack> newAudioTrack = AudioTrack::create(this, audioTrackPrivate);
1086             newAudioTrack->setSourceBuffer(this);
1087
1088             // 5.2.3 If audioTracks.length equals 0, then run the following steps:
1089             if (!audioTracks()->length()) {
1090                 // 5.2.3.1 Set the enabled property on new audio track to true.
1091                 newAudioTrack->setEnabled(true);
1092
1093                 // 5.2.3.2 Set active track flag to true.
1094                 activeTrackFlag = true;
1095             }
1096
1097             // 5.2.4 Add new audio track to the audioTracks attribute on this SourceBuffer object.
1098             // 5.2.5 Queue a task to fire a trusted event named addtrack, that does not bubble and is
1099             // not cancelable, and that uses the TrackEvent interface, at the AudioTrackList object
1100             // referenced by the audioTracks attribute on this SourceBuffer object.
1101             audioTracks()->append(newAudioTrack);
1102
1103             // 5.2.6 Add new audio track to the audioTracks attribute on the HTMLMediaElement.
1104             // 5.2.7 Queue a task to fire a trusted event named addtrack, that does not bubble and is
1105             // not cancelable, and that uses the TrackEvent interface, at the AudioTrackList object
1106             // referenced by the audioTracks attribute on the HTMLMediaElement.
1107             m_source->mediaElement()->audioTracks()->append(newAudioTrack);
1108
1109             // 5.2.8 Create a new track buffer to store coded frames for this track.
1110             ASSERT(!m_trackBufferMap.contains(newAudioTrack->id()));
1111             TrackBuffer& trackBuffer = m_trackBufferMap.add(newAudioTrack->id(), TrackBuffer()).iterator->value;
1112
1113             // 5.2.9 Add the track description for this track to the track buffer.
1114             trackBuffer.description = audioTrackInfo.description;
1115
1116             m_audioCodecs.append(trackBuffer.description->codec());
1117         }
1118
1119         // 5.3 For each video track in the initialization segment, run following steps:
1120         for (auto& videoTrackInfo : segment.videoTracks) {
1121             VideoTrackPrivate* videoTrackPrivate = videoTrackInfo.track.get();
1122
1123             // FIXME: Implement steps 5.3.1-5.3.8.1 as per Editor's Draft 09 January 2015, and reorder this
1124             // 5.3.1 Let new video track be a new VideoTrack object.
1125             // 5.3.2 Generate a unique ID and assign it to the id property on new video track.
1126             RefPtr<VideoTrack> newVideoTrack = VideoTrack::create(this, videoTrackPrivate);
1127             newVideoTrack->setSourceBuffer(this);
1128
1129             // 5.3.3 If videoTracks.length equals 0, then run the following steps:
1130             if (!videoTracks()->length()) {
1131                 // 5.3.3.1 Set the selected property on new video track to true.
1132                 newVideoTrack->setSelected(true);
1133
1134                 // 5.3.3.2 Set active track flag to true.
1135                 activeTrackFlag = true;
1136             }
1137
1138             // 5.3.4 Add new video track to the videoTracks attribute on this SourceBuffer object.
1139             // 5.3.5 Queue a task to fire a trusted event named addtrack, that does not bubble and is
1140             // not cancelable, and that uses the TrackEvent interface, at the VideoTrackList object
1141             // referenced by the videoTracks attribute on this SourceBuffer object.
1142             videoTracks()->append(newVideoTrack);
1143
1144             // 5.3.6 Add new video track to the videoTracks attribute on the HTMLMediaElement.
1145             // 5.3.7 Queue a task to fire a trusted event named addtrack, that does not bubble and is
1146             // not cancelable, and that uses the TrackEvent interface, at the VideoTrackList object
1147             // referenced by the videoTracks attribute on the HTMLMediaElement.
1148             m_source->mediaElement()->videoTracks()->append(newVideoTrack);
1149
1150             // 5.3.8 Create a new track buffer to store coded frames for this track.
1151             ASSERT(!m_trackBufferMap.contains(newVideoTrack->id()));
1152             TrackBuffer& trackBuffer = m_trackBufferMap.add(newVideoTrack->id(), TrackBuffer()).iterator->value;
1153
1154             // 5.3.9 Add the track description for this track to the track buffer.
1155             trackBuffer.description = videoTrackInfo.description;
1156
1157             m_videoCodecs.append(trackBuffer.description->codec());
1158         }
1159
1160         // 5.4 For each text track in the initialization segment, run following steps:
1161         for (auto& textTrackInfo : segment.textTracks) {
1162             InbandTextTrackPrivate* textTrackPrivate = textTrackInfo.track.get();
1163
1164             // FIXME: Implement steps 5.4.1-5.4.8.1 as per Editor's Draft 09 January 2015, and reorder this
1165             // 5.4.1 Let new text track be a new TextTrack object with its properties populated with the
1166             // appropriate information from the initialization segment.
1167             RefPtr<InbandTextTrack> newTextTrack = InbandTextTrack::create(scriptExecutionContext(), this, textTrackPrivate);
1168
1169             // 5.4.2 If the mode property on new text track equals "showing" or "hidden", then set active
1170             // track flag to true.
1171             if (textTrackPrivate->mode() != InbandTextTrackPrivate::Disabled)
1172                 activeTrackFlag = true;
1173
1174             // 5.4.3 Add new text track to the textTracks attribute on this SourceBuffer object.
1175             // 5.4.4 Queue a task to fire a trusted event named addtrack, that does not bubble and is
1176             // not cancelable, and that uses the TrackEvent interface, at textTracks attribute on this
1177             // SourceBuffer object.
1178             textTracks()->append(newTextTrack);
1179
1180             // 5.4.5 Add new text track to the textTracks attribute on the HTMLMediaElement.
1181             // 5.4.6 Queue a task to fire a trusted event named addtrack, that does not bubble and is
1182             // not cancelable, and that uses the TrackEvent interface, at the TextTrackList object
1183             // referenced by the textTracks attribute on the HTMLMediaElement.
1184             m_source->mediaElement()->textTracks()->append(newTextTrack);
1185
1186             // 5.4.7 Create a new track buffer to store coded frames for this track.
1187             ASSERT(!m_trackBufferMap.contains(textTrackPrivate->id()));
1188             TrackBuffer& trackBuffer = m_trackBufferMap.add(textTrackPrivate->id(), TrackBuffer()).iterator->value;
1189
1190             // 5.4.8 Add the track description for this track to the track buffer.
1191             trackBuffer.description = textTrackInfo.description;
1192
1193             m_textCodecs.append(trackBuffer.description->codec());
1194         }
1195
1196         // 5.5 If active track flag equals true, then run the following steps:
1197         if (activeTrackFlag) {
1198             // 5.5.1 Add this SourceBuffer to activeSourceBuffers.
1199             // 5.5.2 Queue a task to fire a simple event named addsourcebuffer at activeSourceBuffers
1200             setActive(true);
1201         }
1202
1203         // 5.6 Set first initialization segment flag to true.
1204         m_receivedFirstInitializationSegment = true;
1205     }
1206
1207     // 6. If the HTMLMediaElement.readyState attribute is HAVE_NOTHING, then run the following steps:
1208     if (m_private->readyState() == MediaPlayer::HaveNothing) {
1209         // 6.1 If one or more objects in sourceBuffers have first initialization segment flag set to false, then abort these steps.
1210         for (auto& sourceBuffer : *m_source->sourceBuffers()) {
1211             if (!sourceBuffer->m_receivedFirstInitializationSegment)
1212                 return;
1213         }
1214
1215         // 6.2 Set the HTMLMediaElement.readyState attribute to HAVE_METADATA.
1216         // 6.3 Queue a task to fire a simple event named loadedmetadata at the media element.
1217         m_private->setReadyState(MediaPlayer::HaveMetadata);
1218     }
1219
1220     // 7. If the active track flag equals true and the HTMLMediaElement.readyState
1221     // attribute is greater than HAVE_CURRENT_DATA, then set the HTMLMediaElement.readyState
1222     // attribute to HAVE_METADATA.
1223     if (activeTrackFlag && m_private->readyState() > MediaPlayer::HaveCurrentData)
1224         m_private->setReadyState(MediaPlayer::HaveMetadata);
1225 }
1226
1227 bool SourceBuffer::validateInitializationSegment(const InitializationSegment& segment)
1228 {
1229     // FIXME: ordering of all 3.5.X (X>=7) functions needs to be updated to post-[24 July 2014 Editor's Draft] version
1230     // 3.5.8 Initialization Segment Received (ctd)
1231     // https://rawgit.com/w3c/media-source/c3ad59c7a370d04430969ba73d18dc9bcde57a33/index.html#sourcebuffer-init-segment-received [Editor's Draft 09 January 2015]
1232
1233     // Note: those are checks from step 3.1
1234     //   * The number of audio, video, and text tracks match what was in the first initialization segment.
1235     if (segment.audioTracks.size() != audioTracks()->length()
1236         || segment.videoTracks.size() != videoTracks()->length()
1237         || segment.textTracks.size() != textTracks()->length())
1238         return false;
1239
1240     //   * The codecs for each track, match what was specified in the first initialization segment.
1241     for (auto& audioTrackInfo : segment.audioTracks) {
1242         if (!m_audioCodecs.contains(audioTrackInfo.description->codec()))
1243             return false;
1244     }
1245
1246     for (auto& videoTrackInfo : segment.videoTracks) {
1247         if (!m_videoCodecs.contains(videoTrackInfo.description->codec()))
1248             return false;
1249     }
1250
1251     for (auto& textTrackInfo : segment.textTracks) {
1252         if (!m_textCodecs.contains(textTrackInfo.description->codec()))
1253             return false;
1254     }
1255
1256     //   * If more than one track for a single type are present (ie 2 audio tracks), then the Track
1257     //   IDs match the ones in the first initialization segment.
1258     if (segment.audioTracks.size() >= 2) {
1259         for (auto& audioTrackInfo : segment.audioTracks) {
1260             if (!m_trackBufferMap.contains(audioTrackInfo.track->id()))
1261                 return false;
1262         }
1263     }
1264
1265     if (segment.videoTracks.size() >= 2) {
1266         for (auto& videoTrackInfo : segment.videoTracks) {
1267             if (!m_trackBufferMap.contains(videoTrackInfo.track->id()))
1268                 return false;
1269         }
1270     }
1271
1272     if (segment.textTracks.size() >= 2) {
1273         for (auto& textTrackInfo : segment.videoTracks) {
1274             if (!m_trackBufferMap.contains(textTrackInfo.track->id()))
1275                 return false;
1276         }
1277     }
1278
1279     return true;
1280 }
1281
1282 class SampleLessThanComparator {
1283 public:
1284     bool operator()(std::pair<MediaTime, RefPtr<MediaSample>> value1, std::pair<MediaTime, RefPtr<MediaSample>> value2)
1285     {
1286         return value1.first < value2.first;
1287     }
1288
1289     bool operator()(MediaTime value1, std::pair<MediaTime, RefPtr<MediaSample>> value2)
1290     {
1291         return value1 < value2.first;
1292     }
1293
1294     bool operator()(std::pair<MediaTime, RefPtr<MediaSample>> value1, MediaTime value2)
1295     {
1296         return value1.first < value2;
1297     }
1298 };
1299
1300 void SourceBuffer::appendError(bool decodeErrorParam)
1301 {
1302     // 3.5.3 Append Error Algorithm
1303     // https://rawgit.com/w3c/media-source/c3ad59c7a370d04430969ba73d18dc9bcde57a33/index.html#sourcebuffer-append-error [Editor's Draft 09 January 2015]
1304
1305     ASSERT(m_updating);
1306     // 1. Run the reset parser state algorithm.
1307     resetParserState();
1308
1309     // 2. Set the updating attribute to false.
1310     m_updating = false;
1311
1312     // 3. Queue a task to fire a simple event named error at this SourceBuffer object.
1313     scheduleEvent(eventNames().errorEvent);
1314
1315     // 4. Queue a task to fire a simple event named updateend at this SourceBuffer object.
1316     scheduleEvent(eventNames().updateendEvent);
1317
1318     // 5. If decode error is true, then run the end of stream algorithm with the error parameter set to "decode".
1319     if (decodeErrorParam)
1320         m_source->streamEndedWithError(decodeError(), IgnorableExceptionCode());
1321 }
1322
1323 void SourceBuffer::sourceBufferPrivateDidReceiveSample(SourceBufferPrivate*, PassRefPtr<MediaSample> prpSample)
1324 {
1325     if (isRemoved())
1326         return;
1327
1328     // 3.5.1 Segment Parser Loop
1329     // 6.1 If the first initialization segment received flag is false, then run the append error algorithm
1330     //     with the decode error parameter set to true and abort this algorithm.
1331     // Note: current design makes SourceBuffer somehow ignorant of append state - it's more a thing
1332     //  of SourceBufferPrivate. That's why this check can't really be done in appendInternal.
1333     //  unless we force some kind of design with state machine switching.
1334     if (!m_receivedFirstInitializationSegment) {
1335         appendError(true);
1336         return;
1337     }
1338
1339     RefPtr<MediaSample> sample = prpSample;
1340
1341     // 3.5.8 Coded Frame Processing
1342     // http://www.w3.org/TR/media-source/#sourcebuffer-coded-frame-processing
1343
1344     // When complete coded frames have been parsed by the segment parser loop then the following steps
1345     // are run:
1346     // 1. For each coded frame in the media segment run the following steps:
1347     // 1.1. Loop Top
1348     do {
1349         MediaTime presentationTimestamp;
1350         MediaTime decodeTimestamp;
1351
1352         if (m_shouldGenerateTimestamps) {
1353             // ↳ If generate timestamps flag equals true:
1354             // 1. Let presentation timestamp equal 0.
1355             presentationTimestamp = MediaTime::zeroTime();
1356
1357             // 2. Let decode timestamp equal 0.
1358             decodeTimestamp = MediaTime::zeroTime();
1359         } else {
1360             // ↳ Otherwise:
1361             // 1. Let presentation timestamp be a double precision floating point representation of
1362             // the coded frame's presentation timestamp in seconds.
1363             presentationTimestamp = sample->presentationTime();
1364
1365             // 2. Let decode timestamp be a double precision floating point representation of the coded frame's
1366             // decode timestamp in seconds.
1367             decodeTimestamp = sample->decodeTime();
1368         }
1369
1370         // 1.2 Let frame duration be a double precision floating point representation of the coded frame's
1371         // duration in seconds.
1372         MediaTime frameDuration = sample->duration();
1373
1374         // 1.3 If mode equals "sequence" and group start timestamp is set, then run the following steps:
1375         if (m_mode == sequenceKeyword()) {
1376             // 1.3.1 Set timestampOffset equal to group start timestamp - presentation timestamp.
1377             m_timestampOffset = m_groupStartTimestamp;
1378
1379             // 1.3.2 Set group end timestamp equal to group start timestamp.
1380             m_groupEndTimestamp = m_groupStartTimestamp;
1381
1382             // 1.3.3 Set the need random access point flag on all track buffers to true.
1383             for (auto& trackBuffer : m_trackBufferMap.values())
1384                 trackBuffer.needRandomAccessFlag = true;
1385
1386             // 1.3.4 Unset group start timestamp.
1387             m_groupStartTimestamp = MediaTime::invalidTime();
1388         }
1389
1390         // 1.4 If timestampOffset is not 0, then run the following steps:
1391         if (m_timestampOffset) {
1392             // 1.4.1 Add timestampOffset to the presentation timestamp.
1393             presentationTimestamp += m_timestampOffset;
1394
1395             // 1.4.2 Add timestampOffset to the decode timestamp.
1396             decodeTimestamp += m_timestampOffset;
1397         }
1398
1399         // 1.5 Let track buffer equal the track buffer that the coded frame will be added to.
1400         AtomicString trackID = sample->trackID();
1401         auto it = m_trackBufferMap.find(trackID);
1402         if (it == m_trackBufferMap.end())
1403             it = m_trackBufferMap.add(trackID, TrackBuffer()).iterator;
1404         TrackBuffer& trackBuffer = it->value;
1405
1406         // 1.6 ↳ If last decode timestamp for track buffer is set and decode timestamp is less than last
1407         // decode timestamp:
1408         // OR
1409         // ↳ If last decode timestamp for track buffer is set and the difference between decode timestamp and
1410         // last decode timestamp is greater than 2 times last frame duration:
1411         if (trackBuffer.lastDecodeTimestamp.isValid() && (decodeTimestamp < trackBuffer.lastDecodeTimestamp
1412             || abs(decodeTimestamp - trackBuffer.lastDecodeTimestamp) > (trackBuffer.lastFrameDuration * 2))) {
1413
1414             // 1.6.1:
1415             if (m_mode == segmentsKeyword()) {
1416                 // ↳ If mode equals "segments":
1417                 // Set group end timestamp to presentation timestamp.
1418                 m_groupEndTimestamp = presentationTimestamp;
1419             } else if (m_mode == sequenceKeyword()) {
1420                 // ↳ If mode equals "sequence":
1421                 // Set group start timestamp equal to the group end timestamp.
1422                 m_groupStartTimestamp = m_groupEndTimestamp;
1423             }
1424
1425             for (auto& trackBuffer : m_trackBufferMap.values()) {
1426                 // 1.6.2 Unset the last decode timestamp on all track buffers.
1427                 trackBuffer.lastDecodeTimestamp = MediaTime::invalidTime();
1428                 // 1.6.3 Unset the last frame duration on all track buffers.
1429                 trackBuffer.lastFrameDuration = MediaTime::invalidTime();
1430                 // 1.6.4 Unset the highest presentation timestamp on all track buffers.
1431                 trackBuffer.highestPresentationTimestamp = MediaTime::invalidTime();
1432                 // 1.6.5 Set the need random access point flag on all track buffers to true.
1433                 trackBuffer.needRandomAccessFlag = true;
1434             }
1435
1436             // 1.6.6 Jump to the Loop Top step above to restart processing of the current coded frame.
1437             continue;
1438         }
1439
1440         if (m_timestampOffset) {
1441             // Reflect the new timestamps back into the sample.
1442             sample->offsetTimestampsBy(m_timestampOffset);
1443         }
1444
1445         // 1.7 Let frame end timestamp equal the sum of presentation timestamp and frame duration.
1446         MediaTime frameEndTimestamp = presentationTimestamp + frameDuration;
1447
1448         // 1.8 If presentation timestamp is less than appendWindowStart, then set the need random access
1449         // point flag to true, drop the coded frame, and jump to the top of the loop to start processing
1450         // the next coded frame.
1451         // 1.9 If frame end timestamp is greater than appendWindowEnd, then set the need random access
1452         // point flag to true, drop the coded frame, and jump to the top of the loop to start processing
1453         // the next coded frame.
1454         if (presentationTimestamp < m_appendWindowStart || frameEndTimestamp > m_appendWindowEnd) {
1455             trackBuffer.needRandomAccessFlag = true;
1456             didDropSample();
1457             return;
1458         }
1459
1460
1461         // 1.10 If the decode timestamp is less than the presentation start time, then run the end of stream
1462         // algorithm with the error parameter set to "decode", and abort these steps.
1463         // NOTE: Until <https://www.w3.org/Bugs/Public/show_bug.cgi?id=27487> is resolved, we will only check
1464         // the presentation timestamp.
1465         MediaTime presentationStartTime = MediaTime::zeroTime();
1466         if (presentationTimestamp < presentationStartTime) {
1467             LOG(MediaSource, "SourceBuffer::sourceBufferPrivateDidReceiveSample(%p) - failing because presentationTimestamp < presentationStartTime", this);
1468             m_source->streamEndedWithError(decodeError(), IgnorableExceptionCode());
1469             return;
1470         }
1471
1472         // 1.11 If the need random access point flag on track buffer equals true, then run the following steps:
1473         if (trackBuffer.needRandomAccessFlag) {
1474             // 1.11.1 If the coded frame is not a random access point, then drop the coded frame and jump
1475             // to the top of the loop to start processing the next coded frame.
1476             if (!sample->isSync()) {
1477                 didDropSample();
1478                 return;
1479             }
1480
1481             // 1.11.2 Set the need random access point flag on track buffer to false.
1482             trackBuffer.needRandomAccessFlag = false;
1483         }
1484
1485         // 1.12 Let spliced audio frame be an unset variable for holding audio splice information
1486         // 1.13 Let spliced timed text frame be an unset variable for holding timed text splice information
1487         // FIXME: Add support for sample splicing.
1488
1489         SampleMap erasedSamples;
1490         MediaTime microsecond(1, 1000000);
1491
1492         // 1.14 If last decode timestamp for track buffer is unset and presentation timestamp falls
1493         // falls within the presentation interval of a coded frame in track buffer, then run the
1494         // following steps:
1495         if (trackBuffer.lastDecodeTimestamp.isInvalid()) {
1496             auto iter = trackBuffer.samples.presentationOrder().findSampleContainingPresentationTime(presentationTimestamp);
1497             if (iter != trackBuffer.samples.presentationOrder().end()) {
1498                 // 1.14.1 Let overlapped frame be the coded frame in track buffer that matches the condition above.
1499                 RefPtr<MediaSample> overlappedFrame = iter->second;
1500
1501                 // 1.14.2 If track buffer contains audio coded frames:
1502                 // Run the audio splice frame algorithm and if a splice frame is returned, assign it to
1503                 // spliced audio frame.
1504                 // FIXME: Add support for sample splicing.
1505
1506                 // If track buffer contains video coded frames:
1507                 if (trackBuffer.description->isVideo()) {
1508                     // 1.14.2.1 Let overlapped frame presentation timestamp equal the presentation timestamp
1509                     // of overlapped frame.
1510                     MediaTime overlappedFramePresentationTimestamp = overlappedFrame->presentationTime();
1511
1512                     // 1.14.2.2 Let remove window timestamp equal overlapped frame presentation timestamp
1513                     // plus 1 microsecond.
1514                     MediaTime removeWindowTimestamp = overlappedFramePresentationTimestamp + microsecond;
1515
1516                     // 1.14.2.3 If the presentation timestamp is less than the remove window timestamp,
1517                     // then remove overlapped frame and any coded frames that depend on it from track buffer.
1518                     if (presentationTimestamp < removeWindowTimestamp)
1519                         erasedSamples.addSample(iter->second);
1520                 }
1521
1522                 // If track buffer contains timed text coded frames:
1523                 // Run the text splice frame algorithm and if a splice frame is returned, assign it to spliced timed text frame.
1524                 // FIXME: Add support for sample splicing.
1525             }
1526         }
1527
1528         // 1.15 Remove existing coded frames in track buffer:
1529         // If highest presentation timestamp for track buffer is not set:
1530         if (trackBuffer.highestPresentationTimestamp.isInvalid()) {
1531             // Remove all coded frames from track buffer that have a presentation timestamp greater than or
1532             // equal to presentation timestamp and less than frame end timestamp.
1533             auto iter_pair = trackBuffer.samples.presentationOrder().findSamplesBetweenPresentationTimes(presentationTimestamp, frameEndTimestamp);
1534             if (iter_pair.first != trackBuffer.samples.presentationOrder().end())
1535                 erasedSamples.addRange(iter_pair.first, iter_pair.second);
1536         }
1537
1538         // If highest presentation timestamp for track buffer is set and less than or equal to presentation timestamp
1539         if (trackBuffer.highestPresentationTimestamp.isValid() && trackBuffer.highestPresentationTimestamp <= presentationTimestamp) {
1540             // Remove all coded frames from track buffer that have a presentation timestamp greater than highest
1541             // presentation timestamp and less than or equal to frame end timestamp.
1542             do {
1543                 // NOTE: Searching from the end of the trackBuffer will be vastly more efficient if the search range is
1544                 // near the end of the buffered range. Use a linear-backwards search if the search range is within one
1545                 // frame duration of the end:
1546                 if (!m_buffered)
1547                     break;
1548
1549                 unsigned bufferedLength = m_buffered->ranges().length();
1550                 if (!bufferedLength)
1551                     break;
1552
1553                 MediaTime highestBufferedTime = m_buffered->ranges().maximumBufferedTime();
1554
1555                 PresentationOrderSampleMap::iterator_range range;
1556                 if (highestBufferedTime - trackBuffer.highestPresentationTimestamp < trackBuffer.lastFrameDuration)
1557                     range = trackBuffer.samples.presentationOrder().findSamplesWithinPresentationRangeFromEnd(trackBuffer.highestPresentationTimestamp, frameEndTimestamp);
1558                 else
1559                     range = trackBuffer.samples.presentationOrder().findSamplesWithinPresentationRange(trackBuffer.highestPresentationTimestamp, frameEndTimestamp);
1560
1561                 if (range.first != trackBuffer.samples.presentationOrder().end())
1562                     erasedSamples.addRange(range.first, range.second);
1563             } while(false);
1564         }
1565
1566         // 1.16 Remove decoding dependencies of the coded frames removed in the previous step:
1567         DecodeOrderSampleMap::MapType dependentSamples;
1568         if (!erasedSamples.empty()) {
1569             // If detailed information about decoding dependencies is available:
1570             // FIXME: Add support for detailed dependency information
1571
1572             // Otherwise: Remove all coded frames between the coded frames removed in the previous step
1573             // and the next random access point after those removed frames.
1574             auto firstDecodeIter = trackBuffer.samples.decodeOrder().findSampleWithDecodeKey(erasedSamples.decodeOrder().begin()->first);
1575             auto lastDecodeIter = trackBuffer.samples.decodeOrder().findSampleWithDecodeKey(erasedSamples.decodeOrder().rbegin()->first);
1576             auto nextSyncIter = trackBuffer.samples.decodeOrder().findSyncSampleAfterDecodeIterator(lastDecodeIter);
1577             dependentSamples.insert(firstDecodeIter, nextSyncIter);
1578
1579             RefPtr<TimeRanges> erasedRanges = removeSamplesFromTrackBuffer(dependentSamples, trackBuffer, this, "sourceBufferPrivateDidReceiveSample");
1580
1581             // Only force the TrackBuffer to re-enqueue if the removed ranges overlap with enqueued and possibly
1582             // not yet displayed samples.
1583             MediaTime currentMediaTime = m_source->currentTime();
1584             if (currentMediaTime < trackBuffer.lastEnqueuedPresentationTime) {
1585                 PlatformTimeRanges possiblyEnqueuedRanges(currentMediaTime, trackBuffer.lastEnqueuedPresentationTime);
1586                 possiblyEnqueuedRanges.intersectWith(erasedRanges->ranges());
1587                 if (possiblyEnqueuedRanges.length())
1588                     trackBuffer.needsReenqueueing = true;
1589             }
1590
1591             erasedRanges->invert();
1592             m_buffered->intersectWith(*erasedRanges);
1593         }
1594
1595         // 1.17 If spliced audio frame is set:
1596         // Add spliced audio frame to the track buffer.
1597         // If spliced timed text frame is set:
1598         // Add spliced timed text frame to the track buffer.
1599         // FIXME: Add support for sample splicing.
1600
1601         // Otherwise:
1602         // Add the coded frame with the presentation timestamp, decode timestamp, and frame duration to the track buffer.
1603         trackBuffer.samples.addSample(sample);
1604
1605         if (trackBuffer.lastEnqueuedDecodeEndTime.isInvalid() || decodeTimestamp >= trackBuffer.lastEnqueuedDecodeEndTime) {
1606             DecodeOrderSampleMap::KeyType decodeKey(decodeTimestamp, presentationTimestamp);
1607             trackBuffer.decodeQueue.insert(DecodeOrderSampleMap::MapType::value_type(decodeKey, sample));
1608         }
1609
1610         // 1.18 Set last decode timestamp for track buffer to decode timestamp.
1611         trackBuffer.lastDecodeTimestamp = decodeTimestamp;
1612
1613         // 1.19 Set last frame duration for track buffer to frame duration.
1614         trackBuffer.lastFrameDuration = frameDuration;
1615
1616         // 1.20 If highest presentation timestamp for track buffer is unset or frame end timestamp is greater
1617         // than highest presentation timestamp, then set highest presentation timestamp for track buffer
1618         // to frame end timestamp.
1619         if (trackBuffer.highestPresentationTimestamp.isInvalid() || frameEndTimestamp > trackBuffer.highestPresentationTimestamp)
1620             trackBuffer.highestPresentationTimestamp = frameEndTimestamp;
1621
1622         // 1.21 If frame end timestamp is greater than group end timestamp, then set group end timestamp equal
1623         // to frame end timestamp.
1624         if (m_groupEndTimestamp.isInvalid() || frameEndTimestamp > m_groupEndTimestamp)
1625             m_groupEndTimestamp = frameEndTimestamp;
1626
1627         // 1.22 If generate timestamps flag equals true, then set timestampOffset equal to frame end timestamp.
1628         if (m_shouldGenerateTimestamps)
1629             m_timestampOffset = frameEndTimestamp;
1630
1631         m_buffered->add(presentationTimestamp.toDouble(), (presentationTimestamp + frameDuration + microsecond).toDouble());
1632         m_bufferedSinceLastMonitor += frameDuration.toDouble();
1633
1634         break;
1635     } while (1);
1636
1637     // Steps 2-4 will be handled by MediaSource::monitorSourceBuffers()
1638
1639     // 5. If the media segment contains data beyond the current duration, then run the duration change algorithm with new
1640     // duration set to the maximum of the current duration and the group end timestamp.
1641     if (m_groupEndTimestamp > m_source->duration())
1642         m_source->setDurationInternal(m_groupEndTimestamp);
1643 }
1644
1645 bool SourceBuffer::hasAudio() const
1646 {
1647     return m_audioTracks && m_audioTracks->length();
1648 }
1649
1650 bool SourceBuffer::hasVideo() const
1651 {
1652     return m_videoTracks && m_videoTracks->length();
1653 }
1654
1655 bool SourceBuffer::sourceBufferPrivateHasAudio(const SourceBufferPrivate*) const
1656 {
1657     return hasAudio();
1658 }
1659
1660 bool SourceBuffer::sourceBufferPrivateHasVideo(const SourceBufferPrivate*) const
1661 {
1662     return hasVideo();
1663 }
1664
1665 void SourceBuffer::videoTrackSelectedChanged(VideoTrack* track)
1666 {
1667     // 2.4.5 Changes to selected/enabled track state
1668     // If the selected video track changes, then run the following steps:
1669     // 1. If the SourceBuffer associated with the previously selected video track is not associated with
1670     // any other enabled tracks, run the following steps:
1671     if (track->selected()
1672         && (!m_videoTracks || !m_videoTracks->isAnyTrackEnabled())
1673         && (!m_audioTracks || !m_audioTracks->isAnyTrackEnabled())
1674         && (!m_textTracks || !m_textTracks->isAnyTrackEnabled())) {
1675         // 1.1 Remove the SourceBuffer from activeSourceBuffers.
1676         // 1.2 Queue a task to fire a simple event named removesourcebuffer at activeSourceBuffers
1677         setActive(false);
1678     } else if (!track->selected()) {
1679         // 2. If the SourceBuffer associated with the newly selected video track is not already in activeSourceBuffers,
1680         // run the following steps:
1681         // 2.1 Add the SourceBuffer to activeSourceBuffers.
1682         // 2.2 Queue a task to fire a simple event named addsourcebuffer at activeSourceBuffers
1683         setActive(true);
1684     }
1685
1686     if (!isRemoved())
1687         m_source->mediaElement()->videoTrackSelectedChanged(track);
1688 }
1689
1690 void SourceBuffer::audioTrackEnabledChanged(AudioTrack* track)
1691 {
1692     // 2.4.5 Changes to selected/enabled track state
1693     // If an audio track becomes disabled and the SourceBuffer associated with this track is not
1694     // associated with any other enabled or selected track, then run the following steps:
1695     if (track->enabled()
1696         && (!m_videoTracks || !m_videoTracks->isAnyTrackEnabled())
1697         && (!m_audioTracks || !m_audioTracks->isAnyTrackEnabled())
1698         && (!m_textTracks || !m_textTracks->isAnyTrackEnabled())) {
1699         // 1. Remove the SourceBuffer associated with the audio track from activeSourceBuffers
1700         // 2. Queue a task to fire a simple event named removesourcebuffer at activeSourceBuffers
1701         setActive(false);
1702     } else if (!track->enabled()) {
1703         // If an audio track becomes enabled and the SourceBuffer associated with this track is
1704         // not already in activeSourceBuffers, then run the following steps:
1705         // 1. Add the SourceBuffer associated with the audio track to activeSourceBuffers
1706         // 2. Queue a task to fire a simple event named addsourcebuffer at activeSourceBuffers
1707         setActive(true);
1708     }
1709
1710     if (!isRemoved())
1711         m_source->mediaElement()->audioTrackEnabledChanged(track);
1712 }
1713
1714 void SourceBuffer::textTrackModeChanged(TextTrack* track)
1715 {
1716     // 2.4.5 Changes to selected/enabled track state
1717     // If a text track mode becomes "disabled" and the SourceBuffer associated with this track is not
1718     // associated with any other enabled or selected track, then run the following steps:
1719     if (track->mode() == TextTrack::disabledKeyword()
1720         && (!m_videoTracks || !m_videoTracks->isAnyTrackEnabled())
1721         && (!m_audioTracks || !m_audioTracks->isAnyTrackEnabled())
1722         && (!m_textTracks || !m_textTracks->isAnyTrackEnabled())) {
1723         // 1. Remove the SourceBuffer associated with the audio track from activeSourceBuffers
1724         // 2. Queue a task to fire a simple event named removesourcebuffer at activeSourceBuffers
1725         setActive(false);
1726     } else {
1727         // If a text track mode becomes "showing" or "hidden" and the SourceBuffer associated with this
1728         // track is not already in activeSourceBuffers, then run the following steps:
1729         // 1. Add the SourceBuffer associated with the text track to activeSourceBuffers
1730         // 2. Queue a task to fire a simple event named addsourcebuffer at activeSourceBuffers
1731         setActive(true);
1732     }
1733
1734     if (!isRemoved())
1735         m_source->mediaElement()->textTrackModeChanged(track);
1736 }
1737
1738 void SourceBuffer::textTrackAddCue(TextTrack* track, WTF::PassRefPtr<TextTrackCue> cue)
1739 {
1740     if (!isRemoved())
1741         m_source->mediaElement()->textTrackAddCue(track, cue);
1742 }
1743
1744 void SourceBuffer::textTrackAddCues(TextTrack* track, TextTrackCueList const* cueList)
1745 {
1746     if (!isRemoved())
1747         m_source->mediaElement()->textTrackAddCues(track, cueList);
1748 }
1749
1750 void SourceBuffer::textTrackRemoveCue(TextTrack* track, WTF::PassRefPtr<TextTrackCue> cue)
1751 {
1752     if (!isRemoved())
1753         m_source->mediaElement()->textTrackRemoveCue(track, cue);
1754 }
1755
1756 void SourceBuffer::textTrackRemoveCues(TextTrack* track, TextTrackCueList const* cueList)
1757 {
1758     if (!isRemoved())
1759         m_source->mediaElement()->textTrackRemoveCues(track, cueList);
1760 }
1761
1762 void SourceBuffer::textTrackKindChanged(TextTrack* track)
1763 {
1764     if (!isRemoved())
1765         m_source->mediaElement()->textTrackKindChanged(track);
1766 }
1767
1768 void SourceBuffer::sourceBufferPrivateDidBecomeReadyForMoreSamples(SourceBufferPrivate*, AtomicString trackID)
1769 {
1770     LOG(MediaSource, "SourceBuffer::sourceBufferPrivateDidBecomeReadyForMoreSamples(%p)", this);
1771     auto it = m_trackBufferMap.find(trackID);
1772     if (it == m_trackBufferMap.end())
1773         return;
1774
1775     TrackBuffer& trackBuffer = it->value;
1776     if (!trackBuffer.needsReenqueueing && !m_source->isSeeking())
1777         provideMediaData(trackBuffer, trackID);
1778 }
1779
1780 void SourceBuffer::provideMediaData(TrackBuffer& trackBuffer, AtomicString trackID)
1781 {
1782 #if !LOG_DISABLED
1783     unsigned enqueuedSamples = 0;
1784 #endif
1785
1786     auto sampleIt = trackBuffer.decodeQueue.begin();
1787     for (auto sampleEnd = trackBuffer.decodeQueue.end(); sampleIt != sampleEnd; ++sampleIt) {
1788         if (!m_private->isReadyForMoreSamples(trackID)) {
1789             m_private->notifyClientWhenReadyForMoreSamples(trackID);
1790             break;
1791         }
1792
1793         RefPtr<MediaSample> sample = sampleIt->second;
1794         // Do not enqueue samples spanning a significant unbuffered gap.
1795         // NOTE: one second is somewhat arbitrary. MediaSource::monitorSourceBuffers() is run
1796         // on the playbackTimer, which is effectively every 350ms. Allowing > 350ms gap between
1797         // enqueued samples allows for situations where we overrun the end of a buffered range
1798         // but don't notice for 350s of playback time, and the client can enqueue data for the
1799         // new current time without triggering this early return.
1800         // FIXME(135867): Make this gap detection logic less arbitrary.
1801         MediaTime oneSecond(1, 1);
1802         if (trackBuffer.lastEnqueuedDecodeEndTime.isValid() && sample->decodeTime() - trackBuffer.lastEnqueuedDecodeEndTime > oneSecond)
1803             break;
1804
1805         trackBuffer.lastEnqueuedPresentationTime = sample->presentationTime();
1806         trackBuffer.lastEnqueuedDecodeEndTime = sample->decodeTime() + sample->duration();
1807         m_private->enqueueSample(sample.release(), trackID);
1808 #if !LOG_DISABLED
1809         ++enqueuedSamples;
1810 #endif
1811
1812     }
1813     trackBuffer.decodeQueue.erase(trackBuffer.decodeQueue.begin(), sampleIt);
1814
1815     LOG(MediaSource, "SourceBuffer::provideMediaData(%p) - Enqueued %u samples", this, enqueuedSamples);
1816 }
1817
1818 void SourceBuffer::reenqueueMediaForTime(TrackBuffer& trackBuffer, AtomicString trackID, const MediaTime& time)
1819 {
1820     // Find the sample which contains the current presentation time.
1821     auto currentSamplePTSIterator = trackBuffer.samples.presentationOrder().findSampleContainingPresentationTime(time);
1822
1823     if (currentSamplePTSIterator == trackBuffer.samples.presentationOrder().end()) {
1824         trackBuffer.decodeQueue.clear();
1825         m_private->flushAndEnqueueNonDisplayingSamples(Vector<RefPtr<MediaSample>>(), trackID);
1826         return;
1827     }
1828
1829     // Seach backward for the previous sync sample.
1830     DecodeOrderSampleMap::KeyType decodeKey(currentSamplePTSIterator->second->decodeTime(), currentSamplePTSIterator->second->presentationTime());
1831     auto currentSampleDTSIterator = trackBuffer.samples.decodeOrder().findSampleWithDecodeKey(decodeKey);
1832     ASSERT(currentSampleDTSIterator != trackBuffer.samples.decodeOrder().end());
1833
1834     auto reverseCurrentSampleIter = --DecodeOrderSampleMap::reverse_iterator(currentSampleDTSIterator);
1835     auto reverseLastSyncSampleIter = trackBuffer.samples.decodeOrder().findSyncSamplePriorToDecodeIterator(reverseCurrentSampleIter);
1836     if (reverseLastSyncSampleIter == trackBuffer.samples.decodeOrder().rend()) {
1837         trackBuffer.decodeQueue.clear();
1838         m_private->flushAndEnqueueNonDisplayingSamples(Vector<RefPtr<MediaSample>>(), trackID);
1839         return;
1840     }
1841
1842     Vector<RefPtr<MediaSample>> nonDisplayingSamples;
1843     for (auto iter = reverseLastSyncSampleIter; iter != reverseCurrentSampleIter; --iter)
1844         nonDisplayingSamples.append(iter->second);
1845
1846     m_private->flushAndEnqueueNonDisplayingSamples(nonDisplayingSamples, trackID);
1847
1848     if (!nonDisplayingSamples.isEmpty()) {
1849         trackBuffer.lastEnqueuedPresentationTime = nonDisplayingSamples.last()->presentationTime();
1850         trackBuffer.lastEnqueuedDecodeEndTime = nonDisplayingSamples.last()->decodeTime();
1851     } else {
1852         trackBuffer.lastEnqueuedPresentationTime = MediaTime::invalidTime();
1853         trackBuffer.lastEnqueuedDecodeEndTime = MediaTime::invalidTime();
1854     }
1855
1856     // Fill the decode queue with the remaining samples.
1857     trackBuffer.decodeQueue.clear();
1858     for (auto iter = currentSampleDTSIterator; iter != trackBuffer.samples.decodeOrder().end(); ++iter)
1859         trackBuffer.decodeQueue.insert(*iter);
1860     provideMediaData(trackBuffer, trackID);
1861
1862     trackBuffer.needsReenqueueing = false;
1863 }
1864
1865
1866 void SourceBuffer::didDropSample()
1867 {
1868     if (!isRemoved())
1869         m_source->mediaElement()->incrementDroppedFrameCount();
1870 }
1871
1872 void SourceBuffer::monitorBufferingRate()
1873 {
1874     if (!m_bufferedSinceLastMonitor)
1875         return;
1876
1877     double now = monotonicallyIncreasingTime();
1878     double interval = now - m_timeOfBufferingMonitor;
1879     double rateSinceLastMonitor = m_bufferedSinceLastMonitor / interval;
1880
1881     m_timeOfBufferingMonitor = now;
1882     m_bufferedSinceLastMonitor = 0;
1883
1884     m_averageBufferRate = m_averageBufferRate * (1 - ExponentialMovingAverageCoefficient) + rateSinceLastMonitor * ExponentialMovingAverageCoefficient;
1885
1886     LOG(MediaSource, "SourceBuffer::monitorBufferingRate(%p) - m_avegareBufferRate: %lf", this, m_averageBufferRate);
1887 }
1888
1889 std::unique_ptr<PlatformTimeRanges> SourceBuffer::bufferedAccountingForEndOfStream() const
1890 {
1891     // FIXME: Revisit this method once the spec bug <https://www.w3.org/Bugs/Public/show_bug.cgi?id=26436> is resolved.
1892     std::unique_ptr<PlatformTimeRanges> virtualRanges = PlatformTimeRanges::create(m_buffered->ranges());
1893     if (m_source->isEnded()) {
1894         MediaTime start = virtualRanges->maximumBufferedTime();
1895         MediaTime end = m_source->duration();
1896         if (start <= end)
1897             virtualRanges->add(start, end);
1898     }
1899     return virtualRanges;
1900 }
1901
1902 bool SourceBuffer::hasCurrentTime() const
1903 {
1904     if (isRemoved() || !m_buffered->length())
1905         return false;
1906
1907     MediaTime currentTime = m_source->currentTime();
1908     MediaTime duration = m_source->duration();
1909     if (currentTime >= duration)
1910         return true;
1911
1912     std::unique_ptr<PlatformTimeRanges> ranges = bufferedAccountingForEndOfStream();
1913     return abs(ranges->nearest(currentTime) - currentTime) <= currentTimeFudgeFactor();
1914 }
1915
1916 bool SourceBuffer::hasFutureTime() const
1917 {
1918     if (isRemoved())
1919         return false;
1920
1921     std::unique_ptr<PlatformTimeRanges> ranges = bufferedAccountingForEndOfStream();
1922     if (!ranges->length())
1923         return false;
1924
1925     MediaTime currentTime = m_source->currentTime();
1926     MediaTime duration = m_source->duration();
1927     if (currentTime >= duration)
1928         return true;
1929
1930     MediaTime nearest = ranges->nearest(currentTime);
1931     if (abs(nearest - currentTime) > currentTimeFudgeFactor())
1932         return false;
1933
1934     size_t found = ranges->find(nearest);
1935     if (found == notFound)
1936         return false;
1937
1938     MediaTime localEnd = ranges->end(found);
1939     if (localEnd == duration)
1940         return true;
1941
1942     return localEnd - currentTime > currentTimeFudgeFactor();
1943 }
1944
1945 bool SourceBuffer::canPlayThrough()
1946 {
1947     if (isRemoved())
1948         return false;
1949
1950     monitorBufferingRate();
1951
1952     // Assuming no fluctuations in the buffering rate, loading 1 second per second or greater
1953     // means indefinite playback. This could be improved by taking jitter into account.
1954     if (m_averageBufferRate > 1)
1955         return true;
1956
1957     // Add up all the time yet to be buffered.
1958     MediaTime currentTime = m_source->currentTime();
1959     MediaTime duration = m_source->duration();
1960
1961     std::unique_ptr<PlatformTimeRanges> unbufferedRanges = bufferedAccountingForEndOfStream();
1962     unbufferedRanges->invert();
1963     unbufferedRanges->intersectWith(PlatformTimeRanges(currentTime, std::max(currentTime, duration)));
1964     MediaTime unbufferedTime = unbufferedRanges->totalDuration();
1965     if (!unbufferedTime.isValid())
1966         return true;
1967
1968     MediaTime timeRemaining = duration - currentTime;
1969     return unbufferedTime.toDouble() / m_averageBufferRate < timeRemaining.toDouble();
1970 }
1971
1972 size_t SourceBuffer::extraMemoryCost() const
1973 {
1974     size_t extraMemoryCost = m_pendingAppendData.capacity();
1975     for (auto& trackBuffer : m_trackBufferMap.values())
1976         extraMemoryCost += trackBuffer.samples.sizeInBytes();
1977
1978     return extraMemoryCost;
1979 }
1980
1981 void SourceBuffer::reportExtraMemoryCost()
1982 {
1983     size_t extraMemoryCost = this->extraMemoryCost();
1984     if (extraMemoryCost < m_reportedExtraMemoryCost)
1985         return;
1986
1987     size_t extraMemoryCostDelta = extraMemoryCost - m_reportedExtraMemoryCost;
1988     m_reportedExtraMemoryCost = extraMemoryCost;
1989
1990     JSC::JSLockHolder lock(scriptExecutionContext()->vm());
1991     if (extraMemoryCostDelta > 0)
1992         scriptExecutionContext()->vm().heap.reportExtraMemoryCost(extraMemoryCostDelta);
1993 }
1994
1995 Vector<String> SourceBuffer::bufferedSamplesForTrackID(const AtomicString& trackID)
1996 {
1997     auto it = m_trackBufferMap.find(trackID);
1998     if (it == m_trackBufferMap.end())
1999         return Vector<String>();
2000
2001     TrackBuffer& trackBuffer = it->value;
2002     Vector<String> sampleDescriptions;
2003     for (auto& pair : trackBuffer.samples.decodeOrder())
2004         sampleDescriptions.append(toString(*pair.second));
2005
2006     return sampleDescriptions;
2007 }
2008
2009 Document& SourceBuffer::document() const
2010 {
2011     ASSERT(scriptExecutionContext());
2012     return downcast<Document>(*scriptExecutionContext());
2013 }
2014
2015 void SourceBuffer::setMode(const AtomicString& newMode, ExceptionCode& ec)
2016 {
2017     // 3.1 Attributes - mode
2018     // http://www.w3.org/TR/media-source/#widl-SourceBuffer-mode
2019
2020     // On setting, run the following steps:
2021
2022     // 1. Let new mode equal the new value being assigned to this attribute.
2023     // 2. If generate timestamps flag equals true and new mode equals "segments", then throw an INVALID_ACCESS_ERR exception and abort these steps.
2024     if (m_shouldGenerateTimestamps && newMode == segmentsKeyword()) {
2025         ec = INVALID_ACCESS_ERR;
2026         return;
2027     }
2028
2029     // 3. If this object has been removed from the sourceBuffers attribute of the parent media source, then throw an INVALID_STATE_ERR exception and abort these steps.
2030     // 4. If the updating attribute equals true, then throw an INVALID_STATE_ERR exception and abort these steps.
2031     if (isRemoved() || m_updating) {
2032         ec = INVALID_STATE_ERR;
2033         return;
2034     }
2035
2036     // 5. If the readyState attribute of the parent media source is in the "ended" state then run the following steps:
2037     if (m_source->readyState() == MediaSource::endedKeyword()) {
2038         // 5.1. Set the readyState attribute of the parent media source to "open"
2039         // 5.2. Queue a task to fire a simple event named sourceopen at the parent media source.
2040         m_source->openIfInEndedState();
2041     }
2042
2043     // 6. If the append state equals PARSING_MEDIA_SEGMENT, then throw an INVALID_STATE_ERR and abort these steps.
2044     if (m_appendState == ParsingMediaSegment) {
2045         ec = INVALID_STATE_ERR;
2046         return;
2047     }
2048
2049     // 7. If the new mode equals "sequence", then set the group start timestamp to the group end timestamp.
2050     if (newMode == sequenceKeyword())
2051         m_groupStartTimestamp = m_groupEndTimestamp;
2052
2053     // 8. Update the attribute to new mode.
2054     m_mode = newMode;
2055 }
2056
2057 } // namespace WebCore
2058
2059 #endif