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