ff55d1b0b5ac0822bb56fdd7c95c8515a23e3e6c
[WebKit-https.git] / Source / WebCore / platform / graphics / MediaPlayerPrivate.h
1 /*
2  * Copyright (C) 2009, 2010, 2011 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 "TimeRanges.h"
33 #include <wtf/Forward.h>
34
35 namespace WebCore {
36
37 class IntRect;
38 class IntSize;
39
40 class MediaPlayerPrivateInterface {
41     WTF_MAKE_NONCOPYABLE(MediaPlayerPrivateInterface); WTF_MAKE_FAST_ALLOCATED;
42 public:
43     MediaPlayerPrivateInterface() { }
44     virtual ~MediaPlayerPrivateInterface() { }
45
46     virtual void load(const String& url) = 0;
47     virtual void cancelLoad() = 0;
48     
49     virtual void prepareToPlay() { }
50     virtual PlatformMedia platformMedia() const { return NoPlatformMedia; }
51 #if USE(ACCELERATED_COMPOSITING)
52     virtual PlatformLayer* platformLayer() const { return 0; }
53 #endif
54
55     virtual void play() = 0;
56     virtual void pause() = 0;    
57
58     virtual bool supportsFullscreen() const { return false; }
59     virtual bool supportsSave() const { return false; }
60     virtual bool supportsScanning() const { return false; }
61
62     virtual IntSize naturalSize() const = 0;
63
64     virtual bool hasVideo() const = 0;
65     virtual bool hasAudio() const = 0;
66
67     virtual void setVisible(bool) = 0;
68
69     virtual float duration() const = 0;
70
71     virtual float currentTime() const = 0;
72     virtual void seek(float time) = 0;
73     virtual bool seeking() const = 0;
74
75     virtual float startTime() const { return 0; }
76
77     virtual double initialTime() const { return 0; }
78
79     virtual void setRate(float) = 0;
80     virtual void setPreservesPitch(bool) { }
81
82     virtual bool paused() const = 0;
83
84     virtual void setVolume(float) = 0;
85
86     virtual bool supportsMuting() const { return false; }
87     virtual void setMuted(bool) { }
88
89     virtual bool hasClosedCaptions() const { return false; }    
90     virtual void setClosedCaptionsVisible(bool) { }
91
92     virtual MediaPlayer::NetworkState networkState() const = 0;
93     virtual MediaPlayer::ReadyState readyState() const = 0;
94
95     virtual PassRefPtr<TimeRanges> seekable() const { return maxTimeSeekable() ? TimeRanges::create(0, maxTimeSeekable()) : TimeRanges::create(); }
96     virtual float maxTimeSeekable() const = 0;
97     virtual PassRefPtr<TimeRanges> buffered() const = 0;
98
99     virtual unsigned bytesLoaded() const = 0;
100
101     virtual void setSize(const IntSize&) = 0;
102
103     virtual void paint(GraphicsContext*, const IntRect&) = 0;
104
105     virtual void paintCurrentFrameInContext(GraphicsContext* c, const IntRect& r) { paint(c, r); }
106
107     virtual void setPreload(MediaPlayer::Preload) { };
108
109     virtual bool hasAvailableVideoFrame() const { return readyState() >= MediaPlayer::HaveCurrentData; }
110
111     virtual bool canLoadPoster() const { return false; }
112     virtual void setPoster(const String&) { }
113
114 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
115     virtual void deliverNotification(MediaPlayerProxyNotificationType) = 0;
116     virtual void setMediaPlayerProxy(WebMediaPlayerProxy*) = 0;
117     virtual void setControls(bool) { }
118     virtual void enterFullscreen() { }
119     virtual void exitFullscreen() { }
120 #endif
121
122 #if USE(ACCELERATED_COMPOSITING)
123     // whether accelerated rendering is supported by the media engine for the current media.
124     virtual bool supportsAcceleratedRendering() const { return false; }
125     // called when the rendering system flips the into or out of accelerated rendering mode.
126     virtual void acceleratedRenderingStateChanged() { }
127 #endif
128
129     virtual bool hasSingleSecurityOrigin() const { return false; }
130
131     virtual MediaPlayer::MovieLoadType movieLoadType() const { return MediaPlayer::Unknown; }
132
133     virtual void prepareForRendering() { }
134
135     // Time value in the movie's time scale. It is only necessary to override this if the media
136     // engine uses rational numbers to represent media time.
137     virtual float mediaTimeForTimeValue(float timeValue) const { return timeValue; }
138
139     // Overide this if it is safe for HTMLMediaElement to cache movie time and report
140     // 'currentTime' as [cached time + elapsed wall time]. Returns the maximum wall time
141     // it is OK to calculate movie time before refreshing the cached time.
142     virtual double maximumDurationToCacheMediaTime() const { return 0; }
143
144     virtual unsigned decodedFrameCount() const { return 0; }
145     virtual unsigned droppedFrameCount() const { return 0; }
146     virtual unsigned audioDecodedByteCount() const { return 0; }
147     virtual unsigned videoDecodedByteCount() const { return 0; }
148
149     void getSitesInMediaCache(Vector<String>&) { }
150     void clearMediaCache() { }
151     void clearMediaCacheForSite(const String&) { }
152
153     virtual void setPrivateBrowsingMode(bool) { }
154
155
156 #if ENABLE(WEB_AUDIO)
157     virtual AudioSourceProvider* audioSourceProvider() { return 0; }
158 #endif
159
160 #if ENABLE(MEDIA_SOURCE)
161     virtual MediaPlayer::AddIdStatus sourceAddId(const String&, const String&) { return MediaPlayer::NotSupported; }
162     virtual bool sourceRemoveId(const String&) { return false; }
163     virtual bool sourceAppend(const unsigned char*, unsigned) { return false; }
164     virtual void sourceEndOfStream(MediaPlayer::EndOfStreamStatus) { };
165 #endif
166
167 #if ENABLE(ENCRYPTED_MEDIA)
168     virtual MediaPlayer::MediaKeyException addKey(const String& keySystem, const unsigned char* key, unsigned keyLength, const unsigned char* initData, unsigned initDataLength, const String& sessionId) { return MediaPlayer::KeySystemNotSupported; }
169     virtual MediaPlayer::MediaKeyException generateKeyRequest(const String& keySystem, const unsigned char* initData, unsigned initDataLength) { return MediaPlayer::KeySystemNotSupported; }
170     virtual MediaPlayer::MediaKeyException cancelKeyRequest(const String& keySystem, const String& sessionId) { return MediaPlayer::KeySystemNotSupported; }
171 #endif
172 };
173
174 }
175
176 #endif
177 #endif