1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
|
/*
* 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 "WebTimeRange.h"
#include "WebVideoFrame.h"
#include "platform/WebCanvas.h"
#include "platform/WebString.h"
namespace WebKit {
class WebAudioSourceProvider;
class WebAudioSourceProviderClient;
class WebMediaPlayerClient;
class WebStreamTextureClient;
class WebString;
class WebURL;
struct WebRect;
struct WebSize;
class WebMediaPlayer {
public:
enum NetworkState {
NetworkStateEmpty,
NetworkStateIdle,
NetworkStateLoading,
NetworkStateLoaded,
NetworkStateFormatError,
NetworkStateNetworkError,
NetworkStateDecodeError,
};
enum ReadyState {
ReadyStateHaveNothing,
ReadyStateHaveMetadata,
ReadyStateHaveCurrentData,
ReadyStateHaveFutureData,
ReadyStateHaveEnoughData,
};
enum MovieLoadType {
MovieLoadTypeUnknown,
MovieLoadTypeDownload,
MovieLoadTypeStoredStream,
MovieLoadTypeLiveStream,
};
enum Preload {
PreloadNone,
PreloadMetaData,
PreloadAuto,
};
enum AddIdStatus {
AddIdStatusOk,
AddIdStatusNotSupported,
AddIdStatusReachedIdLimit
};
enum EndOfStreamStatus {
EndOfStreamStatusNoError,
EndOfStreamStatusNetworkError,
EndOfStreamStatusDecodeError,
};
// Represents synchronous exceptions that can be thrown from the Encrypted
// Media methods. This is different from the asynchronous MediaKeyError.
enum MediaKeyException {
MediaKeyExceptionNoError,
MediaKeyExceptionInvalidPlayerState,
MediaKeyExceptionKeySystemNotSupported,
};
enum CORSMode {
CORSModeUnspecified,
CORSModeAnonymous,
CORSModeUseCredentials,
};
virtual ~WebMediaPlayer() {}
virtual void load(const WebURL&, CORSMode) = 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&, uint8_t alpha) = 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 bool didLoadingProgress() const = 0;
virtual unsigned long long totalBytes() const = 0;
virtual bool hasSingleSecurityOrigin() const = 0;
virtual bool didPassCORSAccessCheck() 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 void setStreamTextureClient(WebStreamTextureClient*) { }
virtual WebAudioSourceProvider* audioSourceProvider() { return 0; }
virtual AddIdStatus sourceAddId(const WebString& id, const WebString& type,
const WebVector<WebString>& codecs) { return AddIdStatusNotSupported; }
virtual bool sourceRemoveId(const WebString& id) { return false; }
virtual WebTimeRanges sourceBuffered(const WebString& id) { return WebTimeRanges(); };
virtual bool sourceAppend(const WebString& id, const unsigned char* data, unsigned length) { return false; }
virtual bool sourceAbort(const WebString& id) { return false; }
virtual void sourceSetDuration(double) { }
virtual void sourceEndOfStream(EndOfStreamStatus) { }
virtual bool sourceSetTimestampOffset(const WebString& id, double offset) { return false; }
// Returns whether keySystem is supported. If true, the result will be
// reported by an event.
virtual MediaKeyException generateKeyRequest(const WebString& keySystem, const unsigned char* initData, unsigned initDataLength) { return MediaKeyExceptionKeySystemNotSupported; }
virtual MediaKeyException addKey(const WebString& keySystem, const unsigned char* key, unsigned keyLength, const unsigned char* initData, unsigned initDataLength, const WebString& sessionId) { return MediaKeyExceptionKeySystemNotSupported; }
virtual MediaKeyException cancelKeyRequest(const WebString& keySystem, const WebString& sessionId) { return MediaKeyExceptionKeySystemNotSupported; }
// Instruct WebMediaPlayer to enter/exit fullscreen.
virtual void enterFullscreen() { }
virtual void exitFullscreen() { }
// Returns true if the player can enter fullscreen.
virtual bool canEnterFullscreen() const { return false; }
};
} // namespace WebKit
#endif
|