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