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
|
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Delegate calls from WebCore::MediaPlayerPrivate to Chrome's video player.
// It contains PipelineImpl which is the actual media player pipeline, it glues
// the media player pipeline, data source, audio renderer and renderer.
// PipelineImpl would creates multiple threads and access some public methods
// of this class, so we need to be extra careful about concurrent access of
// methods and members.
//
// WebMediaPlayerImpl works with multiple objects, the most important ones are:
//
// media::PipelineImpl
// The media playback pipeline.
//
// WebVideoRenderer
// Video renderer object.
//
// WebMediaPlayerImpl::Proxy
// Proxies methods calls from the media pipeline to WebKit.
//
// WebKit::WebMediaPlayerClient
// WebKit client of this media player object.
//
// The following diagram shows the relationship of these objects:
// (note: ref-counted reference is marked by a "r".)
//
// WebMediaPlayerImpl ------> PipelineImpl
// | ^ | r
// | | v
// | | WebVideoRenderer
// | | ^ r
// | | |
// | r | r |
// .------> Proxy <-----.
// |
// |
// v
// WebMediaPlayerClient
//
// Notice that Proxy and WebVideoRenderer are referencing each other. This
// interdependency has to be treated carefully.
//
// Other issues:
// During tear down of the whole browser or a tab, the DOM tree may not be
// destructed nicely, and there will be some dangling media threads trying to
// the main thread, so we need this class to listen to destruction event of the
// main thread and cleanup the media threads when the even is received. Also
// at destruction of this class we will need to unhook it from destruction event
// list of the main thread.
#ifndef WEBKIT_GLUE_WEBMEDIAPLAYER_IMPL_H_
#define WEBKIT_GLUE_WEBMEDIAPLAYER_IMPL_H_
#include "base/lock.h"
#include "base/message_loop.h"
#include "base/ref_counted.h"
#include "base/scoped_ptr.h"
#include "base/waitable_event.h"
#include "gfx/rect.h"
#include "gfx/size.h"
#include "media/base/filters.h"
#include "media/base/pipeline_impl.h"
#include "skia/ext/platform_canvas.h"
#include "third_party/WebKit/WebKit/chromium/public/WebMediaPlayer.h"
#include "third_party/WebKit/WebKit/chromium/public/WebMediaPlayerClient.h"
class GURL;
namespace webkit_glue {
class MediaResourceLoaderBridgeFactory;
class WebDataSource;
class WebVideoRenderer;
class WebMediaPlayerImpl : public WebKit::WebMediaPlayer,
public MessageLoop::DestructionObserver {
public:
// A proxy class that dispatches method calls from the media pipeline to
// WebKit. Since there are multiple threads in the media pipeline and there's
// need for the media pipeline to call to WebKit, e.g. repaint requests,
// initialization events, etc, we have this class to bridge all method calls
// from the media pipeline on different threads and serialize these calls
// on the render thread.
// Because of the nature of this object that it works with different threads,
// it is made ref-counted.
class Proxy : public base::RefCountedThreadSafe<Proxy> {
public:
Proxy(MessageLoop* render_loop,
WebMediaPlayerImpl* webmediaplayer);
// Public methods called from the video renderer.
void Repaint();
void SetVideoRenderer(scoped_refptr<WebVideoRenderer> video_renderer);
void SetDataSource(scoped_refptr<WebDataSource> data_source);
// Public methods called from WebMediaPlayerImpl.
void Paint(skia::PlatformCanvas* canvas, const gfx::Rect& dest_rect);
void SetSize(const gfx::Rect& rect);
void Detach();
void GetCurrentFrame(scoped_refptr<media::VideoFrame>* frame_out);
void PutCurrentFrame(scoped_refptr<media::VideoFrame> frame);
void AbortDataSource();
// Public methods called from the pipeline via callback issued by
// WebMediaPlayerImpl.
void PipelineInitializationCallback();
void PipelineSeekCallback();
void PipelineEndedCallback();
void PipelineErrorCallback();
void NetworkEventCallback();
// Returns the message loop used by the proxy.
MessageLoop* message_loop() { return render_loop_; }
private:
friend class base::RefCountedThreadSafe<Proxy>;
virtual ~Proxy();
// Invoke |webmediaplayer_| to perform a repaint.
void RepaintTask();
// Notify |webmediaplayer_| that initialization has finished.
void PipelineInitializationTask();
// Notify |webmediaplayer_| that a seek has finished.
void PipelineSeekTask();
// Notify |webmediaplayer_| that the media has ended.
void PipelineEndedTask();
// Notify |webmediaplayer_| that a pipeline error has been set.
void PipelineErrorTask();
// Notify |webmediaplayer_| that there's a network event.
void NetworkEventTask();
// The render message loop where WebKit lives.
MessageLoop* render_loop_;
WebMediaPlayerImpl* webmediaplayer_;
scoped_refptr<WebDataSource> data_source_;
scoped_refptr<WebVideoRenderer> video_renderer_;
Lock lock_;
int outstanding_repaints_;
};
// Construct a WebMediaPlayerImpl with reference to the client, and media
// filter collection. By providing the filter collection the implementor can
// provide more specific media filters that does resource loading and
// rendering. |collection| should contain filter factories for:
// 1. Data source
// 2. Audio renderer
// 3. Video renderer (optional)
//
// There are some default filters provided by this method:
// 1. FFmpeg demuxer
// 2. FFmpeg audio decoder
// 3. FFmpeg video decoder
// 4. Video renderer
// 5. Null audio renderer
// The video renderer provided by this class is using the graphics context
// provided by WebKit to perform renderering. The simple data source does
// resource loading by loading the whole resource object into memory. Null
// audio renderer is a fake audio device that plays silence. Provider of the
// |collection| can override the default filters by adding extra filters to
// |collection| before calling this method.
//
WebMediaPlayerImpl(WebKit::WebMediaPlayerClient* client,
const media::MediaFilterCollection& collection,
MediaResourceLoaderBridgeFactory* bridge_factory_simple,
MediaResourceLoaderBridgeFactory* bridge_factory_buffered,
bool use_simple_data_source,
scoped_refptr<WebVideoRenderer> web_video_renderer);
virtual ~WebMediaPlayerImpl();
virtual void load(const WebKit::WebURL& url);
virtual void cancelLoad();
// Playback controls.
virtual void play();
virtual void pause();
virtual bool supportsFullscreen() const;
virtual bool supportsSave() const;
virtual void seek(float seconds);
virtual void setEndTime(float seconds);
virtual void setRate(float rate);
virtual void setVolume(float volume);
virtual void setVisible(bool visible);
virtual bool setAutoBuffer(bool autoBuffer);
virtual bool totalBytesKnown();
virtual const WebKit::WebTimeRanges& buffered();
virtual float maxTimeSeekable() const;
// Methods for painting.
virtual void setSize(const WebKit::WebSize& size);
virtual void paint(WebKit::WebCanvas* canvas, const WebKit::WebRect& rect);
// True if the loaded media has a playable video/audio track.
virtual bool hasVideo() const;
virtual bool hasAudio() const;
// Dimensions of the video.
virtual WebKit::WebSize naturalSize() const;
// Getters of playback state.
virtual bool paused() const;
virtual bool seeking() const;
virtual float duration() const;
virtual float currentTime() const;
// Get rate of loading the resource.
virtual int32 dataRate() const;
// Internal states of loading and network.
// TODO(hclam): Ask the pipeline about the state rather than having reading
// them from members which would cause race conditions.
virtual WebKit::WebMediaPlayer::NetworkState networkState() const {
return network_state_;
}
virtual WebKit::WebMediaPlayer::ReadyState readyState() const {
return ready_state_;
}
virtual unsigned long long bytesLoaded() const;
virtual unsigned long long totalBytes() const;
virtual bool hasSingleSecurityOrigin() const;
virtual WebKit::WebMediaPlayer::MovieLoadType movieLoadType() const;
virtual WebKit::WebVideoFrame* getCurrentFrame();
virtual void putCurrentFrame(WebKit::WebVideoFrame* web_video_frame);
// As we are closing the tab or even the browser, |main_loop_| is destroyed
// even before this object gets destructed, so we need to know when
// |main_loop_| is being destroyed and we can stop posting repaint task
// to it.
virtual void WillDestroyCurrentMessageLoop();
void Repaint();
void OnPipelineInitialize();
void OnPipelineSeek();
void OnPipelineEnded();
void OnPipelineError();
void OnNetworkEvent();
private:
// Helpers that set the network/ready state and notifies the client if
// they've changed.
void SetNetworkState(WebKit::WebMediaPlayer::NetworkState state);
void SetReadyState(WebKit::WebMediaPlayer::ReadyState state);
// Destroy resources held.
void Destroy();
// Callback executed after |pipeline_| stops which signals Destroy()
// to continue.
void PipelineStoppedCallback();
// Getter method to |client_|.
WebKit::WebMediaPlayerClient* GetClient();
// TODO(hclam): get rid of these members and read from the pipeline directly.
WebKit::WebMediaPlayer::NetworkState network_state_;
WebKit::WebMediaPlayer::ReadyState ready_state_;
// Keep a list of buffered time ranges.
WebKit::WebTimeRanges buffered_;
// Message loops for posting tasks between Chrome's main thread. Also used
// for DCHECKs so methods calls won't execute in the wrong thread.
MessageLoop* main_loop_;
// A collection of filters.
media::MediaFilterCollection filter_collection_;
// The actual pipeline and the thread it runs on.
scoped_refptr<media::PipelineImpl> pipeline_;
base::Thread pipeline_thread_;
// Playback state.
//
// TODO(scherkus): we have these because Pipeline favours the simplicity of a
// single "playback rate" over worrying about paused/stopped etc... It forces
// all clients to manage the pause+playback rate externally, but is that
// really a bad thing?
//
// TODO(scherkus): since SetPlaybackRate(0) is asynchronous and we don't want
// to hang the render thread during pause(), we record the time at the same
// time we pause and then return that value in currentTime(). Otherwise our
// clock can creep forward a little bit while the asynchronous
// SetPlaybackRate(0) is being executed.
bool paused_;
float playback_rate_;
base::TimeDelta paused_time_;
WebKit::WebMediaPlayerClient* client_;
scoped_refptr<Proxy> proxy_;
// Used to block Destroy() until Pipeline::Stop() is completed.
base::WaitableEvent pipeline_stopped_;
#if WEBKIT_USING_CG
scoped_ptr<skia::PlatformCanvas> skia_canvas_;
#endif
DISALLOW_COPY_AND_ASSIGN(WebMediaPlayerImpl);
};
} // namespace webkit_glue
#endif // WEBKIT_GLUE_WEBMEDIAPLAYER_IMPL_H_
|