Expose a flag so that fullscreen video on android can work with FULLSCREEN_API
[WebKit-https.git] / Source / WebKit / chromium / public / WebMediaPlayer.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebMediaPlayer_h
32 #define WebMediaPlayer_h
33
34 #include "WebTimeRange.h"
35 #include "WebVideoFrame.h"
36 #include "platform/WebCanvas.h"
37 #include "platform/WebString.h"
38
39 namespace WebKit {
40
41 class WebAudioSourceProvider;
42 class WebAudioSourceProviderClient;
43 class WebMediaPlayerClient;
44 class WebStreamTextureClient;
45 class WebString;
46 class WebURL;
47 struct WebRect;
48 struct WebSize;
49
50 class WebMediaPlayer {
51 public:
52     enum NetworkState {
53         NetworkStateEmpty,
54         NetworkStateIdle,
55         NetworkStateLoading,
56         NetworkStateLoaded,
57         NetworkStateFormatError,
58         NetworkStateNetworkError,
59         NetworkStateDecodeError,
60     };
61
62     enum ReadyState {
63         ReadyStateHaveNothing,
64         ReadyStateHaveMetadata,
65         ReadyStateHaveCurrentData,
66         ReadyStateHaveFutureData,
67         ReadyStateHaveEnoughData,
68     };
69
70     enum MovieLoadType {
71         MovieLoadTypeUnknown,
72         MovieLoadTypeDownload,
73         MovieLoadTypeStoredStream,
74         MovieLoadTypeLiveStream,
75     };
76
77     enum Preload {
78         PreloadNone,
79         PreloadMetaData,
80         PreloadAuto,
81     };
82
83     enum AddIdStatus {
84         AddIdStatusOk,
85         AddIdStatusNotSupported,
86         AddIdStatusReachedIdLimit
87     };
88
89     enum EndOfStreamStatus {
90         EndOfStreamStatusNoError,
91         EndOfStreamStatusNetworkError,
92         EndOfStreamStatusDecodeError,
93     };
94
95     // Represents synchronous exceptions that can be thrown from the Encrypted
96     // Media methods. This is different from the asynchronous MediaKeyError.
97     enum MediaKeyException {
98         MediaKeyExceptionNoError,
99         MediaKeyExceptionInvalidPlayerState,
100         MediaKeyExceptionKeySystemNotSupported,
101     };
102
103     virtual ~WebMediaPlayer() {}
104
105     virtual void load(const WebURL&) = 0;
106     virtual void cancelLoad() = 0;
107
108     // Playback controls.
109     virtual void play() = 0;
110     virtual void pause() = 0;
111     virtual bool supportsFullscreen() const = 0;
112     virtual bool supportsSave() const = 0;
113     virtual void seek(float seconds) = 0;
114     virtual void setEndTime(float seconds) = 0;
115     virtual void setRate(float) = 0;
116     virtual void setVolume(float) = 0;
117     virtual void setVisible(bool) = 0;
118     virtual void setPreload(Preload) { };
119     virtual bool totalBytesKnown() = 0;
120     virtual const WebTimeRanges& buffered() = 0;
121     virtual float maxTimeSeekable() const = 0;
122
123     virtual void setSize(const WebSize&) = 0;
124
125     virtual void paint(WebCanvas*, const WebRect&, uint8_t alpha) = 0;
126
127     // True if the loaded media has a playable video/audio track.
128     virtual bool hasVideo() const = 0;
129     virtual bool hasAudio() const = 0;
130
131     // Dimension of the video.
132     virtual WebSize naturalSize() const = 0;
133
134     // Getters of playback state.
135     virtual bool paused() const = 0;
136     virtual bool seeking() const = 0;
137     virtual float duration() const = 0;
138     virtual float currentTime() const = 0;
139
140     // Get rate of loading the resource.
141     virtual int dataRate() const = 0;
142
143     // Internal states of loading and network.
144     virtual NetworkState networkState() const = 0;
145     virtual ReadyState readyState() const = 0;
146
147     virtual unsigned long long bytesLoaded() const = 0;
148     virtual unsigned long long totalBytes() const = 0;
149
150     virtual bool hasSingleSecurityOrigin() const = 0;
151     virtual MovieLoadType movieLoadType() const = 0;
152
153     virtual float mediaTimeForTimeValue(float timeValue) const = 0;
154
155     virtual unsigned decodedFrameCount() const = 0;
156     virtual unsigned droppedFrameCount() const = 0;
157     virtual unsigned audioDecodedByteCount() const = 0;
158     virtual unsigned videoDecodedByteCount() const = 0;
159
160     // This function returns a pointer to a WebVideoFrame, which is
161     // a WebKit wrapper for a video frame in chromium. This places a lock
162     // on the frame in chromium, and calls to this method should always be
163     // followed with a call to putCurrentFrame(). The ownership of this object
164     // is not transferred to the caller, and the caller should not free the
165     // returned object.
166     virtual WebVideoFrame* getCurrentFrame() { return 0; }
167     // This function releases the lock on the current video frame in Chromium.
168     // It should always be called after getCurrentFrame(). Frame passed to this
169     // method should no longer be referenced after the call is made.
170     virtual void putCurrentFrame(WebVideoFrame*) { }
171
172     virtual void setStreamTextureClient(WebStreamTextureClient*) { }
173
174     virtual WebAudioSourceProvider* audioSourceProvider() { return 0; }
175
176     virtual AddIdStatus sourceAddId(const WebString& id, const WebString& type) { return AddIdStatusNotSupported; }
177     virtual bool sourceRemoveId(const WebString& id) { return false; }
178     virtual bool sourceAppend(const unsigned char* data, unsigned length) { return false; }
179     virtual void sourceEndOfStream(EndOfStreamStatus)  { }
180
181     // Returns whether keySystem is supported. If true, the result will be
182     // reported by an event.
183     virtual MediaKeyException generateKeyRequest(const WebString& keySystem, const unsigned char* initData, unsigned initDataLength) { return MediaKeyExceptionKeySystemNotSupported; }
184     virtual MediaKeyException addKey(const WebString& keySystem, const unsigned char* key, unsigned keyLength, const unsigned char* initData, unsigned initDataLength, const WebString& sessionId) { return MediaKeyExceptionKeySystemNotSupported; }
185     virtual MediaKeyException cancelKeyRequest(const WebString& keySystem, const WebString& sessionId) { return MediaKeyExceptionKeySystemNotSupported; }
186
187     // Instuct WebMediaPlayer to enter/exit fullscreen.
188     // Returns true if the player can enter fullscreen.
189     virtual bool enterFullscreen() { return false; }
190     virtual void exitFullscreen() { }
191 };
192
193 } // namespace WebKit
194
195 #endif