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