2 * Copyright (C) 2009 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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
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.
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.
31 #ifndef WebMediaPlayer_h
32 #define WebMediaPlayer_h
34 #include "WebCanvas.h"
35 #include "WebVector.h"
36 #include "WebVideoFrame.h"
40 class WebMediaPlayerClient;
46 WebTimeRange() : start(0), end(0) {}
47 WebTimeRange(float s, float e) : start(s), end(e) {}
53 typedef WebVector<WebTimeRange> WebTimeRanges;
55 class WebMediaPlayer {
82 virtual ~WebMediaPlayer() {}
84 virtual void load(const WebURL&) = 0;
85 virtual void cancelLoad() = 0;
88 virtual void play() = 0;
89 virtual void pause() = 0;
90 virtual bool supportsFullscreen() const = 0;
91 virtual bool supportsSave() const = 0;
92 virtual void seek(float seconds) = 0;
93 virtual void setEndTime(float seconds) = 0;
94 virtual void setRate(float) = 0;
95 virtual void setVolume(float) = 0;
96 virtual void setVisible(bool) = 0;
97 virtual bool setAutoBuffer(bool) = 0;
98 virtual bool totalBytesKnown() = 0;
99 virtual const WebTimeRanges& buffered() = 0;
100 virtual float maxTimeSeekable() const = 0;
102 virtual void setSize(const WebSize&) = 0;
104 virtual void paint(WebCanvas*, const WebRect&) = 0;
106 // True if the loaded media has a playable video/audio track.
107 virtual bool hasVideo() const = 0;
108 virtual bool hasAudio() const = 0;
110 // Dimension of the video.
111 virtual WebSize naturalSize() const = 0;
113 // Getters of playback state.
114 virtual bool paused() const = 0;
115 virtual bool seeking() const = 0;
116 virtual float duration() const = 0;
117 virtual float currentTime() const = 0;
119 // Get rate of loading the resource.
120 virtual int dataRate() const = 0;
122 // Internal states of loading and network.
123 virtual NetworkState networkState() const = 0;
124 virtual ReadyState readyState() const = 0;
126 virtual unsigned long long bytesLoaded() const = 0;
127 virtual unsigned long long totalBytes() const = 0;
129 virtual bool hasSingleSecurityOrigin() const = 0;
130 virtual MovieLoadType movieLoadType() const = 0;
132 virtual unsigned decodedFrameCount() const = 0;
133 virtual unsigned droppedFrameCount() const = 0;
134 virtual unsigned audioDecodedByteCount() const = 0;
135 virtual unsigned videoDecodedByteCount() const = 0;
137 // This function returns a pointer to a WebVideoFrame, which is
138 // a WebKit wrapper for a video frame in chromium. This places a lock
139 // on the frame in chromium, and calls to this method should always be
140 // followed with a call to putCurrentFrame(). The ownership of this object
141 // is not transferred to the caller, and the caller should not free the
143 virtual WebVideoFrame* getCurrentFrame() { return 0; }
144 // This function releases the lock on the current video frame in Chromium.
145 // It should always be called after getCurrentFrame(). Frame passed to this
146 // method should no longer be referenced after the call is made.
147 virtual void putCurrentFrame(WebVideoFrame*) { }
150 } // namespace WebKit