Remove std::chrono completely
[WebKit.git] / Source / WebCore / platform / graphics / MediaPlayer.h
1 /*
2  * Copyright (C) 2007-2014 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 #ifndef MediaPlayer_h
27 #define MediaPlayer_h
28
29 #if ENABLE(VIDEO)
30 #include "GraphicsTypes3D.h"
31
32 #include "AudioTrackPrivate.h"
33 #include "ContentType.h"
34 #include "LegacyCDMSession.h"
35 #include "InbandTextTrackPrivate.h"
36 #include "IntRect.h"
37 #include "URL.h"
38 #include "LayoutRect.h"
39 #include "MediaPlayerEnums.h"
40 #include "NativeImage.h"
41 #include "PlatformLayer.h"
42 #include "PlatformMediaResourceLoader.h"
43 #include "PlatformMediaSession.h"
44 #include "SecurityOriginHash.h"
45 #include "Timer.h"
46 #include "VideoTrackPrivate.h"
47 #include <runtime/Uint8Array.h>
48 #include <wtf/Forward.h>
49 #include <wtf/Function.h>
50 #include <wtf/HashSet.h>
51 #include <wtf/Logger.h>
52 #include <wtf/MediaTime.h>
53 #include <wtf/Noncopyable.h>
54 #include <wtf/Ref.h>
55 #include <wtf/RefCounted.h>
56 #include <wtf/WallTime.h>
57 #include <wtf/text/StringHash.h>
58
59 #if ENABLE(AVF_CAPTIONS)
60 #include "PlatformTextTrack.h"
61 #endif
62
63 OBJC_CLASS AVAsset;
64 OBJC_CLASS AVPlayer;
65 OBJC_CLASS NSArray;
66 OBJC_CLASS QTMovie;
67
68 class AVCFPlayer;
69 class QTMovieGWorld;
70 class QTMovieVisualContext;
71
72 namespace WebCore {
73
74 class AudioSourceProvider;
75 class AuthenticationChallenge;
76 #if ENABLE(ENCRYPTED_MEDIA)
77 class CDMInstance;
78 #endif
79 class MediaPlaybackTarget;
80 #if ENABLE(MEDIA_SOURCE)
81 class MediaSourcePrivateClient;
82 #endif
83 #if ENABLE(MEDIA_STREAM)
84 class MediaStreamPrivate;
85 #endif
86 class MediaPlayerPrivateInterface;
87 class TextTrackRepresentation;
88 struct Cookie;
89
90 // Structure that will hold every native
91 // types supported by the current media player.
92 // We have to do that has multiple media players
93 // backend can live at runtime.
94 struct PlatformMedia {
95     enum {
96         None,
97         QTMovieType,
98         QTMovieGWorldType,
99         QTMovieVisualContextType,
100         AVFoundationMediaPlayerType,
101         AVFoundationCFMediaPlayerType,
102         AVFoundationAssetType,
103     } type;
104
105     union {
106         QTMovie* qtMovie;
107         QTMovieGWorld* qtMovieGWorld;
108         QTMovieVisualContext* qtMovieVisualContext;
109         AVPlayer* avfMediaPlayer;
110         AVCFPlayer* avcfMediaPlayer;
111         AVAsset* avfAsset;
112     } media;
113 };
114
115 struct MediaEngineSupportParameters {
116
117     MediaEngineSupportParameters() = default;
118
119     ContentType type;
120     URL url;
121     bool isMediaSource { false };
122     bool isMediaStream { false };
123     Vector<ContentType> contentTypesRequiringHardwareSupport;
124 };
125
126 struct PlatformVideoPlaybackQualityMetrics {
127     PlatformVideoPlaybackQualityMetrics(unsigned long totalVideoFrames, unsigned long droppedVideoFrames, unsigned long corruptedVideoFrames, double totalFrameDelay)
128         : totalVideoFrames(totalVideoFrames)
129         , droppedVideoFrames(droppedVideoFrames)
130         , corruptedVideoFrames(corruptedVideoFrames)
131         , totalFrameDelay(totalFrameDelay)
132     {
133     }
134
135     unsigned long totalVideoFrames;
136     unsigned long droppedVideoFrames;
137     unsigned long corruptedVideoFrames;
138     double totalFrameDelay;
139 };
140
141 extern const PlatformMedia NoPlatformMedia;
142
143 class LegacyCDMSessionClient;
144 class CachedResourceLoader;
145 class ContentType;
146 class GraphicsContext;
147 class GraphicsContext3D;
148 class IntRect;
149 class IntSize;
150 class MediaPlayer;
151 class PlatformTimeRanges;
152
153 struct MediaPlayerFactory;
154
155 #if PLATFORM(WIN) && USE(AVFOUNDATION)
156 struct GraphicsDeviceAdapter;
157 #endif
158
159 #if USE(GSTREAMER)
160 class MediaPlayerRequestInstallMissingPluginsCallback;
161 #endif
162
163 class MediaPlayerClient {
164 public:
165     virtual ~MediaPlayerClient() = default;
166
167     // the network state has changed
168     virtual void mediaPlayerNetworkStateChanged(MediaPlayer*) { }
169
170     // the ready state has changed
171     virtual void mediaPlayerReadyStateChanged(MediaPlayer*) { }
172
173     // the volume state has changed
174     virtual void mediaPlayerVolumeChanged(MediaPlayer*) { }
175
176     // the mute state has changed
177     virtual void mediaPlayerMuteChanged(MediaPlayer*) { }
178
179     // time has jumped, eg. not as a result of normal playback
180     virtual void mediaPlayerTimeChanged(MediaPlayer*) { }
181
182     // the media file duration has changed, or is now known
183     virtual void mediaPlayerDurationChanged(MediaPlayer*) { }
184
185     // the playback rate has changed
186     virtual void mediaPlayerRateChanged(MediaPlayer*) { }
187
188     // the play/pause status changed
189     virtual void mediaPlayerPlaybackStateChanged(MediaPlayer*) { }
190
191     // The MediaPlayer has found potentially problematic media content.
192     // This is used internally to trigger swapping from a <video>
193     // element to an <embed> in standalone documents
194     virtual void mediaPlayerSawUnsupportedTracks(MediaPlayer*) { }
195
196     // The MediaPlayer could not discover an engine which supports the requested resource.
197     virtual void mediaPlayerResourceNotSupported(MediaPlayer*) { }
198
199 // Presentation-related methods
200     // a new frame of video is available
201     virtual void mediaPlayerRepaint(MediaPlayer*) { }
202
203     // the movie size has changed
204     virtual void mediaPlayerSizeChanged(MediaPlayer*) { }
205
206     virtual void mediaPlayerEngineUpdated(MediaPlayer*) { }
207
208     // The first frame of video is available to render. A media engine need only make this callback if the
209     // first frame is not available immediately when prepareForRendering is called.
210     virtual void mediaPlayerFirstVideoFrameAvailable(MediaPlayer*) { }
211
212     // A characteristic of the media file, eg. video, audio, closed captions, etc, has changed.
213     virtual void mediaPlayerCharacteristicChanged(MediaPlayer*) { }
214     
215     // whether the rendering system can accelerate the display of this MediaPlayer.
216     virtual bool mediaPlayerRenderingCanBeAccelerated(MediaPlayer*) { return false; }
217
218     // called when the media player's rendering mode changed, which indicates a change in the
219     // availability of the platformLayer().
220     virtual void mediaPlayerRenderingModeChanged(MediaPlayer*) { }
221
222     // whether accelerated compositing is enabled for video rendering
223     virtual bool mediaPlayerAcceleratedCompositingEnabled() { return false; }
224
225     virtual void mediaPlayerActiveSourceBuffersChanged(const MediaPlayer*) { }
226
227 #if PLATFORM(WIN) && USE(AVFOUNDATION)
228     virtual GraphicsDeviceAdapter* mediaPlayerGraphicsDeviceAdapter(const MediaPlayer*) const { return 0; }
229 #endif
230
231 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
232     virtual RefPtr<ArrayBuffer> mediaPlayerCachedKeyForKeyId(const String&) const { return nullptr; }
233     virtual bool mediaPlayerKeyNeeded(MediaPlayer*, Uint8Array*) { return false; }
234     virtual String mediaPlayerMediaKeysStorageDirectory() const { return emptyString(); }
235 #endif
236
237 #if ENABLE(ENCRYPTED_MEDIA)
238     virtual void mediaPlayerInitializationDataEncountered(const String&, RefPtr<ArrayBuffer>&&) { }
239 #endif
240     
241 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
242     virtual void mediaPlayerCurrentPlaybackTargetIsWirelessChanged(MediaPlayer*) { };
243 #endif
244
245     virtual String mediaPlayerReferrer() const { return String(); }
246     virtual String mediaPlayerUserAgent() const { return String(); }
247     virtual void mediaPlayerEnterFullscreen() { }
248     virtual void mediaPlayerExitFullscreen() { }
249     virtual bool mediaPlayerIsFullscreen() const { return false; }
250     virtual bool mediaPlayerIsFullscreenPermitted() const { return false; }
251     virtual bool mediaPlayerIsVideo() const { return false; }
252     virtual LayoutRect mediaPlayerContentBoxRect() const { return LayoutRect(); }
253     virtual float mediaPlayerContentsScale() const { return 1; }
254     virtual void mediaPlayerSetSize(const IntSize&) { }
255     virtual void mediaPlayerPause() { }
256     virtual void mediaPlayerPlay() { }
257     virtual bool mediaPlayerPlatformVolumeConfigurationRequired() const { return false; }
258     virtual bool mediaPlayerIsPaused() const { return true; }
259     virtual bool mediaPlayerIsLooping() const { return false; }
260     virtual CachedResourceLoader* mediaPlayerCachedResourceLoader() { return 0; }
261     virtual RefPtr<PlatformMediaResourceLoader> mediaPlayerCreateResourceLoader() { return nullptr; }
262     virtual bool doesHaveAttribute(const AtomicString&, AtomicString* = 0) const { return false; }
263     virtual bool mediaPlayerShouldUsePersistentCache() const { return true; }
264     virtual const String& mediaPlayerMediaCacheDirectory() const { return emptyString(); }
265
266 #if ENABLE(VIDEO_TRACK)
267     virtual void mediaPlayerDidAddAudioTrack(AudioTrackPrivate&) { }
268     virtual void mediaPlayerDidAddTextTrack(InbandTextTrackPrivate&) { }
269     virtual void mediaPlayerDidAddVideoTrack(VideoTrackPrivate&) { }
270     virtual void mediaPlayerDidRemoveAudioTrack(AudioTrackPrivate&) { }
271     virtual void mediaPlayerDidRemoveTextTrack(InbandTextTrackPrivate&) { }
272     virtual void mediaPlayerDidRemoveVideoTrack(VideoTrackPrivate&) { }
273
274     virtual void textTrackRepresentationBoundsChanged(const IntRect&) { }
275 #if ENABLE(AVF_CAPTIONS)
276     virtual Vector<RefPtr<PlatformTextTrack>> outOfBandTrackSources() { return Vector<RefPtr<PlatformTextTrack>>(); }
277 #endif
278 #endif
279
280 #if PLATFORM(IOS)
281     virtual String mediaPlayerNetworkInterfaceName() const { return String(); }
282     virtual bool mediaPlayerGetRawCookies(const URL&, Vector<Cookie>&) const { return false; }
283 #endif
284     
285     virtual bool mediaPlayerShouldWaitForResponseToAuthenticationChallenge(const AuthenticationChallenge&) { return false; }
286     virtual void mediaPlayerHandlePlaybackCommand(PlatformMediaSession::RemoteControlCommandType) { }
287
288     virtual String mediaPlayerSourceApplicationIdentifier() const { return emptyString(); }
289
290     virtual bool mediaPlayerIsInMediaDocument() const { return false; }
291     virtual void mediaPlayerEngineFailedToLoad() const { }
292
293     virtual double mediaPlayerRequestedPlaybackRate() const { return 0; }
294     virtual MediaPlayerEnums::VideoFullscreenMode mediaPlayerFullscreenMode() const { return MediaPlayerEnums::VideoFullscreenModeNone; }
295     virtual Vector<String> mediaPlayerPreferredAudioCharacteristics() const { return Vector<String>(); }
296
297 #if USE(GSTREAMER)
298     virtual void requestInstallMissingPlugins(const String&, const String&, MediaPlayerRequestInstallMissingPluginsCallback&) { };
299 #endif
300
301     virtual bool mediaPlayerShouldDisableSleep() const { return false; }
302     virtual const Vector<ContentType>& mediaContentTypesRequiringHardwareSupport() const;
303     virtual bool mediaPlayerShouldCheckHardwareSupport() const { return false; }
304
305 #if !RELEASE_LOG_DISABLED
306     virtual const void* mediaPlayerLogIdentifier() { return nullptr; }
307     virtual const Logger& mediaPlayerLogger() = 0;
308 #endif
309 };
310
311 class MediaPlayerSupportsTypeClient {
312 public:
313     virtual ~MediaPlayerSupportsTypeClient() = default;
314
315     virtual bool mediaPlayerNeedsSiteSpecificHacks() const { return false; }
316     virtual String mediaPlayerDocumentHost() const { return String(); }
317 };
318
319 class MediaPlayer : public MediaPlayerEnums, public RefCounted<MediaPlayer> {
320     WTF_MAKE_NONCOPYABLE(MediaPlayer); WTF_MAKE_FAST_ALLOCATED;
321 public:
322     static Ref<MediaPlayer> create(MediaPlayerClient&);
323     virtual ~MediaPlayer();
324
325     void invalidate();
326
327     // Media engine support.
328     enum SupportsType { IsNotSupported, IsSupported, MayBeSupported };
329     static MediaPlayer::SupportsType supportsType(const MediaEngineSupportParameters&, const MediaPlayerSupportsTypeClient*);
330     static void getSupportedTypes(HashSet<String, ASCIICaseInsensitiveHash>&);
331     static bool isAvailable();
332     static HashSet<RefPtr<SecurityOrigin>> originsInMediaCache(const String& path);
333     static void clearMediaCache(const String& path, WallTime modifiedSince);
334     static void clearMediaCacheForOrigins(const String& path, const HashSet<RefPtr<SecurityOrigin>>&);
335     static bool supportsKeySystem(const String& keySystem, const String& mimeType);
336
337     bool supportsPictureInPicture() const;
338     bool supportsFullscreen() const;
339     bool supportsScanning() const;
340     bool canSaveMediaData() const;
341     bool requiresImmediateCompositing() const;
342     bool doesHaveAttribute(const AtomicString&, AtomicString* value = nullptr) const;
343     PlatformMedia platformMedia() const;
344     PlatformLayer* platformLayer() const;
345
346 #if PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
347     void setVideoFullscreenLayer(PlatformLayer*, WTF::Function<void()>&& completionHandler = [] { });
348     void setVideoFullscreenFrame(FloatRect);
349     using MediaPlayerEnums::VideoGravity;
350     void setVideoFullscreenGravity(VideoGravity);
351     void setVideoFullscreenMode(VideoFullscreenMode);
352     VideoFullscreenMode fullscreenMode() const;
353 #endif
354
355 #if PLATFORM(IOS)
356     NSArray *timedMetadata() const;
357     String accessLog() const;
358     String errorLog() const;
359 #endif
360
361     FloatSize naturalSize();
362     bool hasVideo() const;
363     bool hasAudio() const;
364
365     bool inMediaDocument() const;
366
367     IntSize size() const { return m_size; }
368     void setSize(const IntSize& size);
369
370     bool load(const URL&, const ContentType&, const String& keySystem);
371 #if ENABLE(MEDIA_SOURCE)
372     bool load(const URL&, const ContentType&, MediaSourcePrivateClient*);
373 #endif
374 #if ENABLE(MEDIA_STREAM)
375     bool load(MediaStreamPrivate&);
376 #endif
377     void cancelLoad();
378
379     bool visible() const;
380     void setVisible(bool);
381
382     void prepareToPlay();
383     void play();
384     void pause();
385     void setShouldBufferData(bool);
386
387 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
388     // Represents synchronous exceptions that can be thrown from the Encrypted Media methods.
389     // This is different from the asynchronous MediaKeyError.
390     enum MediaKeyException { NoError, InvalidPlayerState, KeySystemNotSupported };
391
392     std::unique_ptr<LegacyCDMSession> createSession(const String& keySystem, LegacyCDMSessionClient*);
393     void setCDMSession(LegacyCDMSession*);
394     void keyAdded();
395 #endif
396
397 #if ENABLE(ENCRYPTED_MEDIA)
398     void cdmInstanceAttached(CDMInstance&);
399     void cdmInstanceDetached(CDMInstance&);
400     void attemptToDecryptWithInstance(CDMInstance&);
401 #endif
402
403     bool paused() const;
404     bool seeking() const;
405
406     static double invalidTime() { return -1.0;}
407     MediaTime duration() const;
408     MediaTime currentTime() const;
409     void seek(const MediaTime&);
410     void seekWithTolerance(const MediaTime&, const MediaTime& negativeTolerance, const MediaTime& positiveTolerance);
411
412     MediaTime startTime() const;
413     MediaTime initialTime() const;
414
415     MediaTime getStartDate() const;
416
417     double rate() const;
418     void setRate(double);
419     double requestedRate() const;
420
421     bool preservesPitch() const;
422     void setPreservesPitch(bool);
423
424     std::unique_ptr<PlatformTimeRanges> buffered();
425     std::unique_ptr<PlatformTimeRanges> seekable();
426     MediaTime minTimeSeekable();
427     MediaTime maxTimeSeekable();
428
429     double seekableTimeRangesLastModifiedTime();
430     double liveUpdateInterval();
431
432     bool didLoadingProgress();
433
434     double volume() const;
435     void setVolume(double);
436     bool platformVolumeConfigurationRequired() const { return client().mediaPlayerPlatformVolumeConfigurationRequired(); }
437
438     bool muted() const;
439     void setMuted(bool);
440
441     bool hasClosedCaptions() const;
442     void setClosedCaptionsVisible(bool closedCaptionsVisible);
443
444     void paint(GraphicsContext&, const FloatRect&);
445     void paintCurrentFrameInContext(GraphicsContext&, const FloatRect&);
446
447     // copyVideoTextureToPlatformTexture() is used to do the GPU-GPU textures copy without a readback to system memory.
448     // The first five parameters denote the corresponding GraphicsContext, destination texture, requested level, requested type and the required internalFormat for destination texture.
449     // The last two parameters premultiplyAlpha and flipY denote whether addtional premultiplyAlpha and flip operation are required during the copy.
450     // It returns true on success and false on failure.
451
452     // In the GPU-GPU textures copy, the source texture(Video texture) should have valid target, internalFormat and size, etc.
453     // The destination texture may need to be resized to to the dimensions of the source texture or re-defined to the required internalFormat.
454     // The current restrictions require that format shoud be RGB or RGBA, type should be UNSIGNED_BYTE and level should be 0. It may be lifted in the future.
455
456     // Each platform port can have its own implementation on this function. The default implementation for it is a single "return false" in MediaPlayerPrivate.h.
457     // In chromium, the implementation is based on GL_CHROMIUM_copy_texture extension which is documented at
458     // http://src.chromium.org/viewvc/chrome/trunk/src/gpu/GLES2/extensions/CHROMIUM/CHROMIUM_copy_texture.txt and implemented at
459     // http://src.chromium.org/viewvc/chrome/trunk/src/gpu/command_buffer/service/gles2_cmd_copy_texture_chromium.cc via shaders.
460     bool copyVideoTextureToPlatformTexture(GraphicsContext3D*, Platform3DObject texture, GC3Denum target, GC3Dint level, GC3Denum internalFormat, GC3Denum format, GC3Denum type, bool premultiplyAlpha, bool flipY);
461
462     NativeImagePtr nativeImageForCurrentTime();
463
464     using MediaPlayerEnums::NetworkState;
465     NetworkState networkState();
466
467     using MediaPlayerEnums::ReadyState;
468     ReadyState readyState();
469
470     using MediaPlayerEnums::MovieLoadType;
471     MovieLoadType movieLoadType() const;
472
473     using MediaPlayerEnums::Preload;
474     Preload preload() const;
475     void setPreload(Preload);
476
477     void networkStateChanged();
478     void readyStateChanged();
479     void volumeChanged(double);
480     void muteChanged(bool);
481     void timeChanged();
482     void sizeChanged();
483     void rateChanged();
484     void playbackStateChanged();
485     void durationChanged();
486     void firstVideoFrameAvailable();
487     void characteristicChanged();
488
489     void repaint();
490
491     MediaPlayerClient& client() const { return *m_client; }
492
493     bool hasAvailableVideoFrame() const;
494     void prepareForRendering();
495
496     bool canLoadPoster() const;
497     void setPoster(const String&);
498
499 #if USE(NATIVE_FULLSCREEN_VIDEO)
500     void enterFullscreen();
501     void exitFullscreen();
502 #endif
503
504 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
505     enum WirelessPlaybackTargetType { TargetTypeNone, TargetTypeAirPlay, TargetTypeTVOut };
506     WirelessPlaybackTargetType wirelessPlaybackTargetType() const;
507
508     String wirelessPlaybackTargetName() const;
509
510     bool wirelessVideoPlaybackDisabled() const;
511     void setWirelessVideoPlaybackDisabled(bool);
512
513     void currentPlaybackTargetIsWirelessChanged();
514     void playbackTargetAvailabilityChanged();
515
516     bool isCurrentPlaybackTargetWireless() const;
517     bool canPlayToWirelessPlaybackTarget() const;
518     void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&);
519
520     void setShouldPlayToPlaybackTarget(bool);
521 #endif
522
523     double minFastReverseRate() const;
524     double maxFastForwardRate() const;
525
526 #if USE(NATIVE_FULLSCREEN_VIDEO)
527     bool canEnterFullscreen() const;
528 #endif
529
530     // whether accelerated rendering is supported by the media engine for the current media.
531     bool supportsAcceleratedRendering() const;
532     // called when the rendering system flips the into or out of accelerated rendering mode.
533     void acceleratedRenderingStateChanged();
534
535     bool shouldMaintainAspectRatio() const;
536     void setShouldMaintainAspectRatio(bool);
537
538 #if PLATFORM(WIN) && USE(AVFOUNDATION)
539     GraphicsDeviceAdapter* graphicsDeviceAdapter() const;
540 #endif
541
542     bool hasSingleSecurityOrigin() const;
543
544     bool didPassCORSAccessCheck() const;
545
546     MediaTime mediaTimeForTimeValue(const MediaTime&) const;
547
548     double maximumDurationToCacheMediaTime() const;
549
550     unsigned decodedFrameCount() const;
551     unsigned droppedFrameCount() const;
552     unsigned audioDecodedByteCount() const;
553     unsigned videoDecodedByteCount() const;
554
555     void setPrivateBrowsingMode(bool);
556
557 #if ENABLE(WEB_AUDIO)
558     AudioSourceProvider* audioSourceProvider();
559 #endif
560
561 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
562     RefPtr<ArrayBuffer> cachedKeyForKeyId(const String& keyId) const;
563     bool keyNeeded(Uint8Array* initData);
564     String mediaKeysStorageDirectory() const;
565 #endif
566
567 #if ENABLE(ENCRYPTED_MEDIA)
568     void initializationDataEncountered(const String&, RefPtr<ArrayBuffer>&&);
569 #endif
570
571     String referrer() const;
572     String userAgent() const;
573
574     String engineDescription() const;
575     long platformErrorCode() const;
576
577     CachedResourceLoader* cachedResourceLoader();
578     RefPtr<PlatformMediaResourceLoader> createResourceLoader();
579
580 #if ENABLE(VIDEO_TRACK)
581     void addAudioTrack(AudioTrackPrivate&);
582     void addTextTrack(InbandTextTrackPrivate&);
583     void addVideoTrack(VideoTrackPrivate&);
584     void removeAudioTrack(AudioTrackPrivate&);
585     void removeTextTrack(InbandTextTrackPrivate&);
586     void removeVideoTrack(VideoTrackPrivate&);
587
588     bool requiresTextTrackRepresentation() const;
589     void setTextTrackRepresentation(TextTrackRepresentation*);
590     void syncTextTrackBounds();
591     void tracksChanged();
592 #if ENABLE(AVF_CAPTIONS)
593     void notifyTrackModeChanged();
594     Vector<RefPtr<PlatformTextTrack>> outOfBandTrackSources();
595 #endif
596 #endif
597
598 #if PLATFORM(IOS)
599     String mediaPlayerNetworkInterfaceName() const;
600     bool getRawCookies(const URL&, Vector<Cookie>&) const;
601 #endif
602
603     static void resetMediaEngines();
604
605 #if USE(GSTREAMER)
606     WEBCORE_EXPORT void simulateAudioInterruption();
607 #endif
608
609     String languageOfPrimaryAudioTrack() const;
610
611     size_t extraMemoryCost() const;
612
613     unsigned long long fileSize() const;
614
615 #if ENABLE(MEDIA_SOURCE)
616     std::optional<PlatformVideoPlaybackQualityMetrics> videoPlaybackQualityMetrics();
617 #endif
618
619     bool shouldWaitForResponseToAuthenticationChallenge(const AuthenticationChallenge&);
620     void handlePlaybackCommand(PlatformMediaSession::RemoteControlCommandType);
621     String sourceApplicationIdentifier() const;
622     Vector<String> preferredAudioCharacteristics() const;
623
624     bool ended() const;
625
626     void setShouldDisableSleep(bool);
627     bool shouldDisableSleep() const;
628
629     String contentMIMEType() const { return m_contentType.containerType(); }
630     String contentTypeCodecs() const { return m_contentType.parameter(ContentType::codecsParameter()); }
631     bool contentMIMETypeWasInferredFromExtension() const { return m_contentMIMETypeWasInferredFromExtension; }
632
633     const Vector<ContentType>& mediaContentTypesRequiringHardwareSupport() const;
634     bool shouldCheckHardwareSupport() const;
635
636 #if !RELEASE_LOG_DISABLED
637     const Logger& mediaPlayerLogger();
638     const void* mediaPlayerLogIdentifier() { return client().mediaPlayerLogIdentifier(); }
639 #endif
640
641 private:
642     MediaPlayer(MediaPlayerClient&);
643
644     const MediaPlayerFactory* nextBestMediaEngine(const MediaPlayerFactory*) const;
645     void loadWithNextMediaEngine(const MediaPlayerFactory*);
646     void reloadTimerFired();
647
648     MediaPlayerClient* m_client;
649     Timer m_reloadTimer;
650     std::unique_ptr<MediaPlayerPrivateInterface> m_private;
651     const MediaPlayerFactory* m_currentMediaEngine;
652     URL m_url;
653     ContentType m_contentType;
654     String m_keySystem;
655     IntSize m_size;
656     Preload m_preload;
657     bool m_visible;
658     double m_volume;
659     bool m_muted;
660     bool m_preservesPitch;
661     bool m_privateBrowsing;
662     bool m_shouldPrepareToRender;
663     bool m_contentMIMETypeWasInferredFromExtension;
664     bool m_initializingMediaEngine { false };
665
666 #if ENABLE(MEDIA_SOURCE)
667     RefPtr<MediaSourcePrivateClient> m_mediaSource;
668 #endif
669 #if ENABLE(MEDIA_STREAM)
670     RefPtr<MediaStreamPrivate> m_mediaStream;
671 #endif
672 };
673
674 using CreateMediaEnginePlayer = WTF::Function<std::unique_ptr<MediaPlayerPrivateInterface> (MediaPlayer*)>;
675 typedef void (*MediaEngineSupportedTypes)(HashSet<String, ASCIICaseInsensitiveHash>& types);
676 typedef MediaPlayer::SupportsType (*MediaEngineSupportsType)(const MediaEngineSupportParameters& parameters);
677 typedef HashSet<RefPtr<SecurityOrigin>> (*MediaEngineOriginsInMediaCache)(const String& path);
678 typedef void (*MediaEngineClearMediaCache)(const String& path, WallTime modifiedSince);
679 typedef void (*MediaEngineClearMediaCacheForOrigins)(const String& path, const HashSet<RefPtr<SecurityOrigin>>&);
680 typedef bool (*MediaEngineSupportsKeySystem)(const String& keySystem, const String& mimeType);
681
682 typedef void (*MediaEngineRegistrar)(CreateMediaEnginePlayer&&, MediaEngineSupportedTypes, MediaEngineSupportsType,
683     MediaEngineOriginsInMediaCache, MediaEngineClearMediaCache, MediaEngineClearMediaCacheForOrigins, MediaEngineSupportsKeySystem);
684 typedef void (*MediaEngineRegister)(MediaEngineRegistrar);
685
686 class MediaPlayerFactorySupport {
687 public:
688     WEBCORE_EXPORT static void callRegisterMediaEngine(MediaEngineRegister);
689 };
690
691 } // namespace WebCore
692
693 namespace WTF {
694
695 template<typename Type>
696 struct LogArgument;
697
698 template <>
699 struct LogArgument<MediaTime> {
700     static String toString(const MediaTime& time)
701     {
702         return time.toString();
703     }
704 };
705 }
706
707 #endif // ENABLE(VIDEO)
708
709 #endif