Define media buffering policy
[WebKit-https.git] / Source / WebCore / html / HTMLMediaElement.h
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 #pragma once
27
28 #if ENABLE(VIDEO)
29
30 #include "ActiveDOMObject.h"
31 #include "ApplicationStateChangeListener.h"
32 #include "AutoplayEvent.h"
33 #include "DeferrableTask.h"
34 #include "GenericEventQueue.h"
35 #include "HTMLElement.h"
36 #include "HTMLMediaElementEnums.h"
37 #include "MediaCanStartListener.h"
38 #include "MediaControllerInterface.h"
39 #include "MediaElementSession.h"
40 #include "MediaPlayer.h"
41 #include "MediaProducer.h"
42 #include "VisibilityChangeClient.h"
43 #include <wtf/Function.h>
44 #include <wtf/LoggerHelper.h>
45 #include <wtf/WeakPtr.h>
46
47 #if ENABLE(VIDEO_TRACK)
48 #include "AudioTrack.h"
49 #include "CaptionUserPreferences.h"
50 #include "PODIntervalTree.h"
51 #include "TextTrack.h"
52 #include "TextTrackCue.h"
53 #include "VTTCue.h"
54 #include "VideoTrack.h"
55 #endif
56
57 #if USE(AUDIO_SESSION) && PLATFORM(MAC)
58 #include "AudioSession.h"
59 #endif
60
61 #if ENABLE(ENCRYPTED_MEDIA)
62 #include "CDMClient.h"
63 #endif
64
65 #ifndef NDEBUG
66 #include <wtf/StringPrintStream.h>
67 #endif
68
69 namespace PAL {
70 class SleepDisabler;
71 }
72
73 namespace WebCore {
74
75 class AudioSourceProvider;
76 class AudioTrackList;
77 class AudioTrackPrivate;
78 class Blob;
79 class DOMException;
80 class DOMWrapperWorld;
81 class DeferredPromise;
82 class Event;
83 class HTMLSourceElement;
84 class HTMLTrackElement;
85 class InbandTextTrackPrivate;
86 class JSDOMGlobalObject;
87 class MediaController;
88 class MediaControls;
89 class MediaControlsHost;
90 class MediaElementAudioSourceNode;
91 class MediaError;
92 class MediaKeys;
93 class MediaResourceLoader;
94 class MediaSession;
95 class MediaSource;
96 class MediaStream;
97 class RenderMedia;
98 class ScriptController;
99 class ScriptExecutionContext;
100 class SourceBuffer;
101 class TextTrackList;
102 class TimeRanges;
103 class VideoPlaybackQuality;
104 class VideoTrackList;
105 class VideoTrackPrivate;
106 class WebKitMediaKeys;
107
108 template<typename> class DOMPromiseDeferred;
109
110 #if ENABLE(VIDEO_TRACK)
111 using CueIntervalTree = PODIntervalTree<MediaTime, TextTrackCue*>;
112 using CueInterval = CueIntervalTree::IntervalType;
113 using CueList = Vector<CueInterval>;
114 #endif
115
116 using MediaProvider = Optional<Variant<
117 #if ENABLE(MEDIA_STREAM)
118     RefPtr<MediaStream>,
119 #endif
120 #if ENABLE(MEDIA_SOURCE)
121     RefPtr<MediaSource>,
122 #endif
123     RefPtr<Blob>>>;
124
125 class HTMLMediaElement
126     : public HTMLElement
127     , public ActiveDOMObject
128     , public MediaControllerInterface
129     , public PlatformMediaSessionClient
130     , private MediaCanStartListener
131     , private MediaPlayerClient
132     , private MediaProducer
133     , private VisibilityChangeClient
134     , private ApplicationStateChangeListener
135 #if ENABLE(VIDEO_TRACK)
136     , private AudioTrackClient
137     , private TextTrackClient
138     , private VideoTrackClient
139 #endif
140 #if USE(AUDIO_SESSION) && PLATFORM(MAC)
141     , private AudioSession::MutedStateObserver
142 #endif
143 #if ENABLE(ENCRYPTED_MEDIA)
144     , private CDMClient
145 #endif
146 #if !RELEASE_LOG_DISABLED
147     , private LoggerHelper
148 #endif
149 {
150     WTF_MAKE_ISO_ALLOCATED(HTMLMediaElement);
151 public:
152     RefPtr<MediaPlayer> player() const { return m_player; }
153
154     virtual bool isVideo() const { return false; }
155     bool hasVideo() const override { return false; }
156     bool hasAudio() const override;
157
158     static HashSet<HTMLMediaElement*>& allMediaElements();
159
160     WEBCORE_EXPORT static RefPtr<HTMLMediaElement> bestMediaElementForShowingPlaybackControlsManager(MediaElementSession::PlaybackControlsPurpose);
161
162     static bool isRunningDestructor();
163
164     WEBCORE_EXPORT void rewind(double timeDelta);
165     WEBCORE_EXPORT void returnToRealtime() override;
166
167     // Eventually overloaded in HTMLVideoElement
168     bool supportsFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) const override { return false; };
169
170     bool supportsScanning() const override;
171
172     bool canSaveMediaData() const;
173
174     bool doesHaveAttribute(const AtomicString&, AtomicString* value = nullptr) const override;
175
176     PlatformLayer* platformLayer() const;
177     bool isVideoLayerInline();
178     void setPreparedToReturnVideoLayerToInline(bool);
179     void waitForPreparedForInlineThen(WTF::Function<void()>&& completionHandler = [] { });
180 #if PLATFORM(IOS_FAMILY) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
181     void setVideoFullscreenLayer(PlatformLayer*, WTF::Function<void()>&& completionHandler = [] { });
182 #ifdef __OBJC__
183     PlatformLayer* videoFullscreenLayer() const { return m_videoFullscreenLayer.get(); }
184 #endif
185     void setVideoFullscreenFrame(FloatRect);
186     void setVideoFullscreenGravity(MediaPlayerEnums::VideoGravity);
187     MediaPlayerEnums::VideoGravity videoFullscreenGravity() const { return m_videoFullscreenGravity; }
188 #endif
189
190     void scheduleCheckPlaybackTargetCompatability();
191     void checkPlaybackTargetCompatablity();
192     void scheduleResolvePendingPlayPromises();
193     void scheduleRejectPendingPlayPromises(Ref<DOMException>&&);
194     using PlayPromiseVector = Vector<DOMPromiseDeferred<void>>;
195     void rejectPendingPlayPromises(PlayPromiseVector&&, Ref<DOMException>&&);
196     void resolvePendingPlayPromises(PlayPromiseVector&&);
197     void scheduleNotifyAboutPlaying();
198     void notifyAboutPlaying(PlayPromiseVector&&);
199     
200     MediaPlayerEnums::MovieLoadType movieLoadType() const;
201     
202     bool inActiveDocument() const { return m_inActiveDocument; }
203
204     Document* hostingDocument() const final { return &document(); }
205
206 // DOM API
207 // error state
208     WEBCORE_EXPORT MediaError* error() const;
209
210     const URL& currentSrc() const { return m_currentSrc; }
211
212     const MediaProvider& srcObject() const { return m_mediaProvider; }
213     void setSrcObject(MediaProvider&&);
214
215     WEBCORE_EXPORT void setCrossOrigin(const AtomicString&);
216     WEBCORE_EXPORT String crossOrigin() const;
217
218 // network state
219     using HTMLMediaElementEnums::NetworkState;
220     WEBCORE_EXPORT NetworkState networkState() const;
221
222     WEBCORE_EXPORT String preload() const;
223     WEBCORE_EXPORT void setPreload(const String&);
224
225     Ref<TimeRanges> buffered() const override;
226     WEBCORE_EXPORT void load();
227     WEBCORE_EXPORT String canPlayType(const String& mimeType) const;
228
229 // ready state
230     using HTMLMediaElementEnums::ReadyState;
231     ReadyState readyState() const override;
232     WEBCORE_EXPORT bool seeking() const;
233
234 // playback state
235     WEBCORE_EXPORT double currentTime() const override;
236     WEBCORE_EXPORT void setCurrentTime(double) override;
237     void setCurrentTimeWithTolerance(double, double toleranceBefore, double toleranceAfter);
238     double currentTimeForBindings() const { return currentTime(); }
239     WEBCORE_EXPORT ExceptionOr<void> setCurrentTimeForBindings(double);
240     WEBCORE_EXPORT double getStartDate() const;
241     WEBCORE_EXPORT double duration() const override;
242     WEBCORE_EXPORT bool paused() const override;
243     double defaultPlaybackRate() const override;
244     void setDefaultPlaybackRate(double) override;
245     WEBCORE_EXPORT double playbackRate() const override;
246     void setPlaybackRate(double) override;
247
248 // MediaTime versions of playback state
249     MediaTime currentMediaTime() const;
250     void setCurrentTime(const MediaTime&);
251     MediaTime durationMediaTime() const;
252     WEBCORE_EXPORT void fastSeek(const MediaTime&);
253
254     void updatePlaybackRate();
255     WEBCORE_EXPORT bool webkitPreservesPitch() const;
256     WEBCORE_EXPORT void setWebkitPreservesPitch(bool);
257     Ref<TimeRanges> played() override;
258     Ref<TimeRanges> seekable() const override;
259     double seekableTimeRangesLastModifiedTime() const;
260     double liveUpdateInterval() const;
261     WEBCORE_EXPORT bool ended() const;
262     bool autoplay() const;
263     bool isAutoplaying() const { return m_autoplaying; }
264     bool loop() const;
265     void setLoop(bool b);
266
267     void play(DOMPromiseDeferred<void>&&);
268
269     WEBCORE_EXPORT void play() override;
270     WEBCORE_EXPORT void pause() override;
271     WEBCORE_EXPORT void fastSeek(double);
272     double minFastReverseRate() const;
273     double maxFastForwardRate() const;
274
275     using HTMLMediaElementEnums::BufferingPolicy;
276     void setBufferingPolicy(BufferingPolicy);
277     WEBCORE_EXPORT BufferingPolicy bufferingPolicy() const;
278     WEBCORE_EXPORT void purgeBufferedDataIfPossible();
279
280 // captions
281     WEBCORE_EXPORT bool webkitHasClosedCaptions() const;
282     WEBCORE_EXPORT bool webkitClosedCaptionsVisible() const;
283     WEBCORE_EXPORT void setWebkitClosedCaptionsVisible(bool);
284
285     bool elementIsHidden() const { return m_elementIsHidden; }
286
287 #if ENABLE(MEDIA_STATISTICS)
288 // Statistics
289     unsigned webkitAudioDecodedByteCount() const;
290     unsigned webkitVideoDecodedByteCount() const;
291 #endif
292
293 #if ENABLE(MEDIA_SOURCE)
294 //  Media Source.
295     void detachMediaSource();
296     void incrementDroppedFrameCount() { ++m_droppedVideoFrames; }
297     size_t maximumSourceBufferSize(const SourceBuffer&) const;
298 #endif
299
300 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
301     WebKitMediaKeys* webkitKeys() const { return m_webKitMediaKeys.get(); }
302     void webkitSetMediaKeys(WebKitMediaKeys*);
303
304     void keyAdded();
305 #endif
306
307 #if ENABLE(ENCRYPTED_MEDIA)
308     MediaKeys* mediaKeys() const;
309
310     void setMediaKeys(MediaKeys*, Ref<DeferredPromise>&&);
311 #endif
312
313 // controls
314     WEBCORE_EXPORT bool controls() const;
315     WEBCORE_EXPORT void setControls(bool);
316     WEBCORE_EXPORT double volume() const override;
317     WEBCORE_EXPORT ExceptionOr<void> setVolume(double) override;
318     WEBCORE_EXPORT bool muted() const override;
319     WEBCORE_EXPORT void setMuted(bool) override;
320
321     WEBCORE_EXPORT void togglePlayState();
322     WEBCORE_EXPORT void beginScrubbing() override;
323     WEBCORE_EXPORT void endScrubbing() override;
324
325     void beginScanning(ScanDirection) override;
326     void endScanning() override;
327     double nextScanRate();
328
329     WEBCORE_EXPORT bool canPlay() const override;
330
331     double percentLoaded() const;
332
333     bool shouldForceControlsDisplay() const;
334
335 #if ENABLE(VIDEO_TRACK)
336     ExceptionOr<TextTrack&> addTextTrack(const String& kind, const String& label, const String& language);
337
338     AudioTrackList& ensureAudioTracks();
339     TextTrackList& ensureTextTracks();
340     VideoTrackList& ensureVideoTracks();
341     AudioTrackList* audioTracks() const { return m_audioTracks.get(); }
342     TextTrackList* textTracks() const { return m_textTracks.get(); }
343     VideoTrackList* videoTracks() const { return m_videoTracks.get(); }
344
345     CueList currentlyActiveCues() const { return m_currentlyActiveCues; }
346
347     void addAudioTrack(Ref<AudioTrack>&&);
348     void addTextTrack(Ref<TextTrack>&&);
349     void addVideoTrack(Ref<VideoTrack>&&);
350     void removeAudioTrack(Ref<AudioTrack>&&);
351     void removeTextTrack(Ref<TextTrack>&&, bool scheduleEvent = true);
352     void removeVideoTrack(Ref<VideoTrack>&&);
353     void forgetResourceSpecificTracks();
354     void closeCaptionTracksChanged();
355     void notifyMediaPlayerOfTextTrackChanges();
356
357     virtual void didAddTextTrack(HTMLTrackElement&);
358     virtual void didRemoveTextTrack(HTMLTrackElement&);
359
360     void mediaPlayerDidAddAudioTrack(AudioTrackPrivate&) final;
361     void mediaPlayerDidAddTextTrack(InbandTextTrackPrivate&) final;
362     void mediaPlayerDidAddVideoTrack(VideoTrackPrivate&) final;
363     void mediaPlayerDidRemoveAudioTrack(AudioTrackPrivate&) final;
364     void mediaPlayerDidRemoveTextTrack(InbandTextTrackPrivate&) final;
365     void mediaPlayerDidRemoveVideoTrack(VideoTrackPrivate&) final;
366
367 #if ENABLE(AVF_CAPTIONS)
368     Vector<RefPtr<PlatformTextTrack>> outOfBandTrackSources() final;
369 #endif
370
371     struct TrackGroup;
372     void configureTextTrackGroupForLanguage(const TrackGroup&) const;
373     void scheduleConfigureTextTracks();
374     void configureTextTracks();
375     void configureTextTrackGroup(const TrackGroup&);
376
377     void setSelectedTextTrack(TextTrack*);
378
379     bool textTracksAreReady() const;
380     using HTMLMediaElementEnums::TextTrackVisibilityCheckType;
381     void configureTextTrackDisplay(TextTrackVisibilityCheckType checkType = CheckTextTrackVisibility);
382     void updateTextTrackDisplay();
383
384     // AudioTrackClient
385     void audioTrackEnabledChanged(AudioTrack&) final;
386
387     void textTrackReadyStateChanged(TextTrack*);
388
389     // TextTrackClient
390     void textTrackKindChanged(TextTrack&) override;
391     void textTrackModeChanged(TextTrack&) override;
392     void textTrackAddCues(TextTrack&, const TextTrackCueList&) override;
393     void textTrackRemoveCues(TextTrack&, const TextTrackCueList&) override;
394     void textTrackAddCue(TextTrack&, TextTrackCue&) override;
395     void textTrackRemoveCue(TextTrack&, TextTrackCue&) override;
396
397     // VideoTrackClient
398     void videoTrackSelectedChanged(VideoTrack&) final;
399
400     bool requiresTextTrackRepresentation() const;
401     void setTextTrackRepresentation(TextTrackRepresentation*);
402     void syncTextTrackBounds();
403 #endif
404
405 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
406     void webkitShowPlaybackTargetPicker();
407     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
408     bool removeEventListener(const AtomicString& eventType, EventListener&, const ListenerOptions&) override;
409
410     void wirelessRoutesAvailableDidChange() override;
411     void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) override;
412     void setShouldPlayToPlaybackTarget(bool) override;
413 #endif
414     bool isPlayingToWirelessPlaybackTarget() const override { return m_isPlayingToWirelessTarget; };
415     void setIsPlayingToWirelessTarget(bool);
416     bool webkitCurrentPlaybackTargetIsWireless() const;
417
418     void setPlayingOnSecondScreen(bool value);
419     bool isPlayingOnSecondScreen() const override { return m_playingOnSecondScreen; }
420
421     bool isPlayingToExternalTarget() const { return isPlayingToWirelessPlaybackTarget() || isPlayingOnSecondScreen(); }
422
423     // EventTarget function.
424     // Both Node (via HTMLElement) and ActiveDOMObject define this method, which
425     // causes an ambiguity error at compile time. This class's constructor
426     // ensures that both implementations return document, so return the result
427     // of one of them here.
428     using HTMLElement::scriptExecutionContext;
429
430     bool hasSingleSecurityOrigin() const { return !m_player || m_player->hasSingleSecurityOrigin(); }
431     bool didPassCORSAccessCheck() const { return m_player && m_player->didPassCORSAccessCheck(); }
432     bool wouldTaintOrigin(const SecurityOrigin& origin) const { return m_player && m_player->wouldTaintOrigin(origin); }
433     
434     WEBCORE_EXPORT bool isFullscreen() const override;
435     bool isStandardFullscreen() const;
436     void toggleStandardFullscreenState();
437
438     using MediaPlayerEnums::VideoFullscreenMode;
439     VideoFullscreenMode fullscreenMode() const { return m_videoFullscreenMode; }
440     virtual void fullscreenModeChanged(VideoFullscreenMode);
441
442     void enterFullscreen(VideoFullscreenMode);
443     void enterFullscreen() override;
444     WEBCORE_EXPORT void exitFullscreen();
445     WEBCORE_EXPORT void setVideoFullscreenStandby(bool);
446
447     bool hasClosedCaptions() const override;
448     bool closedCaptionsVisible() const override;
449     void setClosedCaptionsVisible(bool) override;
450
451     MediaControls* mediaControls() const;
452
453     void sourceWasRemoved(HTMLSourceElement&);
454     void sourceWasAdded(HTMLSourceElement&);
455
456     void privateBrowsingStateDidChange() override;
457
458     // Media cache management.
459     WEBCORE_EXPORT static void setMediaCacheDirectory(const String&);
460     WEBCORE_EXPORT static const String& mediaCacheDirectory();
461     WEBCORE_EXPORT static HashSet<RefPtr<SecurityOrigin>> originsInMediaCache(const String&);
462     WEBCORE_EXPORT static void clearMediaCache(const String&, WallTime modifiedSince = { });
463     WEBCORE_EXPORT static void clearMediaCacheForOrigins(const String&, const HashSet<RefPtr<SecurityOrigin>>&);
464     static void resetMediaEngines();
465
466     bool isPlaying() const { return m_playing; }
467
468     bool hasPendingActivity() const override;
469
470 #if ENABLE(WEB_AUDIO)
471     MediaElementAudioSourceNode* audioSourceNode() { return m_audioSourceNode; }
472     void setAudioSourceNode(MediaElementAudioSourceNode*);
473
474     AudioSourceProvider* audioSourceProvider();
475 #endif
476
477     using HTMLMediaElementEnums::InvalidURLAction;
478     bool isSafeToLoadURL(const URL&, InvalidURLAction);
479
480     const String& mediaGroup() const;
481     void setMediaGroup(const String&);
482
483     MediaController* controller() const;
484     void setController(RefPtr<MediaController>&&);
485
486     MediaController* controllerForBindings() const { return controller(); }
487     void setControllerForBindings(MediaController*);
488
489     void enteredOrExitedFullscreen() { configureMediaControls(); }
490
491     unsigned long long fileSize() const;
492
493     void mediaLoadingFailed(MediaPlayerEnums::NetworkState);
494     void mediaLoadingFailedFatally(MediaPlayerEnums::NetworkState);
495
496 #if ENABLE(MEDIA_SESSION)
497     WEBCORE_EXPORT double playerVolume() const;
498
499     const String& kind() const { return m_kind; }
500     void setKind(const String& kind) { m_kind = kind; }
501
502     MediaSession* session() const;
503     void setSession(MediaSession*);
504
505     void setShouldDuck(bool);
506
507     static HTMLMediaElement* elementWithID(uint64_t);
508     uint64_t elementID() const { return m_elementID; }
509 #endif
510
511     RefPtr<VideoPlaybackQuality> getVideoPlaybackQuality();
512
513     MediaPlayerEnums::Preload preloadValue() const { return m_preload; }
514     MediaElementSession& mediaSession() const { return *m_mediaSession; }
515
516 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
517     void pageScaleFactorChanged();
518     void userInterfaceLayoutDirectionChanged();
519     WEBCORE_EXPORT String getCurrentMediaControlsStatus();
520
521     MediaControlsHost* mediaControlsHost() { return m_mediaControlsHost.get(); }
522 #endif
523
524     bool isDisablingSleep() const { return m_sleepDisabler.get(); }
525
526     double maxBufferedTime() const;
527
528     MediaProducer::MediaStateFlags mediaState() const override;
529
530     void layoutSizeChanged();
531     void visibilityDidChange();
532
533     void allowsMediaDocumentInlinePlaybackChanged();
534     void updateShouldPlay();
535
536     RenderMedia* renderer() const;
537
538     void resetPlaybackSessionState();
539     bool isVisibleInViewport() const;
540     bool hasEverNotifiedAboutPlaying() const;
541     void setShouldDelayLoadEvent(bool);
542
543     bool hasEverHadAudio() const { return m_hasEverHadAudio; }
544     bool hasEverHadVideo() const { return m_hasEverHadVideo; }
545
546     double playbackStartedTime() const { return m_playbackStartedTime; }
547
548     bool isTemporarilyAllowingInlinePlaybackAfterFullscreen() const {return m_temporarilyAllowingInlinePlaybackAfterFullscreen; }
549
550     void isVisibleInViewportChanged();
551     void updateRateChangeRestrictions();
552
553     WEBCORE_EXPORT const MediaResourceLoader* lastMediaResourceLoaderForTesting() const;
554
555 #if ENABLE(MEDIA_STREAM)
556     void mediaStreamCaptureStarted() { resumeAutoplaying(); }
557     bool hasMediaStreamSrcObject() const { return m_mediaProvider && WTF::holds_alternative<RefPtr<MediaStream>>(*m_mediaProvider); }
558 #endif
559
560     bool supportsSeeking() const override;
561
562 #if !RELEASE_LOG_DISABLED
563     const Logger& logger() const final { return *m_logger.get(); }
564     const void* logIdentifier() const final { return m_logIdentifier; }
565     WTFLogChannel& logChannel() const final;
566 #endif
567
568     bool willLog(WTFLogLevel) const;
569
570     bool isSuspended() const final;
571
572     WEBCORE_EXPORT void didBecomeFullscreenElement() override;
573     WEBCORE_EXPORT void willExitFullscreen();
574
575     enum class AutoplayEventPlaybackState { None, PreventedAutoplay, StartedWithUserGesture, StartedWithoutUserGesture };
576
577     using HTMLElement::weakPtrFactory;
578
579 protected:
580     HTMLMediaElement(const QualifiedName&, Document&, bool createdByParser);
581     virtual void finishInitialization();
582     virtual ~HTMLMediaElement();
583
584     void parseAttribute(const QualifiedName&, const AtomicString&) override;
585     void finishParsingChildren() override;
586     bool isURLAttribute(const Attribute&) const override;
587     void willAttachRenderers() override;
588     void didAttachRenderers() override;
589     void willDetachRenderers() override;
590     void didDetachRenderers() override;
591
592     void didMoveToNewDocument(Document& oldDocument, Document& newDocument) override;
593
594     enum DisplayMode { Unknown, None, Poster, PosterWaitingForVideo, Video };
595     DisplayMode displayMode() const { return m_displayMode; }
596     virtual void setDisplayMode(DisplayMode mode) { m_displayMode = mode; }
597     
598     bool isMediaElement() const final { return true; }
599
600 #if ENABLE(VIDEO_TRACK)
601     bool ignoreTrackDisplayUpdateRequests() const { return m_ignoreTrackDisplayUpdate > 0 || !m_textTracks || !m_cueTree.size(); }
602     void beginIgnoringTrackDisplayUpdateRequests();
603     void endIgnoringTrackDisplayUpdateRequests();
604 #endif
605
606     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
607
608 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
609     bool mediaControlsDependOnPageScaleFactor() const { return m_mediaControlsDependOnPageScaleFactor; }
610     void setMediaControlsDependOnPageScaleFactor(bool);
611     void updateMediaControlsAfterPresentationModeChange();
612 #endif
613
614     void scheduleEvent(const AtomicString& eventName);
615
616 private:
617     void createMediaPlayer();
618
619     bool supportsFocus() const override;
620     bool isMouseFocusable() const override;
621     bool rendererIsNeeded(const RenderStyle&) override;
622     bool childShouldCreateRenderer(const Node&) const override;
623     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
624     void didFinishInsertingNode() override;
625     void removedFromAncestor(RemovalType, ContainerNode&) override;
626     void didRecalcStyle(Style::Change) override;
627
628     void willBecomeFullscreenElement() override;
629     void willStopBeingFullscreenElement() override;
630
631     // ActiveDOMObject API.
632     const char* activeDOMObjectName() const override;
633     bool canSuspendForDocumentSuspension() const override;
634     void suspend(ReasonForSuspension) override;
635     void resume() override;
636     void stop() override;
637     void stopWithoutDestroyingMediaPlayer();
638     void contextDestroyed() override;
639     
640     void mediaVolumeDidChange() override;
641
642     void visibilityStateChanged() override;
643
644     virtual void updateDisplayState() { }
645     
646     void setReadyState(MediaPlayerEnums::ReadyState);
647     void setNetworkState(MediaPlayerEnums::NetworkState);
648
649     double effectivePlaybackRate() const;
650     double requestedPlaybackRate() const;
651
652     void mediaPlayerNetworkStateChanged(MediaPlayer*) override;
653     void mediaPlayerReadyStateChanged(MediaPlayer*) override;
654     void mediaPlayerTimeChanged(MediaPlayer*) override;
655     void mediaPlayerVolumeChanged(MediaPlayer*) override;
656     void mediaPlayerMuteChanged(MediaPlayer*) override;
657     void mediaPlayerDurationChanged(MediaPlayer*) override;
658     void mediaPlayerRateChanged(MediaPlayer*) override;
659     void mediaPlayerPlaybackStateChanged(MediaPlayer*) override;
660     void mediaPlayerSawUnsupportedTracks(MediaPlayer*) override;
661     void mediaPlayerResourceNotSupported(MediaPlayer*) override;
662     void mediaPlayerRepaint(MediaPlayer*) override;
663     void mediaPlayerSizeChanged(MediaPlayer*) override;
664     bool mediaPlayerRenderingCanBeAccelerated(MediaPlayer*) override;
665     void mediaPlayerRenderingModeChanged(MediaPlayer*) override;
666     bool mediaPlayerAcceleratedCompositingEnabled() override;
667     void mediaPlayerEngineUpdated(MediaPlayer*) override;
668
669     void scheduleMediaEngineWasUpdated();
670     void mediaEngineWasUpdated();
671
672     void mediaPlayerFirstVideoFrameAvailable(MediaPlayer*) override;
673     void mediaPlayerCharacteristicChanged(MediaPlayer*) override;
674
675 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
676     RefPtr<ArrayBuffer> mediaPlayerCachedKeyForKeyId(const String& keyId) const override;
677     bool mediaPlayerKeyNeeded(MediaPlayer*, Uint8Array*) override;
678     String mediaPlayerMediaKeysStorageDirectory() const override;
679 #endif
680
681 #if ENABLE(ENCRYPTED_MEDIA)
682     void mediaPlayerInitializationDataEncountered(const String&, RefPtr<ArrayBuffer>&&) final;
683     void mediaPlayerWaitingForKeyChanged() final;
684
685     void attemptToDecrypt();
686     void attemptToResumePlaybackIfNecessary();
687
688     // CDMClient
689     void cdmClientAttemptToResumePlaybackIfNecessary() final;
690 #endif
691     
692 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
693     void mediaPlayerCurrentPlaybackTargetIsWirelessChanged(MediaPlayer*) override;
694     void enqueuePlaybackTargetAvailabilityChangedEvent();
695
696     using EventTarget::dispatchEvent;
697     void dispatchEvent(Event&) override;
698 #endif
699
700 #if ENABLE(MEDIA_SESSION)
701     void setSessionInternal(MediaSession&);
702 #endif
703
704     String mediaPlayerReferrer() const override;
705     String mediaPlayerUserAgent() const override;
706
707     void mediaPlayerEnterFullscreen() override;
708     void mediaPlayerExitFullscreen() override;
709     bool mediaPlayerIsFullscreen() const override;
710     bool mediaPlayerIsFullscreenPermitted() const override;
711     bool mediaPlayerIsVideo() const override;
712     LayoutRect mediaPlayerContentBoxRect() const override;
713     float mediaPlayerContentsScale() const override;
714     void mediaPlayerSetSize(const IntSize&) override;
715     void mediaPlayerPause() override;
716     void mediaPlayerPlay() override;
717     bool mediaPlayerPlatformVolumeConfigurationRequired() const override;
718     bool mediaPlayerIsPaused() const override;
719     bool mediaPlayerIsLooping() const override;
720     CachedResourceLoader* mediaPlayerCachedResourceLoader() override;
721     RefPtr<PlatformMediaResourceLoader> mediaPlayerCreateResourceLoader() override;
722     bool mediaPlayerShouldUsePersistentCache() const override;
723     const String& mediaPlayerMediaCacheDirectory() const override;
724
725 #if PLATFORM(WIN) && USE(AVFOUNDATION)
726     GraphicsDeviceAdapter* mediaPlayerGraphicsDeviceAdapter(const MediaPlayer*) const override;
727 #endif
728
729     void mediaPlayerActiveSourceBuffersChanged(const MediaPlayer*) override;
730
731     void mediaPlayerHandlePlaybackCommand(PlatformMediaSession::RemoteControlCommandType command) override { didReceiveRemoteControlCommand(command, nullptr); }
732     String sourceApplicationIdentifier() const override;
733     String mediaPlayerSourceApplicationIdentifier() const override { return sourceApplicationIdentifier(); }
734     Vector<String> mediaPlayerPreferredAudioCharacteristics() const override;
735
736 #if PLATFORM(IOS_FAMILY)
737     String mediaPlayerNetworkInterfaceName() const override;
738     bool mediaPlayerGetRawCookies(const URL&, Vector<Cookie>&) const override;
739 #endif
740
741     bool mediaPlayerIsInMediaDocument() const final;
742     void mediaPlayerEngineFailedToLoad() const final;
743
744     double mediaPlayerRequestedPlaybackRate() const final;
745     VideoFullscreenMode mediaPlayerFullscreenMode() const final { return fullscreenMode(); }
746     bool mediaPlayerIsVideoFullscreenStandby() const final { return m_videoFullscreenStandby; }
747     bool mediaPlayerShouldDisableSleep() const final { return shouldDisableSleep() == SleepType::Display; }
748     bool mediaPlayerShouldCheckHardwareSupport() const final;
749     const Vector<ContentType>& mediaContentTypesRequiringHardwareSupport() const final;
750
751 #if USE(GSTREAMER)
752     void requestInstallMissingPlugins(const String& details, const String& description, MediaPlayerRequestInstallMissingPluginsCallback&) final;
753 #endif
754
755     void pendingActionTimerFired();
756     void progressEventTimerFired();
757     void playbackProgressTimerFired();
758     void scanTimerFired();
759     void seekTask();
760     void startPlaybackProgressTimer();
761     void startProgressEventTimer();
762     void stopPeriodicTimers();
763     void cancelPendingTasks();
764     void closeTaskQueues();
765
766     void seek(const MediaTime&);
767     void seekInternal(const MediaTime&);
768     void seekWithTolerance(const MediaTime&, const MediaTime& negativeTolerance, const MediaTime& positiveTolerance, bool fromDOM);
769     void finishSeek();
770     void clearSeeking();
771     void addPlayedRange(const MediaTime& start, const MediaTime& end);
772     
773     void scheduleTimeupdateEvent(bool periodicEvent);
774     virtual void scheduleResizeEvent() { }
775     virtual void scheduleResizeEventIfSizeChanged() { }
776
777     void selectMediaResource();
778     void loadResource(const URL&, ContentType&, const String& keySystem);
779     void scheduleNextSourceChild();
780     void loadNextSourceChild();
781     void userCancelledLoad();
782     void clearMediaPlayer();
783     bool havePotentialSourceChild();
784     void noneSupported();
785     void cancelPendingEventsAndCallbacks();
786     void waitForSourceChange();
787     void prepareToPlay();
788
789     URL selectNextSourceChild(ContentType*, String* keySystem, InvalidURLAction);
790
791 #if ENABLE(VIDEO_TRACK)
792     void updateActiveTextTrackCues(const MediaTime&);
793     HTMLTrackElement* showingTrackWithSameKind(HTMLTrackElement*) const;
794
795     enum ReconfigureMode {
796         Immediately,
797         AfterDelay,
798     };
799     void markCaptionAndSubtitleTracksAsUnconfigured(ReconfigureMode);
800     void captionPreferencesChanged() override;
801     CaptionUserPreferences::CaptionDisplayMode captionDisplayMode();
802 #endif
803
804     // These "internal" functions do not check user gesture restrictions.
805     void playInternal();
806     void pauseInternal();
807
808     void prepareForLoad();
809     void allowVideoRendering();
810
811     bool processingMediaPlayerCallback() const { return m_processingMediaPlayerCallback > 0; }
812     void beginProcessingMediaPlayerCallback() { ++m_processingMediaPlayerCallback; }
813     void endProcessingMediaPlayerCallback() { ASSERT(m_processingMediaPlayerCallback); --m_processingMediaPlayerCallback; }
814
815     void scheduleUpdatePlayState();
816     void updatePlayState();
817
818     void updateVolume();
819     void setPlaying(bool);
820     bool potentiallyPlaying() const;
821     bool endedPlayback() const;
822     bool stoppedDueToErrors() const;
823     bool pausedForUserInteraction() const;
824     bool couldPlayIfEnoughData() const;
825     void dispatchPlayPauseEventsIfNeedsQuirks();
826     SuccessOr<MediaPlaybackDenialReason> canTransitionFromAutoplayToPlay() const;
827
828     void setAutoplayEventPlaybackState(AutoplayEventPlaybackState);
829     void userDidInterfereWithAutoplay();
830     void handleAutoplayEvent(AutoplayEvent);
831
832     MediaTime minTimeSeekable() const;
833     MediaTime maxTimeSeekable() const;
834
835     // Pauses playback without changing any states or generating events
836     void setPausedInternal(bool);
837
838     void setPlaybackRateInternal(double);
839
840     void mediaCanStart(Document&) final;
841
842     void invalidateCachedTime() const;
843     void refreshCachedTime() const;
844
845     bool hasMediaControls() const;
846     bool createMediaControls();
847     void configureMediaControls();
848
849     void prepareMediaFragmentURI();
850     void applyMediaFragmentURI();
851
852     void changeNetworkStateFromLoadingToIdle();
853
854     void removeBehaviorsRestrictionsAfterFirstUserGesture(MediaElementSession::BehaviorRestrictions mask = MediaElementSession::AllRestrictions);
855
856     void updateMediaController();
857     bool isBlocked() const;
858     bool isBlockedOnMediaController() const;
859     bool hasCurrentSrc() const override { return !m_currentSrc.isEmpty(); }
860     bool isLiveStream() const override { return movieLoadType() == MediaPlayerEnums::LiveStream; }
861
862     void updateSleepDisabling();
863     enum class SleepType {
864         None,
865         Display,
866         System,
867     };
868     SleepType shouldDisableSleep() const;
869
870 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
871     void didAddUserAgentShadowRoot(ShadowRoot&) override;
872     DOMWrapperWorld& ensureIsolatedWorld();
873     bool ensureMediaControlsInjectedScript();
874 #endif
875
876     PlatformMediaSession::MediaType mediaType() const override;
877     PlatformMediaSession::MediaType presentationType() const override;
878     PlatformMediaSession::DisplayType displayType() const override;
879     PlatformMediaSession::CharacteristicsFlags characteristics() const final;
880
881     void suspendPlayback() override;
882     void resumeAutoplaying() override;
883     void mayResumePlayback(bool shouldResume) override;
884     uint64_t mediaSessionUniqueIdentifier() const final;
885     String mediaSessionTitle() const override;
886     double mediaSessionDuration() const override { return duration(); }
887     double mediaSessionCurrentTime() const override { return currentTime(); }
888     bool canReceiveRemoteControlCommands() const override { return true; }
889     void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) override;
890     bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const override;
891     bool shouldOverrideBackgroundLoadingRestriction() const override;
892     bool canProduceAudio() const final;
893     bool processingUserGestureForMedia() const final;
894
895     void pageMutedStateDidChange() override;
896
897 #if USE(AUDIO_SESSION) && PLATFORM(MAC)
898     void hardwareMutedStateDidChange(AudioSession*) final;
899 #endif
900
901     bool effectiveMuted() const;
902
903     void registerWithDocument(Document&);
904     void unregisterWithDocument(Document&);
905
906     void updateCaptionContainer();
907     void ensureMediaControlsShadowRoot();
908
909     using JSSetupFunction = WTF::Function<bool(JSDOMGlobalObject&, JSC::ExecState&, ScriptController&, DOMWrapperWorld&)>;
910     bool setupAndCallJS(const JSSetupFunction&);
911
912 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
913     void prepareForDocumentSuspension() final;
914     void resumeFromDocumentSuspension() final;
915
916     void scheduleUpdateMediaState();
917     void updateMediaState();
918     bool hasPlaybackTargetAvailabilityListeners() const { return m_hasPlaybackTargetAvailabilityListeners; }
919 #endif
920
921     bool isVideoTooSmallForInlinePlayback();
922     void updateShouldAutoplay();
923
924     void pauseAfterDetachedTask();
925     void updatePlaybackControlsManager();
926     void schedulePlaybackControlsManagerUpdate();
927     void playbackControlsManagerBehaviorRestrictionsTimerFired();
928
929     void updateRenderer();
930
931     void updatePageScaleFactorJSProperty();
932     void updateUsesLTRUserInterfaceLayoutDirectionJSProperty();
933     void setControllerJSProperty(const char*, JSC::JSValue);
934
935     void addBehaviorRestrictionsOnEndIfNecessary();
936     void handleSeekToPlaybackPosition(double);
937     void seekToPlaybackPositionEndedTimerFired();
938
939     void applicationWillResignActive() final;
940     void applicationDidBecomeActive() final;
941
942     void setInActiveDocument(bool);
943
944 #if !RELEASE_LOG_DISABLED
945     const char* logClassName() const final { return "HTMLMediaElement"; }
946
947     const void* mediaPlayerLogIdentifier() final { return logIdentifier(); }
948     const Logger& mediaPlayerLogger() final { return logger(); }
949 #endif
950
951     Timer m_progressEventTimer;
952     Timer m_playbackProgressTimer;
953     Timer m_scanTimer;
954     Timer m_playbackControlsManagerBehaviorRestrictionsTimer;
955     Timer m_seekToPlaybackPositionEndedTimer;
956     DeferrableTask<Timer> m_configureTextTracksTask;
957     DeferrableTask<Timer> m_checkPlaybackTargetCompatablityTask;
958     DeferrableTask<Timer> m_updateMediaStateTask;
959     DeferrableTask<Timer> m_mediaEngineUpdatedTask;
960     DeferrableTask<Timer> m_updatePlayStateTask;
961     DeferrableTask<Timer> m_resumeTaskQueue;
962     DeferrableTask<Timer> m_seekTaskQueue;
963     DeferrableTask<Timer> m_playbackControlsManagerBehaviorRestrictionsQueue;
964     GenericTaskQueue<Timer> m_promiseTaskQueue;
965     GenericTaskQueue<Timer> m_pauseAfterDetachedTaskQueue;
966     GenericTaskQueue<Timer> m_resourceSelectionTaskQueue;
967     GenericTaskQueue<Timer> m_visibilityChangeTaskQueue;
968     GenericTaskQueue<Timer> m_fullscreenTaskQueue;
969     GenericTaskQueue<Timer> m_playbackTargetIsWirelessQueue;
970     RefPtr<TimeRanges> m_playedTimeRanges;
971     GenericEventQueue m_asyncEventQueue;
972 #if PLATFORM(IOS_FAMILY)
973     DeferrableTask<Timer> m_volumeRevertTaskQueue;
974 #endif
975
976     PlayPromiseVector m_pendingPlayPromises;
977
978     double m_requestedPlaybackRate { 1 };
979     double m_reportedPlaybackRate { 1 };
980     double m_defaultPlaybackRate { 1 };
981     bool m_webkitPreservesPitch { true };
982     NetworkState m_networkState { NETWORK_EMPTY };
983     ReadyState m_readyState { HAVE_NOTHING };
984     ReadyState m_readyStateMaximum { HAVE_NOTHING };
985     URL m_currentSrc;
986
987     RefPtr<MediaError> m_error;
988
989     struct PendingSeek {
990         PendingSeek(const MediaTime& now, const MediaTime& targetTime, const MediaTime& negativeTolerance, const MediaTime& positiveTolerance)
991             : now(now)
992             , targetTime(targetTime)
993             , negativeTolerance(negativeTolerance)
994             , positiveTolerance(positiveTolerance)
995         {
996         }
997         MediaTime now;
998         MediaTime targetTime;
999         MediaTime negativeTolerance;
1000         MediaTime positiveTolerance;
1001     };
1002     std::unique_ptr<PendingSeek> m_pendingSeek;
1003     SeekType m_pendingSeekType { NoSeek };
1004
1005     double m_volume { 1 };
1006     bool m_volumeInitialized { false };
1007     MediaTime m_lastSeekTime;
1008     
1009     MonotonicTime m_previousProgressTime { MonotonicTime::infinity() };
1010     double m_playbackStartedTime { 0 };
1011
1012     // The last time a timeupdate event was sent (based on monotonic clock).
1013     MonotonicTime m_clockTimeAtLastUpdateEvent;
1014
1015     // The last time a timeupdate event was sent in movie time.
1016     MediaTime m_lastTimeUpdateEventMovieTime;
1017     
1018     // Loading state.
1019     enum LoadState { WaitingForSource, LoadingFromSrcAttr, LoadingFromSourceElement };
1020     LoadState m_loadState { WaitingForSource };
1021     RefPtr<HTMLSourceElement> m_currentSourceNode;
1022     RefPtr<HTMLSourceElement> m_nextChildNodeToConsider;
1023
1024     VideoFullscreenMode m_videoFullscreenMode { VideoFullscreenModeNone };
1025     bool m_videoFullscreenStandby { false };
1026     bool m_preparedForInline;
1027     WTF::Function<void()> m_preparedForInlineCompletionHandler;
1028
1029     bool m_temporarilyAllowingInlinePlaybackAfterFullscreen { false };
1030
1031 #if PLATFORM(IOS_FAMILY) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
1032     RetainPtr<PlatformLayer> m_videoFullscreenLayer;
1033     FloatRect m_videoFullscreenFrame;
1034     MediaPlayerEnums::VideoGravity m_videoFullscreenGravity { MediaPlayer::VideoGravityResizeAspect };
1035 #endif
1036
1037     RefPtr<MediaPlayer> m_player;
1038
1039     MediaPlayerEnums::Preload m_preload { MediaPlayer::Auto };
1040
1041     DisplayMode m_displayMode { Unknown };
1042
1043     // Counter incremented while processing a callback from the media player, so we can avoid
1044     // calling the media engine recursively.
1045     int m_processingMediaPlayerCallback { 0 };
1046
1047 #if ENABLE(MEDIA_SESSION)
1048     String m_kind;
1049     RefPtr<MediaSession> m_session;
1050     bool m_shouldDuck { false };
1051     uint64_t m_elementID;
1052 #endif
1053
1054 #if ENABLE(MEDIA_SOURCE)
1055     RefPtr<MediaSource> m_mediaSource;
1056     unsigned m_droppedVideoFrames { 0 };
1057 #endif
1058
1059     mutable MediaTime m_cachedTime;
1060     mutable MonotonicTime m_clockTimeAtLastCachedTimeUpdate;
1061     mutable MonotonicTime m_minimumClockTimeToUpdateCachedTime;
1062
1063     MediaTime m_fragmentStartTime;
1064     MediaTime m_fragmentEndTime;
1065
1066     using PendingActionFlags = unsigned;
1067     PendingActionFlags m_pendingActionFlags { 0 };
1068
1069     enum ActionAfterScanType { Nothing, Play, Pause };
1070     ActionAfterScanType m_actionAfterScan { Nothing };
1071
1072     enum ScanType { Seek, Scan };
1073     ScanType m_scanType { Scan };
1074     ScanDirection m_scanDirection { Forward };
1075
1076     BufferingPolicy m_bufferingPolicy { BufferingPolicy::Default };
1077
1078     bool m_firstTimePlaying : 1;
1079     bool m_playing : 1;
1080     bool m_isWaitingUntilMediaCanStart : 1;
1081     bool m_shouldDelayLoadEvent : 1;
1082     bool m_haveFiredLoadedData : 1;
1083     bool m_inActiveDocument : 1;
1084     bool m_autoplaying : 1;
1085     bool m_muted : 1;
1086     bool m_explicitlyMuted : 1;
1087     bool m_initiallyMuted : 1;
1088     bool m_paused : 1;
1089     bool m_seeking : 1;
1090     bool m_seekRequested : 1;
1091
1092     // data has not been loaded since sending a "stalled" event
1093     bool m_sentStalledEvent : 1;
1094
1095     // time has not changed since sending an "ended" event
1096     bool m_sentEndEvent : 1;
1097
1098     bool m_pausedInternal : 1;
1099
1100     bool m_closedCaptionsVisible : 1;
1101     bool m_webkitLegacyClosedCaptionOverride : 1;
1102     bool m_completelyLoaded : 1;
1103     bool m_havePreparedToPlay : 1;
1104     bool m_parsingInProgress : 1;
1105     bool m_elementIsHidden : 1;
1106     bool m_elementWasRemovedFromDOM : 1;
1107     bool m_creatingControls : 1;
1108     bool m_receivedLayoutSizeChanged : 1;
1109     bool m_hasEverNotifiedAboutPlaying : 1;
1110
1111     bool m_hasEverHadAudio : 1;
1112     bool m_hasEverHadVideo : 1;
1113
1114 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
1115     bool m_mediaControlsDependOnPageScaleFactor : 1;
1116     bool m_haveSetUpCaptionContainer : 1;
1117 #endif
1118
1119     bool m_isScrubbingRemotely : 1;
1120     bool m_waitingToEnterFullscreen : 1;
1121
1122 #if ENABLE(VIDEO_TRACK)
1123     bool m_tracksAreReady : 1;
1124     bool m_haveVisibleTextTrack : 1;
1125     bool m_processingPreferenceChange : 1;
1126
1127     AutoplayEventPlaybackState m_autoplayEventPlaybackState { AutoplayEventPlaybackState::None };
1128
1129     String m_subtitleTrackLanguage;
1130     MediaTime m_lastTextTrackUpdateTime { -1, 1 };
1131
1132     Optional<CaptionUserPreferences::CaptionDisplayMode> m_captionDisplayMode;
1133
1134     RefPtr<AudioTrackList> m_audioTracks;
1135     RefPtr<TextTrackList> m_textTracks;
1136     RefPtr<VideoTrackList> m_videoTracks;
1137     Vector<RefPtr<TextTrack>> m_textTracksWhenResourceSelectionBegan;
1138
1139     CueIntervalTree m_cueTree;
1140
1141     CueList m_currentlyActiveCues;
1142     int m_ignoreTrackDisplayUpdate { 0 };
1143
1144     bool m_requireCaptionPreferencesChangedCallbacks { false };
1145 #endif
1146
1147 #if ENABLE(WEB_AUDIO)
1148     // This is a weak reference, since m_audioSourceNode holds a reference to us.
1149     // The value is set just after the MediaElementAudioSourceNode is created.
1150     // The value is cleared in MediaElementAudioSourceNode::~MediaElementAudioSourceNode().
1151     MediaElementAudioSourceNode* m_audioSourceNode { nullptr };
1152 #endif
1153
1154     String m_mediaGroup;
1155     friend class MediaController;
1156     RefPtr<MediaController> m_mediaController;
1157
1158     std::unique_ptr<PAL::SleepDisabler> m_sleepDisabler;
1159
1160     WeakPtr<const MediaResourceLoader> m_lastMediaResourceLoaderForTesting;
1161
1162     friend class TrackDisplayUpdateScope;
1163
1164     RefPtr<Blob> m_blob;
1165     MediaProvider m_mediaProvider;
1166
1167 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
1168     RefPtr<WebKitMediaKeys> m_webKitMediaKeys;
1169 #endif
1170 #if ENABLE(ENCRYPTED_MEDIA)
1171     RefPtr<MediaKeys> m_mediaKeys;
1172     bool m_attachingMediaKeys { false };
1173     bool m_playbackBlockedWaitingForKey { false };
1174     GenericTaskQueue<Timer> m_encryptedMediaQueue;
1175 #endif
1176
1177     std::unique_ptr<MediaElementSession> m_mediaSession;
1178     size_t m_reportedExtraMemoryCost { 0 };
1179
1180 #if !RELEASE_LOG_DISABLED
1181     RefPtr<Logger> m_logger;
1182     const void* m_logIdentifier;
1183 #endif
1184
1185 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
1186     friend class MediaControlsHost;
1187     RefPtr<MediaControlsHost> m_mediaControlsHost;
1188     RefPtr<DOMWrapperWorld> m_isolatedWorld;
1189 #endif
1190
1191 #if ENABLE(MEDIA_STREAM)
1192     RefPtr<MediaStream> m_mediaStreamSrcObject;
1193     bool m_settingMediaStreamSrcObject { false };
1194 #endif
1195
1196 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
1197     MediaProducer::MediaStateFlags m_mediaState { MediaProducer::IsNotPlaying };
1198     bool m_hasPlaybackTargetAvailabilityListeners { false };
1199     bool m_failedToPlayToWirelessTarget { false };
1200 #endif
1201
1202     bool m_isPlayingToWirelessTarget { false };
1203     bool m_playingOnSecondScreen { false };
1204 };
1205
1206 String convertEnumerationToString(HTMLMediaElement::AutoplayEventPlaybackState);
1207
1208 } // namespace WebCore
1209
1210 namespace WTF {
1211
1212 template<> struct LogArgument<WebCore::HTMLMediaElement::AutoplayEventPlaybackState> {
1213     static String toString(WebCore::HTMLMediaElement::AutoplayEventPlaybackState reason) { return convertEnumerationToString(reason); }
1214 };
1215
1216 #if ENABLE(VIDEO_TRACK) && !defined(NDEBUG)
1217
1218 // Template specialization required by PodIntervalTree in debug mode.
1219 template<> struct ValueToString<WebCore::TextTrackCue*> {
1220     static String string(const WebCore::TextTrackCue* cue) { return cue->debugString(); }
1221 };
1222
1223 #endif
1224
1225 #ifndef NDEBUG
1226
1227 template<> struct ValueToString<MediaTime> {
1228     static String string(const MediaTime& time) { return toString(time); }
1229 };
1230
1231 #endif
1232
1233 } // namespace WTF
1234
1235 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLMediaElement)
1236     static bool isType(const WebCore::Element& element) { return element.isMediaElement(); }
1237     static bool isType(const WebCore::Node& node) { return is<WebCore::Element>(node) && isType(downcast<WebCore::Element>(node)); }
1238 SPECIALIZE_TYPE_TRAITS_END()
1239
1240 #endif