29363a19c327118b9f675f47ef9afda0aea6831b
[WebKit-https.git] / Source / WebCore / html / HTMLMediaElement.cpp
1 /*
2  * Copyright (C) 2007-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "HTMLMediaElement.h"
28
29 #if ENABLE(VIDEO)
30
31 #include "ApplicationCacheHost.h"
32 #include "ApplicationCacheResource.h"
33 #include "Attribute.h"
34 #include "CSSPropertyNames.h"
35 #include "CSSValueKeywords.h"
36 #include "ChromeClient.h"
37 #include "ClientRect.h"
38 #include "ClientRectList.h"
39 #include "CommonVM.h"
40 #include "ContentSecurityPolicy.h"
41 #include "ContentType.h"
42 #include "CookieJar.h"
43 #include "DiagnosticLoggingClient.h"
44 #include "DiagnosticLoggingKeys.h"
45 #include "DisplaySleepDisabler.h"
46 #include "Document.h"
47 #include "DocumentLoader.h"
48 #include "ElementIterator.h"
49 #include "EventNames.h"
50 #include "FrameLoader.h"
51 #include "FrameLoaderClient.h"
52 #include "FrameView.h"
53 #include "HTMLParserIdioms.h"
54 #include "HTMLSourceElement.h"
55 #include "HTMLVideoElement.h"
56 #include "JSDOMError.h"
57 #include "JSDOMPromise.h"
58 #include "JSHTMLMediaElement.h"
59 #include "Language.h"
60 #include "Logging.h"
61 #include "MIMETypeRegistry.h"
62 #include "MainFrame.h"
63 #include "MediaController.h"
64 #include "MediaControls.h"
65 #include "MediaDocument.h"
66 #include "MediaError.h"
67 #include "MediaFragmentURIParser.h"
68 #include "MediaList.h"
69 #include "MediaPlayer.h"
70 #include "MediaQueryEvaluator.h"
71 #include "MediaResourceLoader.h"
72 #include "MemoryPressureHandler.h"
73 #include "NetworkingContext.h"
74 #include "NoEventDispatchAssertion.h"
75 #include "Page.h"
76 #include "PageGroup.h"
77 #include "PlatformMediaSessionManager.h"
78 #include "ProgressTracker.h"
79 #include "RenderLayerCompositor.h"
80 #include "RenderVideo.h"
81 #include "RenderView.h"
82 #include "ResourceLoadInfo.h"
83 #include "ScriptController.h"
84 #include "ScriptSourceCode.h"
85 #include "SecurityOriginData.h"
86 #include "SecurityPolicy.h"
87 #include "SessionID.h"
88 #include "Settings.h"
89 #include "ShadowRoot.h"
90 #include "TimeRanges.h"
91 #include "UserContentController.h"
92 #include "UserGestureIndicator.h"
93 #include <limits>
94 #include <runtime/Uint8Array.h>
95 #include <wtf/CurrentTime.h>
96 #include <wtf/MathExtras.h>
97 #include <wtf/Ref.h>
98 #include <wtf/text/CString.h>
99
100 #if ENABLE(VIDEO_TRACK)
101 #include "AudioTrackList.h"
102 #include "HTMLTrackElement.h"
103 #include "InbandGenericTextTrack.h"
104 #include "InbandTextTrackPrivate.h"
105 #include "InbandWebVTTTextTrack.h"
106 #include "RuntimeEnabledFeatures.h"
107 #include "TextTrackCueList.h"
108 #include "TextTrackList.h"
109 #include "VideoTrackList.h"
110 #endif
111
112 #if ENABLE(WEB_AUDIO)
113 #include "AudioSourceProvider.h"
114 #include "MediaElementAudioSourceNode.h"
115 #endif
116
117 #if PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
118 #include "WebVideoFullscreenInterface.h"
119 #endif
120
121 #if PLATFORM(IOS)
122 #include "RuntimeApplicationChecks.h"
123 #include "WebVideoFullscreenInterfaceAVKit.h"
124 #endif
125
126 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
127 #include "WebKitPlaybackTargetAvailabilityEvent.h"
128 #endif
129
130 #if ENABLE(MEDIA_SESSION)
131 #include "MediaSession.h"
132 #endif
133
134 #if ENABLE(MEDIA_SOURCE)
135 #include "DOMWindow.h"
136 #include "MediaSource.h"
137 #include "VideoPlaybackQuality.h"
138 #endif
139
140 #if ENABLE(MEDIA_STREAM)
141 #include "DOMURL.h"
142 #include "MediaStream.h"
143 #include "MediaStreamRegistry.h"
144 #endif
145
146 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
147 #include "WebKitMediaKeyNeededEvent.h"
148 #include "WebKitMediaKeys.h"
149 #endif
150
151 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
152 #include "JSMediaControlsHost.h"
153 #include "MediaControlsHost.h"
154 #include <bindings/ScriptObject.h>
155 #endif
156
157 #if ENABLE(ENCRYPTED_MEDIA)
158 #include "NotImplemented.h"
159 #endif
160
161 namespace WebCore {
162
163 static const double SeekRepeatDelay = 0.1;
164 static const double SeekTime = 0.2;
165 static const double ScanRepeatDelay = 1.5;
166 static const double ScanMaximumRate = 8;
167
168 static const double HideMediaControlsAfterEndedDelay = 6;
169
170 static void setFlags(unsigned& value, unsigned flags)
171 {
172     value |= flags;
173 }
174
175 static void clearFlags(unsigned& value, unsigned flags)
176 {
177     value &= ~flags;
178 }
179     
180 #if !LOG_DISABLED
181 static String urlForLoggingMedia(const URL& url)
182 {
183     static const unsigned maximumURLLengthForLogging = 128;
184
185     if (url.string().length() < maximumURLLengthForLogging)
186         return url.string();
187     return url.string().substring(0, maximumURLLengthForLogging) + "...";
188 }
189
190 static const char* boolString(bool val)
191 {
192     return val ? "true" : "false";
193 }
194
195 static String actionName(HTMLMediaElementEnums::DelayedActionType action)
196 {
197     StringBuilder actionBuilder;
198
199 #define ACTION(_actionType) \
200     if (action & (HTMLMediaElementEnums::_actionType)) { \
201         if (!actionBuilder.isEmpty()) \
202         actionBuilder.appendLiteral(", "); \
203         actionBuilder.append(#_actionType); \
204     } \
205
206     ACTION(LoadMediaResource);
207     ACTION(ConfigureTextTracks);
208     ACTION(TextTrackChangesNotification);
209     ACTION(ConfigureTextTrackDisplay);
210     ACTION(CheckPlaybackTargetCompatablity);
211     ACTION(CheckMediaState);
212     ACTION(MediaEngineUpdated);
213
214     return actionBuilder.toString();
215
216 #undef ACTION
217 }
218
219 #endif
220
221 #ifndef LOG_MEDIA_EVENTS
222 // Default to not logging events because so many are generated they can overwhelm the rest of 
223 // the logging.
224 #define LOG_MEDIA_EVENTS 0
225 #endif
226
227 #ifndef LOG_CACHED_TIME_WARNINGS
228 // Default to not logging warnings about excessive drift in the cached media time because it adds a
229 // fair amount of overhead and logging.
230 #define LOG_CACHED_TIME_WARNINGS 0
231 #endif
232
233 #if ENABLE(MEDIA_SOURCE)
234 // URL protocol used to signal that the media source API is being used.
235 static const char* mediaSourceBlobProtocol = "blob";
236 #endif
237
238 #if ENABLE(MEDIA_STREAM)
239 // URL protocol used to signal that the media stream API is being used.
240 static const char* mediaStreamBlobProtocol = "blob";
241 #endif
242
243 using namespace HTMLNames;
244
245 typedef HashMap<Document*, HashSet<HTMLMediaElement*>> DocumentElementSetMap;
246 static DocumentElementSetMap& documentToElementSetMap()
247 {
248     static NeverDestroyed<DocumentElementSetMap> map;
249     return map;
250 }
251
252 static void addElementToDocumentMap(HTMLMediaElement& element, Document& document)
253 {
254     DocumentElementSetMap& map = documentToElementSetMap();
255     HashSet<HTMLMediaElement*> set = map.take(&document);
256     set.add(&element);
257     map.add(&document, set);
258 }
259
260 static void removeElementFromDocumentMap(HTMLMediaElement& element, Document& document)
261 {
262     DocumentElementSetMap& map = documentToElementSetMap();
263     HashSet<HTMLMediaElement*> set = map.take(&document);
264     set.remove(&element);
265     if (!set.isEmpty())
266         map.add(&document, set);
267 }
268
269 #if ENABLE(VIDEO_TRACK)
270
271 class TrackDisplayUpdateScope {
272 public:
273     TrackDisplayUpdateScope(HTMLMediaElement& element)
274         : m_element(element)
275     {
276         m_element.beginIgnoringTrackDisplayUpdateRequests();
277     }
278     ~TrackDisplayUpdateScope()
279     {
280         m_element.endIgnoringTrackDisplayUpdateRequests();
281     }
282     
283 private:
284     HTMLMediaElement& m_element;
285 };
286
287 #endif
288
289 struct HTMLMediaElement::TrackGroup {
290     enum GroupKind { CaptionsAndSubtitles, Description, Chapter, Metadata, Other };
291
292     TrackGroup(GroupKind kind)
293         : kind(kind)
294     {
295     }
296
297     Vector<RefPtr<TextTrack>> tracks;
298     RefPtr<TextTrack> visibleTrack;
299     RefPtr<TextTrack> defaultTrack;
300     GroupKind kind;
301     bool hasSrcLang { false };
302 };
303
304 HashSet<HTMLMediaElement*>& HTMLMediaElement::allMediaElements()
305 {
306     static NeverDestroyed<HashSet<HTMLMediaElement*>> elements;
307     return elements;
308 }
309
310 #if ENABLE(MEDIA_SESSION)
311 typedef HashMap<uint64_t, HTMLMediaElement*> IDToElementMap;
312
313 static IDToElementMap& elementIDsToElements()
314 {
315     static NeverDestroyed<IDToElementMap> map;
316     return map;
317 }
318
319 HTMLMediaElement* HTMLMediaElement::elementWithID(uint64_t id)
320 {
321     if (id == HTMLMediaElementInvalidID)
322         return nullptr;
323     
324     return elementIDsToElements().get(id);
325 }
326
327 static uint64_t nextElementID()
328 {
329     static uint64_t elementID = 0;
330     return ++elementID;
331 }
332 #endif
333
334 struct MediaElementSessionInfo {
335     const MediaElementSession* session;
336     MediaElementSession::PlaybackControlsPurpose purpose;
337
338     double timeOfLastUserInteraction;
339     bool canShowControlsManager : 1;
340     bool isVisibleInViewportOrFullscreen : 1;
341     bool isLargeEnoughForMainContent : 1;
342     bool isPlayingAudio : 1;
343 };
344
345 static MediaElementSessionInfo mediaElementSessionInfoForSession(const MediaElementSession& session, MediaElementSession::PlaybackControlsPurpose purpose)
346 {
347     const HTMLMediaElement& element = session.element();
348     return {
349         &session,
350         purpose,
351         session.mostRecentUserInteractionTime(),
352         session.canShowControlsManager(purpose),
353         element.isFullscreen() || element.isVisibleInViewport(),
354         session.isLargeEnoughForMainContent(MediaSessionMainContentPurpose::MediaControls),
355         element.isPlaying() && element.hasAudio() && !element.muted()
356     };
357 }
358
359 static bool preferMediaControlsForCandidateSessionOverOtherCandidateSession(const MediaElementSessionInfo& session, const MediaElementSessionInfo& otherSession)
360 {
361     MediaElementSession::PlaybackControlsPurpose purpose = session.purpose;
362     ASSERT(purpose == otherSession.purpose);
363
364     // For the controls manager, prioritize visible media over offscreen media.
365     if (purpose == MediaElementSession::PlaybackControlsPurpose::ControlsManager && session.isVisibleInViewportOrFullscreen != otherSession.isVisibleInViewportOrFullscreen)
366         return session.isVisibleInViewportOrFullscreen;
367
368     // For Now Playing, prioritize elements that would normally satisfy main content.
369     if (purpose == MediaElementSession::PlaybackControlsPurpose::NowPlaying && session.isLargeEnoughForMainContent != otherSession.isLargeEnoughForMainContent)
370         return session.isLargeEnoughForMainContent;
371
372     // As a tiebreaker, prioritize elements that the user recently interacted with.
373     return session.timeOfLastUserInteraction > otherSession.timeOfLastUserInteraction;
374 }
375
376 static bool mediaSessionMayBeConfusedWithMainContent(const MediaElementSessionInfo& session, MediaElementSession::PlaybackControlsPurpose purpose)
377 {
378     if (purpose == MediaElementSession::PlaybackControlsPurpose::NowPlaying)
379         return session.isPlayingAudio;
380
381     if (!session.isVisibleInViewportOrFullscreen)
382         return false;
383
384     if (!session.isLargeEnoughForMainContent)
385         return false;
386
387     // Even if this video is not a candidate, if it is visible to the user and large enough
388     // to be main content, it poses a risk for being confused with main content.
389     return true;
390 }
391
392 HTMLMediaElement::HTMLMediaElement(const QualifiedName& tagName, Document& document, bool createdByParser)
393     : HTMLElement(tagName, document)
394     , ActiveDOMObject(&document)
395     , m_pendingActionTimer(*this, &HTMLMediaElement::pendingActionTimerFired)
396     , m_progressEventTimer(*this, &HTMLMediaElement::progressEventTimerFired)
397     , m_playbackProgressTimer(*this, &HTMLMediaElement::playbackProgressTimerFired)
398     , m_scanTimer(*this, &HTMLMediaElement::scanTimerFired)
399     , m_playbackControlsManagerBehaviorRestrictionsTimer(*this, &HTMLMediaElement::playbackControlsManagerBehaviorRestrictionsTimerFired)
400     , m_seekToPlaybackPositionEndedTimer(*this, &HTMLMediaElement::seekToPlaybackPositionEndedTimerFired)
401     , m_asyncEventQueue(*this)
402     , m_lastTimeUpdateEventMovieTime(MediaTime::positiveInfiniteTime())
403     , m_firstTimePlaying(true)
404     , m_playing(false)
405     , m_isWaitingUntilMediaCanStart(false)
406     , m_shouldDelayLoadEvent(false)
407     , m_haveFiredLoadedData(false)
408     , m_inActiveDocument(true)
409     , m_autoplaying(true)
410     , m_muted(false)
411     , m_explicitlyMuted(false)
412     , m_initiallyMuted(false)
413     , m_paused(true)
414     , m_seeking(false)
415     , m_sentStalledEvent(false)
416     , m_sentEndEvent(false)
417     , m_pausedInternal(false)
418     , m_sendProgressEvents(true)
419     , m_closedCaptionsVisible(false)
420     , m_webkitLegacyClosedCaptionOverride(false)
421     , m_completelyLoaded(false)
422     , m_havePreparedToPlay(false)
423     , m_parsingInProgress(createdByParser)
424     , m_elementIsHidden(document.hidden())
425     , m_creatingControls(false)
426     , m_receivedLayoutSizeChanged(false)
427     , m_hasEverNotifiedAboutPlaying(false)
428     , m_hasEverHadAudio(false)
429     , m_hasEverHadVideo(false)
430 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
431     , m_mediaControlsDependOnPageScaleFactor(false)
432     , m_haveSetUpCaptionContainer(false)
433 #endif
434     , m_isScrubbingRemotely(false)
435 #if ENABLE(VIDEO_TRACK)
436     , m_tracksAreReady(true)
437     , m_haveVisibleTextTrack(false)
438     , m_processingPreferenceChange(false)
439 #endif
440     , m_mediaSession(std::make_unique<MediaElementSession>(*this))
441 {
442     allMediaElements().add(this);
443
444     LOG(Media, "HTMLMediaElement::HTMLMediaElement(%p)", this);
445     setHasCustomStyleResolveCallbacks();
446
447     m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForFullscreen);
448     m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePageConsentToLoadMedia);
449 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
450     m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureToAutoplayToExternalDevice);
451 #endif
452     m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
453     m_mediaSession->addBehaviorRestriction(MediaElementSession::RequirePlaybackToControlControlsManager);
454
455 #if PLATFORM(IOS)
456     m_sendProgressEvents = false;
457 #endif
458
459     if (document.settings().invisibleAutoplayNotPermitted())
460         m_mediaSession->addBehaviorRestriction(MediaElementSession::InvisibleAutoplayNotPermitted);
461
462     if (document.ownerElement() || !document.isMediaDocument()) {
463         bool shouldAudioPlaybackRequireUserGesture = document.audioPlaybackRequiresUserGesture();
464         bool shouldVideoPlaybackRequireUserGesture = document.videoPlaybackRequiresUserGesture();
465
466         if (shouldVideoPlaybackRequireUserGesture) {
467             m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForVideoRateChange);
468             if (document.settings().requiresUserGestureToLoadVideo())
469                 m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForLoad);
470         }
471
472         if (shouldAudioPlaybackRequireUserGesture)
473             m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureForAudioRateChange);
474
475 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
476         if (shouldVideoPlaybackRequireUserGesture || shouldAudioPlaybackRequireUserGesture)
477             m_mediaSession->addBehaviorRestriction(MediaElementSession::RequireUserGestureToShowPlaybackTargetPicker);
478 #endif
479
480         if (!document.settings().mediaDataLoadsAutomatically())
481             m_mediaSession->addBehaviorRestriction(MediaElementSession::AutoPreloadingNotPermitted);
482
483         if (document.settings().mainContentUserGestureOverrideEnabled())
484             m_mediaSession->addBehaviorRestriction(MediaElementSession::OverrideUserGestureRequirementForMainContent);
485     }
486
487 #if PLATFORM(IOS)
488     if (!document.settings().videoPlaybackRequiresUserGesture() && !document.settings().audioPlaybackRequiresUserGesture()) {
489         // Relax RequireUserGestureForFullscreen when videoPlaybackRequiresUserGesture and audioPlaybackRequiresUserGesture is not set:
490         m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequireUserGestureForFullscreen);
491     }
492 #endif
493
494 #if ENABLE(VIDEO_TRACK)
495     if (document.page())
496         m_captionDisplayMode = document.page()->group().captionPreferences().captionDisplayMode();
497 #endif
498
499 #if ENABLE(MEDIA_SESSION)
500     m_elementID = nextElementID();
501     elementIDsToElements().add(m_elementID, this);
502
503     setSessionInternal(document.defaultMediaSession());
504 #endif
505
506     registerWithDocument(document);
507 }
508
509 HTMLMediaElement::~HTMLMediaElement()
510 {
511     LOG(Media, "HTMLMediaElement::~HTMLMediaElement(%p)", this);
512
513     beginIgnoringTrackDisplayUpdateRequests();
514     allMediaElements().remove(this);
515
516     m_asyncEventQueue.close();
517
518     setShouldDelayLoadEvent(false);
519     unregisterWithDocument(document());
520
521 #if ENABLE(VIDEO_TRACK)
522     if (m_audioTracks)
523         m_audioTracks->clearElement();
524     if (m_textTracks)
525         m_textTracks->clearElement();
526     if (m_videoTracks)
527         m_videoTracks->clearElement();
528 #endif
529
530 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
531     if (hasEventListeners(eventNames().webkitplaybacktargetavailabilitychangedEvent)) {
532         m_hasPlaybackTargetAvailabilityListeners = false;
533         m_mediaSession->setHasPlaybackTargetAvailabilityListeners(*this, false);
534         updateMediaState();
535     }
536 #endif
537
538     if (m_mediaController) {
539         m_mediaController->removeMediaElement(*this);
540         m_mediaController = nullptr;
541     }
542
543 #if ENABLE(MEDIA_SOURCE)
544     detachMediaSource();
545 #endif
546
547 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
548     webkitSetMediaKeys(nullptr);
549 #endif
550
551 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
552     if (m_isolatedWorld)
553         m_isolatedWorld->clearWrappers();
554 #endif
555
556 #if ENABLE(MEDIA_SESSION)
557     if (m_session) {
558         m_session->removeMediaElement(*this);
559         m_session = nullptr;
560     }
561
562     elementIDsToElements().remove(m_elementID);
563 #endif
564
565     m_seekTaskQueue.close();
566     m_promiseTaskQueue.close();
567     m_pauseAfterDetachedTaskQueue.close();
568     m_updatePlaybackControlsManagerQueue.close();
569     m_playbackControlsManagerBehaviorRestrictionsQueue.close();
570
571     m_completelyLoaded = true;
572
573     if (m_player) {
574         m_player->invalidate();
575         m_player = nullptr;
576     }
577
578     m_mediaSession = nullptr;
579     updatePlaybackControlsManager();
580 }
581
582 static bool needsPlaybackControlsManagerQuirk(Page& page)
583 {
584     if (!page.settings().needsSiteSpecificQuirks())
585         return false;
586
587     auto* document = page.mainFrame().document();
588     if (!document)
589         return false;
590
591     String host = document->url().host();
592     return equalLettersIgnoringASCIICase(host, "netflix.com") || host.endsWithIgnoringASCIICase(".netflix.com");
593 }
594
595 HTMLMediaElement* HTMLMediaElement::bestMediaElementForShowingPlaybackControlsManager(MediaElementSession::PlaybackControlsPurpose purpose)
596 {
597     auto allSessions = PlatformMediaSessionManager::sharedManager().currentSessionsMatching([] (const PlatformMediaSession& session) {
598         return is<MediaElementSession>(session);
599     });
600
601     Vector<MediaElementSessionInfo> candidateSessions;
602     bool atLeastOneNonCandidateMayBeConfusedForMainContent = false;
603     for (auto& session : allSessions) {
604         auto mediaElementSessionInfo = mediaElementSessionInfoForSession(downcast<MediaElementSession>(*session), purpose);
605         if (mediaElementSessionInfo.canShowControlsManager)
606             candidateSessions.append(mediaElementSessionInfo);
607         else if (mediaSessionMayBeConfusedWithMainContent(mediaElementSessionInfo, purpose))
608             atLeastOneNonCandidateMayBeConfusedForMainContent = true;
609     }
610
611     if (!candidateSessions.size())
612         return nullptr;
613
614     std::sort(candidateSessions.begin(), candidateSessions.end(), preferMediaControlsForCandidateSessionOverOtherCandidateSession);
615     auto strongestSessionCandidate = candidateSessions.first();
616     if (!strongestSessionCandidate.isVisibleInViewportOrFullscreen && !strongestSessionCandidate.isPlayingAudio && atLeastOneNonCandidateMayBeConfusedForMainContent)
617         return nullptr;
618
619     HTMLMediaElement* strongestElementCandidate = &strongestSessionCandidate.session->element();
620     if (strongestElementCandidate) {
621         if (Page* page = strongestElementCandidate->document().page()) {
622             if (needsPlaybackControlsManagerQuirk(*page))
623                 return nullptr;
624         }
625     }
626
627     return strongestElementCandidate;
628 }
629
630 void HTMLMediaElement::registerWithDocument(Document& document)
631 {
632     m_mediaSession->registerWithDocument(document);
633
634     if (m_isWaitingUntilMediaCanStart)
635         document.addMediaCanStartListener(this);
636
637 #if !PLATFORM(IOS)
638     document.registerForMediaVolumeCallbacks(this);
639     document.registerForPrivateBrowsingStateChangedCallbacks(this);
640 #endif
641
642     document.registerForVisibilityStateChangedCallbacks(this);
643
644 #if ENABLE(VIDEO_TRACK)
645     if (m_requireCaptionPreferencesChangedCallbacks)
646         document.registerForCaptionPreferencesChangedCallbacks(this);
647 #endif
648
649 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
650     if (m_mediaControlsDependOnPageScaleFactor)
651         document.registerForPageScaleFactorChangedCallbacks(this);
652     document.registerForUserInterfaceLayoutDirectionChangedCallbacks(*this);
653 #endif
654
655 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
656     document.registerForDocumentSuspensionCallbacks(this);
657 #endif
658
659     document.registerForAllowsMediaDocumentInlinePlaybackChangedCallbacks(*this);
660
661     document.addAudioProducer(this);
662     addElementToDocumentMap(*this, document);
663 }
664
665 void HTMLMediaElement::unregisterWithDocument(Document& document)
666 {
667     m_mediaSession->unregisterWithDocument(document);
668
669     if (m_isWaitingUntilMediaCanStart)
670         document.removeMediaCanStartListener(this);
671
672 #if !PLATFORM(IOS)
673     document.unregisterForMediaVolumeCallbacks(this);
674     document.unregisterForPrivateBrowsingStateChangedCallbacks(this);
675 #endif
676
677     document.unregisterForVisibilityStateChangedCallbacks(this);
678
679 #if ENABLE(VIDEO_TRACK)
680     if (m_requireCaptionPreferencesChangedCallbacks)
681         document.unregisterForCaptionPreferencesChangedCallbacks(this);
682 #endif
683
684 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
685     if (m_mediaControlsDependOnPageScaleFactor)
686         document.unregisterForPageScaleFactorChangedCallbacks(this);
687     document.unregisterForUserInterfaceLayoutDirectionChangedCallbacks(*this);
688 #endif
689
690 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
691     document.unregisterForDocumentSuspensionCallbacks(this);
692 #endif
693
694     document.unregisterForAllowsMediaDocumentInlinePlaybackChangedCallbacks(*this);
695
696     document.removeAudioProducer(this);
697     removeElementFromDocumentMap(*this, document);
698 }
699
700 void HTMLMediaElement::didMoveToNewDocument(Document& oldDocument)
701 {
702     if (m_shouldDelayLoadEvent) {
703         oldDocument.decrementLoadEventDelayCount();
704         document().incrementLoadEventDelayCount();
705     }
706
707     unregisterWithDocument(oldDocument);
708
709     registerWithDocument(document());
710
711     HTMLElement::didMoveToNewDocument(oldDocument);
712     updateShouldAutoplay();
713 }
714
715 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
716 void HTMLMediaElement::prepareForDocumentSuspension()
717 {
718     m_mediaSession->unregisterWithDocument(document());
719 }
720
721 void HTMLMediaElement::resumeFromDocumentSuspension()
722 {
723     m_mediaSession->registerWithDocument(document());
724     updateShouldAutoplay();
725 }
726 #endif
727
728 bool HTMLMediaElement::supportsFocus() const
729 {
730     if (document().isMediaDocument())
731         return false;
732
733     // If no controls specified, we should still be able to focus the element if it has tabIndex.
734     return controls() ||  HTMLElement::supportsFocus();
735 }
736
737 bool HTMLMediaElement::isMouseFocusable() const
738 {
739     return false;
740 }
741
742 void HTMLMediaElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
743 {
744     if (name == srcAttr) {
745 #if PLATFORM(IOS)
746         // Note, unless the restriction on requiring user action has been removed,
747         // do not begin downloading data on iOS.
748         if (!value.isNull() && m_mediaSession->dataLoadingPermitted(*this))
749 #else
750         // Trigger a reload, as long as the 'src' attribute is present.
751         if (!value.isNull())
752 #endif
753         {
754             clearMediaPlayer(LoadMediaResource);
755             scheduleDelayedAction(LoadMediaResource);
756         }
757     } else if (name == controlsAttr)
758         configureMediaControls();
759     else if (name == loopAttr)
760         updateSleepDisabling();
761     else if (name == preloadAttr) {
762         if (equalLettersIgnoringASCIICase(value, "none"))
763             m_preload = MediaPlayer::None;
764         else if (equalLettersIgnoringASCIICase(value, "metadata"))
765             m_preload = MediaPlayer::MetaData;
766         else {
767             // The spec does not define an "invalid value default" but "auto" is suggested as the
768             // "missing value default", so use it for everything except "none" and "metadata"
769             m_preload = MediaPlayer::Auto;
770         }
771
772         // The attribute must be ignored if the autoplay attribute is present
773         if (!autoplay() && m_player)
774             m_player->setPreload(m_mediaSession->effectivePreloadForElement(*this));
775
776     } else if (name == mediagroupAttr)
777         setMediaGroup(value);
778     else
779         HTMLElement::parseAttribute(name, value);
780 }
781
782 void HTMLMediaElement::finishParsingChildren()
783 {
784     HTMLElement::finishParsingChildren();
785     m_parsingInProgress = false;
786     
787 #if ENABLE(VIDEO_TRACK)
788     if (descendantsOfType<HTMLTrackElement>(*this).first())
789         scheduleDelayedAction(ConfigureTextTracks);
790 #endif
791 }
792
793 bool HTMLMediaElement::rendererIsNeeded(const RenderStyle& style)
794 {
795     return controls() && HTMLElement::rendererIsNeeded(style);
796 }
797
798 RenderPtr<RenderElement> HTMLMediaElement::createElementRenderer(RenderStyle&& style, const RenderTreePosition&)
799 {
800     return createRenderer<RenderMedia>(*this, WTFMove(style));
801 }
802
803 bool HTMLMediaElement::childShouldCreateRenderer(const Node& child) const
804 {
805 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
806     return hasShadowRootParent(child) && HTMLElement::childShouldCreateRenderer(child);
807 #else
808     if (!hasMediaControls())
809         return false;
810     // <media> doesn't allow its content, including shadow subtree, to
811     // be rendered. So this should return false for most of the children.
812     // One exception is a shadow tree built for rendering controls which should be visible.
813     // So we let them go here by comparing its subtree root with one of the controls.
814     return &mediaControls()->treeScope() == &child.treeScope()
815         && hasShadowRootParent(child)
816         && HTMLElement::childShouldCreateRenderer(child);
817 #endif
818 }
819
820 Node::InsertionNotificationRequest HTMLMediaElement::insertedInto(ContainerNode& insertionPoint)
821 {
822     LOG(Media, "HTMLMediaElement::insertedInto(%p)", this);
823
824     HTMLElement::insertedInto(insertionPoint);
825     if (insertionPoint.isConnected()) {
826         m_inActiveDocument = true;
827
828 #if PLATFORM(IOS)
829         if (m_networkState == NETWORK_EMPTY && !attributeWithoutSynchronization(srcAttr).isEmpty() && m_mediaSession->dataLoadingPermitted(*this))
830 #else
831         if (m_networkState == NETWORK_EMPTY && !attributeWithoutSynchronization(srcAttr).isEmpty())
832 #endif
833             scheduleDelayedAction(LoadMediaResource);
834     }
835
836     if (!m_explicitlyMuted) {
837         m_explicitlyMuted = true;
838         m_muted = hasAttributeWithoutSynchronization(mutedAttr);
839         m_mediaSession->canProduceAudioChanged();
840     }
841
842     return InsertionShouldCallFinishedInsertingSubtree;
843 }
844
845 void HTMLMediaElement::finishedInsertingSubtree()
846 {
847     configureMediaControls();
848 }
849
850 void HTMLMediaElement::pauseAfterDetachedTask()
851 {
852     // If we were re-inserted into an active document, no need to pause.
853     if (m_inActiveDocument)
854         return;
855
856     if (hasMediaControls())
857         mediaControls()->hide();
858     if (m_networkState > NETWORK_EMPTY)
859         pause();
860     if (m_videoFullscreenMode != VideoFullscreenModeNone)
861         exitFullscreen();
862
863     if (!m_player)
864         return;
865
866     size_t extraMemoryCost = m_player->extraMemoryCost();
867     if (extraMemoryCost > m_reportedExtraMemoryCost) {
868         JSC::VM& vm = commonVM();
869         JSC::JSLockHolder lock(vm);
870
871         size_t extraMemoryCostDelta = extraMemoryCost - m_reportedExtraMemoryCost;
872         m_reportedExtraMemoryCost = extraMemoryCost;
873         // FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
874         // https://bugs.webkit.org/show_bug.cgi?id=142595
875         vm.heap.deprecatedReportExtraMemory(extraMemoryCostDelta);
876     }
877 }
878
879 void HTMLMediaElement::removedFrom(ContainerNode& insertionPoint)
880 {
881     LOG(Media, "HTMLMediaElement::removedFrom(%p)", this);
882
883     m_inActiveDocument = false;
884     if (insertionPoint.isConnected()) {
885         // Pause asynchronously to let the operation that removed us finish, in case we get inserted back into a document.
886         m_pauseAfterDetachedTaskQueue.enqueueTask(std::bind(&HTMLMediaElement::pauseAfterDetachedTask, this));
887     }
888
889     HTMLElement::removedFrom(insertionPoint);
890 }
891
892 void HTMLMediaElement::willAttachRenderers()
893 {
894     ASSERT(!renderer());
895 }
896
897 inline void HTMLMediaElement::updateRenderer()
898 {
899     if (auto* renderer = this->renderer())
900         renderer->updateFromElement();
901 }
902
903 void HTMLMediaElement::didAttachRenderers()
904 {
905     if (auto* renderer = this->renderer()) {
906         renderer->updateFromElement();
907         if (m_mediaSession && m_mediaSession->wantsToObserveViewportVisibilityForAutoplay())
908             renderer->registerForVisibleInViewportCallback();
909     }
910     updateShouldAutoplay();
911 }
912
913 void HTMLMediaElement::willDetachRenderers()
914 {
915     if (auto* renderer = this->renderer())
916         renderer->unregisterForVisibleInViewportCallback();
917 }
918
919 void HTMLMediaElement::didDetachRenderers()
920 {
921     updateShouldAutoplay();
922 }
923
924 void HTMLMediaElement::didRecalcStyle(Style::Change)
925 {
926     updateRenderer();
927 }
928
929 void HTMLMediaElement::scheduleDelayedAction(DelayedActionType actionType)
930 {
931     LOG(Media, "HTMLMediaElement::scheduleDelayedAction(%p) - setting %s flag", this, actionName(actionType).utf8().data());
932
933     if ((actionType & LoadMediaResource) && !(m_pendingActionFlags & LoadMediaResource)) {
934         prepareForLoad();
935         setFlags(m_pendingActionFlags, LoadMediaResource);
936     }
937
938 #if ENABLE(VIDEO_TRACK)
939     if (actionType & ConfigureTextTracks)
940         setFlags(m_pendingActionFlags, ConfigureTextTracks);
941 #endif
942
943 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
944     if (actionType & CheckPlaybackTargetCompatablity)
945         setFlags(m_pendingActionFlags, CheckPlaybackTargetCompatablity);
946 #endif
947
948     if (actionType & CheckMediaState)
949         setFlags(m_pendingActionFlags, CheckMediaState);
950
951     if (actionType & MediaEngineUpdated)
952         setFlags(m_pendingActionFlags, MediaEngineUpdated);
953
954     if (actionType & UpdatePlayState)
955         setFlags(m_pendingActionFlags, UpdatePlayState);
956
957     m_pendingActionTimer.startOneShot(0);
958 }
959
960 void HTMLMediaElement::scheduleNextSourceChild()
961 {
962     // Schedule the timer to try the next <source> element WITHOUT resetting state ala prepareForLoad.
963     LOG(Media, "HTMLMediaElement::scheduleNextSourceChild(%p) - setting %s flag", this, actionName(LoadMediaResource).utf8().data());
964     setFlags(m_pendingActionFlags, LoadMediaResource);
965     m_pendingActionTimer.startOneShot(0);
966 }
967
968 void HTMLMediaElement::mediaPlayerActiveSourceBuffersChanged(const MediaPlayer*)
969 {
970     m_hasEverHadAudio |= hasAudio();
971     m_hasEverHadVideo |= hasVideo();
972 }
973
974 void HTMLMediaElement::scheduleEvent(const AtomicString& eventName)
975 {
976 #if LOG_MEDIA_EVENTS
977     LOG(Media, "HTMLMediaElement::scheduleEvent(%p) - scheduling '%s'", this, eventName.string().ascii().data());
978 #endif
979     RefPtr<Event> event = Event::create(eventName, false, true);
980     
981     // Don't set the event target, the event queue will set it in GenericEventQueue::timerFired and setting it here
982     // will trigger an ASSERT if this element has been marked for deletion.
983
984     m_asyncEventQueue.enqueueEvent(WTFMove(event));
985 }
986
987 void HTMLMediaElement::scheduleResolvePendingPlayPromises()
988 {
989     m_promiseTaskQueue.enqueueTask(std::bind(&HTMLMediaElement::resolvePendingPlayPromises, this));
990 }
991
992 void HTMLMediaElement::rejectPendingPlayPromises(DOMError& error)
993 {
994     Vector<DOMPromise<void>> pendingPlayPromises = WTFMove(m_pendingPlayPromises);
995
996     for (auto& promise : pendingPlayPromises)
997         promise.rejectType<IDLInterface<DOMError>>(error);
998 }
999
1000 void HTMLMediaElement::resolvePendingPlayPromises()
1001 {
1002     Vector<DOMPromise<void>> pendingPlayPromises = WTFMove(m_pendingPlayPromises);
1003
1004     for (auto& promise : pendingPlayPromises)
1005         promise.resolve();
1006 }
1007
1008 void HTMLMediaElement::scheduleNotifyAboutPlaying()
1009 {
1010     m_promiseTaskQueue.enqueueTask(std::bind(&HTMLMediaElement::notifyAboutPlaying, this));
1011 }
1012
1013 void HTMLMediaElement::notifyAboutPlaying()
1014 {
1015     m_playbackStartedTime = currentMediaTime().toDouble();
1016     dispatchEvent(Event::create(eventNames().playingEvent, false, true));
1017     resolvePendingPlayPromises();
1018
1019     m_hasEverNotifiedAboutPlaying = true;
1020     scheduleUpdatePlaybackControlsManager();
1021 }
1022
1023 bool HTMLMediaElement::hasEverNotifiedAboutPlaying() const
1024 {
1025     return m_hasEverNotifiedAboutPlaying;
1026 }
1027
1028 void HTMLMediaElement::pendingActionTimerFired()
1029 {
1030     Ref<HTMLMediaElement> protectedThis(*this); // loadNextSourceChild may fire 'beforeload', which can make arbitrary DOM mutations.
1031     PendingActionFlags pendingActions = m_pendingActionFlags;
1032     m_pendingActionFlags = 0;
1033
1034 #if ENABLE(VIDEO_TRACK)
1035     if (pendingActions & ConfigureTextTracks)
1036         configureTextTracks();
1037 #endif
1038
1039     if (pendingActions & LoadMediaResource) {
1040         if (m_loadState == LoadingFromSourceElement)
1041             loadNextSourceChild();
1042         else
1043             loadInternal();
1044     }
1045
1046 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1047     if (pendingActions & CheckPlaybackTargetCompatablity && m_isPlayingToWirelessTarget && !m_player->canPlayToWirelessPlaybackTarget()) {
1048         LOG(Media, "HTMLMediaElement::pendingActionTimerFired(%p) - calling setShouldPlayToPlaybackTarget(false)", this);
1049         m_failedToPlayToWirelessTarget = true;
1050         m_player->setShouldPlayToPlaybackTarget(false);
1051     }
1052
1053     if (pendingActions & CheckMediaState)
1054         updateMediaState();
1055 #endif
1056
1057     if (pendingActions & MediaEngineUpdated)
1058         mediaEngineWasUpdated();
1059
1060     if (pendingActions & UpdatePlayState)
1061         updatePlayState();
1062 }
1063
1064 MediaError* HTMLMediaElement::error() const
1065 {
1066     return m_error.get();
1067 }
1068
1069 void HTMLMediaElement::setSrc(const String& url)
1070 {
1071     setAttributeWithoutSynchronization(srcAttr, url);
1072 }
1073
1074 #if ENABLE(MEDIA_STREAM)
1075 void HTMLMediaElement::setSrcObject(ScriptExecutionContext& context, MediaStream* mediaStream)
1076 {
1077     // FIXME: Setting the srcObject attribute may cause other changes to the media element's internal state:
1078     // Specifically, if srcObject is specified, the UA must use it as the source of media, even if the src
1079     // attribute is also set or children are present. If the value of srcObject is replaced or set to null
1080     // the UA must re-run the media element load algorithm.
1081     //
1082     // https://bugs.webkit.org/show_bug.cgi?id=124896
1083
1084     m_mediaStreamSrcObject = mediaStream;
1085     if (mediaStream) {
1086         m_settingMediaStreamSrcObject = true;
1087         setSrc(DOMURL::createPublicURL(context, *mediaStream));
1088         m_settingMediaStreamSrcObject = false;
1089     }
1090 }
1091 #endif
1092
1093 void HTMLMediaElement::setCrossOrigin(const AtomicString& value)
1094 {
1095     setAttributeWithoutSynchronization(crossoriginAttr, value);
1096 }
1097
1098 String HTMLMediaElement::crossOrigin() const
1099 {
1100     return parseCORSSettingsAttribute(attributeWithoutSynchronization(crossoriginAttr));
1101 }
1102
1103 HTMLMediaElement::NetworkState HTMLMediaElement::networkState() const
1104 {
1105     return m_networkState;
1106 }
1107
1108 String HTMLMediaElement::canPlayType(const String& mimeType) const
1109 {
1110     MediaEngineSupportParameters parameters;
1111     ContentType contentType(mimeType);
1112     parameters.type = contentType.type().convertToASCIILowercase();
1113     parameters.codecs = contentType.parameter(ASCIILiteral("codecs"));
1114     MediaPlayer::SupportsType support = MediaPlayer::supportsType(parameters, this);
1115     String canPlay;
1116
1117     // 4.8.10.3
1118     switch (support)
1119     {
1120         case MediaPlayer::IsNotSupported:
1121             canPlay = emptyString();
1122             break;
1123         case MediaPlayer::MayBeSupported:
1124             canPlay = ASCIILiteral("maybe");
1125             break;
1126         case MediaPlayer::IsSupported:
1127             canPlay = ASCIILiteral("probably");
1128             break;
1129     }
1130     
1131     LOG(Media, "HTMLMediaElement::canPlayType(%p) - [%s] -> %s", this, mimeType.utf8().data(), canPlay.utf8().data());
1132
1133     return canPlay;
1134 }
1135
1136 double HTMLMediaElement::getStartDate() const
1137 {
1138     if (!m_player)
1139         return std::numeric_limits<double>::quiet_NaN();
1140     return m_player->getStartDate().toDouble();
1141 }
1142
1143 void HTMLMediaElement::load()
1144 {
1145     Ref<HTMLMediaElement> protectedThis(*this); // loadInternal may result in a 'beforeload' event, which can make arbitrary DOM mutations.
1146     
1147     LOG(Media, "HTMLMediaElement::load(%p)", this);
1148     
1149     if (!m_mediaSession->dataLoadingPermitted(*this))
1150         return;
1151     if (ScriptController::processingUserGestureForMedia())
1152         removeBehaviorsRestrictionsAfterFirstUserGesture();
1153
1154     prepareForLoad();
1155     loadInternal();
1156     prepareToPlay();
1157 }
1158
1159 void HTMLMediaElement::prepareForLoad()
1160 {
1161     LOG(Media, "HTMLMediaElement::prepareForLoad(%p)", this);
1162
1163     // Perform the cleanup required for the resource load algorithm to run.
1164     stopPeriodicTimers();
1165     m_pendingActionTimer.stop();
1166     // FIXME: Figure out appropriate place to reset LoadTextTrackResource if necessary and set m_pendingActionFlags to 0 here.
1167     m_pendingActionFlags &= ~LoadMediaResource;
1168     m_sentEndEvent = false;
1169     m_sentStalledEvent = false;
1170     m_haveFiredLoadedData = false;
1171     m_completelyLoaded = false;
1172     m_havePreparedToPlay = false;
1173     m_displayMode = Unknown;
1174     m_currentSrc = URL();
1175
1176 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1177     m_failedToPlayToWirelessTarget = false;
1178 #endif
1179
1180     // 1 - Abort any already-running instance of the resource selection algorithm for this element.
1181     m_loadState = WaitingForSource;
1182     m_currentSourceNode = nullptr;
1183
1184     // 2 - If there are any tasks from the media element's media element event task source in 
1185     // one of the task queues, then remove those tasks.
1186     cancelPendingEventsAndCallbacks();
1187
1188     // 3 - If the media element's networkState is set to NETWORK_LOADING or NETWORK_IDLE, queue
1189     // a task to fire a simple event named abort at the media element.
1190     if (m_networkState == NETWORK_LOADING || m_networkState == NETWORK_IDLE)
1191         scheduleEvent(eventNames().abortEvent);
1192
1193 #if ENABLE(MEDIA_SOURCE)
1194     detachMediaSource();
1195 #endif
1196
1197     createMediaPlayer();
1198
1199     // 4 - If the media element's networkState is not set to NETWORK_EMPTY, then run these substeps
1200     if (m_networkState != NETWORK_EMPTY) {
1201         // 4.1 - Queue a task to fire a simple event named emptied at the media element.
1202         scheduleEvent(eventNames().emptiedEvent);
1203
1204         // 4.2 - If a fetching process is in progress for the media element, the user agent should stop it.
1205         m_networkState = NETWORK_EMPTY;
1206
1207         // 4.3 - Forget the media element's media-resource-specific tracks.
1208         forgetResourceSpecificTracks();
1209
1210         // 4.4 - If readyState is not set to HAVE_NOTHING, then set it to that state.
1211         m_readyState = HAVE_NOTHING;
1212         m_readyStateMaximum = HAVE_NOTHING;
1213
1214         // 4.5 - If the paused attribute is false, then set it to true.
1215         m_paused = true;
1216
1217         // 4.6 - If seeking is true, set it to false.
1218         clearSeeking();
1219
1220         // 4.7 - Set the current playback position to 0.
1221         //       Set the official playback position to 0.
1222         //       If this changed the official playback position, then queue a task to fire a simple event named timeupdate at the media element.
1223         // FIXME: Add support for firing this event. e.g., scheduleEvent(eventNames().timeUpdateEvent);
1224
1225         // 4.8 - Set the initial playback position to 0.
1226         // FIXME: Make this less subtle. The position only becomes 0 because of the createMediaPlayer() call
1227         // above.
1228         refreshCachedTime();
1229
1230         invalidateCachedTime();
1231
1232         // 4.9 - Set the timeline offset to Not-a-Number (NaN).
1233         // 4.10 - Update the duration attribute to Not-a-Number (NaN).
1234
1235         updateMediaController();
1236 #if ENABLE(VIDEO_TRACK)
1237         updateActiveTextTrackCues(MediaTime::zeroTime());
1238 #endif
1239     }
1240
1241     // 5 - Set the playbackRate attribute to the value of the defaultPlaybackRate attribute.
1242     setPlaybackRate(defaultPlaybackRate());
1243
1244     // 6 - Set the error attribute to null and the autoplaying flag to true.
1245     m_error = nullptr;
1246     m_autoplaying = true;
1247     mediaSession().clientWillBeginAutoplaying();
1248
1249     // 7 - Invoke the media element's resource selection algorithm.
1250
1251     // 8 - Note: Playback of any previously playing media resource for this element stops.
1252
1253     // The resource selection algorithm
1254     // 1 - Set the networkState to NETWORK_NO_SOURCE
1255     m_networkState = NETWORK_NO_SOURCE;
1256
1257     // 2 - Asynchronously await a stable state.
1258
1259     m_playedTimeRanges = TimeRanges::create();
1260
1261     // FIXME: Investigate whether these can be moved into m_networkState != NETWORK_EMPTY block above
1262     // so they are closer to the relevant spec steps.
1263     m_lastSeekTime = MediaTime::zeroTime();
1264
1265     // The spec doesn't say to block the load event until we actually run the asynchronous section
1266     // algorithm, but do it now because we won't start that until after the timer fires and the 
1267     // event may have already fired by then.
1268     MediaPlayer::Preload effectivePreload = m_mediaSession->effectivePreloadForElement(*this);
1269     if (effectivePreload != MediaPlayer::None)
1270         setShouldDelayLoadEvent(true);
1271
1272 #if PLATFORM(IOS)
1273     if (effectivePreload != MediaPlayer::None && m_mediaSession->allowsAutomaticMediaDataLoading(*this))
1274         prepareToPlay();
1275 #endif
1276
1277     configureMediaControls();
1278 }
1279
1280 void HTMLMediaElement::loadInternal()
1281 {
1282     LOG(Media, "HTMLMediaElement::loadInternal(%p)", this);
1283
1284     // Some of the code paths below this function dispatch the BeforeLoad event. This ASSERT helps
1285     // us catch those bugs more quickly without needing all the branches to align to actually
1286     // trigger the event.
1287     ASSERT(NoEventDispatchAssertion::isEventAllowedInMainThread());
1288
1289     // If we can't start a load right away, start it later.
1290     if (!m_mediaSession->pageAllowsDataLoading(*this)) {
1291         LOG(Media, "HTMLMediaElement::loadInternal(%p) - not allowed to load in background, waiting", this);
1292         setShouldDelayLoadEvent(false);
1293         if (m_isWaitingUntilMediaCanStart)
1294             return;
1295         m_isWaitingUntilMediaCanStart = true;
1296         document().addMediaCanStartListener(this);
1297         return;
1298     }
1299
1300     clearFlags(m_pendingActionFlags, LoadMediaResource);
1301
1302     // Once the page has allowed an element to load media, it is free to load at will. This allows a 
1303     // playlist that starts in a foreground tab to continue automatically if the tab is subsequently 
1304     // put into the background.
1305     m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequirePageConsentToLoadMedia);
1306
1307 #if ENABLE(VIDEO_TRACK)
1308     if (hasMediaControls())
1309         mediaControls()->changedClosedCaptionsVisibility();
1310
1311     // HTMLMediaElement::textTracksAreReady will need "... the text tracks whose mode was not in the
1312     // disabled state when the element's resource selection algorithm last started".
1313     m_textTracksWhenResourceSelectionBegan.clear();
1314     if (m_textTracks) {
1315         for (unsigned i = 0; i < m_textTracks->length(); ++i) {
1316             TextTrack* track = m_textTracks->item(i);
1317             if (track->mode() != TextTrack::Mode::Disabled)
1318                 m_textTracksWhenResourceSelectionBegan.append(track);
1319         }
1320     }
1321 #endif
1322
1323     selectMediaResource();
1324 }
1325
1326 void HTMLMediaElement::selectMediaResource()
1327 {
1328     LOG(Media, "HTMLMediaElement::selectMediaResource(%p)", this);
1329
1330     ASSERT(m_player);
1331     if (!m_player)
1332         return;
1333
1334     enum Mode { attribute, children };
1335
1336     // 3 - If the media element has a src attribute, then let mode be attribute.
1337     Mode mode = attribute;
1338     if (!hasAttributeWithoutSynchronization(srcAttr)) {
1339         // Otherwise, if the media element does not have a src attribute but has a source 
1340         // element child, then let mode be children and let candidate be the first such 
1341         // source element child in tree order.
1342         if (auto firstSource = childrenOfType<HTMLSourceElement>(*this).first()) {
1343             mode = children;
1344             m_nextChildNodeToConsider = firstSource;
1345             m_currentSourceNode = nullptr;
1346         } else {
1347             // Otherwise the media element has neither a src attribute nor a source element 
1348             // child: set the networkState to NETWORK_EMPTY, and abort these steps; the 
1349             // synchronous section ends.
1350             m_loadState = WaitingForSource;
1351             setShouldDelayLoadEvent(false);
1352             m_networkState = NETWORK_EMPTY;
1353
1354             LOG(Media, "HTMLMediaElement::selectMediaResource(%p) - nothing to load", this);
1355             return;
1356         }
1357     }
1358
1359     // 4 - Set the media element's delaying-the-load-event flag to true (this delays the load event), 
1360     // and set its networkState to NETWORK_LOADING.
1361     setShouldDelayLoadEvent(true);
1362     m_networkState = NETWORK_LOADING;
1363
1364     // 5 - Queue a task to fire a simple event named loadstart at the media element.
1365     scheduleEvent(eventNames().loadstartEvent);
1366
1367     // 6 - If mode is attribute, then run these substeps
1368     if (mode == attribute) {
1369         m_loadState = LoadingFromSrcAttr;
1370
1371         // If the src attribute's value is the empty string ... jump down to the failed step below
1372         URL mediaURL = getNonEmptyURLAttribute(srcAttr);
1373         if (mediaURL.isEmpty()) {
1374             mediaLoadingFailed(MediaPlayer::FormatError);
1375             LOG(Media, "HTMLMediaElement::selectMediaResource(%p) -  empty 'src'", this);
1376             return;
1377         }
1378
1379         if (!isSafeToLoadURL(mediaURL, Complain) || !dispatchBeforeLoadEvent(mediaURL.string())) {
1380             mediaLoadingFailed(MediaPlayer::FormatError);
1381             return;
1382         }
1383
1384         // No type or key system information is available when the url comes
1385         // from the 'src' attribute so MediaPlayer
1386         // will have to pick a media engine based on the file extension.
1387         ContentType contentType((String()));
1388         loadResource(mediaURL, contentType, String());
1389         LOG(Media, "HTMLMediaElement::selectMediaResource(%p) - using 'src' attribute url", this);
1390         return;
1391     }
1392
1393     // Otherwise, the source elements will be used
1394     loadNextSourceChild();
1395 }
1396
1397 void HTMLMediaElement::loadNextSourceChild()
1398 {
1399     ContentType contentType((String()));
1400     String keySystem;
1401     URL mediaURL = selectNextSourceChild(&contentType, &keySystem, Complain);
1402     if (!mediaURL.isValid()) {
1403         waitForSourceChange();
1404         return;
1405     }
1406
1407     // Recreate the media player for the new url
1408     createMediaPlayer();
1409
1410     m_loadState = LoadingFromSourceElement;
1411     loadResource(mediaURL, contentType, keySystem);
1412 }
1413
1414 void HTMLMediaElement::loadResource(const URL& initialURL, ContentType& contentType, const String& keySystem)
1415 {
1416     ASSERT(isSafeToLoadURL(initialURL, Complain));
1417
1418     LOG(Media, "HTMLMediaElement::loadResource(%p) - %s, %s, %s", this, urlForLoggingMedia(initialURL).utf8().data(), contentType.raw().utf8().data(), keySystem.utf8().data());
1419
1420     Frame* frame = document().frame();
1421     if (!frame) {
1422         mediaLoadingFailed(MediaPlayer::FormatError);
1423         return;
1424     }
1425
1426     Page* page = frame->page();
1427     if (!page) {
1428         mediaLoadingFailed(MediaPlayer::FormatError);
1429         return;
1430     }
1431
1432     URL url = initialURL;
1433     if (!frame->loader().willLoadMediaElementURL(url)) {
1434         mediaLoadingFailed(MediaPlayer::FormatError);
1435         return;
1436     }
1437
1438 #if ENABLE(CONTENT_EXTENSIONS)
1439     if (auto* documentLoader = frame->loader().documentLoader()) {
1440         if (page->userContentProvider().processContentExtensionRulesForLoad(url, ResourceType::Media, *documentLoader).blockedLoad) {
1441             mediaLoadingFailed(MediaPlayer::FormatError);
1442             return;
1443         }
1444     }
1445 #endif
1446
1447     // The resource fetch algorithm 
1448     m_networkState = NETWORK_LOADING;
1449
1450     // If the URL should be loaded from the application cache, pass the URL of the cached file to the media engine.
1451     ApplicationCacheResource* resource = nullptr;
1452     if (frame->loader().documentLoader()->applicationCacheHost().shouldLoadResourceFromApplicationCache(ResourceRequest(url), resource)) {
1453         // Resources that are not present in the manifest will always fail to load (at least, after the
1454         // cache has been primed the first time), making the testing of offline applications simpler.
1455         if (!resource || resource->path().isEmpty()) {
1456             mediaLoadingFailed(MediaPlayer::NetworkError);
1457             return;
1458         }
1459     }
1460
1461     // Log that we started loading a media element.
1462     page->diagnosticLoggingClient().logDiagnosticMessage(isVideo() ? DiagnosticLoggingKeys::videoKey() : DiagnosticLoggingKeys::audioKey(), DiagnosticLoggingKeys::loadingKey(), ShouldSample::No);
1463
1464     m_firstTimePlaying = true;
1465
1466     // Set m_currentSrc *before* changing to the cache URL, the fact that we are loading from the app
1467     // cache is an internal detail not exposed through the media element API.
1468     m_currentSrc = url;
1469
1470     if (resource) {
1471         url = ApplicationCacheHost::createFileURL(resource->path());
1472         LOG(Media, "HTMLMediaElement::loadResource(%p) - will load from app cache -> %s", this, urlForLoggingMedia(url).utf8().data());
1473     }
1474
1475     LOG(Media, "HTMLMediaElement::loadResource(%p) - m_currentSrc -> %s", this, urlForLoggingMedia(m_currentSrc).utf8().data());
1476
1477     if (m_sendProgressEvents)
1478         startProgressEventTimer();
1479
1480     bool privateMode = document().page() && document().page()->usesEphemeralSession();
1481     m_player->setPrivateBrowsingMode(privateMode);
1482
1483     // Reset display mode to force a recalculation of what to show because we are resetting the player.
1484     setDisplayMode(Unknown);
1485
1486     if (!autoplay())
1487         m_player->setPreload(m_mediaSession->effectivePreloadForElement(*this));
1488     m_player->setPreservesPitch(m_webkitPreservesPitch);
1489
1490     if (!m_explicitlyMuted) {
1491         m_explicitlyMuted = true;
1492         m_muted = hasAttributeWithoutSynchronization(mutedAttr);
1493         m_mediaSession->canProduceAudioChanged();
1494     }
1495
1496     updateVolume();
1497
1498     bool loadAttempted = false;
1499 #if ENABLE(MEDIA_SOURCE)
1500     ASSERT(!m_mediaSource);
1501
1502     if (url.protocolIs(mediaSourceBlobProtocol))
1503         m_mediaSource = MediaSource::lookup(url.string());
1504
1505     if (m_mediaSource) {
1506         if (m_mediaSource->attachToElement(*this))
1507             m_player->load(url, contentType, m_mediaSource.get());
1508         else {
1509             // Forget our reference to the MediaSource, so we leave it alone
1510             // while processing remainder of load failure.
1511             m_mediaSource = nullptr;
1512             mediaLoadingFailed(MediaPlayer::FormatError);
1513         }
1514         loadAttempted = true;
1515     }
1516 #endif
1517
1518 #if ENABLE(MEDIA_STREAM)
1519     if (!loadAttempted) {
1520         if (!m_mediaStreamSrcObject && url.protocolIs(mediaStreamBlobProtocol))
1521             m_mediaStreamSrcObject = MediaStreamRegistry::shared().lookUp(url);
1522
1523         if (m_mediaStreamSrcObject) {
1524             loadAttempted = true;
1525             if (!m_player->load(m_mediaStreamSrcObject->privateStream()))
1526                 mediaLoadingFailed(MediaPlayer::FormatError);
1527         }
1528     }
1529 #endif
1530
1531     if (!loadAttempted && !m_player->load(url, contentType, keySystem))
1532         mediaLoadingFailed(MediaPlayer::FormatError);
1533
1534     // If there is no poster to display, allow the media engine to render video frames as soon as
1535     // they are available.
1536     updateDisplayState();
1537
1538     updateRenderer();
1539 }
1540
1541 #if ENABLE(VIDEO_TRACK)
1542
1543 static bool trackIndexCompare(TextTrack* a, TextTrack* b)
1544 {
1545     return a->trackIndex() - b->trackIndex() < 0;
1546 }
1547
1548 static bool eventTimeCueCompare(const std::pair<MediaTime, TextTrackCue*>& a, const std::pair<MediaTime, TextTrackCue*>& b)
1549 {
1550     // 12 - Sort the tasks in events in ascending time order (tasks with earlier
1551     // times first).
1552     if (a.first != b.first)
1553         return a.first - b.first < MediaTime::zeroTime();
1554
1555     // If the cues belong to different text tracks, it doesn't make sense to
1556     // compare the two tracks by the relative cue order, so return the relative
1557     // track order.
1558     if (a.second->track() != b.second->track())
1559         return trackIndexCompare(a.second->track(), b.second->track());
1560
1561     // 12 - Further sort tasks in events that have the same time by the
1562     // relative text track cue order of the text track cues associated
1563     // with these tasks.
1564     return a.second->isOrderedBefore(b.second);
1565 }
1566
1567 static bool compareCueInterval(const CueInterval& one, const CueInterval& two)
1568 {
1569     return one.data()->isOrderedBefore(two.data());
1570 }
1571
1572 void HTMLMediaElement::updateActiveTextTrackCues(const MediaTime& movieTime)
1573 {
1574     // 4.8.10.8 Playing the media resource
1575
1576     //  If the current playback position changes while the steps are running,
1577     //  then the user agent must wait for the steps to complete, and then must
1578     //  immediately rerun the steps.
1579     if (ignoreTrackDisplayUpdateRequests())
1580         return;
1581
1582     LOG(Media, "HTMLMediaElement::updateActiveTextTrackCues(%p)", this);
1583
1584     // 1 - Let current cues be a list of cues, initialized to contain all the
1585     // cues of all the hidden, showing, or showing by default text tracks of the
1586     // media element (not the disabled ones) whose start times are less than or
1587     // equal to the current playback position and whose end times are greater
1588     // than the current playback position.
1589     CueList currentCues;
1590
1591     // The user agent must synchronously unset [the text track cue active] flag
1592     // whenever ... the media element's readyState is changed back to HAVE_NOTHING.
1593     if (m_readyState != HAVE_NOTHING && m_player) {
1594         currentCues = m_cueTree.allOverlaps(m_cueTree.createInterval(movieTime, movieTime));
1595         if (currentCues.size() > 1)
1596             std::sort(currentCues.begin(), currentCues.end(), &compareCueInterval);
1597     }
1598
1599     CueList previousCues;
1600     CueList missedCues;
1601
1602     // 2 - Let other cues be a list of cues, initialized to contain all the cues
1603     // of hidden, showing, and showing by default text tracks of the media
1604     // element that are not present in current cues.
1605     previousCues = m_currentlyActiveCues;
1606
1607     // 3 - Let last time be the current playback position at the time this
1608     // algorithm was last run for this media element, if this is not the first
1609     // time it has run.
1610     MediaTime lastTime = m_lastTextTrackUpdateTime;
1611
1612     // 4 - If the current playback position has, since the last time this
1613     // algorithm was run, only changed through its usual monotonic increase
1614     // during normal playback, then let missed cues be the list of cues in other
1615     // cues whose start times are greater than or equal to last time and whose
1616     // end times are less than or equal to the current playback position.
1617     // Otherwise, let missed cues be an empty list.
1618     if (lastTime >= MediaTime::zeroTime() && m_lastSeekTime < movieTime) {
1619         for (auto& cue : m_cueTree.allOverlaps(m_cueTree.createInterval(lastTime, movieTime))) {
1620             // Consider cues that may have been missed since the last seek time.
1621             if (cue.low() > std::max(m_lastSeekTime, lastTime) && cue.high() < movieTime)
1622                 missedCues.append(cue);
1623         }
1624     }
1625
1626     m_lastTextTrackUpdateTime = movieTime;
1627
1628     // 5 - If the time was reached through the usual monotonic increase of the
1629     // current playback position during normal playback, and if the user agent
1630     // has not fired a timeupdate event at the element in the past 15 to 250ms
1631     // and is not still running event handlers for such an event, then the user
1632     // agent must queue a task to fire a simple event named timeupdate at the
1633     // element. (In the other cases, such as explicit seeks, relevant events get
1634     // fired as part of the overall process of changing the current playback
1635     // position.)
1636     if (!m_paused && m_lastSeekTime <= lastTime)
1637         scheduleTimeupdateEvent(false);
1638
1639     // Explicitly cache vector sizes, as their content is constant from here.
1640     size_t currentCuesSize = currentCues.size();
1641     size_t missedCuesSize = missedCues.size();
1642     size_t previousCuesSize = previousCues.size();
1643
1644     // 6 - If all of the cues in current cues have their text track cue active
1645     // flag set, none of the cues in other cues have their text track cue active
1646     // flag set, and missed cues is empty, then abort these steps.
1647     bool activeSetChanged = missedCuesSize;
1648
1649     for (size_t i = 0; !activeSetChanged && i < previousCuesSize; ++i)
1650         if (!currentCues.contains(previousCues[i]) && previousCues[i].data()->isActive())
1651             activeSetChanged = true;
1652
1653     for (size_t i = 0; i < currentCuesSize; ++i) {
1654         TextTrackCue* cue = currentCues[i].data();
1655
1656         if (cue->isRenderable())
1657             toVTTCue(cue)->updateDisplayTree(movieTime);
1658
1659         if (!cue->isActive())
1660             activeSetChanged = true;
1661     }
1662
1663     if (!activeSetChanged)
1664         return;
1665
1666     // 7 - If the time was reached through the usual monotonic increase of the
1667     // current playback position during normal playback, and there are cues in
1668     // other cues that have their text track cue pause-on-exi flag set and that
1669     // either have their text track cue active flag set or are also in missed
1670     // cues, then immediately pause the media element.
1671     for (size_t i = 0; !m_paused && i < previousCuesSize; ++i) {
1672         if (previousCues[i].data()->pauseOnExit()
1673             && previousCues[i].data()->isActive()
1674             && !currentCues.contains(previousCues[i]))
1675             pause();
1676     }
1677
1678     for (size_t i = 0; !m_paused && i < missedCuesSize; ++i) {
1679         if (missedCues[i].data()->pauseOnExit())
1680             pause();
1681     }
1682
1683     // 8 - Let events be a list of tasks, initially empty. Each task in this
1684     // list will be associated with a text track, a text track cue, and a time,
1685     // which are used to sort the list before the tasks are queued.
1686     Vector<std::pair<MediaTime, TextTrackCue*>> eventTasks;
1687
1688     // 8 - Let affected tracks be a list of text tracks, initially empty.
1689     Vector<TextTrack*> affectedTracks;
1690
1691     for (size_t i = 0; i < missedCuesSize; ++i) {
1692         // 9 - For each text track cue in missed cues, prepare an event named enter
1693         // for the TextTrackCue object with the text track cue start time.
1694         eventTasks.append({ missedCues[i].data()->startMediaTime(), missedCues[i].data() });
1695
1696         // 10 - For each text track [...] in missed cues, prepare an event
1697         // named exit for the TextTrackCue object with the  with the later of
1698         // the text track cue end time and the text track cue start time.
1699
1700         // Note: An explicit task is added only if the cue is NOT a zero or
1701         // negative length cue. Otherwise, the need for an exit event is
1702         // checked when these tasks are actually queued below. This doesn't
1703         // affect sorting events before dispatch either, because the exit
1704         // event has the same time as the enter event.
1705         if (missedCues[i].data()->startMediaTime() < missedCues[i].data()->endMediaTime())
1706             eventTasks.append({ missedCues[i].data()->endMediaTime(), missedCues[i].data() });
1707     }
1708
1709     for (size_t i = 0; i < previousCuesSize; ++i) {
1710         // 10 - For each text track cue in other cues that has its text
1711         // track cue active flag set prepare an event named exit for the
1712         // TextTrackCue object with the text track cue end time.
1713         if (!currentCues.contains(previousCues[i]))
1714             eventTasks.append({ previousCues[i].data()->endMediaTime(), previousCues[i].data() });
1715     }
1716
1717     for (size_t i = 0; i < currentCuesSize; ++i) {
1718         // 11 - For each text track cue in current cues that does not have its
1719         // text track cue active flag set, prepare an event named enter for the
1720         // TextTrackCue object with the text track cue start time.
1721         if (!previousCues.contains(currentCues[i]))
1722             eventTasks.append({ currentCues[i].data()->startMediaTime(), currentCues[i].data() });
1723     }
1724
1725     // 12 - Sort the tasks in events in ascending time order (tasks with earlier
1726     // times first).
1727     std::sort(eventTasks.begin(), eventTasks.end(), eventTimeCueCompare);
1728
1729     for (auto& eventTask : eventTasks) {
1730         if (!affectedTracks.contains(eventTask.second->track()))
1731             affectedTracks.append(eventTask.second->track());
1732
1733         // 13 - Queue each task in events, in list order.
1734
1735         // Each event in eventTasks may be either an enterEvent or an exitEvent,
1736         // depending on the time that is associated with the event. This
1737         // correctly identifies the type of the event, if the startTime is
1738         // less than the endTime in the cue.
1739         if (eventTask.second->startTime() >= eventTask.second->endTime()) {
1740             auto enterEvent = Event::create(eventNames().enterEvent, false, false);
1741             enterEvent->setTarget(eventTask.second);
1742             m_asyncEventQueue.enqueueEvent(WTFMove(enterEvent));
1743
1744             auto exitEvent = Event::create(eventNames().exitEvent, false, false);
1745             exitEvent->setTarget(eventTask.second);
1746             m_asyncEventQueue.enqueueEvent(WTFMove(exitEvent));
1747         } else {
1748             RefPtr<Event> event;
1749             if (eventTask.first == eventTask.second->startMediaTime())
1750                 event = Event::create(eventNames().enterEvent, false, false);
1751             else
1752                 event = Event::create(eventNames().exitEvent, false, false);
1753             event->setTarget(eventTask.second);
1754             m_asyncEventQueue.enqueueEvent(WTFMove(event));
1755         }
1756     }
1757
1758     // 14 - Sort affected tracks in the same order as the text tracks appear in
1759     // the media element's list of text tracks, and remove duplicates.
1760     std::sort(affectedTracks.begin(), affectedTracks.end(), trackIndexCompare);
1761
1762     // 15 - For each text track in affected tracks, in the list order, queue a
1763     // task to fire a simple event named cuechange at the TextTrack object, and, ...
1764     for (auto& affectedTrack : affectedTracks) {
1765         auto event = Event::create(eventNames().cuechangeEvent, false, false);
1766         event->setTarget(affectedTrack);
1767         m_asyncEventQueue.enqueueEvent(WTFMove(event));
1768
1769         // ... if the text track has a corresponding track element, to then fire a
1770         // simple event named cuechange at the track element as well.
1771         if (is<LoadableTextTrack>(*affectedTrack)) {
1772             auto event = Event::create(eventNames().cuechangeEvent, false, false);
1773             auto* trackElement = downcast<LoadableTextTrack>(*affectedTrack).trackElement();
1774             ASSERT(trackElement);
1775             event->setTarget(trackElement);
1776             m_asyncEventQueue.enqueueEvent(WTFMove(event));
1777         }
1778     }
1779
1780     // 16 - Set the text track cue active flag of all the cues in the current
1781     // cues, and unset the text track cue active flag of all the cues in the
1782     // other cues.
1783     for (size_t i = 0; i < currentCuesSize; ++i)
1784         currentCues[i].data()->setIsActive(true);
1785
1786     for (size_t i = 0; i < previousCuesSize; ++i)
1787         if (!currentCues.contains(previousCues[i]))
1788             previousCues[i].data()->setIsActive(false);
1789
1790     // Update the current active cues.
1791     m_currentlyActiveCues = currentCues;
1792
1793     if (activeSetChanged)
1794         updateTextTrackDisplay();
1795 }
1796
1797 bool HTMLMediaElement::textTracksAreReady() const
1798 {
1799     // 4.8.10.12.1 Text track model
1800     // ...
1801     // The text tracks of a media element are ready if all the text tracks whose mode was not 
1802     // in the disabled state when the element's resource selection algorithm last started now
1803     // have a text track readiness state of loaded or failed to load.
1804     for (unsigned i = 0; i < m_textTracksWhenResourceSelectionBegan.size(); ++i) {
1805         if (m_textTracksWhenResourceSelectionBegan[i]->readinessState() == TextTrack::Loading
1806             || m_textTracksWhenResourceSelectionBegan[i]->readinessState() == TextTrack::NotLoaded)
1807             return false;
1808     }
1809
1810     return true;
1811 }
1812
1813 void HTMLMediaElement::textTrackReadyStateChanged(TextTrack* track)
1814 {
1815     if (m_player && m_textTracksWhenResourceSelectionBegan.contains(track)) {
1816         if (track->readinessState() != TextTrack::Loading)
1817             setReadyState(m_player->readyState());
1818     } else {
1819         // The track readiness state might have changed as a result of the user
1820         // clicking the captions button. In this case, a check whether all the
1821         // resources have failed loading should be done in order to hide the CC button.
1822         if (hasMediaControls() && track->readinessState() == TextTrack::FailedToLoad)
1823             mediaControls()->refreshClosedCaptionsButtonVisibility();
1824     }
1825 }
1826
1827 void HTMLMediaElement::audioTrackEnabledChanged(AudioTrack& track)
1828 {
1829     if (m_audioTracks && m_audioTracks->contains(track))
1830         m_audioTracks->scheduleChangeEvent();
1831     if (ScriptController::processingUserGestureForMedia())
1832         removeBehaviorsRestrictionsAfterFirstUserGesture(MediaElementSession::AllRestrictions & ~MediaElementSession::RequireUserGestureToControlControlsManager);
1833 }
1834
1835 void HTMLMediaElement::textTrackModeChanged(TextTrack& track)
1836 {
1837     bool trackIsLoaded = true;
1838     if (track.trackType() == TextTrack::TrackElement) {
1839         trackIsLoaded = false;
1840         for (auto& trackElement : childrenOfType<HTMLTrackElement>(*this)) {
1841             if (&trackElement.track() == &track) {
1842                 if (trackElement.readyState() == HTMLTrackElement::LOADING || trackElement.readyState() == HTMLTrackElement::LOADED)
1843                     trackIsLoaded = true;
1844                 break;
1845             }
1846         }
1847     }
1848
1849     // If this is the first added track, create the list of text tracks.
1850     if (!m_textTracks)
1851         m_textTracks = TextTrackList::create(this, ActiveDOMObject::scriptExecutionContext());
1852     
1853     // Mark this track as "configured" so configureTextTracks won't change the mode again.
1854     track.setHasBeenConfigured(true);
1855     
1856     if (track.mode() != TextTrack::Mode::Disabled && trackIsLoaded)
1857         textTrackAddCues(track, *track.cues());
1858
1859     configureTextTrackDisplay(AssumeTextTrackVisibilityChanged);
1860
1861     if (m_textTracks && m_textTracks->contains(track))
1862         m_textTracks->scheduleChangeEvent();
1863
1864 #if ENABLE(AVF_CAPTIONS)
1865     if (track.trackType() == TextTrack::TrackElement && m_player)
1866         m_player->notifyTrackModeChanged();
1867 #endif
1868 }
1869
1870 void HTMLMediaElement::videoTrackSelectedChanged(VideoTrack& track)
1871 {
1872     if (m_videoTracks && m_videoTracks->contains(track))
1873         m_videoTracks->scheduleChangeEvent();
1874 }
1875
1876 void HTMLMediaElement::textTrackKindChanged(TextTrack& track)
1877 {
1878     if (track.kind() != TextTrack::Kind::Captions && track.kind() != TextTrack::Kind::Subtitles && track.mode() == TextTrack::Mode::Showing)
1879         track.setMode(TextTrack::Mode::Hidden);
1880 }
1881
1882 void HTMLMediaElement::beginIgnoringTrackDisplayUpdateRequests()
1883 {
1884     ++m_ignoreTrackDisplayUpdate;
1885 }
1886
1887 void HTMLMediaElement::endIgnoringTrackDisplayUpdateRequests()
1888 {
1889     ASSERT(m_ignoreTrackDisplayUpdate);
1890     --m_ignoreTrackDisplayUpdate;
1891     if (!m_ignoreTrackDisplayUpdate && m_inActiveDocument)
1892         updateActiveTextTrackCues(currentMediaTime());
1893 }
1894
1895 void HTMLMediaElement::textTrackAddCues(TextTrack& track, const TextTrackCueList& cues)
1896 {
1897     if (track.mode() == TextTrack::Mode::Disabled)
1898         return;
1899
1900     TrackDisplayUpdateScope scope { *this };
1901     for (unsigned i = 0; i < cues.length(); ++i)
1902         textTrackAddCue(track, *cues.item(i));
1903 }
1904
1905 void HTMLMediaElement::textTrackRemoveCues(TextTrack&, const TextTrackCueList& cues)
1906 {
1907     TrackDisplayUpdateScope scope { *this };
1908     for (unsigned i = 0; i < cues.length(); ++i) {
1909         auto& cue = *cues.item(i);
1910         textTrackRemoveCue(*cue.track(), cue);
1911     }
1912 }
1913
1914 void HTMLMediaElement::textTrackAddCue(TextTrack& track, TextTrackCue& cue)
1915 {
1916     if (track.mode() == TextTrack::Mode::Disabled)
1917         return;
1918
1919     // Negative duration cues need be treated in the interval tree as
1920     // zero-length cues.
1921     MediaTime endTime = std::max(cue.startMediaTime(), cue.endMediaTime());
1922
1923     CueInterval interval = m_cueTree.createInterval(cue.startMediaTime(), endTime, &cue);
1924     if (!m_cueTree.contains(interval))
1925         m_cueTree.add(interval);
1926     updateActiveTextTrackCues(currentMediaTime());
1927 }
1928
1929 void HTMLMediaElement::textTrackRemoveCue(TextTrack&, TextTrackCue& cue)
1930 {
1931     // Negative duration cues need to be treated in the interval tree as
1932     // zero-length cues.
1933     MediaTime endTime = std::max(cue.startMediaTime(), cue.endMediaTime());
1934
1935     CueInterval interval = m_cueTree.createInterval(cue.startMediaTime(), endTime, &cue);
1936     m_cueTree.remove(interval);
1937
1938     // Since the cue will be removed from the media element and likely the
1939     // TextTrack might also be destructed, notifying the region of the cue
1940     // removal shouldn't be done.
1941     if (cue.isRenderable())
1942         toVTTCue(&cue)->notifyRegionWhenRemovingDisplayTree(false);
1943
1944     size_t index = m_currentlyActiveCues.find(interval);
1945     if (index != notFound) {
1946         cue.setIsActive(false);
1947         m_currentlyActiveCues.remove(index);
1948     }
1949
1950     if (cue.isRenderable())
1951         toVTTCue(&cue)->removeDisplayTree();
1952     updateActiveTextTrackCues(currentMediaTime());
1953
1954     if (cue.isRenderable())
1955         toVTTCue(&cue)->notifyRegionWhenRemovingDisplayTree(true);
1956 }
1957
1958 #endif
1959
1960 static inline bool isAllowedToLoadMediaURL(HTMLMediaElement& element, const URL& url, bool isInUserAgentShadowTree)
1961 {
1962     // Elements in user agent show tree should load whatever the embedding document policy is.
1963     if (isInUserAgentShadowTree)
1964         return true;
1965
1966     ASSERT(element.document().contentSecurityPolicy());
1967     return element.document().contentSecurityPolicy()->allowMediaFromSource(url);
1968 }
1969
1970 bool HTMLMediaElement::isSafeToLoadURL(const URL& url, InvalidURLAction actionIfInvalid)
1971 {
1972     if (!url.isValid()) {
1973         LOG(Media, "HTMLMediaElement::isSafeToLoadURL(%p) - %s -> FALSE because url is invalid", this, urlForLoggingMedia(url).utf8().data());
1974         return false;
1975     }
1976
1977     Frame* frame = document().frame();
1978     if (!frame || !document().securityOrigin().canDisplay(url)) {
1979         if (actionIfInvalid == Complain)
1980             FrameLoader::reportLocalLoadFailed(frame, url.stringCenterEllipsizedToLength());
1981         LOG(Media, "HTMLMediaElement::isSafeToLoadURL(%p) - %s -> FALSE rejected by SecurityOrigin", this, urlForLoggingMedia(url).utf8().data());
1982         return false;
1983     }
1984
1985     if (!isAllowedToLoadMediaURL(*this, url, isInUserAgentShadowTree())) {
1986         LOG(Media, "HTMLMediaElement::isSafeToLoadURL(%p) - %s -> rejected by Content Security Policy", this, urlForLoggingMedia(url).utf8().data());
1987         return false;
1988     }
1989
1990     return true;
1991 }
1992
1993 void HTMLMediaElement::startProgressEventTimer()
1994 {
1995     if (m_progressEventTimer.isActive())
1996         return;
1997
1998     m_previousProgressTime = monotonicallyIncreasingTime();
1999     // 350ms is not magic, it is in the spec!
2000     m_progressEventTimer.startRepeating(0.350);
2001 }
2002
2003 void HTMLMediaElement::waitForSourceChange()
2004 {
2005     LOG(Media, "HTMLMediaElement::waitForSourceChange(%p)", this);
2006
2007     stopPeriodicTimers();
2008     m_loadState = WaitingForSource;
2009
2010     // 6.17 - Waiting: Set the element's networkState attribute to the NETWORK_NO_SOURCE value
2011     m_networkState = NETWORK_NO_SOURCE;
2012
2013     // 6.18 - Set the element's delaying-the-load-event flag to false. This stops delaying the load event.
2014     setShouldDelayLoadEvent(false);
2015
2016     updateDisplayState();
2017     updateRenderer();
2018 }
2019
2020 void HTMLMediaElement::noneSupported()
2021 {
2022     LOG(Media, "HTMLMediaElement::noneSupported(%p)", this);
2023
2024     stopPeriodicTimers();
2025     m_loadState = WaitingForSource;
2026     m_currentSourceNode = nullptr;
2027
2028     // 4.8.10.5 
2029     // 6 - Reaching this step indicates that the media resource failed to load or that the given 
2030     // URL could not be resolved. In one atomic operation, run the following steps:
2031
2032     // 6.1 - Set the error attribute to a new MediaError object whose code attribute is set to
2033     // MEDIA_ERR_SRC_NOT_SUPPORTED.
2034     m_error = MediaError::create(MediaError::MEDIA_ERR_SRC_NOT_SUPPORTED);
2035
2036     // 6.2 - Forget the media element's media-resource-specific text tracks.
2037     forgetResourceSpecificTracks();
2038
2039     // 6.3 - Set the element's networkState attribute to the NETWORK_NO_SOURCE value.
2040     m_networkState = NETWORK_NO_SOURCE;
2041
2042     // 7 - Queue a task to fire a simple event named error at the media element.
2043     scheduleEvent(eventNames().errorEvent);
2044
2045     rejectPendingPlayPromises(DOMError::create("NotSupportedError", "The operation is not supported."));
2046
2047 #if ENABLE(MEDIA_SOURCE)
2048     detachMediaSource();
2049 #endif
2050
2051     // 8 - Set the element's delaying-the-load-event flag to false. This stops delaying the load event.
2052     setShouldDelayLoadEvent(false);
2053
2054     // 9 - Abort these steps. Until the load() method is invoked or the src attribute is changed, 
2055     // the element won't attempt to load another resource.
2056
2057     updateDisplayState();
2058     updateRenderer();
2059 }
2060
2061 void HTMLMediaElement::mediaLoadingFailedFatally(MediaPlayer::NetworkState error)
2062 {
2063     LOG(Media, "HTMLMediaElement::mediaLoadingFailedFatally(%p) - error = %d", this, static_cast<int>(error));
2064
2065     // 1 - The user agent should cancel the fetching process.
2066     stopPeriodicTimers();
2067     m_loadState = WaitingForSource;
2068
2069     // 2 - Set the error attribute to a new MediaError object whose code attribute is 
2070     // set to MEDIA_ERR_NETWORK/MEDIA_ERR_DECODE.
2071     if (error == MediaPlayer::NetworkError)
2072         m_error = MediaError::create(MediaError::MEDIA_ERR_NETWORK);
2073     else if (error == MediaPlayer::DecodeError)
2074         m_error = MediaError::create(MediaError::MEDIA_ERR_DECODE);
2075     else
2076         ASSERT_NOT_REACHED();
2077
2078     // 3 - Queue a task to fire a simple event named error at the media element.
2079     scheduleEvent(eventNames().errorEvent);
2080
2081 #if ENABLE(MEDIA_SOURCE)
2082     detachMediaSource();
2083 #endif
2084
2085     // 4 - Set the element's networkState attribute to the NETWORK_EMPTY value and queue a
2086     // task to fire a simple event called emptied at the element.
2087     m_networkState = NETWORK_EMPTY;
2088     scheduleEvent(eventNames().emptiedEvent);
2089
2090     // 5 - Set the element's delaying-the-load-event flag to false. This stops delaying the load event.
2091     setShouldDelayLoadEvent(false);
2092
2093     // 6 - Abort the overall resource selection algorithm.
2094     m_currentSourceNode = nullptr;
2095
2096 #if PLATFORM(COCOA)
2097     if (is<MediaDocument>(document()))
2098         downcast<MediaDocument>(document()).mediaElementSawUnsupportedTracks();
2099 #endif
2100 }
2101
2102 void HTMLMediaElement::cancelPendingEventsAndCallbacks()
2103 {
2104     LOG(Media, "HTMLMediaElement::cancelPendingEventsAndCallbacks(%p)", this);
2105     m_asyncEventQueue.cancelAllEvents();
2106
2107     for (auto& source : childrenOfType<HTMLSourceElement>(*this))
2108         source.cancelPendingErrorEvent();
2109
2110     rejectPendingPlayPromises(DOMError::create("AbortError", "The operation was aborted."));
2111 }
2112
2113 void HTMLMediaElement::mediaPlayerNetworkStateChanged(MediaPlayer*)
2114 {
2115     beginProcessingMediaPlayerCallback();
2116     setNetworkState(m_player->networkState());
2117     endProcessingMediaPlayerCallback();
2118 }
2119
2120 static void logMediaLoadRequest(Page* page, const String& mediaEngine, const String& errorMessage, bool succeeded)
2121 {
2122     if (!page)
2123         return;
2124
2125     DiagnosticLoggingClient& diagnosticLoggingClient = page->diagnosticLoggingClient();
2126     if (!succeeded) {
2127         diagnosticLoggingClient.logDiagnosticMessageWithResult(DiagnosticLoggingKeys::mediaLoadingFailedKey(), errorMessage, DiagnosticLoggingResultFail, ShouldSample::No);
2128         return;
2129     }
2130
2131     diagnosticLoggingClient.logDiagnosticMessage(DiagnosticLoggingKeys::mediaLoadedKey(), mediaEngine, ShouldSample::No);
2132
2133     if (!page->hasSeenAnyMediaEngine())
2134         diagnosticLoggingClient.logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsAtLeastOneMediaEngineKey(), emptyString(), ShouldSample::No);
2135
2136     if (!page->hasSeenMediaEngine(mediaEngine))
2137         diagnosticLoggingClient.logDiagnosticMessage(DiagnosticLoggingKeys::pageContainsMediaEngineKey(), mediaEngine, ShouldSample::No);
2138
2139     page->sawMediaEngine(mediaEngine);
2140 }
2141
2142 static String stringForNetworkState(MediaPlayer::NetworkState state)
2143 {
2144     switch (state) {
2145     case MediaPlayer::Empty: return ASCIILiteral("Empty");
2146     case MediaPlayer::Idle: return ASCIILiteral("Idle");
2147     case MediaPlayer::Loading: return ASCIILiteral("Loading");
2148     case MediaPlayer::Loaded: return ASCIILiteral("Loaded");
2149     case MediaPlayer::FormatError: return ASCIILiteral("FormatError");
2150     case MediaPlayer::NetworkError: return ASCIILiteral("NetworkError");
2151     case MediaPlayer::DecodeError: return ASCIILiteral("DecodeError");
2152     default: return emptyString();
2153     }
2154 }
2155
2156 void HTMLMediaElement::mediaLoadingFailed(MediaPlayer::NetworkState error)
2157 {
2158     stopPeriodicTimers();
2159     
2160     // If we failed while trying to load a <source> element, the movie was never parsed, and there are more
2161     // <source> children, schedule the next one
2162     if (m_readyState < HAVE_METADATA && m_loadState == LoadingFromSourceElement) {
2163         
2164         // resource selection algorithm
2165         // Step 9.Otherwise.9 - Failed with elements: Queue a task, using the DOM manipulation task source, to fire a simple event named error at the candidate element.
2166         if (m_currentSourceNode)
2167             m_currentSourceNode->scheduleErrorEvent();
2168         else
2169             LOG(Media, "HTMLMediaElement::setNetworkState(%p) - error event not sent, <source> was removed", this);
2170         
2171         // 9.Otherwise.10 - Asynchronously await a stable state. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended.
2172         
2173         // 9.Otherwise.11 - Forget the media element's media-resource-specific tracks.
2174         forgetResourceSpecificTracks();
2175
2176         if (havePotentialSourceChild()) {
2177             LOG(Media, "HTMLMediaElement::setNetworkState(%p) - scheduling next <source>", this);
2178             scheduleNextSourceChild();
2179         } else {
2180             LOG(Media, "HTMLMediaElement::setNetworkState(%p) - no more <source> elements, waiting", this);
2181             waitForSourceChange();
2182         }
2183         
2184         return;
2185     }
2186     
2187     if ((error == MediaPlayer::NetworkError && m_readyState >= HAVE_METADATA) || error == MediaPlayer::DecodeError)
2188         mediaLoadingFailedFatally(error);
2189     else if ((error == MediaPlayer::FormatError || error == MediaPlayer::NetworkError) && m_loadState == LoadingFromSrcAttr)
2190         noneSupported();
2191     
2192     updateDisplayState();
2193     if (hasMediaControls()) {
2194         mediaControls()->reset();
2195         mediaControls()->reportedError();
2196     }
2197
2198     logMediaLoadRequest(document().page(), String(), stringForNetworkState(error), false);
2199
2200     m_mediaSession->clientCharacteristicsChanged();
2201 }
2202
2203 void HTMLMediaElement::setNetworkState(MediaPlayer::NetworkState state)
2204 {
2205     LOG(Media, "HTMLMediaElement::setNetworkState(%p) - new state = %d, current state = %d", this, static_cast<int>(state), static_cast<int>(m_networkState));
2206
2207     if (state == MediaPlayer::Empty) {
2208         // Just update the cached state and leave, we can't do anything.
2209         m_networkState = NETWORK_EMPTY;
2210         return;
2211     }
2212
2213     if (state == MediaPlayer::FormatError || state == MediaPlayer::NetworkError || state == MediaPlayer::DecodeError) {
2214         mediaLoadingFailed(state);
2215         return;
2216     }
2217
2218     if (state == MediaPlayer::Idle) {
2219         if (m_networkState > NETWORK_IDLE) {
2220             changeNetworkStateFromLoadingToIdle();
2221             setShouldDelayLoadEvent(false);
2222         } else {
2223             m_networkState = NETWORK_IDLE;
2224         }
2225     }
2226
2227     if (state == MediaPlayer::Loading) {
2228         if (m_networkState < NETWORK_LOADING || m_networkState == NETWORK_NO_SOURCE)
2229             startProgressEventTimer();
2230         m_networkState = NETWORK_LOADING;
2231     }
2232
2233     if (state == MediaPlayer::Loaded) {
2234         if (m_networkState != NETWORK_IDLE)
2235             changeNetworkStateFromLoadingToIdle();
2236         m_completelyLoaded = true;
2237     }
2238
2239     if (hasMediaControls())
2240         mediaControls()->updateStatusDisplay();
2241 }
2242
2243 void HTMLMediaElement::changeNetworkStateFromLoadingToIdle()
2244 {
2245     m_progressEventTimer.stop();
2246     if (hasMediaControls() && m_player->didLoadingProgress())
2247         mediaControls()->bufferingProgressed();
2248
2249     // Schedule one last progress event so we guarantee that at least one is fired
2250     // for files that load very quickly.
2251     scheduleEvent(eventNames().progressEvent);
2252     scheduleEvent(eventNames().suspendEvent);
2253     m_networkState = NETWORK_IDLE;
2254 }
2255
2256 void HTMLMediaElement::mediaPlayerReadyStateChanged(MediaPlayer*)
2257 {
2258     beginProcessingMediaPlayerCallback();
2259
2260     setReadyState(m_player->readyState());
2261
2262     endProcessingMediaPlayerCallback();
2263 }
2264
2265 SuccessOr<MediaPlaybackDenialReason> HTMLMediaElement::canTransitionFromAutoplayToPlay() const
2266 {
2267     if (isAutoplaying()
2268      && mediaSession().autoplayPermitted()
2269      && paused()
2270      && autoplay()
2271      && !pausedForUserInteraction()
2272      && !document().isSandboxed(SandboxAutomaticFeatures))
2273         return mediaSession().playbackPermitted(*this);
2274
2275     return MediaPlaybackDenialReason::PageConsentRequired;
2276 }
2277
2278 void HTMLMediaElement::setReadyState(MediaPlayer::ReadyState state)
2279 {
2280     LOG(Media, "HTMLMediaElement::setReadyState(%p) - new state = %d, current state = %d,", this, static_cast<int>(state), static_cast<int>(m_readyState));
2281
2282     // Set "wasPotentiallyPlaying" BEFORE updating m_readyState, potentiallyPlaying() uses it
2283     bool wasPotentiallyPlaying = potentiallyPlaying();
2284
2285     ReadyState oldState = m_readyState;
2286     ReadyState newState = static_cast<ReadyState>(state);
2287
2288 #if ENABLE(VIDEO_TRACK)
2289     bool tracksAreReady = textTracksAreReady();
2290
2291     if (newState == oldState && m_tracksAreReady == tracksAreReady)
2292         return;
2293
2294     m_tracksAreReady = tracksAreReady;
2295 #else
2296     if (newState == oldState)
2297         return;
2298     bool tracksAreReady = true;
2299 #endif
2300     
2301     if (tracksAreReady)
2302         m_readyState = newState;
2303     else {
2304         // If a media file has text tracks the readyState may not progress beyond HAVE_FUTURE_DATA until
2305         // the text tracks are ready, regardless of the state of the media file.
2306         if (newState <= HAVE_METADATA)
2307             m_readyState = newState;
2308         else
2309             m_readyState = HAVE_CURRENT_DATA;
2310     }
2311     
2312     if (oldState > m_readyStateMaximum)
2313         m_readyStateMaximum = oldState;
2314
2315     if (m_networkState == NETWORK_EMPTY)
2316         return;
2317
2318     if (m_seeking) {
2319         // 4.8.10.9, step 11
2320         if (wasPotentiallyPlaying && m_readyState < HAVE_FUTURE_DATA)
2321             scheduleEvent(eventNames().waitingEvent);
2322
2323         // 4.8.10.10 step 14 & 15.
2324         if (!m_player->seeking() && m_readyState >= HAVE_CURRENT_DATA)
2325             finishSeek();
2326     } else {
2327         if (wasPotentiallyPlaying && m_readyState < HAVE_FUTURE_DATA) {
2328             // 4.8.10.8
2329             invalidateCachedTime();
2330             scheduleTimeupdateEvent(false);
2331             scheduleEvent(eventNames().waitingEvent);
2332         }
2333     }
2334
2335     if (m_readyState >= HAVE_METADATA && oldState < HAVE_METADATA) {
2336         prepareMediaFragmentURI();
2337         scheduleEvent(eventNames().durationchangeEvent);
2338         scheduleResizeEvent();
2339         scheduleEvent(eventNames().loadedmetadataEvent);
2340 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
2341         if (hasEventListeners(eventNames().webkitplaybacktargetavailabilitychangedEvent))
2342             enqueuePlaybackTargetAvailabilityChangedEvent();
2343 #endif
2344         m_initiallyMuted = m_volume < 0.05 || muted();
2345
2346         if (hasMediaControls())
2347             mediaControls()->loadedMetadata();
2348         updateRenderer();
2349
2350         if (is<MediaDocument>(document()))
2351             downcast<MediaDocument>(document()).mediaElementNaturalSizeChanged(expandedIntSize(m_player->naturalSize()));
2352
2353         logMediaLoadRequest(document().page(), m_player->engineDescription(), String(), true);
2354
2355 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
2356         updateMediaState(UpdateState::Asynchronously);
2357 #endif
2358
2359         m_mediaSession->clientCharacteristicsChanged();
2360     }
2361
2362     bool shouldUpdateDisplayState = false;
2363
2364     if (m_readyState >= HAVE_CURRENT_DATA && oldState < HAVE_CURRENT_DATA && !m_haveFiredLoadedData) {
2365         m_haveFiredLoadedData = true;
2366         shouldUpdateDisplayState = true;
2367         scheduleEvent(eventNames().loadeddataEvent);
2368         setShouldDelayLoadEvent(false);
2369         applyMediaFragmentURI();
2370     }
2371
2372     bool isPotentiallyPlaying = potentiallyPlaying();
2373     if (m_readyState == HAVE_FUTURE_DATA && oldState <= HAVE_CURRENT_DATA && tracksAreReady) {
2374         scheduleEvent(eventNames().canplayEvent);
2375         if (isPotentiallyPlaying)
2376             scheduleNotifyAboutPlaying();
2377         shouldUpdateDisplayState = true;
2378     }
2379
2380     if (m_readyState == HAVE_ENOUGH_DATA && oldState < HAVE_ENOUGH_DATA && tracksAreReady) {
2381         if (oldState <= HAVE_CURRENT_DATA)
2382             scheduleEvent(eventNames().canplayEvent);
2383
2384         scheduleEvent(eventNames().canplaythroughEvent);
2385
2386         if (isPotentiallyPlaying && oldState <= HAVE_CURRENT_DATA)
2387             scheduleNotifyAboutPlaying();
2388
2389         auto success = canTransitionFromAutoplayToPlay();
2390         if (success) {
2391             m_paused = false;
2392             invalidateCachedTime();
2393             m_playbackStartedTime = currentMediaTime().toDouble();
2394             scheduleEvent(eventNames().playEvent);
2395             scheduleNotifyAboutPlaying();
2396         } else if (success.value() == MediaPlaybackDenialReason::UserGestureRequired)
2397             m_preventedFromPlayingWithoutUserGesture = true;
2398
2399         shouldUpdateDisplayState = true;
2400     }
2401
2402     if (shouldUpdateDisplayState) {
2403         updateDisplayState();
2404         if (hasMediaControls()) {
2405             mediaControls()->refreshClosedCaptionsButtonVisibility();
2406             mediaControls()->updateStatusDisplay();
2407         }
2408     }
2409
2410     updatePlayState();
2411     updateMediaController();
2412 #if ENABLE(VIDEO_TRACK)
2413     updateActiveTextTrackCues(currentMediaTime());
2414 #endif
2415 }
2416
2417 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
2418 RefPtr<ArrayBuffer> HTMLMediaElement::mediaPlayerCachedKeyForKeyId(const String& keyId) const
2419 {
2420     return m_mediaKeys ? m_mediaKeys->cachedKeyForKeyId(keyId) : nullptr;
2421 }
2422
2423 bool HTMLMediaElement::mediaPlayerKeyNeeded(MediaPlayer*, Uint8Array* initData)
2424 {
2425     if (!hasEventListeners("webkitneedkey")) {
2426         m_error = MediaError::create(MediaError::MEDIA_ERR_ENCRYPTED);
2427         scheduleEvent(eventNames().errorEvent);
2428         return false;
2429     }
2430
2431     auto event = WebKitMediaKeyNeededEvent::create(eventNames().webkitneedkeyEvent, initData);
2432     event->setTarget(this);
2433     m_asyncEventQueue.enqueueEvent(WTFMove(event));
2434
2435     return true;
2436 }
2437
2438 String HTMLMediaElement::mediaPlayerMediaKeysStorageDirectory() const
2439 {
2440     String storageDirectory = document().settings().mediaKeysStorageDirectory();
2441     if (storageDirectory.isEmpty())
2442         return emptyString();
2443
2444     return pathByAppendingComponent(storageDirectory, SecurityOriginData::fromSecurityOrigin(document().securityOrigin()).databaseIdentifier());
2445 }
2446
2447 void HTMLMediaElement::webkitSetMediaKeys(WebKitMediaKeys* mediaKeys)
2448 {
2449     if (m_mediaKeys == mediaKeys)
2450         return;
2451
2452     if (m_mediaKeys)
2453         m_mediaKeys->setMediaElement(nullptr);
2454     m_mediaKeys = mediaKeys;
2455     if (m_mediaKeys)
2456         m_mediaKeys->setMediaElement(this);
2457 }
2458
2459 void HTMLMediaElement::keyAdded()
2460 {
2461     if (m_player)
2462         m_player->keyAdded();
2463 }
2464
2465 #endif
2466
2467 #if ENABLE(ENCRYPTED_MEDIA)
2468
2469 MediaKeys* HTMLMediaElement::mediaKeys() const
2470 {
2471     return nullptr;
2472 }
2473
2474 void HTMLMediaElement::setMediaKeys(MediaKeys*, Ref<DeferredPromise>&&)
2475 {
2476     notImplemented();
2477 }
2478
2479 #endif // ENABLE(ENCRYPTED_MEDIA)
2480
2481 void HTMLMediaElement::progressEventTimerFired()
2482 {
2483     ASSERT(m_player);
2484     if (m_networkState != NETWORK_LOADING)
2485         return;
2486
2487     double time = monotonicallyIncreasingTime();
2488     double timedelta = time - m_previousProgressTime;
2489
2490     if (m_player->didLoadingProgress()) {
2491         scheduleEvent(eventNames().progressEvent);
2492         m_previousProgressTime = time;
2493         m_sentStalledEvent = false;
2494         updateRenderer();
2495         if (hasMediaControls())
2496             mediaControls()->bufferingProgressed();
2497     } else if (timedelta > 3.0 && !m_sentStalledEvent) {
2498         scheduleEvent(eventNames().stalledEvent);
2499         m_sentStalledEvent = true;
2500         setShouldDelayLoadEvent(false);
2501     }
2502 }
2503
2504 void HTMLMediaElement::rewind(double timeDelta)
2505 {
2506     LOG(Media, "HTMLMediaElement::rewind(%p) - %f", this, timeDelta);
2507     setCurrentTime(std::max(currentMediaTime() - MediaTime::createWithDouble(timeDelta), minTimeSeekable()));
2508 }
2509
2510 void HTMLMediaElement::returnToRealtime()
2511 {
2512     LOG(Media, "HTMLMediaElement::returnToRealtime(%p)", this);
2513     setCurrentTime(maxTimeSeekable());
2514 }
2515
2516 void HTMLMediaElement::addPlayedRange(const MediaTime& start, const MediaTime& end)
2517 {
2518     LOG(Media, "HTMLMediaElement::addPlayedRange(%p) - [%s, %s]", this, toString(start).utf8().data(), toString(end).utf8().data());
2519     if (!m_playedTimeRanges)
2520         m_playedTimeRanges = TimeRanges::create();
2521     m_playedTimeRanges->ranges().add(start, end);
2522 }  
2523
2524 bool HTMLMediaElement::supportsScanning() const
2525 {
2526     return m_player ? m_player->supportsScanning() : false;
2527 }
2528
2529 void HTMLMediaElement::prepareToPlay()
2530 {
2531     LOG(Media, "HTMLMediaElement::prepareToPlay(%p)", this);
2532     if (m_havePreparedToPlay)
2533         return;
2534     m_havePreparedToPlay = true;
2535     m_player->prepareToPlay();
2536 }
2537
2538 void HTMLMediaElement::fastSeek(double time)
2539 {
2540     fastSeek(MediaTime::createWithDouble(time));
2541 }
2542
2543 void HTMLMediaElement::fastSeek(const MediaTime& time)
2544 {
2545     LOG(Media, "HTMLMediaElement::fastSeek(%p) - %s", this, toString(time).utf8().data());
2546     // 4.7.10.9 Seeking
2547     // 9. If the approximate-for-speed flag is set, adjust the new playback position to a value that will
2548     // allow for playback to resume promptly. If new playback position before this step is before current
2549     // playback position, then the adjusted new playback position must also be before the current playback
2550     // position. Similarly, if the new playback position before this step is after current playback position,
2551     // then the adjusted new playback position must also be after the current playback position.
2552     refreshCachedTime();
2553     MediaTime delta = time - currentMediaTime();
2554     MediaTime negativeTolerance = delta >= MediaTime::zeroTime() ? delta : MediaTime::positiveInfiniteTime();
2555     MediaTime positiveTolerance = delta < MediaTime::zeroTime() ? -delta : MediaTime::positiveInfiniteTime();
2556
2557     seekWithTolerance(time, negativeTolerance, positiveTolerance, true);
2558 }
2559
2560 void HTMLMediaElement::seek(const MediaTime& time)
2561 {
2562     LOG(Media, "HTMLMediaElement::seek(%p) - %s", this, toString(time).utf8().data());
2563     seekWithTolerance(time, MediaTime::zeroTime(), MediaTime::zeroTime(), true);
2564 }
2565
2566 void HTMLMediaElement::seekInternal(const MediaTime& time)
2567 {
2568     LOG(Media, "HTMLMediaElement::seekInternal(%p) - %s", this, toString(time).utf8().data());
2569     seekWithTolerance(time, MediaTime::zeroTime(), MediaTime::zeroTime(), false);
2570 }
2571
2572 void HTMLMediaElement::seekWithTolerance(const MediaTime& inTime, const MediaTime& negativeTolerance, const MediaTime& positiveTolerance, bool fromDOM)
2573 {
2574     // 4.8.10.9 Seeking
2575     MediaTime time = inTime;
2576
2577     // 1 - Set the media element's show poster flag to false.
2578     setDisplayMode(Video);
2579
2580     // 2 - If the media element's readyState is HAVE_NOTHING, abort these steps.
2581     if (m_readyState == HAVE_NOTHING || !m_player)
2582         return;
2583
2584     // If the media engine has been told to postpone loading data, let it go ahead now.
2585     if (m_preload < MediaPlayer::Auto && m_readyState < HAVE_FUTURE_DATA)
2586         prepareToPlay();
2587
2588     // Get the current time before setting m_seeking, m_lastSeekTime is returned once it is set.
2589     refreshCachedTime();
2590     MediaTime now = currentMediaTime();
2591
2592     // 3 - If the element's seeking IDL attribute is true, then another instance of this algorithm is
2593     // already running. Abort that other instance of the algorithm without waiting for the step that
2594     // it is running to complete.
2595     if (m_seekTaskQueue.hasPendingTasks()) {
2596         LOG(Media, "HTMLMediaElement::seekWithTolerance(%p) - cancelling pending seeks", this);
2597         m_seekTaskQueue.cancelAllTasks();
2598         if (m_pendingSeek) {
2599             now = m_pendingSeek->now;
2600             m_pendingSeek = nullptr;
2601         }
2602         m_pendingSeekType = NoSeek;
2603     }
2604
2605     // 4 - Set the seeking IDL attribute to true.
2606     // The flag will be cleared when the engine tells us the time has actually changed.
2607     m_seeking = true;
2608     if (m_playing) {
2609         if (m_lastSeekTime < now)
2610             addPlayedRange(m_lastSeekTime, now);
2611     }
2612     m_lastSeekTime = time;
2613
2614     // 5 - If the seek was in response to a DOM method call or setting of an IDL attribute, then continue
2615     // the script. The remainder of these steps must be run asynchronously.
2616     m_pendingSeek = std::make_unique<PendingSeek>(now, time, negativeTolerance, positiveTolerance);
2617     if (fromDOM) {
2618         LOG(Media, "HTMLMediaElement::seekWithTolerance(%p) - enqueuing seek from %s to %s", this, toString(now).utf8().data(), toString(time).utf8().data());
2619         m_seekTaskQueue.enqueueTask(std::bind(&HTMLMediaElement::seekTask, this));
2620     } else
2621         seekTask();
2622
2623     if (ScriptController::processingUserGestureForMedia())
2624         m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
2625 }
2626
2627 void HTMLMediaElement::seekTask()
2628 {
2629     LOG(Media, "HTMLMediaElement::seekTask(%p)", this);
2630
2631     if (!m_player) {
2632         clearSeeking();
2633         return;
2634     }
2635
2636     ASSERT(m_pendingSeek);
2637     MediaTime now = m_pendingSeek->now;
2638     MediaTime time = m_pendingSeek->targetTime;
2639     MediaTime negativeTolerance = m_pendingSeek->negativeTolerance;
2640     MediaTime positiveTolerance = m_pendingSeek->positiveTolerance;
2641     m_pendingSeek = nullptr;
2642
2643     // 6 - If the new playback position is later than the end of the media resource, then let it be the end 
2644     // of the media resource instead.
2645     time = std::min(time, durationMediaTime());
2646
2647     // 7 - If the new playback position is less than the earliest possible position, let it be that position instead.
2648     MediaTime earliestTime = m_player->startTime();
2649     time = std::max(time, earliestTime);
2650
2651     // Ask the media engine for the time value in the movie's time scale before comparing with current time. This
2652     // is necessary because if the seek time is not equal to currentTime but the delta is less than the movie's
2653     // time scale, we will ask the media engine to "seek" to the current movie time, which may be a noop and
2654     // not generate a timechanged callback. This means m_seeking will never be cleared and we will never 
2655     // fire a 'seeked' event.
2656 #if !LOG_DISABLED
2657     MediaTime mediaTime = m_player->mediaTimeForTimeValue(time);
2658     if (time != mediaTime)
2659         LOG(Media, "HTMLMediaElement::seekTask(%p) - %s - media timeline equivalent is %s", this, toString(time).utf8().data(), toString(mediaTime).utf8().data());
2660 #endif
2661     time = m_player->mediaTimeForTimeValue(time);
2662
2663     // 8 - If the (possibly now changed) new playback position is not in one of the ranges given in the
2664     // seekable attribute, then let it be the position in one of the ranges given in the seekable attribute 
2665     // that is the nearest to the new playback position. ... If there are no ranges given in the seekable
2666     // attribute then set the seeking IDL attribute to false and abort these steps.
2667     RefPtr<TimeRanges> seekableRanges = seekable();
2668     bool noSeekRequired = !seekableRanges->length();
2669
2670     // Short circuit seeking to the current time by just firing the events if no seek is required.
2671     // Don't skip calling the media engine if 1) we are in poster mode (because a seek should always cancel
2672     // poster display), or 2) if there is a pending fast seek, or 3) if this seek is not an exact seek
2673     SeekType thisSeekType = (negativeTolerance == MediaTime::zeroTime() && positiveTolerance == MediaTime::zeroTime()) ? Precise : Fast;
2674     if (!noSeekRequired && time == now && thisSeekType == Precise && m_pendingSeekType != Fast && displayMode() != Poster)
2675         noSeekRequired = true;
2676
2677 #if ENABLE(MEDIA_SOURCE)
2678     // Always notify the media engine of a seek if the source is not closed. This ensures that the source is
2679     // always in a flushed state when the 'seeking' event fires.
2680     if (m_mediaSource && !m_mediaSource->isClosed())
2681         noSeekRequired = false;
2682 #endif
2683
2684     if (noSeekRequired) {
2685         LOG(Media, "HTMLMediaElement::seekTask(%p) - seek to %s ignored", this, toString(time).utf8().data());
2686         if (time == now) {
2687             scheduleEvent(eventNames().seekingEvent);
2688             scheduleTimeupdateEvent(false);
2689             scheduleEvent(eventNames().seekedEvent);
2690         }
2691         clearSeeking();
2692         return;
2693     }
2694     time = seekableRanges->ranges().nearest(time);
2695
2696     m_sentEndEvent = false;
2697     m_lastSeekTime = time;
2698     m_pendingSeekType = thisSeekType;
2699     m_seeking = true;
2700
2701     // 10 - Queue a task to fire a simple event named seeking at the element.
2702     scheduleEvent(eventNames().seekingEvent);
2703
2704     // 11 - Set the current playback position to the given new playback position
2705     m_player->seekWithTolerance(time, negativeTolerance, positiveTolerance);
2706
2707     // 12 - Wait until the user agent has established whether or not the media data for the new playback
2708     // position is available, and, if it is, until it has decoded enough data to play back that position.
2709     // 13 - Await a stable state. The synchronous section consists of all the remaining steps of this algorithm.
2710 }
2711
2712 void HTMLMediaElement::clearSeeking()
2713 {
2714     m_seeking = false;
2715     m_pendingSeekType = NoSeek;
2716     invalidateCachedTime();
2717 }
2718
2719 void HTMLMediaElement::finishSeek()
2720 {
2721     // 4.8.10.9 Seeking
2722     // 14 - Set the seeking IDL attribute to false.
2723     clearSeeking();
2724
2725     LOG(Media, "HTMLMediaElement::finishSeek(%p) - current time = %s", this, toString(currentMediaTime()).utf8().data());
2726
2727     // 15 - Run the time maches on steps.
2728     // Handled by mediaPlayerTimeChanged().
2729
2730     // 16 - Queue a task to fire a simple event named timeupdate at the element.
2731     scheduleEvent(eventNames().timeupdateEvent);
2732
2733     // 17 - Queue a task to fire a simple event named seeked at the element.
2734     scheduleEvent(eventNames().seekedEvent);
2735
2736 #if ENABLE(MEDIA_SOURCE)
2737     if (m_mediaSource)
2738         m_mediaSource->monitorSourceBuffers();
2739 #endif
2740 }
2741
2742 HTMLMediaElement::ReadyState HTMLMediaElement::readyState() const
2743 {
2744     return m_readyState;
2745 }
2746
2747 MediaPlayer::MovieLoadType HTMLMediaElement::movieLoadType() const
2748 {
2749     return m_player ? m_player->movieLoadType() : MediaPlayer::Unknown;
2750 }
2751
2752 bool HTMLMediaElement::hasAudio() const
2753 {
2754     return m_player ? m_player->hasAudio() : false;
2755 }
2756
2757 bool HTMLMediaElement::seeking() const
2758 {
2759     return m_seeking;
2760 }
2761
2762 void HTMLMediaElement::refreshCachedTime() const
2763 {
2764     if (!m_player)
2765         return;
2766
2767     m_cachedTime = m_player->currentTime();
2768     if (!m_cachedTime) {
2769         // Do not use m_cachedTime until the media engine returns a non-zero value because we can't 
2770         // estimate current time until playback actually begins. 
2771         invalidateCachedTime(); 
2772         return; 
2773     } 
2774
2775     m_clockTimeAtLastCachedTimeUpdate = monotonicallyIncreasingTime();
2776 }
2777
2778 void HTMLMediaElement::invalidateCachedTime() const
2779 {
2780     m_cachedTime = MediaTime::invalidTime();
2781     if (!m_player || !m_player->maximumDurationToCacheMediaTime())
2782         return;
2783
2784 #if !LOG_DISABLED
2785     if (m_cachedTime.isValid())
2786         LOG(Media, "HTMLMediaElement::invalidateCachedTime(%p)", this);
2787 #endif
2788
2789     // Don't try to cache movie time when playback first starts as the time reported by the engine
2790     // sometimes fluctuates for a short amount of time, so the cached time will be off if we take it
2791     // too early.
2792     static const double minimumTimePlayingBeforeCacheSnapshot = 0.5;
2793
2794     m_minimumClockTimeToUpdateCachedTime = monotonicallyIncreasingTime() + minimumTimePlayingBeforeCacheSnapshot;
2795 }
2796
2797 // playback state
2798 double HTMLMediaElement::currentTime() const
2799 {
2800     return currentMediaTime().toDouble();
2801 }
2802
2803 MediaTime HTMLMediaElement::currentMediaTime() const
2804 {
2805 #if LOG_CACHED_TIME_WARNINGS
2806     static const MediaTime minCachedDeltaForWarning = MediaTime::create(1, 100);
2807 #endif
2808
2809     if (!m_player)
2810         return MediaTime::zeroTime();
2811
2812     if (m_seeking) {
2813         LOG(Media, "HTMLMediaElement::currentTime(%p) - seeking, returning %s", this, toString(m_lastSeekTime).utf8().data());
2814         return m_lastSeekTime;
2815     }
2816
2817     if (m_cachedTime.isValid() && m_paused) {
2818 #if LOG_CACHED_TIME_WARNINGS
2819         MediaTime delta = m_cachedTime - m_player->currentTime();
2820         if (delta > minCachedDeltaForWarning)
2821             LOG(Media, "HTMLMediaElement::currentTime(%p) - WARNING, cached time is %s seconds off of media time when paused", this, toString(delta).utf8().data());
2822 #endif
2823         return m_cachedTime;
2824     }
2825
2826     // Is it too soon use a cached time?
2827     double now = monotonicallyIncreasingTime();
2828     double maximumDurationToCacheMediaTime = m_player->maximumDurationToCacheMediaTime();
2829
2830     if (maximumDurationToCacheMediaTime && m_cachedTime.isValid() && !m_paused && now > m_minimumClockTimeToUpdateCachedTime) {
2831         double clockDelta = now - m_clockTimeAtLastCachedTimeUpdate;
2832
2833         // Not too soon, use the cached time only if it hasn't expired.
2834         if (clockDelta < maximumDurationToCacheMediaTime) {
2835             MediaTime adjustedCacheTime = m_cachedTime + MediaTime::createWithDouble(effectivePlaybackRate() * clockDelta);
2836
2837 #if LOG_CACHED_TIME_WARNINGS
2838             MediaTime delta = adjustedCacheTime - m_player->currentTime();
2839             if (delta > minCachedDeltaForWarning)
2840                 LOG(Media, "HTMLMediaElement::currentTime(%p) - WARNING, cached time is %f seconds off of media time when playing", this, delta);
2841 #endif
2842             return adjustedCacheTime;
2843         }
2844     }
2845
2846 #if LOG_CACHED_TIME_WARNINGS
2847     if (maximumDurationToCacheMediaTime && now > m_minimumClockTimeToUpdateCachedTime && m_cachedTime != MediaPlayer::invalidTime()) {
2848         double clockDelta = now - m_clockTimeAtLastCachedTimeUpdate;
2849         MediaTime delta = m_cachedTime + MediaTime::createWithDouble(effectivePlaybackRate() * clockDelta) - m_player->currentTime();
2850         LOG(Media, "HTMLMediaElement::currentTime(%p) - cached time was %s seconds off of media time when it expired", this, toString(delta).utf8().data());
2851     }
2852 #endif
2853
2854     refreshCachedTime();
2855
2856     if (m_cachedTime.isInvalid())
2857         return MediaTime::zeroTime();
2858     
2859     return m_cachedTime;
2860 }
2861
2862 void HTMLMediaElement::setCurrentTime(double time)
2863 {
2864     setCurrentTime(MediaTime::createWithDouble(time));
2865 }
2866
2867 void HTMLMediaElement::setCurrentTime(const MediaTime& time)
2868 {
2869     if (m_mediaController)
2870         return;
2871
2872     seekInternal(time);
2873 }
2874
2875 ExceptionOr<void> HTMLMediaElement::setCurrentTimeForBindings(double time)
2876 {
2877     if (m_mediaController)
2878         return Exception { INVALID_STATE_ERR };
2879     seek(MediaTime::createWithDouble(time));
2880     return { };
2881 }
2882
2883 double HTMLMediaElement::duration() const
2884 {
2885     return durationMediaTime().toDouble();
2886 }
2887
2888 MediaTime HTMLMediaElement::durationMediaTime() const
2889 {
2890     if (m_player && m_readyState >= HAVE_METADATA)
2891         return m_player->duration();
2892
2893     return MediaTime::invalidTime();
2894 }
2895
2896 bool HTMLMediaElement::paused() const
2897 {
2898     // As of this writing, JavaScript garbage collection calls this function directly. In the past
2899     // we had problems where this was called on an object after a bad cast. The assertion below
2900     // made our regression test detect the problem, so we should keep it because of that. But note
2901     // that the value of the assertion relies on the compiler not being smart enough to know that
2902     // isHTMLUnknownElement is guaranteed to return false for an HTMLMediaElement.
2903     ASSERT(!isHTMLUnknownElement());
2904
2905     return m_paused;
2906 }
2907
2908 double HTMLMediaElement::defaultPlaybackRate() const
2909 {
2910 #if ENABLE(MEDIA_STREAM)
2911     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
2912     // "defaultPlaybackRate" - On setting: ignored. On getting: return 1.0
2913     // A MediaStream is not seekable. Therefore, this attribute must always have the
2914     // value 1.0 and any attempt to alter it must be ignored. Note that this also means
2915     // that the ratechange event will not fire.
2916     if (m_mediaStreamSrcObject)
2917         return 1;
2918 #endif
2919
2920     return m_defaultPlaybackRate;
2921 }
2922
2923 void HTMLMediaElement::setDefaultPlaybackRate(double rate)
2924 {
2925 #if ENABLE(MEDIA_STREAM)
2926     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
2927     // "defaultPlaybackRate" - On setting: ignored. On getting: return 1.0
2928     // A MediaStream is not seekable. Therefore, this attribute must always have the
2929     // value 1.0 and any attempt to alter it must be ignored. Note that this also means
2930     // that the ratechange event will not fire.
2931     if (m_mediaStreamSrcObject)
2932         return;
2933 #endif
2934
2935     if (m_defaultPlaybackRate != rate) {
2936         LOG(Media, "HTMLMediaElement::setDefaultPlaybackRate(%p) - %f", this, rate);
2937         m_defaultPlaybackRate = rate;
2938         scheduleEvent(eventNames().ratechangeEvent);
2939     }
2940 }
2941
2942 double HTMLMediaElement::effectivePlaybackRate() const
2943 {
2944     return m_mediaController ? m_mediaController->playbackRate() : m_reportedPlaybackRate;
2945 }
2946
2947 double HTMLMediaElement::requestedPlaybackRate() const
2948 {
2949     return m_mediaController ? m_mediaController->playbackRate() : m_requestedPlaybackRate;
2950 }
2951
2952 double HTMLMediaElement::playbackRate() const
2953 {
2954 #if ENABLE(MEDIA_STREAM)
2955     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
2956     // "playbackRate" - A MediaStream is not seekable. Therefore, this attribute must always
2957     // have the value 1.0 and any attempt to alter it must be ignored. Note that this also
2958     // means that the ratechange event will not fire.
2959     if (m_mediaStreamSrcObject)
2960         return 1;
2961 #endif
2962
2963     return m_requestedPlaybackRate;
2964 }
2965
2966 void HTMLMediaElement::setPlaybackRate(double rate)
2967 {
2968     LOG(Media, "HTMLMediaElement::setPlaybackRate(%p) - %f", this, rate);
2969
2970 #if ENABLE(MEDIA_STREAM)
2971     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
2972     // "playbackRate" - A MediaStream is not seekable. Therefore, this attribute must always
2973     // have the value 1.0 and any attempt to alter it must be ignored. Note that this also
2974     // means that the ratechange event will not fire.
2975     if (m_mediaStreamSrcObject)
2976         return;
2977 #endif
2978
2979     if (m_player && potentiallyPlaying() && m_player->rate() != rate && !m_mediaController)
2980         m_player->setRate(rate);
2981
2982     if (m_requestedPlaybackRate != rate) {
2983         m_reportedPlaybackRate = m_requestedPlaybackRate = rate;
2984         invalidateCachedTime();
2985         scheduleEvent(eventNames().ratechangeEvent);
2986     }
2987 }
2988
2989 void HTMLMediaElement::updatePlaybackRate()
2990 {
2991     double requestedRate = requestedPlaybackRate();
2992     if (m_player && potentiallyPlaying() && m_player->rate() != requestedRate)
2993         m_player->setRate(requestedRate);
2994 }
2995
2996 bool HTMLMediaElement::webkitPreservesPitch() const
2997 {
2998     return m_webkitPreservesPitch;
2999 }
3000
3001 void HTMLMediaElement::setWebkitPreservesPitch(bool preservesPitch)
3002 {
3003     LOG(Media, "HTMLMediaElement::setWebkitPreservesPitch(%p) - %s", this, boolString(preservesPitch));
3004
3005     m_webkitPreservesPitch = preservesPitch;
3006     
3007     if (!m_player)
3008         return;
3009
3010     m_player->setPreservesPitch(preservesPitch);
3011 }
3012
3013 bool HTMLMediaElement::ended() const
3014 {
3015 #if ENABLE(MEDIA_STREAM)
3016     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
3017     // When the MediaStream state moves from the active to the inactive state, the User Agent
3018     // must raise an ended event on the HTMLMediaElement and set its ended attribute to true.
3019     if (m_mediaStreamSrcObject && m_player && m_player->ended())
3020         return true;
3021 #endif
3022
3023     // 4.8.10.8 Playing the media resource
3024     // The ended attribute must return true if the media element has ended 
3025     // playback and the direction of playback is forwards, and false otherwise.
3026     return endedPlayback() && requestedPlaybackRate() > 0;
3027 }
3028
3029 bool HTMLMediaElement::autoplay() const
3030 {
3031     return hasAttributeWithoutSynchronization(autoplayAttr);
3032 }
3033
3034 String HTMLMediaElement::preload() const
3035 {
3036 #if ENABLE(MEDIA_STREAM)
3037     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
3038     // "preload" - On getting: none. On setting: ignored.
3039     if (m_mediaStreamSrcObject)
3040         return ASCIILiteral("none");
3041 #endif
3042
3043     switch (m_preload) {
3044     case MediaPlayer::None:
3045         return ASCIILiteral("none");
3046     case MediaPlayer::MetaData:
3047         return ASCIILiteral("metadata");
3048     case MediaPlayer::Auto:
3049         return ASCIILiteral("auto");
3050     }
3051
3052     ASSERT_NOT_REACHED();
3053     return String();
3054 }
3055
3056 void HTMLMediaElement::setPreload(const String& preload)
3057 {
3058     LOG(Media, "HTMLMediaElement::setPreload(%p) - %s", this, preload.utf8().data());
3059 #if ENABLE(MEDIA_STREAM)
3060     // http://w3c.github.io/mediacapture-main/#mediastreams-in-media-elements
3061     // "preload" - On getting: none. On setting: ignored.
3062     if (m_mediaStreamSrcObject)
3063         return;
3064 #endif
3065
3066     setAttributeWithoutSynchronization(preloadAttr, preload);
3067 }
3068
3069 void HTMLMediaElement::play(DOMPromise<void>&& promise)
3070 {
3071     LOG(Media, "HTMLMediaElement::play(%p)", this);
3072
3073     auto success = m_mediaSession->playbackPermitted(*this);
3074     if (!success) {
3075         if (success.value() == MediaPlaybackDenialReason::UserGestureRequired)
3076             m_preventedFromPlayingWithoutUserGesture = true;
3077         promise.reject(NotAllowedError);
3078         return;
3079     }
3080
3081     if (m_error && m_error->code() == MediaError::MEDIA_ERR_SRC_NOT_SUPPORTED) {
3082         promise.reject(NOT_SUPPORTED_ERR, "The operation is not supported.");
3083         return;
3084     }
3085
3086     if (ScriptController::processingUserGestureForMedia())
3087         removeBehaviorsRestrictionsAfterFirstUserGesture();
3088
3089     if (!playInternal()) {
3090         promise.reject(NotAllowedError);
3091         return;
3092     }
3093
3094     m_pendingPlayPromises.append(WTFMove(promise));
3095 }
3096
3097 void HTMLMediaElement::play()
3098 {
3099     LOG(Media, "HTMLMediaElement::play(%p)", this);
3100
3101     auto success = m_mediaSession->playbackPermitted(*this);
3102     if (!success) {
3103         if (success.value() == MediaPlaybackDenialReason::UserGestureRequired)
3104             m_preventedFromPlayingWithoutUserGesture = true;
3105         return;
3106     }
3107     if (ScriptController::processingUserGestureForMedia())
3108         removeBehaviorsRestrictionsAfterFirstUserGesture();
3109
3110     playInternal();
3111 }
3112
3113 bool HTMLMediaElement::playInternal()
3114 {
3115     LOG(Media, "HTMLMediaElement::playInternal(%p)", this);
3116     
3117     if (!m_mediaSession->clientWillBeginPlayback()) {
3118         LOG(Media, "  returning because of interruption");
3119         return true; // Treat as success because we will begin playback on cessation of the interruption.
3120     }
3121
3122     // 4.8.10.9. Playing the media resource
3123     if (!m_player || m_networkState == NETWORK_EMPTY)
3124         scheduleDelayedAction(LoadMediaResource);
3125
3126     if (endedPlayback())
3127         seekInternal(MediaTime::zeroTime());
3128
3129     if (m_mediaController)
3130         m_mediaController->bringElementUpToSpeed(*this);
3131
3132     if (m_paused) {
3133         m_paused = false;
3134         invalidateCachedTime();
3135         m_playbackStartedTime = currentMediaTime().toDouble();
3136         scheduleEvent(eventNames().playEvent);
3137
3138         if (m_readyState <= HAVE_CURRENT_DATA)
3139             scheduleEvent(eventNames().waitingEvent);
3140         else if (m_readyState >= HAVE_FUTURE_DATA)
3141             scheduleNotifyAboutPlaying();
3142
3143 #if ENABLE(MEDIA_SESSION)
3144         // 6.3 Activating a media session from a media element
3145         // When the play() method is invoked, the paused attribute is true, and the readyState attribute has the value
3146         // HAVE_FUTURE_DATA or HAVE_ENOUGH_DATA, then
3147         // 1. Let media session be the value of the current media session.
3148         // 2. If we are not currently in media session's list of active participating media elements then append
3149         //    ourselves to this list.
3150         // 3. Let activated be the result of running the media session invocation algorithm for media session.
3151         // 4. If activated is failure, pause ourselves.
3152         if (m_readyState == HAVE_ENOUGH_DATA || m_readyState == HAVE_FUTURE_DATA) {
3153             if (m_session) {
3154                 m_session->addActiveMediaElement(*this);
3155
3156                 if (m_session->kind() == MediaSessionKind::Content) {
3157                     if (Page* page = document().page())
3158                         page->chrome().client().focusedContentMediaElementDidChange(m_elementID);
3159                 }
3160
3161                 if (!m_session->invoke()) {
3162                     pause();
3163                     return false;
3164                 }
3165             }
3166         }
3167 #endif
3168     } else if (m_readyState >= HAVE_FUTURE_DATA)
3169         scheduleResolvePendingPlayPromises();
3170
3171     if (ScriptController::processingUserGestureForMedia() && m_preventedFromPlayingWithoutUserGesture) {
3172         if (Page* page = document().page())
3173             page->chrome().client().didPlayMediaPreventedFromPlayingWithoutUserGesture();
3174         m_preventedFromPlayingWithoutUserGesture = false;
3175     }
3176
3177     m_autoplaying = false;
3178     updatePlayState();
3179
3180     return true;
3181 }
3182
3183 void HTMLMediaElement::pause()
3184 {
3185     LOG(Media, "HTMLMediaElement::pause(%p)", this);
3186
3187     if (!m_mediaSession->playbackPermitted(*this))
3188         return;
3189
3190     if (ScriptController::processingUserGestureForMedia())
3191         removeBehaviorsRestrictionsAfterFirstUserGesture(MediaElementSession::RequireUserGestureToControlControlsManager);
3192
3193     pauseInternal();
3194 }
3195
3196
3197 void HTMLMediaElement::pauseInternal()
3198 {
3199     LOG(Media, "HTMLMediaElement::pauseInternal(%p)", this);
3200
3201     if (!m_mediaSession->clientWillPausePlayback()) {
3202         LOG(Media, "  returning because of interruption");
3203         return;
3204     }
3205
3206     // 4.8.10.9. Playing the media resource
3207     if (!m_player || m_networkState == NETWORK_EMPTY) {
3208         // Unless the restriction on media requiring user action has been lifted
3209         // don't trigger loading if a script calls pause().
3210         if (!m_mediaSession->playbackPermitted(*this))
3211             return;
3212         scheduleDelayedAction(LoadMediaResource);
3213     }
3214
3215     m_autoplaying = false;
3216
3217     if (!m_paused) {
3218         m_paused = true;
3219         scheduleTimeupdateEvent(false);
3220         scheduleEvent(eventNames().pauseEvent);
3221         rejectPendingPlayPromises(DOMError::create("AbortError", "The operation was aborted."));
3222
3223         if (MemoryPressureHandler::singleton().isUnderMemoryPressure())
3224             purgeBufferedDataIfPossible();
3225     }
3226
3227     updatePlayState();
3228 }
3229
3230 #if ENABLE(MEDIA_SOURCE)
3231
3232 void HTMLMediaElement::detachMediaSource()
3233 {
3234     if (!m_mediaSource)
3235         return;
3236
3237     m_mediaSource->detachFromElement(*this);
3238     m_mediaSource = nullptr;
3239 }
3240
3241 #endif
3242
3243 bool HTMLMediaElement::loop() const
3244 {
3245     return hasAttributeWithoutSynchronization(loopAttr);
3246 }
3247
3248 void HTMLMediaElement::setLoop(bool b)
3249 {
3250     LOG(Media, "HTMLMediaElement::setLoop(%p) - %s", this, boolString(b));
3251     setBooleanAttribute(loopAttr, b);
3252 }
3253
3254 bool HTMLMediaElement::controls() const
3255 {
3256     Frame* frame = document().frame();
3257
3258     // always show controls when scripting is disabled
3259     if (frame && !frame->script().canExecuteScripts(NotAboutToExecuteScript))
3260         return true;
3261
3262     return hasAttributeWithoutSynchronization(controlsAttr);
3263 }
3264
3265 void HTMLMediaElement::setControls(bool b)
3266 {
3267     LOG(Media, "HTMLMediaElement::setControls(%p) - %s", this, boolString(b));
3268     setBooleanAttribute(controlsAttr, b);
3269 }
3270
3271 double HTMLMediaElement::volume() const
3272 {
3273     return m_volume;
3274 }
3275
3276 ExceptionOr<void> HTMLMediaElement::setVolume(double volume)
3277 {
3278     LOG(Media, "HTMLMediaElement::setVolume(%p) - %f", this, volume);
3279
3280     if (!(volume >= 0 && volume <= 1))
3281         return Exception { INDEX_SIZE_ERR };
3282
3283 #if !PLATFORM(IOS)
3284     if (m_volume == volume)
3285         return { };
3286
3287     m_volume = volume;
3288     m_volumeInitialized = true;
3289     updateVolume();
3290     scheduleEvent(eventNames().volumechangeEvent);
3291 #endif
3292     return { };
3293 }
3294
3295 bool HTMLMediaElement::muted() const
3296 {
3297     return m_explicitlyMuted ? m_muted : hasAttributeWithoutSynchronization(mutedAttr);
3298 }
3299
3300 void HTMLMediaElement::setMuted(bool muted)
3301 {
3302     LOG(Media, "HTMLMediaElement::setMuted(%p) - %s", this, boolString(muted));
3303
3304     bool mutedStateChanged = m_muted != muted;
3305     if (mutedStateChanged || !m_explicitlyMuted) {
3306         m_muted = muted;
3307         m_explicitlyMuted = true;
3308
3309         if (ScriptController::processingUserGestureForMedia())
3310             removeBehaviorsRestrictionsAfterFirstUserGesture(MediaElementSession::AllRestrictions & ~MediaElementSession::RequireUserGestureToControlControlsManager);
3311
3312         // Avoid recursion when the player reports volume changes.
3313         if (!processingMediaPlayerCallback()) {
3314             if (m_player) {
3315                 m_player->setMuted(effectiveMuted());
3316                 if (hasMediaControls())
3317                     mediaControls()->changedMute();
3318             }
3319         }
3320
3321         if (mutedStateChanged)
3322             scheduleEvent(eventNames().volumechangeEvent);
3323
3324         updateShouldPlay();
3325
3326 #if ENABLE(MEDIA_SESSION)
3327         document().updateIsPlayingMedia(m_elementID);
3328 #else
3329         document().updateIsPlayingMedia();
3330 #endif
3331
3332 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
3333         updateMediaState(UpdateState::Asynchronously);
3334 #endif
3335         m_mediaSession->canProduceAudioChanged();
3336     }
3337
3338     scheduleUpdatePlaybackControlsManager();
3339 }
3340
3341 void HTMLMediaElement::togglePlayState()
3342 {
3343     LOG(Media, "HTMLMediaElement::togglePlayState(%p) - canPlay() is %s", this, boolString(canPlay()));
3344
3345     // We can safely call the internal play/pause methods, which don't check restrictions, because
3346     // this method is only called from the built-in media controller
3347     if (canPlay()) {
3348         updatePlaybackRate();
3349         playInternal();
3350     } else 
3351         pauseInternal();
3352 }
3353
3354 void HTMLMediaElement::beginScrubbing()
3355 {
3356     LOG(Media, "HTMLMediaElement::beginScrubbing(%p) - paused() is %s", this, boolString(paused()));
3357
3358     if (!paused()) {
3359         if (ended()) {
3360             // Because a media element stays in non-paused state when it reaches end, playback resumes 
3361             // when the slider is dragged from the end to another position unless we pause first. Do 
3362             // a "hard pause" so an event is generated, since we want to stay paused after scrubbing finishes.
3363             pause();
3364         } else {
3365             // Not at the end but we still want to pause playback so the media engine doesn't try to
3366             // continue playing during scrubbing. Pause without generating an event as we will 
3367             // unpause after scrubbing finishes.
3368             setPausedInternal(true);
3369         }
3370     }
3371
3372     m_mediaSession->removeBehaviorRestriction(MediaElementSession::RequireUserGestureToControlControlsManager);
3373 }
3374
3375 void HTMLMediaElement::endScrubbing()
3376 {
3377     LOG(Media, "HTMLMediaElement::endScrubbing(%p) - m_pausedInternal is %s", this, boolString(m_pausedInternal));
3378
3379     if (m_pausedInternal)
3380         setPausedInternal(false);
3381 }
3382
3383 void HTMLMediaElement::beginScanning(ScanDirection direction)
3384 {
3385     m_scanType = supportsScanning() ? Scan : Seek;
3386     m_scanDirection = direction;
3387
3388     if (m_scanType == Seek) {
3389         // Scanning by seeking requires the video to be paused during scanning.
3390         m_actionAfterScan = paused() ? Nothing : Play;
3391         pause();
3392     } else {
3393         // Scanning by scanning requires the video to be playing during scanninging.
3394         m_actionAfterScan = paused() ? Pause : Nothing;
3395         play();
3396         setPlaybackRate(nextScanRate());
3397     }
3398
3399     m_scanTimer.start(0, m_scanType == Seek ? SeekRepeatDelay : ScanRepeatDelay);
3400 }
3401
3402 void HTMLMediaElement::endScanning()
3403 {
3404     if (m_scanType == Scan)
3405         setPlaybackRate(defaultPlaybackRate());
3406
3407     if (m_actionAfterScan == Play)
3408         play();
3409     else if (m_actionAfterScan == Pause)
3410         pause();
3411
3412     if (m_scanTimer.isActive())
3413         m_scanTimer.stop();
3414 }
3415
3416 double HTMLMediaElement::nextScanRate()
3417 {
3418     double rate = std::min(ScanMaximumRate, fabs(playbackRate() * 2));
3419     if (m_scanDirection == Backward)
3420         rate *= -1;
3421 #if PLATFORM(IOS)
3422     rate = std::min(std::max(rate, minFastReverseRate()), maxFastForwardRate());
3423 #endif
3424     return rate;
3425 }
3426
3427 void HTMLMediaElement::scanTimerFired()
3428 {
3429     if (m_scanType == Seek) {
3430         double seekTime = m_scanDirection == Forward ? SeekTime : -SeekTime;
3431         setCurrentTime(currentTime() + seekTime);
3432     } else
3433         setPlaybackRate(nextScanRate());
3434 }
3435
3436 // The spec says to fire periodic timeupdate events (those sent while playing) every
3437 // "15 to 250ms", we choose the slowest frequency
3438 static const double maxTimeupdateEventFrequency = 0.25;
3439
3440 void HTMLMediaElement::startPlaybackProgressTimer()
3441 {
3442     if (m_playbackProgressTimer.isActive())
3443         return;
3444
3445     m_previousProgressTime = monotonicallyIncreasingTime();
3446     m_playbackProgressTimer.startRepeating(maxTimeupdateEventFrequency);
3447 }
3448
3449 void HTMLMediaElement::playbackProgressTimerFired()
3450 {
3451     ASSERT(m_player);
3452
3453     if (m_fragmentEndTime.isValid() && currentMediaTime() >= m_fragmentEndTime && requestedPlaybackRate() > 0) {
3454         m_fragmentEndTime = MediaTime::invalidTime();
3455         if (!m_mediaController && !m_paused) {
3456             // changes paused to true and fires a simple event named pause at the media element.
3457             pauseInternal();
3458         }
3459     }
3460     
3461     scheduleTimeupdateEvent(true);
3462
3463     if (!requestedPlaybackRate())
3464         return;
3465
3466     if (!m_paused && hasMediaControls())
3467         mediaControls()->playbackProgressed();
3468
3469 #if ENABLE(VIDEO_TRACK)
3470     updateActiveTextTrackCues(currentMediaTime());
3471 #endif
3472
3473 #if ENABLE(MEDIA_SOURCE)
3474     if (m_mediaSource)
3475         m_mediaSource->monitorSourceBuffers();
3476 #endif
3477 }
3478
3479 void HTMLMediaElement::scheduleTimeupdateEvent(bool periodicEvent)
3480 {
3481     double now = monotonicallyIncreasingTime();
3482     double timedelta = now - m_clockTimeAtLastUpdateEvent;
3483
3484     // throttle the periodic events
3485     if (periodicEvent && timedelta < maxTimeupdateEventFrequency)
3486         return;
3487
3488     // Some media engines make multiple "time changed" callbacks at the same time, but we only want one
3489     // event at a given time so filter here
3490     MediaTime movieTime = currentMediaTime();
3491     if (movieTime != m_lastTimeUpdateEventMovieTime) {
3492         scheduleEvent(eventNames().timeupdateEvent);
3493         m_clockTimeAtLastUpdateEvent = now;
3494         m_lastTimeUpdateEventMovieTime = movieTime;
3495     }
3496 }
3497
3498 bool HTMLMediaElement::canPlay() const
3499 {
3500     return paused() || ended() || m_readyState < HAVE_METADATA;
3501 }
3502
3503 double HTMLMediaElement::percentLoaded() const
3504 {
3505     if (!m_player)
3506         return 0;
3507     MediaTime duration = m_player->duration();
3508
3509     if (!duration || duration.isPositiveInfinite() || duration.isNegativeInfinite())
3510         return 0;
3511
3512     MediaTime buffered = MediaTime::zeroTime();
3513     bool ignored;
3514     std::unique_ptr<PlatformTimeRanges> timeRanges = m_player->buffered();
3515     for (unsigned i = 0; i < timeRanges->length(); ++i) {
3516         MediaTime start = timeRanges->start(i, ignored);
3517         MediaTime end = timeRanges->end(i, ignored);
3518         buffered += end - start;
3519     }
3520     return buffered.toDouble() / duration.toDouble();
3521 }
3522
3523 #if ENABLE(VIDEO_TRACK)
3524
3525 void HTMLMediaElement::mediaPlayerDidAddAudioTrack(AudioTrackPrivate& track)
3526 {
3527     if (isPlaying() && !m_mediaSession->playbackPermitted(*this))
3528         pauseInternal();
3529
3530     addAudioTrack(AudioTrack::create(*this, track));
3531 }
3532
3533 void HTMLMediaElement::mediaPlayerDidAddTextTrack(InbandTextTrackPrivate& track)
3534 {
3535     // 4.8.10.12.2 Sourcing in-band text tracks
3536     // 1. Associate the relevant data with a new text track and its corresponding new TextTrack object.
3537     auto textTrack = InbandTextTrack::create(*ActiveDOMObject::scriptExecutionContext(), *this, track);
3538     textTrack->setMediaElement(this);
3539     
3540     // 2. Set the new text track's kind, label, and language based on the semantics of the relevant data,
3541     // as defined by the relevant specification. If there is no label in that data, then the label must
3542     // be set to the empty string.
3543     // 3. Associate the text track list of cues with the rules for updating the text track rendering appropriate
3544     // for the format in question.
3545     // 4. If the new text track's kind is metadata, then set the text track in-band metadata track dispatch type
3546     // as follows, based on the type of the media resource:
3547     // 5. Populate the new text track's list of cues with the cues parsed so far, folllowing the guidelines for exposing
3548     // cues, and begin updating it dynamically as necessary.
3549     //   - Thess are all done by the media engine.
3550     
3551     // 6. Set the new text track's readiness state to loaded.
3552     textTrack->setReadinessState(TextTrack::Loaded);
3553     
3554     // 7. Set the new text track's mode to the mode consistent with the user's preferences and the requirements of
3555     // the relevant specification for the data.
3556     //  - This will happen in configureTextTracks()
3557     scheduleDelayedAction(ConfigureTextTracks);
3558     
3559     // 8. Add the new text track to the media element's list of text tracks.
3560     // 9. Fire an event with the name addtrack, that does not bubble and is not cancelable, and that uses the TrackEvent
3561     // interface, with the track attribute initialized to the text track's TextTrack object, at the media element's
3562     // textTracks attribute's TextTrackList object.
3563     addTextTrack(WTFMove(textTrack));
3564 }
3565
3566 void HTMLMediaElement::mediaPlayerDidAddVideoTrack(VideoTrackPrivate& track)
3567 {
3568     addVideoTrack(VideoTrack::create(*this, track));
3569 }
3570
3571 void HTMLMediaElement::mediaPlayerDidRemoveAudioTrack(AudioTrackPrivate& track)
3572 {
3573     track.willBeRemoved();
3574 }
3575
3576 void HTMLMediaElement::mediaPlayerDidRemoveTextTrack(InbandTextTrackPrivate& track)
3577 {
3578     track.willBeRemoved();
3579 }
3580
3581 void HTMLMediaElement::mediaPlayerDidRemoveVideoTrack(VideoTrackPrivate& track)
3582 {
3583     track.willBeRemoved();
3584 }
3585
3586 void HTMLMediaElement::closeCaptionTracksChanged()
3587 {
3588     if (hasMediaControls())
3589         mediaControls()->closedCaptionTracksChanged();
3590 }
3591
3592 void HTMLMediaElement::addAudioTrack(Ref<AudioTrack>&& track)
3593 {
3594     audioTracks().append(WTFMove(track));
3595 }
3596
3597 void HTMLMediaElement::addTextTrack(Ref<TextTrack>&& track)
3598 {
3599     if (!m_requireCaptionPreferencesChangedCallbacks) {
3600         m_requireCaptionPreferencesChangedCallbacks = true;
3601         Document& document = this->document();
3602         document.registerForCaptionPreferencesChangedCallbacks(this);
3603         if (Page* page = document.page())
3604             m_captionDisplayMode = page->group().captionPreferences().captionDisplayMode();
3605     }
3606
3607     textTracks().append(WTFMove(track));
3608
3609     closeCaptionTracksChanged();
3610 }
3611
3612 void HTMLMediaElement::addVideoTrack(Ref<VideoTrack>&& track)
3613 {
3614     videoTracks().append(WTFMove(track));
3615 }
3616
3617 void HTMLMediaElement::removeAudioTrack(AudioTrack& track)
3618 {
3619     m_audioTracks->remove(track);
3620     track.clearClient();
3621 }
3622
3623 void HTMLMediaElement::removeTextTrack(TextTrack& track, bool scheduleEvent)
3624 {
3625     TrackDisplayUpdateScope scope { *this };
3626     if (auto* cues = track.cues())
3627         textTrackRemoveCues(track, *cues);
3628     track.clearClient();
3629     if (m_textTracks)
3630         m_textTracks->remove(track, scheduleEvent);
3631
3632     closeCaptionTracksChanged();
3633 }
3634
3635 void HTMLMediaElement::removeVideoTrack(VideoTrack& track)
3636 {
3637     m_videoTracks->remove(track);
3638     track.clearClient();
3639 }
3640
3641 void HTMLMediaElement::forgetResourceSpecificTracks()
3642 {
3643     while (m_audioTracks &&  m_audioTracks->length())
3644         removeAudioTrack(*m_audioTracks->lastItem());
3645
3646     if (m_textTracks) {
3647         TrackDisplayUpdateScope scope { *this };
3648         for (int i = m_textTracks->length() - 1; i >= 0; --i) {
3649             auto& track = *m_textTracks->item(i);
3650             if (track.trackType() == TextTrack::InBand)
3651                 removeTextTrack(track, false);
3652         }
3653     }
3654
3655     while (m_videoTracks &&  m_videoTracks->length())
3656         removeVideoTrack(*m_videoTracks->lastItem());
3657 }
3658
3659 ExceptionOr<TextTrack&> HTMLMediaElement::addTextTrack(const String& kind, const String& label, const String& language)
3660 {
3661     // 4.8.10.12.4 Text track API
3662     // The addTextTrack(kind, label, language) method of media elements, when invoked, must run the following steps:
3663
3664     // 1. If kind is not one of the following strings, then throw a SyntaxError exception and abort these steps
3665     if (!TextTrack::isValidKindKeyword(kind))
3666         return Exception { TypeError };
3667
3668     // 2. If the label argument was omitted, let label be the empty string.
3669     // 3. If the language argument was omitted, let language be the empty string.
3670     // 4. Create a new TextTrack object.
3671
3672     // 5. Create a new text track corresponding to the new object, and set its text track kind to kind, its text 
3673     // track label to label, its text track language to language...
3674     auto track = TextTrack::create(ActiveDOMObject::scriptExecutionContext(), this, kind, emptyString(), label, language);
3675     auto& trackReference = track.get();
3676
3677     // Note, due to side effects when changing track parameters, we have to
3678     // first append the track to the text track list.
3679
3680     // 6. Add the new text track to the media element's list of text tracks.
3681     addTextTrack(WTFMove(track));
3682
3683     // ... its text track readiness state to the text track loaded state ...
3684     trackReference.setReadinessState(TextTrack::Loaded);
3685
3686     // ... its text track mode to the text track hidden mode, and its text track list of cues to an empty list ...
3687     trackReference.setMode(TextTrack::Mode::Hidden);
3688
3689     return trackReference;
3690 }
3691
3692 AudioTrackList& HTMLMediaElement::audioTracks()
3693 {
3694     if (!m_audioTracks)
3695         m_audioTracks = AudioTrackList::create(this, ActiveDOMObject::scriptExecutionContext());
3696
3697     return *m_audioTracks;
3698 }
3699
3700 TextTrackList& HTMLMediaElement::textTracks()
3701 {
3702     if (!m_textTracks)
3703         m_textTracks = TextTrackList::create(this, ActiveDOMObject::scriptExecutionContext());
3704
3705     return *m_textTracks;
3706 }
3707
3708 VideoTrackList& HTMLMediaElement::videoTracks()
3709 {
3710     if (!m_videoTracks)
3711         m_videoTracks = VideoTrackList::create(this, ActiveDOMObject::scriptExecutionContext());
3712
3713     return *m_videoTracks;
3714 }
3715
3716 void HTMLMediaElement::didAddTextTrack(HTMLTrackElement& trackElement)
3717 {
3718     ASSERT(trackElement.hasTagName(trackTag));
3719
3720     // 4.8.10.12.3 Sourcing out-of-band text tracks
3721     // When a track element's parent element changes and the new parent is a media element, 
3722     // then the user agent must add the track element's corresponding text track to the 
3723     // media element's list of text tracks ... [continues in TextTrackList::append]
3724     addTextTrack(trackElement.track());
3725
3726     // Do not schedule the track loading until parsing finishes so we don't start before all tracks
3727     // in the markup have been added.
3728     if (!m_parsingInProgress)
3729         scheduleDelayedAction(ConfigureTextTracks);
3730
3731     if (hasMediaControls())
3732         mediaControls()->closedCaptionTracksChanged();
3733 }
3734
3735 void HTMLMediaElement::didRemoveTextTrack(HTMLTrackElement& trackElement)
3736 {
3737     ASSERT(trackElement.hasTagName(trackTag));
3738
3739 #if !LOG_DISABLED
3740     if (trackElement.hasTagName(trackTag)) {
3741         URL url = trackElement.getNonEmptyURLAttribute(srcAttr);
3742         LOG(Media, "HTMLMediaElement::didRemoveTrack(%p) - 'src' is %s", this, urlForLoggingMedia(url).utf8().data());
3743     }
3744 #endif
3745
3746     auto& textTrack = trackElement.track();
3747
3748     textTrack.setHasBeenConfigured(false);
3749
3750     if (!m_textTracks)
3751         return;
3752     
3753     // 4.8.10.12.3 Sourcing out-of-band text tracks
3754     // When a track element's parent element changes and the old parent was a media element, 
3755     // then the user agent must remove the track element's corresponding text track from the 
3756     // media element's list of text tracks.
3757     removeTextTrack(textTrack);
3758
3759     m_textTracksWhenResourceSelectionBegan.removeFirst(&textTrack);
3760 }
3761
3762 void HTMLMediaElement::configureTextTrackGroup(const TrackGroup& group)
3763 {
3764     ASSERT(group.tracks.size());
3765
3766     LOG(Media, "HTMLMediaElement::configureTextTrackGroup(%p)", this);
3767
3768     Page* page = document().page();
3769     CaptionUserPreferences* captionPreferences = page ? &page->group().captionPreferences() : 0;
3770     CaptionUserPreferences::CaptionDisplayMode displayMode = captionPreferences ? captionPreferences->captionDisplayMode() : CaptionUserPreferences::Automatic;
3771
3772     // First, find the track in the group that should be enabled (if any).
3773     Vector<RefPtr<TextTrack>> currentlyEnabledTracks;
3774     RefPtr<TextTrack> trackToEnable;
3775     RefPtr<TextTrack> defaultTrack;
3776     RefPtr<TextTrack> fallbackTrack;
3777     RefPtr<TextTrack> forcedSubitleTrack;
3778     int highestTrackScore = 0;
3779     int highestForcedScore = 0;
3780
3781     // If there is a visible track, it has already been configured so it won't be considered in the loop below. We don't want to choose another
3782     // track if it is less suitable, and we do want to disable it if another track is more suitable.
3783     int alreadyVisibleTrackScore = 0;
3784     if (group.visibleTrack && captionPreferences) {
3785         alreadyVisibleTrackScore = captionPreferences->textTrackSelectionScore(group.visibleTrack.get(), this);
3786         currentlyEnabledTracks.append(group.visibleTrack);
3787     }
3788
3789     for (size_t i = 0; i < group.tracks.size(); ++i) {
3790         RefPtr<TextTrack> textTrack = group.tracks[i];
3791
3792         if (m_processingPreferenceChange && textTrack->mode() == TextTrack::Mode::Showing)
3793             currentlyEnabledTracks.append(textTrack);
3794
3795         int trackScore = captionPreferences ? captionPreferences->textTrackSelectionScore(textTrack.get(), this) : 0;
3796         LOG(Media, "HTMLMediaElement::configureTextTrackGroup(%p) -  '%s' track with language '%s' and BCP 47 language '%s' has score %d", this, textTrack->kindKeyword().string().utf8().data(), textTrack->language().string().utf8().data(), textTrack->validBCP47Language().string().utf8().data(), trackScore);
3797
3798         if (trackScore) {
3799
3800             // * If the text track kind is { [subtitles or captions] [descriptions] } and the user has indicated an interest in having a
3801             // track with this text track kind, text track language, and text track label enabled, and there is no
3802             // other text track in the media element's list of text tracks with a text track kind of either subtitles
3803             // or captions whose text track mode is showing
3804             // ...
3805             // * If the text track kind is chapters and the text track language is one that the user agent has reason
3806             // to believe is appropriate for the user, and there is no other text track in the media element's list of
3807             // text tracks with a text track kind of chapters whose text track mode is showing
3808             //    Let the text track mode be showing.
3809             if (trackScore > highestTrackScore && trackScore > alreadyVisibleTrackScore) {
3810                 highestTrackScore = trackScore;
3811                 trackToEnable = textTrack;
3812             }
3813
3814             if (!defaultTrack && textTrack->isDefault())
3815                 defaultTrack = textTrack;
3816             if (!defaultTrack && !fallbackTrack)
3817                 fallbackTrack = textTrack;
3818             if (textTrack->containsOnlyForcedSubtitles() && trackScore > highestForcedScore) {
3819                 forcedSubitleTrack = textTrack;
3820                 highestForcedScore = trackScore;
3821             }
3822         } else if (!group.visibleTrack && !defaultTrack && textTrack->isDefault()) {
3823             // * If the track element has a default attribute specified, and there is no other text track in the media
3824             // element's list of text tracks whose text track mode is showing or showing by default
3825             //    Let the text track mode be showing by default.
3826             if (group.kind != TrackGroup::CaptionsAndSubtitles || displayMode != CaptionUserPreferences::ForcedOnly)
3827                 defaultTrack = textTrack;
3828         }
3829     }
3830
3831     if (displayMode != CaptionUserPreferences::Manual) {
3832         if (!trackToEnable && defaultTrack)
3833             trackToEnable = defaultTrack;
3834
3835         // If no track matches the user's preferred language, none was marked as 'default', and there is a forced subtitle track
3836         // in the same language as the language of the primary audio track, enable it.
3837         if (!trackToEnable && forcedSubitleTrack)
3838             trackToEnable = forcedSubitleTrack;
3839
3840         // If no track matches, don't disable an already visible track unless preferences say they all should be off.
3841         if (group.kind != TrackGroup::CaptionsAndSubtitles || displayMode != CaptionUserPreferences::ForcedOnly) {
3842             if (!trackToEnable && !defaultTrack && group.visibleTrack)
3843                 trackToEnable = group.visibleTrack;
3844         }
3845
3846         // If no track matches the user's preferred language and non was marked 'default', enable the first track
3847         // because the user has explicitly stated a preference for this kind of track.
3848         if (!trackToEnable && fallbackTrack)
3849             trackToEnable = fallbackTrack;
3850
3851         if (trackToEnable)
3852             m_subtitleTrackLanguage = trackToEnable->language();
3853         else
3854             m_subtitleTrackLanguage = emptyString();
3855     }
3856
3857     if (currentlyEnabledTracks.size()) {
3858         for (size_t i = 0; i < currentlyEnabledTracks.size(); ++i) {
3859             RefPtr<TextTrack> textTrack = currentlyEnabledTracks[i];
3860             if (textTrack != trackToEnable)
3861                 textTrack->setMode(TextTrack::Mode::Disabled);
3862         }
3863     }
3864
3865     if (trackToEnable) {
3866         trackToEnable->setMode(TextTrack::Mode::Showing);
3867
3868         // If user preferences indicate we should always display captions, make sure we reflect the
3869         // proper status via the webkitClosedCaptionsVisible API call:
3870         if (!webkitClosedCaptionsVisible() && closedCaptionsVisible() && displayMode == CaptionUserPreferences::AlwaysOn)
3871             m_webkitLegacyClosedCaptionOverride = true;
3872     }
3873
3874     m_processingPreferenceChange = false;
3875 }
3876
3877 static JSC::JSValue controllerJSValue(JSC::ExecState& exec, JSDOMGlobalObject& globalObject, HTMLMediaElement& media)
3878 {
3879     JSC::VM& vm = globalObject.vm();
3880     auto scope = DECLARE_THROW_SCOPE(vm);
3881     auto mediaJSWrapper = toJS(&exec, &globalObject, media);
3882     
3883     // Retrieve the controller through the JS object graph
3884     JSC::JSObject* mediaJSWrapperObject = jsDynamicDowncast<JSC::JSObject*>(vm, mediaJSWrapper);
3885     if (!mediaJSWrapperObject)
3886         return JSC::jsNull();
3887     
3888     JSC::Identifier controlsHost = JSC::Identifier::fromString(&vm, "controlsHost");
3889     JSC::JSValue controlsHostJSWrapper = mediaJSWrapperObject->get(&exec, controlsHost);
3890     RETURN_IF_EXCEPTION(scope, JSC::jsNull());
3891
3892     JSC::JSObject* controlsHostJSWrapperObject = jsDynamicDowncast<JSC::JSObject*>(vm, controlsHostJSWrapper);
3893     if (!controlsHostJSWrapperObject)
3894         return JSC::jsNull();
3895
3896     JSC::Identifier controllerID = JSC::Identifier::fromString(&vm, "controller");
3897     JSC::JSValue controllerJSWrapper = controlsHostJSWrapperObject->get(&exec, controllerID);
3898     RETURN_IF_EXCEPTION(scope, JSC::jsNull());
3899
3900     return controllerJSWrapper;
3901 }
3902
3903 void HTMLMediaElement::ensureMediaControlsShadowRoot()
3904 {
3905     ASSERT(!m_creatingControls);
3906     m_creatingControls = true;
3907     ensureUserAgentShadowRoot();
3908     m_creatingControls = false;
3909 }
3910
3911 void HTMLMediaElement::updateCaptionContainer()
3912 {
3913     LOG(Media, "HTMLMediaElement::updateCaptionContainer(%p)", this);
3914 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
3915     if (m_haveSetUpCaptionContainer)
3916         return;
3917
3918     Page* page = document().page();
3919     if (!page)
3920         return;
3921
3922     DOMWrapperWorld& world = ensureIsolatedWorld();
3923
3924     if (!ensureMediaControlsInjectedScript())
3925         return;
3926
3927     ensureMediaControlsShadowRoot();
3928
3929     if (!m_mediaControlsHost)
3930         m_mediaControlsHost = MediaControlsHost::create(this);
3931
3932     ScriptController& scriptController = document().frame()->script();
3933     JSDOMGlobalObject* globalObject = JSC::jsCast<JSDOMGlobalObject*>(scriptController.globalObject(world));
3934     JSC::VM& vm = globalObject->vm();
3935     JSC::JSLockHolder lock(vm);
3936     auto scope = DECLARE_CATCH_SCOPE(vm);
3937     JSC::ExecState* exec = globalObject->globalExec();
3938
3939     JSC::JSValue controllerValue = controllerJSValue(*exec, *globalObject, *this);
3940     JSC::JSObject* controllerObject = jsDynamicDowncast<JSC::JSObject*>(vm, controllerValue);
3941     if (!controllerObject)
3942         return;
3943
3944     // The media controls script must provide a method on the Controller object with the following details.
3945     // Name: updateCaptionContainer
3946     // Parameters:
3947     //     None
3948     // Return value:
3949     //     None
3950     JSC::JSValue methodValue = controllerObject->get(exec, JSC::Identifier::fromString(exec, "updateCaptionContainer"));
3951     JSC::JSObject* methodObject = jsDynamicDowncast<JSC::JSObject*>(vm, methodValue);
3952     if (!methodObject)
3953         return;
3954
3955     JSC::CallData callData;
3956     JSC::CallType callType = methodObject->methodTable()->getCallData(methodObject, callData);
3957     if (callType == JSC::CallType::None)
3958         return;
3959
3960     JSC::MarkedArgumentBuffer noArguments;
3961     JSC::call(exec, methodObject, callType, callData, controllerObject, noArguments);
3962     scope.clearException();
3963
3964     m_haveSetUpCaptionContainer = true;
3965 #endif
3966 }
3967
3968 void HTMLMediaElement::layoutSizeChanged()
3969 {
3970 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
3971     auto task = [this, protectedThis = makeRef(*this)] {
3972         if (ShadowRoot* root = userAgentShadowRoot())
3973             root->dispatchEvent(Event::create("resize", false, false));
3974     };
3975     m_resizeTaskQueue.enqueueTask(WTFMove(task));
3976 #endif
3977
3978     if (!m_receivedLayoutSizeChanged) {
3979         m_receivedLayoutSizeChanged = true;
3980         scheduleUpdatePlaybackControlsManager();
3981     }
3982
3983     // If the video is a candidate for main content, we should register it for viewport visibility callbacks
3984     // if it hasn't already been registered.
3985     if (renderer() && m_mediaSession && !m_mediaSession->wantsToObserveViewportVisibilityForAutoplay() && m_mediaSession->wantsToObserveViewportVisibilityForMediaControls())
3986         renderer()->registerForVisibleInViewportCallback();
3987 }
3988
3989 void HTMLMediaElement::visibilityDidChange()
3990 {
3991     updateShouldAutoplay();
3992 }
3993
3994 void HTMLMediaElement::setSelectedTextTrack(TextTrack* trackToSelect)
3995 {
3996     TextTrackList& trackList = textTracks();
3997     if (!trackList.length())
3998         return;
3999
4000     if (trackToSelect != TextTrack::captionMenuOffItem() && trackToSelect != TextTrack::captionMenuAutomaticItem()) {
4001         if (!trackToSelect || !trackList.contains(*trackToSelect))
4002             return;
4003         
4004         for (int i = 0, length = trackList.length(); i < length; ++i) {
4005             auto& track = *trackList.item(i);
4006             if (&track != trackToSelect)
4007                 track.setMode(TextTrack::Mode::Disabled);
4008             else
4009                 track.setMode(TextTrack::Mode::Showing);
4010         }
4011     } else if (trackToSelect == TextTrack::captionMenuOffItem()) {
4012         for (int i = 0, length = trackList.length(); i < length; ++i)
4013             trackList.item(i)->setMode(TextTrack::Mode::Disabled);
4014     }
4015
4016     if (!document().page())
4017         return;
4018
4019     auto& captionPreferences = document().page()->group().captionPreferences();
4020     CaptionUserPreferences::CaptionDisplayMode displayMode;
4021     if (trackToSelect == TextTrack::captionMenuOffItem())
4022         displayMode = CaptionUserPreferences::ForcedOnly;
4023     else if (trackToSelect == TextTrack::captionMenuAutomaticItem())
4024         displayMode = CaptionUserPreferences::Automatic;
4025     else {
4026         displayMode = CaptionUserPreferences::AlwaysOn;
4027         if (trackToSelect->validBCP47Language().length())
4028             captionPreferences.setPreferredLanguage(trackToSelect->validBCP47Language());
4029     }
4030
4031     captionPreferences.setCaptionDisplayMode(displayMode);
4032 }
4033
4034 void HTMLMediaElement::configureTextTracks()
4035 {
4036     TrackGroup captionAndSubtitleTracks(TrackGroup::CaptionsAndSubtitles);
4037     TrackGroup descriptionTracks(TrackGroup::Description);
4038     TrackGroup chapterTracks(TrackGroup::Chapter);
4039     TrackGroup metadataTracks(TrackGroup::Metadata);
4040     TrackGroup otherTracks(TrackGroup::Other);
4041
4042     if (!m_textTracks)
4043         return;
4044
4045     for (size_t i = 0; i < m_textTracks->length(); ++i) {
4046         RefPtr<TextTrack> textTrack = m_textTracks->item(i);
4047         if (!textTrack)
4048             continue;
4049
4050         auto kind = textTrack->kind();
4051         TrackGroup* currentGroup;
4052         if (kind == TextTrack::Kind::Subtitles || kind == TextTrack::Kind::Captions || kind == TextTrack::Kind::Forced)
4053             currentGroup = &captionAndSubtitleTracks;
4054         else if (kind == TextTrack::Kind::Descriptions)
4055             currentGroup = &descriptionTracks;
4056         else if (kind == TextTrack::Kind::Chapters)
4057             currentGroup = &chapterTracks;
4058         else if (kind == TextTrack::Kind::Metadata)
4059             currentGroup = &metadataTracks;
4060         else
4061             currentGroup = &otherTracks;
4062
4063         if (!currentGroup->visibleTrack && textTrack->mode() == TextTrack::Mode::Showing)
4064             currentGroup->visibleTrack = textTrack;
4065         if (!currentGroup->defaultTrack && textTrack->isDefault())
4066             currentGroup->defaultTrack = textTrack;
4067
4068         // Do not add this track to the group if it has already been automatically configured
4069         // as we only want to call configureTextTrack once per track so that adding another 
4070         // track after the initial configuration doesn't reconfigure every track - only those 
4071         // that should be changed by the new addition. For example all metadata tracks are 
4072         // disabled by default, and we don't want a track that has been enabled by script 
4073         // to be disabled automatically when a new metadata track is added later.
4074         if (textTrack->hasBeenConfigured())
4075             continue;
4076         
4077         if (textTrack->language().length())
4078             currentGroup->hasSrcLang = true;
4079         currentGroup->tracks.append(textTrack);
4080     }
4081     
4082     if (captionAndSubtitleTracks.tracks.size())
4083         configureTextTrackGroup(captionAndSubtitleTracks);
4084     if (descriptionTracks.tracks.size())
4085         configureTextTrackGroup(descriptionTracks);
4086     if (chapterTracks.tracks.size())
4087         configureTextTrackGroup(chapterTracks);
4088     if (metadataTracks.tracks.size())
4089         configureTextTrackGroup(metadataTracks);
4090     if (otherTracks.tracks.size())
4091         configureTextTrackGroup(otherTracks);
4092
4093     updateCaptionContainer();
4094     configureTextTrackDisplay();
4095     if (hasMediaControls())
4096         mediaControls()->closedCaptionTracksChanged();
4097 }
4098 #endif
4099
4100 bool HTMLMediaElement::havePotentialSourceChild()
4101 {
4102     // Stash the current <source> node and next nodes so we can restore them after checking
4103     // to see there is another potential.
4104     RefPtr<HTMLSourceElement> currentSourceNode = m_currentSourceNode;
4105     RefPtr<Node> nextNode = m_nextCh