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