Rename ENABLE_ENCRYPTED_MEDIA_V2 to ENABLE_LEGACY_ENCRYPTED_MEDIA
[WebKit.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
35 namespace WebCore {
36
37 class IntRect;
38 class IntSize;
39 class MediaPlaybackTarget;
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 #if ENABLE(MEDIA_STREAM)
53     virtual void load(MediaStreamPrivate&) = 0;
54 #endif
55     virtual void cancelLoad() = 0;
56     
57     virtual void prepareToPlay() { }
58     virtual PlatformMedia platformMedia() const { return NoPlatformMedia; }
59     virtual PlatformLayer* platformLayer() const { return 0; }
60
61 #if PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
62     virtual void setVideoFullscreenLayer(PlatformLayer*, std::function<void()> completionHandler) { completionHandler(); }
63     virtual void setVideoFullscreenFrame(FloatRect) { }
64     virtual void setVideoFullscreenGravity(MediaPlayer::VideoGravity) { }
65     virtual void setVideoFullscreenMode(MediaPlayer::VideoFullscreenMode) { }
66 #endif
67
68 #if PLATFORM(IOS)
69     virtual NSArray *timedMetadata() const { return 0; }
70     virtual String accessLog() const { return emptyString(); }
71     virtual String errorLog() const { return emptyString(); }
72 #endif
73     virtual long platformErrorCode() const { return 0; }
74
75     virtual void play() = 0;
76     virtual void pause() = 0;    
77     virtual void setShouldBufferData(bool) { }
78
79     virtual bool supportsFullscreen() const { return false; }
80     virtual bool supportsScanning() const { return false; }
81     virtual bool requiresImmediateCompositing() const { return false; }
82
83     virtual bool canSaveMediaData() const { return false; }
84
85     virtual FloatSize naturalSize() const = 0;
86
87     virtual bool hasVideo() const = 0;
88     virtual bool hasAudio() const = 0;
89
90     virtual void setVisible(bool) = 0;
91
92     virtual float duration() const { return 0; }
93     virtual double durationDouble() const { return duration(); }
94     virtual MediaTime durationMediaTime() const { return MediaTime::createWithDouble(durationDouble()); }
95
96     virtual float currentTime() const { return 0; }
97     virtual double currentTimeDouble() const { return currentTime(); }
98     virtual MediaTime currentMediaTime() const { return MediaTime::createWithDouble(currentTimeDouble()); }
99
100     virtual MediaTime getStartDate() const { return MediaTime::createWithDouble(std::numeric_limits<double>::quiet_NaN()); }
101
102     virtual void seek(float) { }
103     virtual void seekDouble(double time) { seek(time); }
104     virtual void seek(const MediaTime& time) { seekDouble(time.toDouble()); }
105     virtual void seekWithTolerance(const MediaTime& time, const MediaTime&, const MediaTime&) { seek(time); }
106
107     virtual bool seeking() const = 0;
108
109     virtual MediaTime startTime() const { return MediaTime::zeroTime(); }
110     virtual MediaTime initialTime() const { return MediaTime::zeroTime(); }
111
112     virtual void setRate(float) { }
113     virtual void setRateDouble(double rate) { setRate(rate); }
114     virtual double rate() const { return 0; }
115
116     virtual void setPreservesPitch(bool) { }
117
118     virtual bool paused() const = 0;
119
120     virtual void setVolume(float) { }
121     virtual void setVolumeDouble(double volume) { return setVolume(volume); }
122 #if PLATFORM(IOS)
123     virtual float volume() const { return 1; }
124 #endif
125
126     virtual bool supportsMuting() const { return false; }
127     virtual void setMuted(bool) { }
128
129     virtual bool hasClosedCaptions() const { return false; }    
130     virtual void setClosedCaptionsVisible(bool) { }
131
132     virtual double maxFastForwardRate() const { return std::numeric_limits<double>::infinity(); }
133     virtual double minFastReverseRate() const { return -std::numeric_limits<double>::infinity(); }
134
135     virtual MediaPlayer::NetworkState networkState() const = 0;
136     virtual MediaPlayer::ReadyState readyState() const = 0;
137
138     virtual std::unique_ptr<PlatformTimeRanges> seekable() const { return maxMediaTimeSeekable() == MediaTime::zeroTime() ? std::make_unique<PlatformTimeRanges>() : std::make_unique<PlatformTimeRanges>(minMediaTimeSeekable(), maxMediaTimeSeekable()); }
139     virtual float maxTimeSeekable() const { return 0; }
140     virtual MediaTime maxMediaTimeSeekable() const { return MediaTime::createWithDouble(maxTimeSeekable()); }
141     virtual double minTimeSeekable() const { return 0; }
142     virtual MediaTime minMediaTimeSeekable() const { return MediaTime::createWithDouble(minTimeSeekable()); }
143     virtual std::unique_ptr<PlatformTimeRanges> buffered() const = 0;
144
145     virtual unsigned long long totalBytes() const { return 0; }
146     virtual bool didLoadingProgress() const = 0;
147
148     virtual void setSize(const IntSize&) = 0;
149
150     virtual void paint(GraphicsContext&, const FloatRect&) = 0;
151
152     virtual void paintCurrentFrameInContext(GraphicsContext& c, const FloatRect& r) { paint(c, r); }
153     virtual bool copyVideoTextureToPlatformTexture(GraphicsContext3D*, Platform3DObject, GC3Denum, GC3Dint, GC3Denum, GC3Denum, GC3Denum, bool, bool) { return false; }
154     virtual NativeImagePtr nativeImageForCurrentTime() { return nullptr; }
155
156     virtual void setPreload(MediaPlayer::Preload) { }
157
158     virtual bool hasAvailableVideoFrame() const { return readyState() >= MediaPlayer::HaveCurrentData; }
159
160     virtual bool canLoadPoster() const { return false; }
161     virtual void setPoster(const String&) { }
162
163 #if USE(NATIVE_FULLSCREEN_VIDEO)
164     virtual void enterFullscreen() { }
165     virtual void exitFullscreen() { }
166 #endif
167
168 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
169
170     virtual String wirelessPlaybackTargetName() const { return emptyString(); }
171     virtual MediaPlayer::WirelessPlaybackTargetType wirelessPlaybackTargetType() const { return MediaPlayer::TargetTypeNone; }
172
173     virtual bool wirelessVideoPlaybackDisabled() const { return true; }
174     virtual void setWirelessVideoPlaybackDisabled(bool) { }
175
176     virtual bool canPlayToWirelessPlaybackTarget() const { return false; }
177     virtual bool isCurrentPlaybackTargetWireless() const { return false; }
178     virtual void setWirelessPlaybackTarget(Ref<MediaPlaybackTarget>&&) { }
179
180     virtual void setShouldPlayToPlaybackTarget(bool) { }
181 #endif
182
183 #if USE(NATIVE_FULLSCREEN_VIDEO)
184     virtual bool canEnterFullscreen() const { return false; }
185 #endif
186
187     // whether accelerated rendering is supported by the media engine for the current media.
188     virtual bool supportsAcceleratedRendering() const { return false; }
189     // called when the rendering system flips the into or out of accelerated rendering mode.
190     virtual void acceleratedRenderingStateChanged() { }
191
192     virtual bool shouldMaintainAspectRatio() const { return true; }
193     virtual void setShouldMaintainAspectRatio(bool) { }
194
195     virtual bool hasSingleSecurityOrigin() const { return false; }
196
197     virtual bool didPassCORSAccessCheck() const { return false; }
198
199     virtual MediaPlayer::MovieLoadType movieLoadType() const { return MediaPlayer::Unknown; }
200
201     virtual void prepareForRendering() { }
202
203     // Time value in the movie's time scale. It is only necessary to override this if the media
204     // engine uses rational numbers to represent media time.
205     virtual MediaTime mediaTimeForTimeValue(const MediaTime& timeValue) const { return timeValue; }
206
207     // Overide this if it is safe for HTMLMediaElement to cache movie time and report
208     // 'currentTime' as [cached time + elapsed wall time]. Returns the maximum wall time
209     // it is OK to calculate movie time before refreshing the cached time.
210     virtual double maximumDurationToCacheMediaTime() const { return 0; }
211
212     virtual unsigned decodedFrameCount() const { return 0; }
213     virtual unsigned droppedFrameCount() const { return 0; }
214     virtual unsigned audioDecodedByteCount() const { return 0; }
215     virtual unsigned videoDecodedByteCount() const { return 0; }
216
217     HashSet<RefPtr<SecurityOrigin>> originsInMediaCache(const String&) { return { }; }
218     void clearMediaCache(const String&, std::chrono::system_clock::time_point) { }
219     void clearMediaCacheForOrigins(const String&, const HashSet<RefPtr<SecurityOrigin>>&) { }
220
221     virtual void setPrivateBrowsingMode(bool) { }
222
223     virtual String engineDescription() const { return emptyString(); }
224
225 #if ENABLE(WEB_AUDIO)
226     virtual AudioSourceProvider* audioSourceProvider() { return 0; }
227 #endif
228
229 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
230     virtual std::unique_ptr<CDMSession> createSession(const String&, CDMSessionClient*) { return nullptr; }
231     virtual void setCDMSession(CDMSession*) { }
232     virtual void keyAdded() { }
233 #endif
234
235 #if ENABLE(VIDEO_TRACK)
236     virtual bool requiresTextTrackRepresentation() const { return false; }
237     virtual void setTextTrackRepresentation(TextTrackRepresentation*) { }
238     virtual void syncTextTrackBounds() { };
239     virtual void tracksChanged() { };
240 #endif
241
242 #if USE(GSTREAMER)
243     virtual void simulateAudioInterruption() { }
244 #endif
245
246     virtual String languageOfPrimaryAudioTrack() const { return emptyString(); }
247
248     virtual size_t extraMemoryCost() const
249     {
250         MediaTime duration = this->durationMediaTime();
251         if (!duration)
252             return 0;
253
254         unsigned long long extra = totalBytes() * buffered()->totalDuration().toDouble() / duration.toDouble();
255         return static_cast<unsigned>(extra);
256     }
257
258     virtual unsigned long long fileSize() const { return 0; }
259
260     virtual bool ended() const { return false; }
261
262 #if ENABLE(MEDIA_SOURCE)
263     virtual unsigned long totalVideoFrames() { return 0; }
264     virtual unsigned long droppedVideoFrames() { return 0; }
265     virtual unsigned long corruptedVideoFrames() { return 0; }
266     virtual MediaTime totalFrameDelay() { return MediaTime::zeroTime(); }
267 #endif
268
269 #if ENABLE(AVF_CAPTIONS)
270     virtual void notifyTrackModeChanged() { }
271 #endif
272
273     virtual void notifyActiveSourceBuffersChanged() { }
274 };
275
276 }
277
278 #endif
279 #endif