6fb96abb164d471782c5a71fe2ece91f23ac1d0c
[WebKit-https.git] / Source / WebCore / platform / graphics / MediaPlayerPrivate.h
1 /*
2  * Copyright (C) 2009-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 MediaPlayerPrivate_h
27 #define MediaPlayerPrivate_h
28
29 #if ENABLE(VIDEO)
30
31 #include "MediaPlayer.h"
32 #include "PlatformTimeRanges.h"
33 #include <wtf/Forward.h>
34 #include <wtf/OwnPtr.h>
35
36 namespace WebCore {
37
38 class IntRect;
39 class IntSize;
40 class PlatformTextTrack;
41
42 class MediaPlayerPrivateInterface {
43     WTF_MAKE_NONCOPYABLE(MediaPlayerPrivateInterface); WTF_MAKE_FAST_ALLOCATED;
44 public:
45     MediaPlayerPrivateInterface() { }
46     virtual ~MediaPlayerPrivateInterface() { }
47
48     virtual void load(const String& url) = 0;
49 #if ENABLE(MEDIA_SOURCE)
50     virtual void load(const String& url, MediaSourcePrivateClient*) = 0;
51 #endif
52     virtual void cancelLoad() = 0;
53     
54     virtual void prepareToPlay() { }
55     virtual PlatformMedia platformMedia() const { return NoPlatformMedia; }
56     virtual PlatformLayer* platformLayer() const { return 0; }
57 #if PLATFORM(IOS)
58     virtual void setVideoFullscreenLayer(PlatformLayer*) { }
59     virtual void setVideoFullscreenFrame(FloatRect) { }
60     virtual void setVideoFullscreenGravity(MediaPlayer::VideoGravity) { }
61 #endif
62     virtual void play() = 0;
63     virtual void pause() = 0;    
64
65     virtual bool supportsFullscreen() const { return false; }
66     virtual bool supportsSave() const { return false; }
67     virtual bool supportsScanning() const { return false; }
68     virtual bool requiresImmediateCompositing() const { return false; }
69
70     virtual IntSize naturalSize() const = 0;
71
72     virtual bool hasVideo() const = 0;
73     virtual bool hasAudio() const = 0;
74
75     virtual void setVisible(bool) = 0;
76
77     virtual float duration() const { return 0; }
78     virtual double durationDouble() const { return duration(); }
79
80     virtual float currentTime() const { return 0; }
81     virtual double currentTimeDouble() const { return currentTime(); }
82
83     virtual void seek(float) { }
84     virtual void seekDouble(double time) { seek(time); }
85     virtual void seekWithTolerance(double time, double, double) { seekDouble(time); }
86
87     virtual bool seeking() const = 0;
88
89     virtual float startTime() const { return 0; }
90     virtual double startTimeDouble() const { return startTime(); }
91
92     virtual double initialTime() const { return 0; }
93
94     virtual void setRate(float) { }
95     virtual void setRateDouble(double rate) { setRate(rate); }
96
97     virtual void setPreservesPitch(bool) { }
98
99     virtual bool paused() const = 0;
100
101     virtual void setVolume(float) { }
102     virtual void setVolumeDouble(double volume) { return setVolume(volume); }
103 #if PLATFORM(IOS)
104     virtual float volume() const { return 1; }
105 #endif
106
107     virtual bool supportsMuting() const { return false; }
108     virtual void setMuted(bool) { }
109
110     virtual bool hasClosedCaptions() const { return false; }    
111     virtual void setClosedCaptionsVisible(bool) { }
112
113     virtual MediaPlayer::NetworkState networkState() const = 0;
114     virtual MediaPlayer::ReadyState readyState() const = 0;
115
116     virtual std::unique_ptr<PlatformTimeRanges> seekable() const { return maxTimeSeekableDouble() ? PlatformTimeRanges::create(minTimeSeekable(), maxTimeSeekableDouble()) : PlatformTimeRanges::create(); }
117     virtual float maxTimeSeekable() const { return 0; }
118     virtual double maxTimeSeekableDouble() const { return maxTimeSeekable(); }
119     virtual double minTimeSeekable() const { return 0; }
120     virtual std::unique_ptr<PlatformTimeRanges> buffered() const = 0;
121
122     virtual bool didLoadingProgress() const = 0;
123
124     virtual void setSize(const IntSize&) = 0;
125
126     virtual void paint(GraphicsContext*, const IntRect&) = 0;
127
128     virtual void paintCurrentFrameInContext(GraphicsContext* c, const IntRect& r) { paint(c, r); }
129     virtual bool copyVideoTextureToPlatformTexture(GraphicsContext3D*, Platform3DObject, GC3Dint, GC3Denum, GC3Denum, bool, bool) { return false; }
130     virtual PassNativeImagePtr nativeImageForCurrentTime() { return nullptr; }
131
132     virtual void setPreload(MediaPlayer::Preload) { }
133
134     virtual bool hasAvailableVideoFrame() const { return readyState() >= MediaPlayer::HaveCurrentData; }
135
136     virtual bool canLoadPoster() const { return false; }
137     virtual void setPoster(const String&) { }
138
139 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
140     virtual void deliverNotification(MediaPlayerProxyNotificationType) { }
141     virtual void setMediaPlayerProxy(WebMediaPlayerProxy*) { }
142     virtual void setControls(bool) { }
143 #endif
144
145 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO) || USE(NATIVE_FULLSCREEN_VIDEO)
146     virtual void enterFullscreen() { }
147     virtual void exitFullscreen() { }
148 #endif
149
150 #if ENABLE(IOS_AIRPLAY)
151     virtual bool isCurrentPlaybackTargetWireless() const { return false; }
152
153     virtual String wirelessPlaybackTargetName() const { return emptyString(); }
154     virtual MediaPlayer::WirelessPlaybackTargetType wirelessPlaybackTargetType() const { return MediaPlayer::TargetTypeNone; }
155
156     virtual void showPlaybackTargetPicker() { }
157
158     virtual bool hasWirelessPlaybackTargets() const { return false; }
159
160     virtual bool wirelessVideoPlaybackDisabled() const { return false; }
161     virtual void setWirelessVideoPlaybackDisabled(bool) { }
162
163     virtual void setHasPlaybackTargetAvailabilityListeners(bool) { }
164 #endif
165
166 #if USE(NATIVE_FULLSCREEN_VIDEO)
167     virtual bool canEnterFullscreen() const { return false; }
168 #endif
169
170     // whether accelerated rendering is supported by the media engine for the current media.
171     virtual bool supportsAcceleratedRendering() const { return false; }
172     // called when the rendering system flips the into or out of accelerated rendering mode.
173     virtual void acceleratedRenderingStateChanged() { }
174
175     virtual bool shouldMaintainAspectRatio() const { return true; }
176     virtual void setShouldMaintainAspectRatio(bool) { }
177
178     virtual bool hasSingleSecurityOrigin() const { return false; }
179
180     virtual bool didPassCORSAccessCheck() const { return false; }
181
182     virtual MediaPlayer::MovieLoadType movieLoadType() const { return MediaPlayer::Unknown; }
183
184     virtual void prepareForRendering() { }
185
186     // Time value in the movie's time scale. It is only necessary to override this if the media
187     // engine uses rational numbers to represent media time.
188     virtual float mediaTimeForTimeValue(float timeValue) const { return timeValue; }
189     virtual double mediaTimeForTimeValueDouble(double timeValue) const { return timeValue; }
190
191     // Overide this if it is safe for HTMLMediaElement to cache movie time and report
192     // 'currentTime' as [cached time + elapsed wall time]. Returns the maximum wall time
193     // it is OK to calculate movie time before refreshing the cached time.
194     virtual double maximumDurationToCacheMediaTime() const { return 0; }
195
196     virtual unsigned decodedFrameCount() const { return 0; }
197     virtual unsigned droppedFrameCount() const { return 0; }
198     virtual unsigned audioDecodedByteCount() const { return 0; }
199     virtual unsigned videoDecodedByteCount() const { return 0; }
200
201     void getSitesInMediaCache(Vector<String>&) { }
202     void clearMediaCache() { }
203     void clearMediaCacheForSite(const String&) { }
204
205     virtual void setPrivateBrowsingMode(bool) { }
206
207     virtual String engineDescription() const { return emptyString(); }
208
209 #if ENABLE(WEB_AUDIO)
210     virtual AudioSourceProvider* audioSourceProvider() { return 0; }
211 #endif
212
213 #if ENABLE(ENCRYPTED_MEDIA)
214     virtual MediaPlayer::MediaKeyException addKey(const String&, const unsigned char*, unsigned, const unsigned char*, unsigned, const String&) { return MediaPlayer::KeySystemNotSupported; }
215     virtual MediaPlayer::MediaKeyException generateKeyRequest(const String&, const unsigned char*, unsigned) { return MediaPlayer::KeySystemNotSupported; }
216     virtual MediaPlayer::MediaKeyException cancelKeyRequest(const String&, const String&) { return MediaPlayer::KeySystemNotSupported; }
217 #endif
218
219 #if ENABLE(ENCRYPTED_MEDIA_V2)
220     virtual std::unique_ptr<CDMSession> createSession(const String&) { return nullptr; }
221 #endif
222
223 #if ENABLE(VIDEO_TRACK)
224     virtual bool requiresTextTrackRepresentation() const { return false; }
225     virtual void setTextTrackRepresentation(TextTrackRepresentation*) { }
226 #endif
227
228 #if USE(PLATFORM_TEXT_TRACK_MENU)
229     virtual bool implementsTextTrackControls() const { return false; }
230     virtual PassRefPtr<PlatformTextTrackMenuInterface> textTrackMenu() { return 0; }
231 #endif
232
233 #if USE(GSTREAMER)
234     virtual void simulateAudioInterruption() { }
235 #endif
236
237 #if PLATFORM(IOS)
238     virtual void attributeChanged(const String&, const String&) { }
239     virtual bool readyForPlayback() const { return true; }
240 #endif
241
242     virtual String languageOfPrimaryAudioTrack() const { return emptyString(); }
243
244     virtual size_t extraMemoryCost() const { return 0; }
245     
246     virtual unsigned long long fileSize() const { return 0; }
247
248 #if ENABLE(MEDIA_SOURCE)
249     virtual unsigned long totalVideoFrames() { return 0; }
250     virtual unsigned long droppedVideoFrames() { return 0; }
251     virtual unsigned long corruptedVideoFrames() { return 0; }
252     virtual double totalFrameDelay() { return 0; }
253 #endif
254
255 #if ENABLE(AVF_CAPTIONS)
256     virtual void notifyTrackModeChanged() { }
257 #endif
258 };
259
260 }
261
262 #endif
263 #endif