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 "../platform/WebCanvas.h" 35 #include "../platform/WebString.h" 36 #include "WebTimeRange.h" 37 38 namespace WebKit { 39 40 class WebAudioSourceProvider; 41 class WebAudioSourceProviderClient; 42 class WebMediaPlayerClient; 43 class WebMediaSource; 44 class WebString; 45 class WebURL; 46 struct WebRect; 47 struct WebSize; 48 class WebGraphicsContext3D; 49 50 class WebMediaPlayer { 51 public: 52 enum NetworkState { 53 NetworkStateEmpty, 54 NetworkStateIdle, 55 NetworkStateLoading, 56 NetworkStateLoaded, 57 NetworkStateFormatError, 58 NetworkStateNetworkError, 59 NetworkStateDecodeError, 60 }; 61 62 enum ReadyState { 63 ReadyStateHaveNothing, 64 ReadyStateHaveMetadata, 65 ReadyStateHaveCurrentData, 66 ReadyStateHaveFutureData, 67 ReadyStateHaveEnoughData, 68 }; 69 70 enum Preload { 71 PreloadNone, 72 PreloadMetaData, 73 PreloadAuto, 74 }; 75 76 // Represents synchronous exceptions that can be thrown from the Encrypted 77 // Media methods. This is different from the asynchronous MediaKeyError. 78 enum MediaKeyException { 79 MediaKeyExceptionNoError, 80 MediaKeyExceptionInvalidPlayerState, 81 MediaKeyExceptionKeySystemNotSupported, 82 }; 83 84 enum CORSMode { 85 CORSModeUnspecified, 86 CORSModeAnonymous, 87 CORSModeUseCredentials, 88 }; 89 90 virtual ~WebMediaPlayer() {} 91 92 virtual void load(const WebURL&, CORSMode) = 0; 93 virtual void load(const WebURL&, WebMediaSource*, CORSMode) = 0; 94 95 // Playback controls. 96 virtual void play() = 0; 97 virtual void pause() = 0; 98 virtual bool supportsFullscreen() const = 0; 99 virtual bool supportsSave() const = 0; 100 virtual void seek(double seconds) = 0; 101 virtual void setRate(double rate) = 0; 102 virtual void setVolume(double volume) = 0; 103 virtual void setPreload(Preload) { }; 104 virtual const WebTimeRanges& buffered() = 0; 105 virtual double maxTimeSeekable() const = 0; 106 107 virtual void paint(WebCanvas*, const WebRect&, unsigned char alpha) = 0; 108 109 // True if the loaded media has a playable video/audio track. 110 virtual bool hasVideo() const = 0; 111 virtual bool hasAudio() const = 0; 112 113 // Dimension of the video. 114 virtual WebSize naturalSize() const = 0; 115 116 // Getters of playback state. 117 virtual bool paused() const = 0; 118 virtual bool seeking() const = 0; 119 virtual double duration() const = 0; 120 virtual double currentTime() const = 0; 121 122 // Internal states of loading and network. 123 virtual NetworkState networkState() const = 0; 124 virtual ReadyState readyState() const = 0; 125 126 virtual bool didLoadingProgress() const = 0; 127 128 virtual bool hasSingleSecurityOrigin() const = 0; 129 virtual bool didPassCORSAccessCheck() const = 0; 130 131 virtual double mediaTimeForTimeValue(double timeValue) const = 0; 132 133 virtual unsigned decodedFrameCount() const = 0; 134 virtual unsigned droppedFrameCount() const = 0; 135 virtual unsigned audioDecodedByteCount() const = 0; 136 virtual unsigned videoDecodedByteCount() const = 0; 137 138 // Do a GPU-GPU textures copy if possible. 139 virtual bool copyVideoTextureToPlatformTexture(WebGraphicsContext3D*, unsigned texture, unsigned level, unsigned internalFormat, unsigned type, bool premultiplyAlpha, bool flipY) { return false; } 140 141 virtual WebAudioSourceProvider* audioSourceProvider() { return 0; } 142 143 // Returns whether keySystem is supported. If true, the result will be 144 // reported by an event. 145 virtual MediaKeyException generateKeyRequest(const WebString& keySystem, const unsigned char* initData, unsigned initDataLength) { return MediaKeyExceptionKeySystemNotSupported; } 146 virtual MediaKeyException addKey(const WebString& keySystem, const unsigned char* key, unsigned keyLength, const unsigned char* initData, unsigned initDataLength, const WebString& sessionId) { return MediaKeyExceptionKeySystemNotSupported; } 147 virtual MediaKeyException cancelKeyRequest(const WebString& keySystem, const WebString& sessionId) { return MediaKeyExceptionKeySystemNotSupported; } 148 149 // Instruct WebMediaPlayer to enter/exit fullscreen. 150 virtual void enterFullscreen() { } 151 virtual void exitFullscreen() { } 152 // Returns true if the player can enter fullscreen. 153 virtual bool canEnterFullscreen() const { return false; } 154 }; 155 156 } // namespace WebKit 157 158 #endif 159