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