2fff3633083a64099289e2a5795933deba595bdb
[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     const char* logClassName() const final { return "HTMLMediaElement"; }
566     WTFLogChannel& logChannel() const final;
567 #endif
568
569     bool willLog(WTFLogLevel) const;
570
571     bool isSuspended() const final;
572
573     WEBCORE_EXPORT void didBecomeFullscreenElement() override;
574     WEBCORE_EXPORT void willExitFullscreen();
575
576     enum class AutoplayEventPlaybackState { None, PreventedAutoplay, StartedWithUserGesture, StartedWithoutUserGesture };
577
578     using HTMLElement::weakPtrFactory;
579
580 protected:
581     HTMLMediaElement(const QualifiedName&, Document&, bool createdByParser);
582     virtual void finishInitialization();
583     virtual ~HTMLMediaElement();
584
585     void parseAttribute(const QualifiedName&, const AtomicString&) override;
586     void finishParsingChildren() override;
587     bool isURLAttribute(const Attribute&) const override;
588     void willAttachRenderers() override;
589     void didAttachRenderers() override;
590     void willDetachRenderers() override;
591     void didDetachRenderers() override;
592
593     void didMoveToNewDocument(Document& oldDocument, Document& newDocument) override;
594
595     enum DisplayMode { Unknown, None, Poster, PosterWaitingForVideo, Video };
596     DisplayMode displayMode() const { return m_displayMode; }
597     virtual void setDisplayMode(DisplayMode mode) { m_displayMode = mode; }
598     
599     bool isMediaElement() const final { return true; }
600
601 #if ENABLE(VIDEO_TRACK)
602     bool ignoreTrackDisplayUpdateRequests() const { return m_ignoreTrackDisplayUpdate > 0 || !m_textTracks || !m_cueTree.size(); }
603     void beginIgnoringTrackDisplayUpdateRequests();
604     void endIgnoringTrackDisplayUpdateRequests();
605 #endif
606
607     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
608
609 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
610     bool mediaControlsDependOnPageScaleFactor() const { return m_mediaControlsDependOnPageScaleFactor; }
611     void setMediaControlsDependOnPageScaleFactor(bool);
612     void updateMediaControlsAfterPresentationModeChange();
613 #endif
614
615     void scheduleEvent(const AtomicString& eventName);
616
617 private:
618     void createMediaPlayer();
619
620     bool supportsFocus() const override;
621     bool isMouseFocusable() const override;
622     bool rendererIsNeeded(const RenderStyle&) override;
623     bool childShouldCreateRenderer(const Node&) const override;
624     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
625     void didFinishInsertingNode() override;
626     void removedFromAncestor(RemovalType, ContainerNode&) override;
627     void didRecalcStyle(Style::Change) override;
628
629     void willBecomeFullscreenElement() override;
630     void willStopBeingFullscreenElement() override;
631
632     // ActiveDOMObject API.
633     const char* activeDOMObjectName() const override;
634     bool canSuspendForDocumentSuspension() const override;
635     void suspend(ReasonForSuspension) override;
636     void resume() override;
637     void stop() override;
638     void stopWithoutDestroyingMediaPlayer();
639     void contextDestroyed() override;
640     
641     void mediaVolumeDidChange() override;
642
643     void visibilityStateChanged() override;
644
645     virtual void updateDisplayState() { }
646     
647     void setReadyState(MediaPlayerEnums::ReadyState);
648     void setNetworkState(MediaPlayerEnums::NetworkState);
649
650     double effectivePlaybackRate() const;
651     double requestedPlaybackRate() const;
652
653     void mediaPlayerNetworkStateChanged(MediaPlayer*) override;
654     void mediaPlayerReadyStateChanged(MediaPlayer*) override;
655     void mediaPlayerTimeChanged(MediaPlayer*) override;
656     void mediaPlayerVolumeChanged(MediaPlayer*) override;
657     void mediaPlayerMuteChanged(MediaPlayer*) override;
658     void mediaPlayerDurationChanged(MediaPlayer*) override;
659     void mediaPlayerRateChanged(MediaPlayer*) override;
660     void mediaPlayerPlaybackStateChanged(MediaPlayer*) override;
661     void mediaPlayerSawUnsupportedTracks(MediaPlayer*) override;
662     void mediaPlayerResourceNotSupported(MediaPlayer*) override;
663     void mediaPlayerRepaint(MediaPlayer*) override;
664     void mediaPlayerSizeChanged(MediaPlayer*) override;
665     bool mediaPlayerRenderingCanBeAccelerated(MediaPlayer*) override;
666     void mediaPlayerRenderingModeChanged(MediaPlayer*) override;
667     bool mediaPlayerAcceleratedCompositingEnabled() override;
668     void mediaPlayerEngineUpdated(MediaPlayer*) override;
669
670     void scheduleMediaEngineWasUpdated();
671     void mediaEngineWasUpdated();
672
673     void mediaPlayerFirstVideoFrameAvailable(MediaPlayer*) override;
674     void mediaPlayerCharacteristicChanged(MediaPlayer*) override;
675
676 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
677     RefPtr<ArrayBuffer> mediaPlayerCachedKeyForKeyId(const String& keyId) const override;
678     bool mediaPlayerKeyNeeded(MediaPlayer*, Uint8Array*) override;
679     String mediaPlayerMediaKeysStorageDirectory() const override;
680 #endif
681
682 #if ENABLE(ENCRYPTED_MEDIA)
683     void mediaPlayerInitializationDataEncountered(const String&, RefPtr<ArrayBuffer>&&) final;
684     void mediaPlayerWaitingForKeyChanged() final;
685
686     void attemptToDecrypt();
687     void attemptToResumePlaybackIfNecessary();
688
689     // CDMClient
690     void cdmClientAttemptToResumePlaybackIfNecessary() final;
691 #endif
692     
693 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
694     void mediaPlayerCurrentPlaybackTargetIsWirelessChanged(MediaPlayer*) override;
695     void enqueuePlaybackTargetAvailabilityChangedEvent();
696
697     using EventTarget::dispatchEvent;
698     void dispatchEvent(Event&) override;
699 #endif
700
701 #if ENABLE(MEDIA_SESSION)
702     void setSessionInternal(MediaSession&);
703 #endif
704
705     String mediaPlayerReferrer() const override;
706     String mediaPlayerUserAgent() const override;
707
708     void mediaPlayerEnterFullscreen() override;
709     void mediaPlayerExitFullscreen() override;
710     bool mediaPlayerIsFullscreen() const override;
711     bool mediaPlayerIsFullscreenPermitted() const override;
712     bool mediaPlayerIsVideo() const override;
713     LayoutRect mediaPlayerContentBoxRect() const override;
714     float mediaPlayerContentsScale() const override;
715     void mediaPlayerSetSize(const IntSize&) override;
716     void mediaPlayerPause() override;
717     void mediaPlayerPlay() override;
718     bool mediaPlayerPlatformVolumeConfigurationRequired() const override;
719     bool mediaPlayerIsPaused() const override;
720     bool mediaPlayerIsLooping() const override;
721     CachedResourceLoader* mediaPlayerCachedResourceLoader() override;
722     RefPtr<PlatformMediaResourceLoader> mediaPlayerCreateResourceLoader() override;
723     bool mediaPlayerShouldUsePersistentCache() const override;
724     const String& mediaPlayerMediaCacheDirectory() const override;
725
726 #if PLATFORM(WIN) && USE(AVFOUNDATION)
727     GraphicsDeviceAdapter* mediaPlayerGraphicsDeviceAdapter(const MediaPlayer*) const override;
728 #endif
729
730     void mediaPlayerActiveSourceBuffersChanged(const MediaPlayer*) override;
731
732     void mediaPlayerHandlePlaybackCommand(PlatformMediaSession::RemoteControlCommandType command) override { didReceiveRemoteControlCommand(command, nullptr); }
733     String sourceApplicationIdentifier() const override;
734     String mediaPlayerSourceApplicationIdentifier() const override { return sourceApplicationIdentifier(); }
735     Vector<String> mediaPlayerPreferredAudioCharacteristics() const override;
736
737 #if PLATFORM(IOS_FAMILY)
738     String mediaPlayerNetworkInterfaceName() const override;
739     bool mediaPlayerGetRawCookies(const URL&, Vector<Cookie>&) const override;
740 #endif
741
742     bool mediaPlayerIsInMediaDocument() const final;
743     void mediaPlayerEngineFailedToLoad() const final;
744
745     double mediaPlayerRequestedPlaybackRate() const final;
746     VideoFullscreenMode mediaPlayerFullscreenMode() const final { return fullscreenMode(); }
747     bool mediaPlayerIsVideoFullscreenStandby() const final { return m_videoFullscreenStandby; }
748     bool mediaPlayerShouldDisableSleep() const final { return shouldDisableSleep() == SleepType::Display; }
749     bool mediaPlayerShouldCheckHardwareSupport() const final;
750     const Vector<ContentType>& mediaContentTypesRequiringHardwareSupport() const final;
751
752 #if USE(GSTREAMER)
753     void requestInstallMissingPlugins(const String& details, const String& description, MediaPlayerRequestInstallMissingPluginsCallback&) final;
754 #endif
755
756     void pendingActionTimerFired();
757     void progressEventTimerFired();
758     void playbackProgressTimerFired();
759     void scanTimerFired();
760     void seekTask();
761     void startPlaybackProgressTimer();
762     void startProgressEventTimer();
763     void stopPeriodicTimers();
764     void cancelPendingTasks();
765     void closeTaskQueues();
766
767     void seek(const MediaTime&);
768     void seekInternal(const MediaTime&);
769     void seekWithTolerance(const MediaTime&, const MediaTime& negativeTolerance, const MediaTime& positiveTolerance, bool fromDOM);
770     void finishSeek();
771     void clearSeeking();
772     void addPlayedRange(const MediaTime& start, const MediaTime& end);
773     
774     void scheduleTimeupdateEvent(bool periodicEvent);
775     virtual void scheduleResizeEvent() { }
776     virtual void scheduleResizeEventIfSizeChanged() { }
777
778     void selectMediaResource();
779     void loadResource(const URL&, ContentType&, const String& keySystem);
780     void scheduleNextSourceChild();
781     void loadNextSourceChild();
782     void userCancelledLoad();
783     void clearMediaPlayer();
784     bool havePotentialSourceChild();
785     void noneSupported();
786     void cancelPendingEventsAndCallbacks();
787     void waitForSourceChange();
788     void prepareToPlay();
789
790     URL selectNextSourceChild(ContentType*, String* keySystem, InvalidURLAction);
791
792 #if ENABLE(VIDEO_TRACK)
793     void updateActiveTextTrackCues(const MediaTime&);
794     HTMLTrackElement* showingTrackWithSameKind(HTMLTrackElement*) const;
795
796     enum ReconfigureMode {
797         Immediately,
798         AfterDelay,
799     };
800     void markCaptionAndSubtitleTracksAsUnconfigured(ReconfigureMode);
801     void captionPreferencesChanged() override;
802     CaptionUserPreferences::CaptionDisplayMode captionDisplayMode();
803 #endif
804
805     // These "internal" functions do not check user gesture restrictions.
806     void playInternal();
807     void pauseInternal();
808
809     void prepareForLoad();
810     void allowVideoRendering();
811
812     bool processingMediaPlayerCallback() const { return m_processingMediaPlayerCallback > 0; }
813     void beginProcessingMediaPlayerCallback() { ++m_processingMediaPlayerCallback; }
814     void endProcessingMediaPlayerCallback() { ASSERT(m_processingMediaPlayerCallback); --m_processingMediaPlayerCallback; }
815
816     void scheduleUpdatePlayState();
817     void updatePlayState();
818
819     void updateVolume();
820     void setPlaying(bool);
821     bool potentiallyPlaying() const;
822     bool endedPlayback() const;
823     bool stoppedDueToErrors() const;
824     bool pausedForUserInteraction() const;
825     bool couldPlayIfEnoughData() const;
826     void dispatchPlayPauseEventsIfNeedsQuirks();
827     SuccessOr<MediaPlaybackDenialReason> canTransitionFromAutoplayToPlay() const;
828
829     void setAutoplayEventPlaybackState(AutoplayEventPlaybackState);
830     void userDidInterfereWithAutoplay();
831     void handleAutoplayEvent(AutoplayEvent);
832
833     MediaTime minTimeSeekable() const;
834     MediaTime maxTimeSeekable() const;
835
836     // Pauses playback without changing any states or generating events
837     void setPausedInternal(bool);
838
839     void setPlaybackRateInternal(double);
840
841     void mediaCanStart(Document&) final;
842
843     void invalidateCachedTime() const;
844     void refreshCachedTime() const;
845
846     bool hasMediaControls() const;
847     bool createMediaControls();
848     void configureMediaControls();
849
850     void prepareMediaFragmentURI();
851     void applyMediaFragmentURI();
852
853     void changeNetworkStateFromLoadingToIdle();
854
855     void removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::BehaviorRestrictions mask = MediaElementSession::AllRestrictions);
856
857     void updateMediaController();
858     bool isBlocked() const;
859     bool isBlockedOnMediaController() const;
860     bool hasCurrentSrc() const override { return !m_currentSrc.isEmpty(); }
861     bool isLiveStream() const override { return movieLoadType() == MediaPlayerEnums::LiveStream; }
862
863     void updateSleepDisabling();
864     enum class SleepType {
865         None,
866         Display,
867         System,
868     };
869     SleepType shouldDisableSleep() const;
870
871 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
872     void didAddUserAgentShadowRoot(ShadowRoot&) override;
873     DOMWrapperWorld& ensureIsolatedWorld();
874     bool ensureMediaControlsInjectedScript();
875 #endif
876
877     PlatformMediaSession::MediaType mediaType() const override;
878     PlatformMediaSession::MediaType presentationType() const override;
879     PlatformMediaSession::DisplayType displayType() const override;
880     PlatformMediaSession::CharacteristicsFlags characteristics() const final;
881
882     void suspendPlayback() override;
883     void resumeAutoplaying() override;
884     void mayResumePlayback(bool shouldResume) override;
885     uint64_t mediaSessionUniqueIdentifier() const final;
886     String mediaSessionTitle() const override;
887     double mediaSessionDuration() const override { return duration(); }
888     double mediaSessionCurrentTime() const override { return currentTime(); }
889     bool canReceiveRemoteControlCommands() const override { return true; }
890     void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) override;
891     bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const override;
892     bool shouldOverrideBackgroundLoadingRestriction() const override;
893     bool canProduceAudio() const final;
894     bool processingUserGestureForMedia() const final;
895     bool hasMediaStreamSource() const final;
896
897     void pageMutedStateDidChange() override;
898
899 #if USE(AUDIO_SESSION) && PLATFORM(MAC)
900     void hardwareMutedStateDidChange(AudioSession*) final;
901 #endif
902
903     bool effectiveMuted() const;
904
905     void registerWithDocument(Document&);
906     void unregisterWithDocument(Document&);
907
908     void updateCaptionContainer();
909     void ensureMediaControlsShadowRoot();
910
911     using JSSetupFunction = WTF::Function<bool(JSDOMGlobalObject&, JSC::ExecState&, ScriptController&, DOMWrapperWorld&)>;
912     bool setupAndCallJS(const JSSetupFunction&);
913
914 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
915     void prepareForDocumentSuspension() final;
916     void resumeFromDocumentSuspension() final;
917
918     void scheduleUpdateMediaState();
919     void updateMediaState();
920     bool hasPlaybackTargetAvailabilityListeners() const { return m_hasPlaybackTargetAvailabilityListeners; }
921 #endif
922
923     bool isVideoTooSmallForInlinePlayback();
924     void updateShouldAutoplay();
925
926     void pauseAfterDetachedTask();
927     void updatePlaybackControlsManager();
928     void schedulePlaybackControlsManagerUpdate();
929     void playbackControlsManagerBehaviorRestrictionsTimerFired();
930
931     void updateRenderer();
932
933     void updatePageScaleFactorJSProperty();
934     void updateUsesLTRUserInterfaceLayoutDirectionJSProperty();
935     void setControllerJSProperty(const char*, JSC::JSValue);
936
937     void addBehaviorRestrictionsOnEndIfNecessary();
938     void handleSeekToPlaybackPosition(double);
939     void seekToPlaybackPositionEndedTimerFired();
940
941     void applicationWillResignActive() final;
942     void applicationDidBecomeActive() final;
943
944     void setInActiveDocument(bool);
945
946 #if !RELEASE_LOG_DISABLED
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     bool m_removedBehaviorRestrictionsAfterFirstUserGesture { false };
1205 };
1206
1207 String convertEnumerationToString(HTMLMediaElement::AutoplayEventPlaybackState);
1208
1209 } // namespace WebCore
1210
1211 namespace WTF {
1212
1213 template<> struct LogArgument<WebCore::HTMLMediaElement::AutoplayEventPlaybackState> {
1214     static String toString(WebCore::HTMLMediaElement::AutoplayEventPlaybackState reason) { return convertEnumerationToString(reason); }
1215 };
1216
1217 #if ENABLE(VIDEO_TRACK) && !defined(NDEBUG)
1218
1219 // Template specialization required by PodIntervalTree in debug mode.
1220 template<> struct ValueToString<WebCore::TextTrackCue*> {
1221     static String string(const WebCore::TextTrackCue* cue) { return cue->debugString(); }
1222 };
1223
1224 #endif
1225
1226 #ifndef NDEBUG
1227
1228 template<> struct ValueToString<MediaTime> {
1229     static String string(const MediaTime& time) { return toString(time); }
1230 };
1231
1232 #endif
1233
1234 } // namespace WTF
1235
1236 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLMediaElement)
1237     static bool isType(const WebCore::Element& element) { return element.isMediaElement(); }
1238     static bool isType(const WebCore::Node& node) { return is<WebCore::Element>(node) && isType(downcast<WebCore::Element>(node)); }
1239 SPECIALIZE_TYPE_TRAITS_END()
1240
1241 #endif