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