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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
/*
* Copyright (C) 2007, 2008, 2009, 2010, 2011 Apple 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``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 APPLE COMPUTER, INC. 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 MediaPlayer_h
#define MediaPlayer_h
#if ENABLE(VIDEO)
#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
#include "MediaPlayerProxy.h"
#endif
#include "Document.h"
#include "IntRect.h"
#include "KURL.h"
#include <wtf/Forward.h>
#include <wtf/HashSet.h>
#include <wtf/OwnPtr.h>
#include <wtf/Noncopyable.h>
#include <wtf/PassOwnPtr.h>
#include <wtf/text/StringHash.h>
#if USE(ACCELERATED_COMPOSITING)
#include "GraphicsLayer.h"
#endif
OBJC_CLASS AVPlayer;
OBJC_CLASS QTMovie;
class AVCFPlayer;
class QTMovieGWorld;
class QTMovieVisualContext;
namespace WebCore {
class AudioSourceProvider;
class GStreamerGWorld;
class MediaPlayerPrivateInterface;
// Structure that will hold every native
// types supported by the current media player.
// We have to do that has multiple media players
// backend can live at runtime.
struct PlatformMedia {
enum {
None,
QTMovieType,
QTMovieGWorldType,
QTMovieVisualContextType,
GStreamerGWorldType,
ChromiumMediaPlayerType,
QtMediaPlayerType,
AVFoundationMediaPlayerType,
AVFoundationCFMediaPlayerType
} type;
union {
QTMovie* qtMovie;
QTMovieGWorld* qtMovieGWorld;
QTMovieVisualContext* qtMovieVisualContext;
GStreamerGWorld* gstreamerGWorld;
MediaPlayerPrivateInterface* chromiumMediaPlayer;
MediaPlayerPrivateInterface* qtMediaPlayer;
AVPlayer* avfMediaPlayer;
AVCFPlayer* avcfMediaPlayer;
} media;
};
extern const PlatformMedia NoPlatformMedia;
class ContentType;
class FrameView;
class GraphicsContext;
class IntRect;
class IntSize;
class MediaPlayer;
struct MediaPlayerFactory;
class TimeRanges;
class MediaPlayerClient {
public:
enum CORSMode { Unspecified, Anonymous, UseCredentials };
virtual ~MediaPlayerClient() { }
// Get the document which the media player is owned by
virtual Document* mediaPlayerOwningDocument() { return 0; }
// the network state has changed
virtual void mediaPlayerNetworkStateChanged(MediaPlayer*) { }
// the ready state has changed
virtual void mediaPlayerReadyStateChanged(MediaPlayer*) { }
// the volume state has changed
virtual void mediaPlayerVolumeChanged(MediaPlayer*) { }
// the mute state has changed
virtual void mediaPlayerMuteChanged(MediaPlayer*) { }
// time has jumped, eg. not as a result of normal playback
virtual void mediaPlayerTimeChanged(MediaPlayer*) { }
// the media file duration has changed, or is now known
virtual void mediaPlayerDurationChanged(MediaPlayer*) { }
// the playback rate has changed
virtual void mediaPlayerRateChanged(MediaPlayer*) { }
// the play/pause status changed
virtual void mediaPlayerPlaybackStateChanged(MediaPlayer*) { }
// The MediaPlayer has found potentially problematic media content.
// This is used internally to trigger swapping from a <video>
// element to an <embed> in standalone documents
virtual void mediaPlayerSawUnsupportedTracks(MediaPlayer*) { }
// The MediaPlayer could not discover an engine which supports the requested resource.
virtual void mediaPlayerResourceNotSupported(MediaPlayer*) { }
// Presentation-related methods
// a new frame of video is available
virtual void mediaPlayerRepaint(MediaPlayer*) { }
// the movie size has changed
virtual void mediaPlayerSizeChanged(MediaPlayer*) { }
virtual void mediaPlayerEngineUpdated(MediaPlayer*) { }
// The first frame of video is available to render. A media engine need only make this callback if the
// first frame is not available immediately when prepareForRendering is called.
virtual void mediaPlayerFirstVideoFrameAvailable(MediaPlayer*) { }
// A characteristic of the media file, eg. video, audio, closed captions, etc, has changed.
virtual void mediaPlayerCharacteristicChanged(MediaPlayer*) { }
#if USE(ACCELERATED_COMPOSITING)
// whether the rendering system can accelerate the display of this MediaPlayer.
virtual bool mediaPlayerRenderingCanBeAccelerated(MediaPlayer*) { return false; }
// called when the media player's rendering mode changed, which indicates a change in the
// availability of the platformLayer().
virtual void mediaPlayerRenderingModeChanged(MediaPlayer*) { }
#endif
#if ENABLE(MEDIA_SOURCE)
virtual void mediaPlayerSourceOpened() { }
virtual String mediaPlayerSourceURL() const { return "x-media-source-unsupported:"; }
#endif
#if ENABLE(ENCRYPTED_MEDIA)
enum MediaKeyErrorCode { UnknownError = 1, ClientError, ServiceError, OutputError, HardwareChangeError, DomainError };
virtual void mediaPlayerKeyAdded(MediaPlayer*, const String& keySystem, const String& sessionId) { }
virtual void mediaPlayerKeyError(MediaPlayer*, const String& keySystem, const String& sessionId, MediaKeyErrorCode errorCode, unsigned short systemCode) { }
virtual void mediaPlayerKeyMessage(MediaPlayer*, const String& keySystem, const String& sessionId, const unsigned char* message, unsigned messageLength) { }
virtual void mediaPlayerKeyNeeded(MediaPlayer*, const String& keySystem, const String& sessionId, const unsigned char* initData, unsigned initDataLength) { }
#endif
virtual String mediaPlayerReferrer() const { return String(); }
virtual String mediaPlayerUserAgent() const { return String(); }
virtual CORSMode mediaPlayerCORSMode() const { return Unspecified; }
};
class MediaPlayerSupportsTypeClient {
public:
virtual ~MediaPlayerSupportsTypeClient() { }
virtual bool mediaPlayerNeedsSiteSpecificHacks() const { return false; }
virtual String mediaPlayerDocumentHost() const { return String(); }
};
class MediaPlayer {
WTF_MAKE_NONCOPYABLE(MediaPlayer); WTF_MAKE_FAST_ALLOCATED;
public:
static PassOwnPtr<MediaPlayer> create(MediaPlayerClient* client)
{
return adoptPtr(new MediaPlayer(client));
}
virtual ~MediaPlayer();
// Media engine support.
enum SupportsType { IsNotSupported, IsSupported, MayBeSupported };
static MediaPlayer::SupportsType supportsType(const ContentType&, const String& keySystem, const KURL&, const MediaPlayerSupportsTypeClient*);
static void getSupportedTypes(HashSet<String>&);
static bool isAvailable();
static void getSitesInMediaCache(Vector<String>&);
static void clearMediaCache();
static void clearMediaCacheForSite(const String&);
bool supportsFullscreen() const;
bool supportsSave() const;
bool supportsScanning() const;
PlatformMedia platformMedia() const;
#if USE(ACCELERATED_COMPOSITING)
PlatformLayer* platformLayer() const;
#endif
IntSize naturalSize();
bool hasVideo() const;
bool hasAudio() const;
void setFrameView(FrameView* frameView) { m_frameView = frameView; }
FrameView* frameView() { return m_frameView; }
bool inMediaDocument();
IntSize size() const { return m_size; }
void setSize(const IntSize& size);
bool load(const KURL&, const ContentType&, const String& keySystem);
void cancelLoad();
bool visible() const;
void setVisible(bool);
void prepareToPlay();
void play();
void pause();
#if ENABLE(MEDIA_SOURCE)
enum AddIdStatus { Ok, NotSupported, ReachedIdLimit };
AddIdStatus sourceAddId(const String& id, const String& type, const Vector<String>& codecs);
bool sourceRemoveId(const String& id);
PassRefPtr<TimeRanges> sourceBuffered(const String& id);
bool sourceAppend(const String& id, const unsigned char* data, unsigned length);
bool sourceAbort(const String& id);
enum EndOfStreamStatus { EosNoError, EosNetworkError, EosDecodeError };
void sourceEndOfStream(EndOfStreamStatus);
#endif
#if ENABLE(ENCRYPTED_MEDIA)
// Represents synchronous exceptions that can be thrown from the Encrypted Media methods.
// This is different from the asynchronous MediaKeyError.
enum MediaKeyException { NoError, InvalidPlayerState, KeySystemNotSupported };
MediaKeyException generateKeyRequest(const String& keySystem, const unsigned char* initData, unsigned initDataLength);
MediaKeyException addKey(const String& keySystem, const unsigned char* key, unsigned keyLength, const unsigned char* initData, unsigned initDataLength, const String& sessionId);
MediaKeyException cancelKeyRequest(const String& keySystem, const String& sessionId);
#endif
bool paused() const;
bool seeking() const;
static float invalidTime() { return -1.0f;}
float duration() const;
float currentTime() const;
void seek(float time);
float startTime() const;
double initialTime() const;
float rate() const;
void setRate(float);
bool preservesPitch() const;
void setPreservesPitch(bool);
PassRefPtr<TimeRanges> buffered();
PassRefPtr<TimeRanges> seekable();
float maxTimeSeekable();
bool didLoadingProgress();
float volume() const;
void setVolume(float);
bool muted() const;
void setMuted(bool);
bool hasClosedCaptions() const;
void setClosedCaptionsVisible(bool closedCaptionsVisible);
bool autoplay() const;
void setAutoplay(bool);
void paint(GraphicsContext*, const IntRect&);
void paintCurrentFrameInContext(GraphicsContext*, const IntRect&);
enum NetworkState { Empty, Idle, Loading, Loaded, FormatError, NetworkError, DecodeError };
NetworkState networkState();
enum ReadyState { HaveNothing, HaveMetadata, HaveCurrentData, HaveFutureData, HaveEnoughData };
ReadyState readyState();
enum MovieLoadType { Unknown, Download, StoredStream, LiveStream };
MovieLoadType movieLoadType() const;
enum Preload { None, MetaData, Auto };
Preload preload() const;
void setPreload(Preload);
void networkStateChanged();
void readyStateChanged();
void volumeChanged(float);
void muteChanged(bool);
void timeChanged();
void sizeChanged();
void rateChanged();
void playbackStateChanged();
void durationChanged();
void firstVideoFrameAvailable();
void characteristicChanged();
void repaint();
MediaPlayerClient* mediaPlayerClient() const { return m_mediaPlayerClient; }
bool hasAvailableVideoFrame() const;
void prepareForRendering();
bool canLoadPoster() const;
void setPoster(const String&);
#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
void deliverNotification(MediaPlayerProxyNotificationType notification);
void setMediaPlayerProxy(WebMediaPlayerProxy* proxy);
void setControls(bool);
#endif
#if ENABLE(PLUGIN_PROXY_FOR_VIDEO) || USE(NATIVE_FULLSCREEN_VIDEO)
void enterFullscreen();
void exitFullscreen();
#endif
#if USE(NATIVE_FULLSCREEN_VIDEO)
bool canEnterFullscreen() const;
#endif
#if USE(ACCELERATED_COMPOSITING)
// whether accelerated rendering is supported by the media engine for the current media.
bool supportsAcceleratedRendering() const;
// called when the rendering system flips the into or out of accelerated rendering mode.
void acceleratedRenderingStateChanged();
#endif
bool hasSingleSecurityOrigin() const;
bool didPassCORSAccessCheck() const;
float mediaTimeForTimeValue(float) const;
double maximumDurationToCacheMediaTime() const;
unsigned decodedFrameCount() const;
unsigned droppedFrameCount() const;
unsigned audioDecodedByteCount() const;
unsigned videoDecodedByteCount() const;
void setPrivateBrowsingMode(bool);
#if ENABLE(WEB_AUDIO)
AudioSourceProvider* audioSourceProvider();
#endif
#if ENABLE(MEDIA_SOURCE)
void sourceOpened();
String sourceURL() const;
#endif
#if ENABLE(ENCRYPTED_MEDIA)
void keyAdded(const String& keySystem, const String& sessionId);
void keyError(const String& keySystem, const String& sessionId, MediaPlayerClient::MediaKeyErrorCode, unsigned short systemCode);
void keyMessage(const String& keySystem, const String& sessionId, const unsigned char* message, unsigned messageLength);
void keyNeeded(const String& keySystem, const String& sessionId, const unsigned char* initData, unsigned initDataLength);
#endif
String referrer() const;
String userAgent() const;
private:
MediaPlayer(MediaPlayerClient*);
void loadWithNextMediaEngine(MediaPlayerFactory*);
void reloadTimerFired(Timer<MediaPlayer>*);
static void initializeMediaEngines();
MediaPlayerClient* m_mediaPlayerClient;
Timer<MediaPlayer> m_reloadTimer;
OwnPtr<MediaPlayerPrivateInterface> m_private;
MediaPlayerFactory* m_currentMediaEngine;
KURL m_url;
String m_contentMIMEType;
String m_contentTypeCodecs;
String m_keySystem;
FrameView* m_frameView;
IntSize m_size;
Preload m_preload;
bool m_visible;
float m_rate;
float m_volume;
bool m_muted;
bool m_preservesPitch;
bool m_privateBrowsing;
bool m_shouldPrepareToRender;
bool m_contentMIMETypeWasInferredFromExtension;
#if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
WebMediaPlayerProxy* m_playerProxy; // not owned or used, passed to m_private
#endif
};
typedef PassOwnPtr<MediaPlayerPrivateInterface> (*CreateMediaEnginePlayer)(MediaPlayer*);
typedef void (*MediaEngineSupportedTypes)(HashSet<String>& types);
#if ENABLE(ENCRYPTED_MEDIA)
typedef MediaPlayer::SupportsType (*MediaEngineSupportsType)(const String& type, const String& codecs, const String& keySystem, const KURL& url);
#else
typedef MediaPlayer::SupportsType (*MediaEngineSupportsType)(const String& type, const String& codecs, const KURL& url);
#endif
typedef void (*MediaEngineGetSitesInMediaCache)(Vector<String>&);
typedef void (*MediaEngineClearMediaCache)();
typedef void (*MediaEngineClearMediaCacheForSite)(const String&);
typedef void (*MediaEngineRegistrar)(CreateMediaEnginePlayer, MediaEngineSupportedTypes, MediaEngineSupportsType,
MediaEngineGetSitesInMediaCache, MediaEngineClearMediaCache, MediaEngineClearMediaCacheForSite);
}
#endif // ENABLE(VIDEO)
#endif
|