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