diff options
Diffstat (limited to 'Source/WebKit/chromium/public/WebMediaPlayer.h')
| -rw-r--r-- | Source/WebKit/chromium/public/WebMediaPlayer.h | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/Source/WebKit/chromium/public/WebMediaPlayer.h b/Source/WebKit/chromium/public/WebMediaPlayer.h new file mode 100644 index 000000000..9aaf1a3d0 --- /dev/null +++ b/Source/WebKit/chromium/public/WebMediaPlayer.h @@ -0,0 +1,173 @@ +/* + * Copyright (C) 2009 Google Inc. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef WebMediaPlayer_h +#define WebMediaPlayer_h + +#include "WebVideoFrame.h" +#include "platform/WebCanvas.h" +#include "platform/WebVector.h" + +namespace WebKit { + +class WebAudioSourceProvider; +class WebAudioSourceProviderClient; +class WebMediaPlayerClient; +class WebURL; +struct WebRect; +struct WebSize; + +struct WebTimeRange { + WebTimeRange() : start(0), end(0) {} + WebTimeRange(float s, float e) : start(s), end(e) {} + + float start; + float end; +}; + +typedef WebVector<WebTimeRange> WebTimeRanges; + +class WebMediaPlayer { +public: + enum NetworkState { + Empty, + Idle, + Loading, + Loaded, + FormatError, + NetworkError, + DecodeError, + }; + + enum ReadyState { + HaveNothing, + HaveMetadata, + HaveCurrentData, + HaveFutureData, + HaveEnoughData, + }; + + enum MovieLoadType { + Unknown, + Download, + StoredStream, + LiveStream, + }; + + enum Preload { + None, + MetaData, + Auto, + }; + + enum EndOfStreamStatus { + EosNoError, + EosNetworkError, + EosDecodeError, + }; + + virtual ~WebMediaPlayer() {} + + virtual void load(const WebURL&) = 0; + virtual void cancelLoad() = 0; + + // Playback controls. + virtual void play() = 0; + virtual void pause() = 0; + virtual bool supportsFullscreen() const = 0; + virtual bool supportsSave() const = 0; + virtual void seek(float seconds) = 0; + virtual void setEndTime(float seconds) = 0; + virtual void setRate(float) = 0; + virtual void setVolume(float) = 0; + virtual void setVisible(bool) = 0; + virtual void setPreload(Preload) { }; + virtual bool totalBytesKnown() = 0; + virtual const WebTimeRanges& buffered() = 0; + virtual float maxTimeSeekable() const = 0; + + virtual void setSize(const WebSize&) = 0; + + virtual void paint(WebCanvas*, const WebRect&) = 0; + + // True if the loaded media has a playable video/audio track. + virtual bool hasVideo() const = 0; + virtual bool hasAudio() const = 0; + + // Dimension of the video. + virtual WebSize naturalSize() const = 0; + + // Getters of playback state. + virtual bool paused() const = 0; + virtual bool seeking() const = 0; + virtual float duration() const = 0; + virtual float currentTime() const = 0; + + // Get rate of loading the resource. + virtual int dataRate() const = 0; + + // Internal states of loading and network. + virtual NetworkState networkState() const = 0; + virtual ReadyState readyState() const = 0; + + virtual unsigned long long bytesLoaded() const = 0; + virtual unsigned long long totalBytes() const = 0; + + virtual bool hasSingleSecurityOrigin() const = 0; + virtual MovieLoadType movieLoadType() const = 0; + + virtual float mediaTimeForTimeValue(float timeValue) const = 0; + + virtual unsigned decodedFrameCount() const = 0; + virtual unsigned droppedFrameCount() const = 0; + virtual unsigned audioDecodedByteCount() const = 0; + virtual unsigned videoDecodedByteCount() const = 0; + + // This function returns a pointer to a WebVideoFrame, which is + // a WebKit wrapper for a video frame in chromium. This places a lock + // on the frame in chromium, and calls to this method should always be + // followed with a call to putCurrentFrame(). The ownership of this object + // is not transferred to the caller, and the caller should not free the + // returned object. + virtual WebVideoFrame* getCurrentFrame() { return 0; } + // This function releases the lock on the current video frame in Chromium. + // It should always be called after getCurrentFrame(). Frame passed to this + // method should no longer be referenced after the call is made. + virtual void putCurrentFrame(WebVideoFrame*) { } + + virtual WebAudioSourceProvider* audioSourceProvider() { return 0; } + + virtual bool sourceAppend(const unsigned char* data, unsigned length) { return false; } + virtual void sourceEndOfStream(EndOfStreamStatus) { } +}; + +} // namespace WebKit + +#endif |
