?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Add ICU message format support
[chromium-blink-merge.git] / media / base / android / media_codec_player.h
blob96934cc34ab4ddbb6ee228c2233217731b2c88b3
1 // Copyright 2015 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef MEDIA_BASE_ANDROID_MEDIA_CODEC_PLAYER_H_
6 #define MEDIA_BASE_ANDROID_MEDIA_CODEC_PLAYER_H_
7
8 #include "base/android/scoped_java_ref.h"
9 #include "base/memory/scoped_ptr.h"
10 #include "base/memory/weak_ptr.h"
11 #include "base/threading/thread.h"
12 #include "base/time/default_tick_clock.h"
13 #include "media/base/android/demuxer_android.h"
14 #include "media/base/android/media_player_android.h"
15 #include "media/base/demuxer_stream.h"
16 #include "media/base/media_export.h"
17 #include "media/base/time_delta_interpolator.h"
18 #include "ui/gfx/geometry/size.h"
19 #include "ui/gl/android/scoped_java_surface.h"
20
21 // The MediaCodecPlayer class implements the media player by using Android's
22 // MediaCodec. It differs from MediaSourcePlayer in that it removes most
23 // processing away from the UI thread: it uses a dedicated Media thread to
24 // receive the data and to handle the commands.
25
26 // The player works as a state machine. Here are relationships between states:
27 //
28 // [ Paused ] ------------------------ (Any state)
29 // | | |
30 // | v v
31 // | <------------------[ WaitingForConfig ] [ Error ]
32 // |
33 // |
34 // | <----------------------------------------------
35 // v |
36 // [ Prefetching ] ------------------- |
37 // | | |
38 // | v |
39 // | <-----------------[ WaitingForSurface ] |
40 // v |
41 // [ Playing ] |
42 // | |
43 // | |
44 // v |
45 // [ Stopping ] --------------------------------> [ WaitingForSeek ]
46
47
48 // Events and actions for pause/resume workflow.
49 // ---------------------------------------------
50 //
51 // Start, no config:
52 // ------------------------> [ Paused ] -----------------> [ Waiting ]
53 // | StopDone: [ for configs ]
54 // | ^ | /
55 // | | | /
56 // | Pause: | | Start w/config: /
57 // | | | dec.Prefetch /
58 // | | | /
59 // | | | /
60 // | | | /
61 // | | | / DemuxerConfigs:
62 // | | | / dec.Prefetch
63 // | | | /
64 // | | | /
65 // | | v /
66 // | /
67 // | ------------------> [ Prefetching ] <--------/ [ Waiting ]
68 // | | [ ] --------------> [ for surface ]
69 // | | | PrefetchDone, /
70 // | | | no surface: /
71 // | | | /
72 // | | | /
73 // | | StopDone w/ | /
74 // | | pending start: | PrefetchDone: /
75 // | | dec.Prefetch | dec.Start /
76 // | | | / SetSurface:
77 // | | | / dec.Start
78 // | | | /
79 // | | v /
80 // | | /
81 // | | [ Playing ] <----------/
82 // | |
83 // | | |
84 // | | |
85 // | | | Pause: dec.RequestToStop
86 // | | |
87 // | | |
88 // | | v
89 // | |
90 // ------------------------- [ Stopping ]
91
92
93 // Events and actions for seek workflow.
94 // -------------------------------------
95 //
96 // Seek: -- --
97 // demuxer.RequestSeek | |
98 // [ Paused ] -----------------------> | |
99 // [ ] <----------------------- | |--
100 // SeekDone: | | |
101 // | | |
102 // | | |
103 // | | |
104 // | | | Start:
105 // Seek: | | | SetPendingStart
106 // dec.Stop | | |
107 // SetPendingSeek | | |
108 // demuxer.RequestSeek | | |
109 // [ Prefetching ] -----------------------> | | |
110 // [ ] <---------------------- | | | Pause:
111 // | SeekDone | | | RemovePendingStart
112 // | w/pending start: | | |
113 // | dec.Prefetch | Waiting | |
114 // | | for | | Seek:
115 // | | seek | | SetPendingSeek
116 // | | | |
117 // | PrefetchDone: dec.Start | | |
118 // | | | | SeekDone
119 // v | | | w/pending seek:
120 // | | | demuxer.RequestSeek
121 // [ Playing ] | | |
122 // | | |
123 // | | |<-
124 // | Seek: SetPendingStart | |
125 // | SetPendingSeek | |
126 // | dec.RequestToStop | |
127 // | | |
128 // | | |
129 // v | |
130 // | |
131 // [ Stopping ] -----------------------> | |
132 // StopDone -- --
133 // w/pending seek:
134 // demuxer.RequestSeek
135
136 namespace media {
137
138 class BrowserCdm;
139 class MediaCodecAudioDecoder;
140 class MediaCodecVideoDecoder;
141
142 // Returns the task runner for the media thread
143 MEDIA_EXPORT scoped_refptr<base::SingleThreadTaskRunner> GetMediaTaskRunner();
144
145 class MEDIA_EXPORT MediaCodecPlayer : public MediaPlayerAndroid,
146 public DemuxerAndroidClient {
147 public:
148 // Typedefs for the notification callbacks
149 typedef base::Callback<void(base::TimeDelta, const gfx::Size&)>
150 MetadataChangedCallback;
151
152 typedef base::Callback<void(base::TimeDelta, base::TimeTicks)>
153 TimeUpdateCallback;
154
155 typedef base::Callback<void(const base::TimeDelta& current_timestamp)>
156 SeekDoneCallback;
157
158 typedef base::Callback<void(int)> ErrorCallback;
159
160 // Constructs a player with the given ID and demuxer. |manager| must outlive
161 // the lifetime of this object.
162 MediaCodecPlayer(int player_id,
163 base::WeakPtr<MediaPlayerManager> manager,
164 const RequestMediaResourcesCB& request_media_resources_cb,
165 scoped_ptr<DemuxerAndroid> demuxer,
166 const GURL& frame_url);
167 ~MediaCodecPlayer() override;
168
169 // A helper method that performs the media thread part of initialization.
170 void Initialize();
171
172 // MediaPlayerAndroid implementation.
173 void DeleteOnCorrectThread() override;
174 void SetVideoSurface(gfx::ScopedJavaSurface surface) override;
175 void Start() override;
176 void Pause(bool is_media_related_action) override;
177 void SeekTo(base::TimeDelta timestamp) override;
178 void Release() override;
179 void SetVolume(double volume) override;
180 int GetVideoWidth() override;
181 int GetVideoHeight() override;
182 base::TimeDelta GetCurrentTime() override;
183 base::TimeDelta GetDuration() override;
184 bool IsPlaying() override;
185 bool CanPause() override;
186 bool CanSeekForward() override;
187 bool CanSeekBackward() override;
188 bool IsPlayerReady() override;
189 void SetCdm(BrowserCdm* cdm) override;
190
191 // DemuxerAndroidClient implementation.
192 void OnDemuxerConfigsAvailable(const DemuxerConfigs& params) override;
193 void OnDemuxerDataAvailable(const DemuxerData& params) override;
194 void OnDemuxerSeekDone(base::TimeDelta actual_browser_seek_time) override;
195 void OnDemuxerDurationChanged(base::TimeDelta duration) override;
196
197 private:
198 // The state machine states.
199 enum PlayerState {
200 kStatePaused,
201 kStateWaitingForConfig,
202 kStatePrefetching,
203 kStatePlaying,
204 kStateStopping,
205 kStateWaitingForSurface,
206 kStateWaitingForSeek,
207 kStateError,
208 };
209
210 enum StartStatus {
211 kStartOk = 0,
212 kStartBrowserSeekRequired,
213 kStartFailed,
214 };
215
216 // Cached values for the manager.
217 struct MediaMetadata {
218 base::TimeDelta duration;
219 gfx::Size video_size;
220 };
221
222 // Information about current seek in progress.
223 struct SeekInfo {
224 const base::TimeDelta seek_time;
225 const bool is_browser_seek;
226 SeekInfo(base::TimeDelta time, bool browser_seek)
227 : seek_time(time), is_browser_seek(browser_seek) {}
228 };
229
230 // MediaPlayerAndroid implementation.
231 // This method caches the data and calls manager's OnMediaMetadataChanged().
232 void OnMediaMetadataChanged(base::TimeDelta duration,
233 const gfx::Size& video_size) override;
234
235 // This method caches the current time and calls manager's OnTimeUpdate().
236 void OnTimeUpdate(base::TimeDelta current_timestamp,
237 base::TimeTicks current_time_ticks) override;
238
239 // Callbacks from decoders
240 void RequestDemuxerData(DemuxerStream::Type stream_type);
241 void OnPrefetchDone();
242 void OnStopDone();
243 void OnError();
244 void OnStarvation(DemuxerStream::Type stream_type);
245 void OnTimeIntervalUpdate(DemuxerStream::Type stream_type,
246 base::TimeDelta now_playing,
247 base::TimeDelta last_buffered);
248
249 // Callbacks from video decoder
250 void OnVideoCodecCreated();
251 void OnVideoResolutionChanged(const gfx::Size& size);
252
253 // Operations called from the state machine.
254 void SetState(PlayerState new_state);
255 void SetPendingStart(bool need_to_start);
256 bool HasPendingStart() const;
257 void SetPendingSeek(base::TimeDelta timestamp);
258 base::TimeDelta GetPendingSeek() const;
259 bool HasVideo() const;
260 bool HasAudio() const;
261 void SetDemuxerConfigs(const DemuxerConfigs& configs);
262 void StartPrefetchDecoders();
263 void StartPlaybackOrBrowserSeek();
264 StartStatus StartPlaybackDecoders();
265 void StopDecoders();
266 void RequestToStopDecoders();
267 void RequestDemuxerSeek(base::TimeDelta seek_time,
268 bool is_browser_seek = false);
269 void ReleaseDecoderResources();
270
271 // Helper methods.
272 void CreateDecoders();
273 bool AudioFinished() const;
274 bool VideoFinished() const;
275 base::TimeDelta GetInterpolatedTime();
276
277 static const char* AsString(PlayerState state);
278
279 // Data.
280
281 // Object for posting tasks on UI thread.
282 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_;
283
284 // Major components: demuxer, audio and video decoders.
285 scoped_ptr<DemuxerAndroid> demuxer_;
286 scoped_ptr<MediaCodecAudioDecoder> audio_decoder_;
287 scoped_ptr<MediaCodecVideoDecoder> video_decoder_;
288
289 // The state of the state machine.
290 PlayerState state_;
291
292 // Notification callbacks, they call MediaPlayerManager.
293 base::Closure request_resources_cb_;
294 TimeUpdateCallback time_update_cb_;
295 base::Closure completion_cb_;
296 SeekDoneCallback seek_done_cb_;
297 ErrorCallback error_cb_;
298
299 // A callback that updates metadata cache and calls the manager.
300 MetadataChangedCallback metadata_changed_cb_;
301
302 // We call the base class' AttachListener() and DetachListener() methods on UI
303 // thread with these callbacks.
304 base::Closure attach_listener_cb_;
305 base::Closure detach_listener_cb_;
306
307 // Error callback is posted by decoders or by this class itself if we cannot
308 // configure or start decoder.
309 base::Closure internal_error_cb_;
310
311 // Total duration reported by demuxer.
312 base::TimeDelta duration_;
313
314 // base::TickClock used by |interpolator_|.
315 base::DefaultTickClock default_tick_clock_;
316
317 // Tracks the most recent media time update and provides interpolated values
318 // as playback progresses.
319 TimeDeltaInterpolator interpolator_;
320
321 // Pending data to be picked up by the upcoming state.
322 gfx::ScopedJavaSurface pending_surface_;
323 bool pending_start_;
324 base::TimeDelta pending_seek_;
325
326 // Data associated with a seek in progress.
327 scoped_ptr<SeekInfo> seek_info_;
328
329 // Configuration data for the manager, accessed on the UI thread.
330 MediaMetadata metadata_cache_;
331
332 // Cached current time, accessed on UI thread.
333 base::TimeDelta current_time_cache_;
334
335 base::WeakPtr<MediaCodecPlayer> media_weak_this_;
336 // NOTE: Weak pointers must be invalidated before all other member variables.
337 base::WeakPtrFactory<MediaCodecPlayer> media_weak_factory_;
338
339 DISALLOW_COPY_AND_ASSIGN(MediaCodecPlayer);
340 };
341
342 } // namespace media
343
344 #endif // MEDIA_BASE_ANDROID_MEDIA_CODEC_PLAYER_H_