forked from WebKit/WebKit-http
-
Notifications
You must be signed in to change notification settings - Fork 157
Expand file tree
/
Copy pathHTMLMediaElement.h
More file actions
1450 lines (1130 loc) · 52.3 KB
/
HTMLMediaElement.h
File metadata and controls
1450 lines (1130 loc) · 52.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2007-2023 Apple Inc. All rights reserved.
* Copyright (C) 2015 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(VIDEO)
#include "ActiveDOMObject.h"
#include "AudioSession.h"
#include "AudioTrackClient.h"
#include "AutoplayEvent.h"
#include "CaptionUserPreferences.h"
#include "HTMLElement.h"
#include "HTMLMediaElementEnums.h"
#include "HTMLMediaElementIdentifier.h"
#include "MediaCanStartListener.h"
#include "MediaControllerInterface.h"
#include "MediaElementSession.h"
#include "MediaPlayer.h"
#include "MediaProducer.h"
#include "MediaResourceSniffer.h"
#include "MediaUniqueIdentifier.h"
#include "ReducedResolutionSeconds.h"
#include "TextTrackClient.h"
#include "URLKeepingBlobAlive.h"
#include "VideoTrackClient.h"
#include "VisibilityChangeClient.h"
#include <wtf/Forward.h>
#include <wtf/Function.h>
#include <wtf/Identified.h>
#include <wtf/LoggerHelper.h>
#include <wtf/Observer.h>
#include <wtf/WallTime.h>
#include <wtf/WeakPtr.h>
#if USE(AUDIO_SESSION) && PLATFORM(MAC)
#include "AudioSession.h"
#endif
#if ENABLE(ENCRYPTED_MEDIA)
#include "CDMClient.h"
#endif
#ifndef NDEBUG
#include <wtf/StringPrintStream.h>
#endif
namespace WTF {
class MachSendRight;
}
namespace JSC {
class JSValue;
}
namespace PAL {
class SessionID;
}
namespace WebCore {
class AudioSourceProvider;
class AudioTrackList;
class AudioTrackPrivate;
class Blob;
class DOMException;
class DOMWrapperWorld;
class DeferredPromise;
class Event;
class HTMLSourceElement;
class HTMLTrackElement;
class InbandTextTrackPrivate;
class JSDOMGlobalObject;
class MediaController;
class MediaControls;
class MediaControlsHost;
class MediaElementAudioSourceNode;
class MediaError;
class MediaKeys;
class MediaResourceLoader;
class MediaSession;
class MediaSource;
class MediaSourceHandle;
class MediaSourceInterfaceProxy;
class MediaStream;
class PausableIntervalTimer;
class RenderMedia;
class ScriptController;
class ScriptExecutionContext;
class SleepDisabler;
class SourceBuffer;
class SpeechSynthesis;
class TextTrackList;
class TimeRanges;
class VideoPlaybackQuality;
class VideoTrackList;
class VideoTrackPrivate;
class WebKitMediaKeys;
enum class DynamicRangeMode : uint8_t;
template<typename> class DOMPromiseDeferred;
template<typename, typename> class PODInterval;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
class RemotePlayback;
#endif
using CueInterval = PODInterval<MediaTime, TextTrackCue*>;
using CueList = Vector<CueInterval>;
enum class HTMLMediaElementSourceType : uint8_t {
File,
HLS,
MediaSource,
ManagedMediaSource,
MediaStream,
LiveStream,
StoredStream,
};
using MediaProvider = std::optional < std::variant <
#if ENABLE(MEDIA_STREAM)
RefPtr<MediaStream>,
#endif
#if ENABLE(MEDIA_SOURCE)
RefPtr<MediaSource>,
#endif
#if ENABLE(MEDIA_SOURCE_IN_WORKERS)
RefPtr<MediaSourceHandle>,
#endif
RefPtr<Blob>>>;
class HTMLMediaElement
: public HTMLElement
, public ActiveDOMObject
, public MediaControllerInterface
, public PlatformMediaSessionClient
, public Identified<HTMLMediaElementIdentifier>
, private MediaCanStartListener
, private MediaPlayerClient
, private MediaProducer
, private VisibilityChangeClient
, private AudioTrackClient
, private TextTrackClient
, private VideoTrackClient
#if USE(AUDIO_SESSION) && PLATFORM(MAC)
, private AudioSessionConfigurationChangeObserver
#endif
#if ENABLE(ENCRYPTED_MEDIA)
, private CDMClient
#endif
#if !RELEASE_LOG_DISABLED
, private LoggerHelper
#endif
, public CanMakeWeakPtr<HTMLMediaElement, WeakPtrFactoryInitialization::Eager>
{
WTF_MAKE_TZONE_OR_ISO_ALLOCATED(HTMLMediaElement);
WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(HTMLMediaElement);
public:
using CanMakeWeakPtr<HTMLMediaElement, WeakPtrFactoryInitialization::Eager>::weakPtrFactory;
using CanMakeWeakPtr<HTMLMediaElement, WeakPtrFactoryInitialization::Eager>::WeakValueType;
using CanMakeWeakPtr<HTMLMediaElement, WeakPtrFactoryInitialization::Eager>::WeakPtrImplType;
// ActiveDOMObject.
void ref() const final { HTMLElement::ref(); }
void deref() const final { HTMLElement::deref(); }
MediaPlayer* player() const { return m_player.get(); }
RefPtr<MediaPlayer> protectedPlayer() const { return m_player; }
WEBCORE_EXPORT std::optional<MediaPlayerIdentifier> playerIdentifier() const;
virtual bool isVideo() const { return false; }
bool hasVideo() const override { return false; }
WEBCORE_EXPORT bool hasAudio() const override;
bool hasRenderer() const { return static_cast<bool>(renderer()); }
WEBCORE_EXPORT static HashSet<WeakRef<HTMLMediaElement>>& allMediaElements();
WEBCORE_EXPORT static RefPtr<HTMLMediaElement> bestMediaElementForRemoteControls(MediaElementSession::PlaybackControlsPurpose, const Document* = nullptr);
WEBCORE_EXPORT void rewind(double timeDelta);
WEBCORE_EXPORT void returnToRealtime() override;
// Eventually overloaded in HTMLVideoElement
bool supportsFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) const override { return false; };
bool supportsScanning() const override;
bool canSaveMediaData() const;
bool doesHaveAttribute(const AtomString&, AtomString* value = nullptr) const override;
PlatformLayer* platformLayer() const;
bool isVideoLayerInline();
void setPreparedToReturnVideoLayerToInline(bool);
void waitForPreparedForInlineThen(Function<void()>&& completionHandler);
#if ENABLE(VIDEO_PRESENTATION_MODE)
RetainPtr<PlatformLayer> createVideoFullscreenLayer();
WEBCORE_EXPORT void setVideoFullscreenLayer(PlatformLayer*, Function<void()>&& completionHandler = [] { });
#ifdef __OBJC__
PlatformLayer* videoFullscreenLayer() const { return m_videoFullscreenLayer.get(); }
#endif
virtual void setVideoFullscreenFrame(const FloatRect&);
void setVideoFullscreenGravity(MediaPlayer::VideoGravity);
MediaPlayer::VideoGravity videoFullscreenGravity() const { return m_videoFullscreenGravity; }
#endif
void checkPlaybackTargetCompatibility();
void scheduleResolvePendingPlayPromises();
void scheduleRejectPendingPlayPromises(Ref<DOMException>&&);
using PlayPromiseVector = Vector<DOMPromiseDeferred<void>>;
void rejectPendingPlayPromises(PlayPromiseVector&&, Ref<DOMException>&&);
void resolvePendingPlayPromises(PlayPromiseVector&&);
void scheduleNotifyAboutPlaying();
void notifyAboutPlaying(PlayPromiseVector&&);
void durationChanged();
MediaPlayer::MovieLoadType movieLoadType() const;
bool inActiveDocument() const { return m_inActiveDocument; }
MediaSessionGroupIdentifier mediaSessionGroupIdentifier() const final;
WEBCORE_EXPORT bool isActiveNowPlayingSession() const;
void isActiveNowPlayingSessionChanged() final;
// DOM API
// error state
WEBCORE_EXPORT MediaError* error() const;
const URL& currentSrc() const { return m_currentSrc; }
const MediaProvider& srcObject() const { return m_mediaProvider; }
void setSrcObject(MediaProvider&&);
WEBCORE_EXPORT void setCrossOrigin(const AtomString&);
WEBCORE_EXPORT String crossOrigin() const;
// network state
using HTMLMediaElementEnums::NetworkState;
WEBCORE_EXPORT NetworkState networkState() const;
WEBCORE_EXPORT String preload() const;
WEBCORE_EXPORT void setPreload(const AtomString&);
Ref<TimeRanges> buffered() const override;
WEBCORE_EXPORT void load();
WEBCORE_EXPORT String canPlayType(const String& mimeType) const;
// ready state
using HTMLMediaElementEnums::ReadyState;
ReadyState readyState() const override;
WEBCORE_EXPORT bool seeking() const;
void setSeeking(bool);
// playback state
WEBCORE_EXPORT double currentTime() const override;
WEBCORE_EXPORT void setCurrentTime(double) override;
void setCurrentTimeWithTolerance(double, double toleranceBefore, double toleranceAfter);
double currentTimeForBindings() const { return currentTime(); }
WEBCORE_EXPORT ExceptionOr<void> setCurrentTimeForBindings(double);
WEBCORE_EXPORT WallTime getStartDate() const;
WEBCORE_EXPORT double duration() const override;
WEBCORE_EXPORT bool paused() const override;
void setPaused(bool);
double defaultPlaybackRate() const override;
void setDefaultPlaybackRate(double) override;
WEBCORE_EXPORT double playbackRate() const override;
void setPlaybackRate(double) override;
WEBCORE_EXPORT bool preservesPitch() const;
WEBCORE_EXPORT void setPreservesPitch(bool);
// MediaTime versions of playback state
MediaTime currentMediaTime() const;
void setCurrentTime(const MediaTime&);
MediaTime durationMediaTime() const;
WEBCORE_EXPORT void fastSeek(const MediaTime&);
void updatePlaybackRate();
Ref<TimeRanges> played() override;
Ref<TimeRanges> seekable() const override;
double seekableTimeRangesLastModifiedTime() const;
double liveUpdateInterval() const;
WEBCORE_EXPORT bool ended() const;
bool autoplay() const;
bool isAutoplaying() const { return m_autoplaying; }
bool loop() const;
void setLoop(bool b);
void play(DOMPromiseDeferred<void>&&);
WEBCORE_EXPORT void play() override;
WEBCORE_EXPORT void pause() override;
WEBCORE_EXPORT void fastSeek(double);
double minFastReverseRate() const;
double maxFastForwardRate() const;
#if ENABLE(MEDIA_STREAM)
void setAudioOutputDevice(String&& deviceId, DOMPromiseDeferred<void>&&);
String audioOutputHashedDeviceId() const { return m_audioOutputHashedDeviceId; }
#endif
using HTMLMediaElementEnums::BufferingPolicy;
WEBCORE_EXPORT void setBufferingPolicy(BufferingPolicy);
WEBCORE_EXPORT BufferingPolicy bufferingPolicy() const;
WEBCORE_EXPORT void purgeBufferedDataIfPossible();
#if ENABLE(MEDIA_STATISTICS)
// Statistics
unsigned webkitAudioDecodedByteCount() const;
unsigned webkitVideoDecodedByteCount() const;
#endif
#if ENABLE(MEDIA_SOURCE)
// Media Source.
void detachMediaSource();
void incrementDroppedFrameCount() { ++m_droppedVideoFrames; }
bool deferredMediaSourceOpenCanProgress() const;
#endif
#if ENABLE(LEGACY_ENCRYPTED_MEDIA)
WebKitMediaKeys* webkitKeys() const { return m_webKitMediaKeys.get(); }
void webkitSetMediaKeys(WebKitMediaKeys*);
void keyAdded();
#endif
#if ENABLE(ENCRYPTED_MEDIA)
MediaKeys* mediaKeys() const;
void setMediaKeys(MediaKeys*, Ref<DeferredPromise>&&);
#endif
// controls
WEBCORE_EXPORT bool controls() const;
WEBCORE_EXPORT void setControls(bool);
WEBCORE_EXPORT double volume() const override;
WEBCORE_EXPORT ExceptionOr<void> setVolume(double) override;
WEBCORE_EXPORT bool muted() const override;
WEBCORE_EXPORT void setMuted(bool) override;
bool volumeLocked() const { return m_volumeLocked; }
WEBCORE_EXPORT void setVolumeLocked(bool);
bool buffering() const { return m_buffering; }
void updateBufferingState();
bool stalled() const { return m_stalled; }
void updateStalledState();
WEBCORE_EXPORT void togglePlayState();
WEBCORE_EXPORT void beginScrubbing() override;
WEBCORE_EXPORT void endScrubbing() override;
void beginScanning(ScanDirection) override;
void endScanning() override;
double nextScanRate();
WEBCORE_EXPORT bool canPlay() const override;
bool shouldForceControlsDisplay() const;
ExceptionOr<Ref<TextTrack>> addTextTrack(const AtomString& kind, const AtomString& label, const AtomString& language);
AudioTrackList& ensureAudioTracks();
TextTrackList& ensureTextTracks();
VideoTrackList& ensureVideoTracks();
AudioTrackList* audioTracks() const { return m_audioTracks.get(); }
TextTrackList* textTracks() const { return m_textTracks.get(); }
VideoTrackList* videoTracks() const { return m_videoTracks.get(); }
CueList currentlyActiveCues() const;
void addAudioTrack(Ref<AudioTrack>&&);
void addTextTrack(Ref<TextTrack>&&);
void addVideoTrack(Ref<VideoTrack>&&);
void removeAudioTrack(Ref<AudioTrack>&&);
void removeAudioTrack(TrackID);
void removeTextTrack(TextTrack&, bool scheduleEvent = true);
void removeTextTrack(TrackID, bool scheduleEvent = true);
void removeVideoTrack(Ref<VideoTrack>&&);
void removeVideoTrack(TrackID);
void forgetResourceSpecificTracks();
void closeCaptionTracksChanged();
void notifyMediaPlayerOfTextTrackChanges();
virtual void didAddTextTrack(HTMLTrackElement&);
virtual void didRemoveTextTrack(HTMLTrackElement&);
void mediaPlayerDidAddAudioTrack(AudioTrackPrivate&) final;
void mediaPlayerDidAddTextTrack(InbandTextTrackPrivate&) final;
void mediaPlayerDidAddVideoTrack(VideoTrackPrivate&) final;
void mediaPlayerDidRemoveAudioTrack(AudioTrackPrivate&) final;
void mediaPlayerDidRemoveTextTrack(InbandTextTrackPrivate&) final;
void mediaPlayerDidRemoveVideoTrack(VideoTrackPrivate&) final;
Vector<RefPtr<PlatformTextTrack>> outOfBandTrackSources() final;
struct TrackGroup;
void configureTextTrackGroupForLanguage(const TrackGroup&) const;
void scheduleConfigureTextTracks();
void configureTextTracks();
void configureTextTrackGroup(const TrackGroup&);
void configureMetadataTextTrackGroup(const TrackGroup&);
void setSelectedTextTrack(TextTrack*);
// AudioTrackClient
void audioTrackEnabledChanged(AudioTrack&) final;
void audioTrackKindChanged(AudioTrack&) final;
void audioTrackLabelChanged(AudioTrack&) final;
void audioTrackLanguageChanged(AudioTrack&) final;
void willRemoveAudioTrack(AudioTrack&) final;
// TextTrackClient
void textTrackKindChanged(TextTrack&) final;
void textTrackModeChanged(TextTrack&) final;
void textTrackLabelChanged(TextTrack&) final;
void textTrackLanguageChanged(TextTrack&) final;
void textTrackAddCues(TextTrack&, const TextTrackCueList&) final;
void textTrackRemoveCues(TextTrack&, const TextTrackCueList&) final;
void textTrackAddCue(TextTrack&, TextTrackCue&) final;
void textTrackRemoveCue(TextTrack&, TextTrackCue&) final;
void willRemoveTextTrack(TextTrack&) final;
// VideoTrackClient
void videoTrackKindChanged(VideoTrack&) final;
void videoTrackLabelChanged(VideoTrack&) final;
void videoTrackLanguageChanged(VideoTrack&) final;
void videoTrackSelectedChanged(VideoTrack&) final;
void willRemoveVideoTrack(VideoTrack&) final;
void setTextTrackRepresentataionBounds(const IntRect&);
void setRequiresTextTrackRepresentation(bool);
bool requiresTextTrackRepresentation() const;
void setTextTrackRepresentation(TextTrackRepresentation*);
void syncTextTrackBounds();
void captionPreferencesChanged();
using HTMLMediaElementEnums::TextTrackVisibilityCheckType;
void textTrackReadyStateChanged(TextTrack*);
void updateTextTrackRepresentationImageIfNeeded();
WEBCORE_EXPORT bool addEventListener(const AtomString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
WEBCORE_EXPORT bool removeEventListener(const AtomString& eventType, EventListener&, const EventListenerOptions&) override;
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
void webkitShowPlaybackTargetPicker();
void wirelessRoutesAvailableDidChange() override;
void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) override;
void setShouldPlayToPlaybackTarget(bool) override;
void playbackTargetPickerWasDismissed() override;
bool hasWirelessPlaybackTargetAlternative() const;
bool isWirelessPlaybackTargetDisabled() const;
void isWirelessPlaybackTargetDisabledChanged();
bool hasTargetAvailabilityListeners();
bool hasEnabledTargetAvailabilityListeners();
#endif
bool isPlayingToWirelessPlaybackTarget() const override { return m_isPlayingToWirelessTarget; };
void setIsPlayingToWirelessTarget(bool);
bool webkitCurrentPlaybackTargetIsWireless() const;
void setPlayingOnSecondScreen(bool value);
bool isPlayingOnSecondScreen() const override { return m_playingOnSecondScreen; }
bool isPlayingToExternalTarget() const { return isPlayingToWirelessPlaybackTarget() || isPlayingOnSecondScreen(); }
// EventTarget function.
// Both Node (via HTMLElement) and ActiveDOMObject define this method, which
// causes an ambiguity error at compile time. This class's constructor
// ensures that both implementations return document, so return the result
// of one of them here.
using HTMLElement::scriptExecutionContext;
bool didPassCORSAccessCheck() const { return m_player && m_player->didPassCORSAccessCheck(); }
bool taintsOrigin(const SecurityOrigin&) const;
WEBCORE_EXPORT bool isFullscreen() const override;
bool isStandardFullscreen() const;
void toggleStandardFullscreenState();
using MediaPlayerEnums::VideoFullscreenMode;
VideoFullscreenMode fullscreenMode() const { return m_videoFullscreenMode; }
void enterFullscreen(VideoFullscreenMode);
WEBCORE_EXPORT void enterFullscreen() override;
WEBCORE_EXPORT void exitFullscreen();
WEBCORE_EXPORT void prepareForVideoFullscreenStandby();
bool hasClosedCaptions() const override;
bool closedCaptionsVisible() const override;
void setClosedCaptionsVisible(bool) override;
void sourceWasRemoved(HTMLSourceElement&);
void sourceWasAdded(HTMLSourceElement&);
// Media cache management.
WEBCORE_EXPORT static void setMediaCacheDirectory(const String&);
WEBCORE_EXPORT static const String& mediaCacheDirectory();
WEBCORE_EXPORT static HashSet<SecurityOriginData> originsInMediaCache(const String&);
WEBCORE_EXPORT static void clearMediaCache(const String&, WallTime modifiedSince = { });
WEBCORE_EXPORT static void clearMediaCacheForOrigins(const String&, const HashSet<SecurityOriginData>&);
bool isPlaying() const final { return m_playing; }
#if ENABLE(WEB_AUDIO)
MediaElementAudioSourceNode* audioSourceNode();
void setAudioSourceNode(MediaElementAudioSourceNode*);
AudioSourceProvider* audioSourceProvider();
#endif
using HTMLMediaElementEnums::InvalidURLAction;
bool isSafeToLoadURL(const URL&, InvalidURLAction, bool shouldLog = true) const;
const String& mediaGroup() const;
void setMediaGroup(const String&);
MediaController* controller() const;
void setController(RefPtr<MediaController>&&);
MediaController* controllerForBindings() const { return controller(); }
void setControllerForBindings(MediaController*);
void enteredOrExitedFullscreen() { configureMediaControls(); }
unsigned long long fileSize() const;
void mediaLoadingFailed(MediaPlayer::NetworkState);
void mediaLoadingFailedFatally(MediaPlayer::NetworkState);
RefPtr<VideoPlaybackQuality> getVideoPlaybackQuality() const;
MediaPlayer::Preload preloadValue() const { return m_preload; }
MediaElementSession* mediaSessionIfExists() const { return m_mediaSession.get(); }
WEBCORE_EXPORT MediaElementSession& mediaSession() const;
void pageScaleFactorChanged();
void userInterfaceLayoutDirectionChanged();
WEBCORE_EXPORT String getCurrentMediaControlsStatus();
WEBCORE_EXPORT void setMediaControlsMaximumRightContainerButtonCountOverride(size_t);
WEBCORE_EXPORT void setMediaControlsHidePlaybackRates(bool);
MediaControlsHost* mediaControlsHost() { return m_mediaControlsHost.get(); }
bool isDisablingSleep() const { return m_sleepDisabler.get(); }
double maxBufferedTime() const;
MediaProducerMediaStateFlags mediaState() const override;
void layoutSizeChanged();
void visibilityDidChange();
void allowsMediaDocumentInlinePlaybackChanged();
void updateShouldPlay();
RenderMedia* renderer() const;
void resetPlaybackSessionState();
WEBCORE_EXPORT bool isVisibleInViewport() const;
bool hasEverNotifiedAboutPlaying() const;
void setShouldDelayLoadEvent(bool);
bool hasEverHadAudio() const { return m_hasEverHadAudio; }
bool hasEverHadVideo() const { return m_hasEverHadVideo; }
double playbackStartedTime() const { return m_playbackStartedTime; }
bool isTemporarilyAllowingInlinePlaybackAfterFullscreen() const {return m_temporarilyAllowingInlinePlaybackAfterFullscreen; }
void isVisibleInViewportChanged();
void updateRateChangeRestrictions();
WEBCORE_EXPORT const MediaResourceLoader* lastMediaResourceLoaderForTesting() const;
#if ENABLE(MEDIA_STREAM)
void mediaStreamCaptureStarted();
bool hasMediaStreamSrcObject() const { return m_mediaProvider && std::holds_alternative<RefPtr<MediaStream>>(*m_mediaProvider); }
#endif
bool supportsSeeking() const override;
using Identified<HTMLMediaElementIdentifier>::identifier;
#if !RELEASE_LOG_DISABLED
const Logger& logger() const final { return *m_logger.get(); }
Ref<Logger> protectedLogger() const;
const void* logIdentifier() const final { return m_logIdentifier; }
ASCIILiteral logClassName() const final { return "HTMLMediaElement"_s; }
WTFLogChannel& logChannel() const final;
#endif
bool willLog(WTFLogLevel) const;
bool isAudible() const final { return canProduceAudio(); }
bool isSuspended() const final;
WEBCORE_EXPORT void didBecomeFullscreenElement() final;
WEBCORE_EXPORT void willExitFullscreen();
WEBCORE_EXPORT void didStopBeingFullscreenElement() final;
void willBecomeFullscreenElement(VideoFullscreenMode = VideoFullscreenModeStandard);
void scheduleEvent(Ref<Event>&&);
enum class AutoplayEventPlaybackState { None, PreventedAutoplay, StartedWithUserGesture, StartedWithoutUserGesture };
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
RemotePlayback& remote() { return m_remote; }
void remoteHasAvailabilityCallbacksChanged();
#endif
void privateBrowsingStateDidChange(PAL::SessionID);
void mediaVolumeDidChange();
void applicationWillResignActive();
void applicationDidBecomeActive();
MediaUniqueIdentifier mediaUniqueIdentifier() const;
String mediaSessionTitle() const;
String sourceApplicationIdentifier() const;
WEBCORE_EXPORT void setOverridePreferredDynamicRangeMode(DynamicRangeMode);
void setPreferredDynamicRangeMode(DynamicRangeMode);
void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument&) override;
using EventTarget::dispatchEvent;
void dispatchEvent(Event&) override;
#if USE(AUDIO_SESSION)
AudioSessionCategory categoryAtMostRecentPlayback() const { return m_categoryAtMostRecentPlayback; }
AudioSessionMode modeAtMostRecentPlayback() const { return m_modeAtMostRecentPlayback; }
#endif
void updateMediaPlayer(IntSize, bool);
WEBCORE_EXPORT bool elementIsHidden() const;
bool showingStats() const { return m_showingStats; }
void setShowingStats(bool);
enum class SpeechSynthesisState : uint8_t { None, Speaking, CompletingExtendedDescription, Paused };
WEBCORE_EXPORT RefPtr<TextTrackCue> cueBeingSpoken() const;
#if ENABLE(SPEECH_SYNTHESIS)
WEBCORE_EXPORT SpeechSynthesis& speechSynthesis();
Ref<SpeechSynthesis> protectedSpeechSynthesis();
#endif
bool hasSource() const { return hasCurrentSrc() || srcObject(); }
WEBCORE_EXPORT void requestHostingContextID(Function<void(LayerHostingContextID)>&&);
WEBCORE_EXPORT LayerHostingContextID layerHostingContextID();
WEBCORE_EXPORT WebCore::FloatSize naturalSize();
WEBCORE_EXPORT WebCore::FloatSize videoLayerSize() const;
void setVideoLayerSizeFenced(const FloatSize&, WTF::MachSendRight&&);
void updateMediaState();
using SourceType = HTMLMediaElementSourceType;
std::optional<SourceType> sourceType() const;
String localizedSourceType() const;
LayoutRect contentBoxRect() const { return mediaPlayerContentBoxRect(); }
#if HAVE(SPATIAL_TRACKING_LABEL)
void updateSpatialTrackingLabel();
void defaultSpatialTrackingLabelChanged(const String&);
const String& spatialTrackingLabel() const;
void setSpatialTrackingLabel(const String&);
#endif
void mediaSourceWasDetached();
protected:
HTMLMediaElement(const QualifiedName&, Document&, bool createdByParser);
virtual ~HTMLMediaElement();
void removeAllEventListeners() final;
void attributeChanged(const QualifiedName&, const AtomString& oldValue, const AtomString& newValue, AttributeModificationReason) override;
void finishParsingChildren() override;
bool isURLAttribute(const Attribute&) const override;
void willAttachRenderers() override;
void didAttachRenderers() override;
void willDetachRenderers() override;
void didDetachRenderers() override;
void didMoveToNewDocument(Document& oldDocument, Document& newDocument) override;
bool isMediaElement() const final { return true; }
RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
SecurityOriginData documentSecurityOrigin() const final;
String audioOutputDeviceId() const final { return m_audioOutputPersistentDeviceId; }
String audioOutputDeviceIdOverride() const final { return m_audioOutputPersistentDeviceId; }
bool mediaControlsDependOnPageScaleFactor() const { return m_mediaControlsDependOnPageScaleFactor; }
void setMediaControlsDependOnPageScaleFactor(bool);
void updateMediaControlsAfterPresentationModeChange();
void scheduleEvent(const AtomString&);
template<typename T> void scheduleEventOn(T& target, Ref<Event>&&);
bool showPosterFlag() const { return m_showPoster; }
void setShowPosterFlag(bool);
void setChangingVideoFullscreenMode(bool value) { m_changingVideoFullscreenMode = value; }
bool isChangingVideoFullscreenMode() const { return m_changingVideoFullscreenMode; }
void mediaPlayerEngineUpdated() override;
void visibilityStateChanged() final;
void mediaPlayerNetworkStateChanged() final;
void mediaPlayerReadyStateChanged() final;
void mediaPlayerTimeChanged() final;
void mediaPlayerVolumeChanged() final;
void mediaPlayerMuteChanged() final;
void mediaPlayerSeeked(const MediaTime&) final;
void mediaPlayerDurationChanged() final;
void mediaPlayerRateChanged() final;
void mediaPlayerPlaybackStateChanged() final;
void mediaPlayerResourceNotSupported() final;
void mediaPlayerRepaint() final;
void mediaPlayerSizeChanged() final;
bool mediaPlayerAcceleratedCompositingEnabled() final;
void mediaPlayerWillInitializeMediaEngine() final;
void mediaPlayerDidInitializeMediaEngine() final;
void mediaPlayerReloadAndResumePlaybackIfNeeded() final;
void mediaPlayerQueueTaskOnEventLoop(Function<void()>&&) final;
void mediaPlayerCharacteristicChanged() final;
bool videoFullscreenStandby() const { return m_videoFullscreenStandby; }
void setVideoFullscreenStandbyInternal(bool videoFullscreenStandby) { m_videoFullscreenStandby = videoFullscreenStandby; }
protected:
// ActiveDOMObject
void stop() override;
private:
friend class Internals;
void createMediaPlayer();
bool supportsFocus() const override;
bool isMouseFocusable() const override;
bool rendererIsNeeded(const RenderStyle&) override;
bool childShouldCreateRenderer(const Node&) const override;
InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
void didFinishInsertingNode() override;
void removedFromAncestor(RemovalType, ContainerNode&) override;
void didRecalcStyle(Style::Change) override;
bool canStartSelection() const override { return false; }
bool isInteractiveContent() const override;
void setFullscreenMode(VideoFullscreenMode);
void willStopBeingFullscreenElement() override;
// ActiveDOMObject.
void suspend(ReasonForSuspension) override;
void resume() override;
bool virtualHasPendingActivity() const override;
void stopWithoutDestroyingMediaPlayer();
void contextDestroyed() override;
void setReadyState(MediaPlayer::ReadyState);
void setNetworkState(MediaPlayer::NetworkState);
WEBCORE_EXPORT double effectivePlaybackRate() const;
double requestedPlaybackRate() const;
void scheduleMediaEngineWasUpdated();
void mediaEngineWasUpdated();
#if ENABLE(LEGACY_ENCRYPTED_MEDIA)
RefPtr<ArrayBuffer> mediaPlayerCachedKeyForKeyId(const String& keyId) const final;
void mediaPlayerKeyNeeded(const SharedBuffer&) final;
String mediaPlayerMediaKeysStorageDirectory() const final;
#endif
#if ENABLE(ENCRYPTED_MEDIA)
void mediaPlayerInitializationDataEncountered(const String&, RefPtr<ArrayBuffer>&&) final;
void mediaPlayerWaitingForKeyChanged() final;
void attemptToDecrypt();
void attemptToResumePlaybackIfNecessary();
// CDMClient
void cdmClientAttemptToResumePlaybackIfNecessary() final;
void cdmClientUnrequestedInitializationDataReceived(const String&, Ref<SharedBuffer>&&) final;
#endif
#if ENABLE(LEGACY_ENCRYPTED_MEDIA) && ENABLE(ENCRYPTED_MEDIA)
void updateShouldContinueAfterNeedKey();
#endif
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
void mediaPlayerCurrentPlaybackTargetIsWirelessChanged(bool) final;
enum class EnqueueBehavior : uint8_t { Always, OnlyWhenChanged };
void enqueuePlaybackTargetAvailabilityChangedEvent(EnqueueBehavior);
#endif
String mediaPlayerReferrer() const override;
String mediaPlayerUserAgent() const override;
bool mediaPlayerIsFullscreen() const override;
bool mediaPlayerIsFullscreenPermitted() const override;
bool mediaPlayerIsVideo() const override;
LayoutRect mediaPlayerContentBoxRect() const override;
float mediaPlayerContentsScale() const override;
bool mediaPlayerPlatformVolumeConfigurationRequired() const override;
bool mediaPlayerIsLooping() const override;
CachedResourceLoader* mediaPlayerCachedResourceLoader() override;
Ref<PlatformMediaResourceLoader> mediaPlayerCreateResourceLoader() override;
bool mediaPlayerShouldUsePersistentCache() const override;
const String& mediaPlayerMediaCacheDirectory() const override;
void mediaPlayerActiveSourceBuffersChanged() override;
String mediaPlayerSourceApplicationIdentifier() const override { return sourceApplicationIdentifier(); }
Vector<String> mediaPlayerPreferredAudioCharacteristics() const override;
String mediaPlayerElementId() const override { return m_id; }
#if PLATFORM(IOS_FAMILY)
String mediaPlayerNetworkInterfaceName() const override;
void mediaPlayerGetRawCookies(const URL&, MediaPlayerClient::GetRawCookiesCallback&&) const final;
#endif
void mediaPlayerEngineFailedToLoad() final;
double mediaPlayerRequestedPlaybackRate() const final;
VideoFullscreenMode mediaPlayerFullscreenMode() const final { return fullscreenMode(); }
bool mediaPlayerIsVideoFullscreenStandby() const final { return m_videoFullscreenStandby; }
bool mediaPlayerShouldDisableSleep() const final { return shouldDisableSleep() == SleepType::Display; }
bool mediaPlayerShouldCheckHardwareSupport() const final;
const Vector<ContentType>& mediaContentTypesRequiringHardwareSupport() const final;
const std::optional<Vector<String>>& allowedMediaContainerTypes() const final;
const std::optional<Vector<String>>& allowedMediaCodecTypes() const final;
const std::optional<Vector<FourCC>>& allowedMediaVideoCodecIDs() const final;
const std::optional<Vector<FourCC>>& allowedMediaAudioCodecIDs() const final;
const std::optional<Vector<FourCC>>& allowedMediaCaptionFormatTypes() const final;
void mediaPlayerBufferedTimeRangesChanged() final;
bool mediaPlayerPrefersSandboxedParsing() const final;
bool mediaPlayerShouldDisableHDR() const final { return shouldDisableHDR(); }
FloatSize mediaPlayerVideoLayerSize() const final { return videoLayerSize(); }
void mediaPlayerVideoLayerSizeDidChange(const FloatSize& size) final { m_videoLayerSize = size; }
MediaPlayerClientIdentifier mediaPlayerClientIdentifier() const final { return identifier(); }
void pendingActionTimerFired();
void progressEventTimerFired();
void playbackProgressTimerFired();
void scanTimerFired();
void seekTask();
void startPlaybackProgressTimer();
void startProgressEventTimer();
void stopPeriodicTimers();
void cancelPendingTasks();
void closeTaskQueues();
void seek(const MediaTime&);
void seekInternal(const MediaTime&);
void seekWithTolerance(const SeekTarget&, bool fromDOM);
void finishSeek();
void clearSeeking();
void addPlayedRange(const MediaTime& start, const MediaTime& end);
void scheduleTimeupdateEvent(bool periodicEvent);
virtual void scheduleResizeEvent(const FloatSize&) { }
virtual void scheduleResizeEventIfSizeChanged(const FloatSize&) { }
void selectMediaResource();
void queueLoadMediaResourceTask();
void loadResource(const URL&, const ContentType&, const String& keySystem);
void scheduleNextSourceChild();
void loadNextSourceChild();
void userCancelledLoad();
void clearMediaPlayer();
bool havePotentialSourceChild();
void noneSupported();
void cancelPendingEventsAndCallbacks();
void waitForSourceChange();
void prepareToPlay();
URL selectNextSourceChild(ContentType*, String* keySystem, InvalidURLAction);
bool ignoreTrackDisplayUpdateRequests() const;
void beginIgnoringTrackDisplayUpdateRequests();
void endIgnoringTrackDisplayUpdateRequests();
void updateActiveTextTrackCues(const MediaTime&);
enum class CueAction : uint8_t { Enter, Exit };
void executeCueEnterOrExitActionForTime(TextTrackCue&, CueAction);
void speakCueText(TextTrackCue&);
void pauseSpeakingCueText();
void resumeSpeakingCueText();
void cancelSpeakingCueText();
bool shouldSpeakCueTextForTime(const MediaTime&);
void pausePlaybackForExtendedTextDescription();
void setSpeechSynthesisState(SpeechSynthesisState);
enum ReconfigureMode { Immediately, AfterDelay };
void markCaptionAndSubtitleTracksAsUnconfigured(ReconfigureMode);
CaptionUserPreferences::CaptionDisplayMode captionDisplayMode();
bool textTracksAreReady() const;
void configureTextTrackDisplay(TextTrackVisibilityCheckType = CheckTextTrackVisibility);
void updateTextTrackDisplay();
// These "internal" functions do not check user gesture restrictions.
void playInternal();
void pauseInternal();
void prepareForLoad();
void allowVideoRendering();
bool processingMediaPlayerCallback() const { return m_processingMediaPlayerCallback > 0; }
void beginProcessingMediaPlayerCallback() { ++m_processingMediaPlayerCallback; }
void endProcessingMediaPlayerCallback() { ASSERT(m_processingMediaPlayerCallback); --m_processingMediaPlayerCallback; }
void scheduleUpdatePlayState();
void updatePlayState();
void updateVolume();
void setPlaying(bool);
bool potentiallyPlaying() const;
bool endedPlayback() const;
bool stoppedDueToErrors() const;
bool pausedForUserInteraction() const;
bool couldPlayIfEnoughData() const;
void dispatchPlayPauseEventsIfNeedsQuirks();
Expected<void, MediaPlaybackDenialReason> canTransitionFromAutoplayToPlay() const;
void setAutoplayEventPlaybackState(AutoplayEventPlaybackState);
void userDidInterfereWithAutoplay();
void handleAutoplayEvent(AutoplayEvent);
MediaTime minTimeSeekable() const;
MediaTime maxTimeSeekable() const;
// Pauses playback without changing any states or generating events
void setPausedInternal(bool);
void pauseAndUpdatePlayStateImmediately();
void setPlaybackRateInternal(double);
void mediaCanStart(Document&) final;
void invalidateCachedTime() const;
void refreshCachedTime() const;
void configureMediaControls();
void prepareMediaFragmentURI();
void applyMediaFragmentURI();
void changeNetworkStateFromLoadingToIdle();
void removeBehaviorRestrictionsAfterFirstUserGesture(MediaElementSession::BehaviorRestrictions mask = MediaElementSession::AllRestrictions);
void updateMediaController();
bool isBlocked() const;
bool isBlockedOnMediaController() const;
void setCurrentSrc(const URL&);