Fix WebKit style violations in Chromium WebMediaPlayer.h & WebMediaPlayerClient.h
[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
38 namespace WebKit {
39
40 class WebAudioSourceProvider;
41 class WebAudioSourceProviderClient;
42 class WebMediaPlayerClient;
43 class WebStreamTextureClient;
44 class WebString;
45 class WebURL;
46 struct WebRect;
47 struct WebSize;
48
49 class WebMediaPlayer {
50 public:
51     enum NetworkState {
52         NetworkStateEmpty,
53         NetworkStateIdle,
54         NetworkStateLoading,
55         NetworkStateLoaded,
56         NetworkStateFormatError,
57         NetworkStateNetworkError,
58         NetworkStateDecodeError,
59         Empty = NetworkStateEmpty,
60         Idle = NetworkStateIdle,
61         Loading = NetworkStateLoading,
62         Loaded = NetworkStateLoaded,
63         FormatError = NetworkStateFormatError,
64         NetworkError = NetworkStateNetworkError,
65         DecodeError = NetworkStateDecodeError,
66     };
67
68     enum ReadyState {
69         ReadyStateHaveNothing,
70         ReadyStateHaveMetadata,
71         ReadyStateHaveCurrentData,
72         ReadyStateHaveFutureData,
73         ReadyStateHaveEnoughData,
74         HaveNothing = ReadyStateHaveNothing,
75         HaveMetadata = ReadyStateHaveMetadata,
76         HaveCurrentData = ReadyStateHaveCurrentData,
77         HaveFutureData = ReadyStateHaveFutureData,
78         HaveEnoughData = ReadyStateHaveEnoughData,
79     };
80
81     enum MovieLoadType {
82         MovieLoadTypeUnknown,
83         MovieLoadTypeDownload,
84         MovieLoadTypeStoredStream,
85         MovieLoadTypeLiveStream,
86         Unknown = MovieLoadTypeUnknown,
87         Download = MovieLoadTypeDownload,
88         StoredStream = MovieLoadTypeStoredStream,
89         LiveStream = MovieLoadTypeLiveStream,
90     };
91
92     enum Preload {
93         PreloadNone,
94         PreloadMetaData,
95         PreloadAuto,
96         None = PreloadNone,
97         MetaData = PreloadMetaData,
98         Auto = PreloadAuto,
99     };
100
101     enum EndOfStreamStatus {
102         EndOfStreamStatusNoError,
103         EndOfStreamStatusNetworkError,
104         EndOfStreamStatusDecodeError,
105         EosNoError = EndOfStreamStatusNoError,
106         EosNetworkError = EndOfStreamStatusNetworkError,
107         EosDecodeError = EndOfStreamStatusDecodeError,
108     };
109
110     // Represents synchronous exceptions that can be thrown from the Encrypted
111     // Media methods. This is different from the asynchronous MediaKeyError.
112     enum MediaKeyException {
113         MediaKeyExceptionNoError,
114         MediaKeyExceptionInvalidPlayerState,
115         MediaKeyExceptionKeySystemNotSupported,
116         NoError = MediaKeyExceptionNoError,
117         InvalidPlayerState = MediaKeyExceptionInvalidPlayerState,
118         KeySystemNotSupported = MediaKeyExceptionKeySystemNotSupported,
119     };
120
121     virtual ~WebMediaPlayer() {}
122
123     virtual void load(const WebURL&) = 0;
124     virtual void cancelLoad() = 0;
125
126     // Playback controls.
127     virtual void play() = 0;
128     virtual void pause() = 0;
129     virtual bool supportsFullscreen() const = 0;
130     virtual bool supportsSave() const = 0;
131     virtual void seek(float seconds) = 0;
132     virtual void setEndTime(float seconds) = 0;
133     virtual void setRate(float) = 0;
134     virtual void setVolume(float) = 0;
135     virtual void setVisible(bool) = 0;
136     virtual void setPreload(Preload) { };
137     virtual bool totalBytesKnown() = 0;
138     virtual const WebTimeRanges& buffered() = 0;
139     virtual float maxTimeSeekable() const = 0;
140
141     virtual void setSize(const WebSize&) = 0;
142
143     virtual void paint(WebCanvas*, const WebRect&, uint8_t alpha) = 0;
144
145     // True if the loaded media has a playable video/audio track.
146     virtual bool hasVideo() const = 0;
147     virtual bool hasAudio() const = 0;
148
149     // Dimension of the video.
150     virtual WebSize naturalSize() const = 0;
151
152     // Getters of playback state.
153     virtual bool paused() const = 0;
154     virtual bool seeking() const = 0;
155     virtual float duration() const = 0;
156     virtual float currentTime() const = 0;
157
158     // Get rate of loading the resource.
159     virtual int dataRate() const = 0;
160
161     // Internal states of loading and network.
162     virtual NetworkState networkState() const = 0;
163     virtual ReadyState readyState() const = 0;
164
165     virtual unsigned long long bytesLoaded() const = 0;
166     virtual unsigned long long totalBytes() const = 0;
167
168     virtual bool hasSingleSecurityOrigin() const = 0;
169     virtual MovieLoadType movieLoadType() const = 0;
170
171     virtual float mediaTimeForTimeValue(float timeValue) const = 0;
172
173     virtual unsigned decodedFrameCount() const = 0;
174     virtual unsigned droppedFrameCount() const = 0;
175     virtual unsigned audioDecodedByteCount() const = 0;
176     virtual unsigned videoDecodedByteCount() const = 0;
177
178     // This function returns a pointer to a WebVideoFrame, which is
179     // a WebKit wrapper for a video frame in chromium. This places a lock
180     // on the frame in chromium, and calls to this method should always be
181     // followed with a call to putCurrentFrame(). The ownership of this object
182     // is not transferred to the caller, and the caller should not free the
183     // returned object.
184     virtual WebVideoFrame* getCurrentFrame() { return 0; }
185     // This function releases the lock on the current video frame in Chromium.
186     // It should always be called after getCurrentFrame(). Frame passed to this
187     // method should no longer be referenced after the call is made.
188     virtual void putCurrentFrame(WebVideoFrame*) { }
189
190     virtual void setStreamTextureClient(WebStreamTextureClient*) { }
191
192     virtual WebAudioSourceProvider* audioSourceProvider() { return 0; }
193
194     virtual bool sourceAppend(const unsigned char* data, unsigned length) { return false; }
195     virtual void sourceEndOfStream(EndOfStreamStatus)  { }
196
197     // Returns whether keySystem is supported. If true, the result will be
198     // reported by an event.
199     virtual MediaKeyException generateKeyRequest(const WebString& keySystem, const unsigned char* initData, unsigned initDataLength) { return KeySystemNotSupported; }
200     virtual MediaKeyException addKey(const WebString& keySystem, const unsigned char* key, unsigned keyLength, const unsigned char* initData, unsigned initDataLength, const WebString& sessionId) { return KeySystemNotSupported; }
201     virtual MediaKeyException cancelKeyRequest(const WebString& keySystem, const WebString& sessionId) { return KeySystemNotSupported; }
202 };
203
204 } // namespace WebKit
205
206 #endif