xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 1 | // Copyright 2014 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 | |
servolk | f54f5c8f | 2015-02-24 20:32:39 | [diff] [blame] | 5 | #ifndef MEDIA_RENDERERS_RENDERER_IMPL_H_ |
| 6 | #define MEDIA_RENDERERS_RENDERER_IMPL_H_ |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 7 | |
servolk | bff54a2 | 2017-01-11 01:39:00 | [diff] [blame] | 8 | #include <list> |
danakj | 4d43bc2 | 2016-04-26 03:36:04 | [diff] [blame] | 9 | #include <memory> |
dalecurtis | e9293458 | 2015-05-12 06:38:00 | [diff] [blame] | 10 | #include <vector> |
| 11 | |
dalecurtis | c11e7bb | 2015-04-03 05:07:08 | [diff] [blame] | 12 | #include "base/cancelable_callback.h" |
avi | a82b9b5 | 2015-12-19 04:27:08 | [diff] [blame] | 13 | #include "base/macros.h" |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 14 | #include "base/memory/ref_counted.h" |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 15 | #include "base/memory/weak_ptr.h" |
| 16 | #include "base/synchronization/lock.h" |
| 17 | #include "base/time/clock.h" |
| 18 | #include "base/time/default_tick_clock.h" |
| 19 | #include "base/time/time.h" |
Chris Cunningham | 038548b | 2017-07-10 22:36:30 | [diff] [blame] | 20 | #include "media/base/audio_decoder_config.h" |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 21 | #include "media/base/buffering_state.h" |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 22 | #include "media/base/decryptor.h" |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 23 | #include "media/base/demuxer_stream.h" |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 24 | #include "media/base/media_export.h" |
| 25 | #include "media/base/pipeline_status.h" |
| 26 | #include "media/base/renderer.h" |
Chris Cunningham | 038548b | 2017-07-10 22:36:30 | [diff] [blame] | 27 | #include "media/base/video_decoder_config.h" |
alokp | 5d86e9b | 2016-05-17 20:20:41 | [diff] [blame] | 28 | #include "ui/gfx/geometry/size.h" |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 29 | |
| 30 | namespace base { |
| 31 | class SingleThreadTaskRunner; |
| 32 | } |
| 33 | |
| 34 | namespace media { |
| 35 | |
| 36 | class AudioRenderer; |
servolk | cfc91f15 | 2017-02-02 05:11:23 | [diff] [blame] | 37 | class MediaResource; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 38 | class TimeSource; |
| 39 | class VideoRenderer; |
scherkus | ece8945 | 2014-09-09 23:13:38 | [diff] [blame] | 40 | class WallClockTimeSource; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 41 | |
| 42 | class MEDIA_EXPORT RendererImpl : public Renderer { |
| 43 | public: |
xhwang | abd95fd | 2014-10-03 07:10:01 | [diff] [blame] | 44 | // Renders audio/video streams using |audio_renderer| and |video_renderer| |
| 45 | // provided. All methods except for GetMediaTime() run on the |task_runner|. |
| 46 | // GetMediaTime() runs on the render main thread because it's part of JS sync |
| 47 | // API. |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 48 | RendererImpl(const scoped_refptr<base::SingleThreadTaskRunner>& task_runner, |
danakj | 4d43bc2 | 2016-04-26 03:36:04 | [diff] [blame] | 49 | std::unique_ptr<AudioRenderer> audio_renderer, |
| 50 | std::unique_ptr<VideoRenderer> video_renderer); |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 51 | |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 52 | ~RendererImpl() final; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 53 | |
| 54 | // Renderer implementation. |
servolk | cfc91f15 | 2017-02-02 05:11:23 | [diff] [blame] | 55 | void Initialize(MediaResource* media_resource, |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 56 | RendererClient* client, |
| 57 | const PipelineStatusCB& init_cb) final; |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 58 | void SetCdm(CdmContext* cdm_context, |
| 59 | const CdmAttachedCB& cdm_attached_cb) final; |
| 60 | void Flush(const base::Closure& flush_cb) final; |
| 61 | void StartPlayingFrom(base::TimeDelta time) final; |
a.berwal | 338bf00 | 2015-04-22 11:14:50 | [diff] [blame] | 62 | void SetPlaybackRate(double playback_rate) final; |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 63 | void SetVolume(float volume) final; |
| 64 | base::TimeDelta GetMediaTime() final; |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 65 | void OnSelectedVideoTracksChanged( |
| 66 | const std::vector<DemuxerStream*>& enabled_tracks, |
| 67 | base::OnceClosure change_completed_cb) override; |
| 68 | void OnEnabledAudioTracksChanged( |
| 69 | const std::vector<DemuxerStream*>& enabled_tracks, |
| 70 | base::OnceClosure change_completed_cb) override; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 71 | |
| 72 | // Helper functions for testing purposes. Must be called before Initialize(). |
| 73 | void DisableUnderflowForTesting(); |
scherkus | ece8945 | 2014-09-09 23:13:38 | [diff] [blame] | 74 | void EnableClocklessVideoPlaybackForTesting(); |
dalecurtis | c11e7bb | 2015-04-03 05:07:08 | [diff] [blame] | 75 | void set_time_source_for_testing(TimeSource* time_source) { |
| 76 | time_source_ = time_source; |
| 77 | } |
| 78 | void set_video_underflow_threshold_for_testing(base::TimeDelta threshold) { |
| 79 | video_underflow_threshold_ = threshold; |
| 80 | } |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 81 | |
| 82 | private: |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 83 | class RendererClientInternal; |
| 84 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 85 | enum State { |
| 86 | STATE_UNINITIALIZED, |
xhwang | a935e44 | 2016-02-11 02:22:45 | [diff] [blame] | 87 | STATE_INIT_PENDING_CDM, // Initialization is waiting for the CDM to be set. |
| 88 | STATE_INITIALIZING, // Initializing audio/video renderers. |
servolk | a1597ec | 2017-04-06 19:49:19 | [diff] [blame] | 89 | STATE_FLUSHING, // Flushing is in progress. |
| 90 | STATE_FLUSHED, // After initialization or after flush completed. |
| 91 | STATE_PLAYING, // After StartPlayingFrom has been called. |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 92 | STATE_ERROR |
| 93 | }; |
| 94 | |
dalecurtis | e9293458 | 2015-05-12 06:38:00 | [diff] [blame] | 95 | bool GetWallClockTimes(const std::vector<base::TimeDelta>& media_timestamps, |
| 96 | std::vector<base::TimeTicks>* wall_clock_times); |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 97 | |
xhwang | a935e44 | 2016-02-11 02:22:45 | [diff] [blame] | 98 | bool HasEncryptedStream(); |
| 99 | |
| 100 | void FinishInitialization(PipelineStatus status); |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 101 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 102 | // Helper functions and callbacks for Initialize(). |
| 103 | void InitializeAudioRenderer(); |
| 104 | void OnAudioRendererInitializeDone(PipelineStatus status); |
| 105 | void InitializeVideoRenderer(); |
| 106 | void OnVideoRendererInitializeDone(PipelineStatus status); |
| 107 | |
| 108 | // Helper functions and callbacks for Flush(). |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 109 | void FlushInternal(); |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 110 | void FlushAudioRenderer(); |
| 111 | void OnAudioRendererFlushDone(); |
| 112 | void FlushVideoRenderer(); |
| 113 | void OnVideoRendererFlushDone(); |
| 114 | |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 115 | // Reinitialize audio/video renderer during a demuxer stream switching. The |
| 116 | // renderer must be flushed first, and when the re-init is completed the |
| 117 | // corresponding callback will be invoked to restart playback. |
| 118 | // The |stream| parameter specifies the new demuxer stream, and the |time| |
| 119 | // parameter specifies the time on media timeline where the switch occured. |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 120 | void ReinitializeAudioRenderer(DemuxerStream* stream, |
| 121 | base::TimeDelta time, |
| 122 | base::OnceClosure reinitialize_completed_cb); |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 123 | void OnAudioRendererReinitialized(DemuxerStream* stream, |
| 124 | base::TimeDelta time, |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 125 | base::OnceClosure reinitialize_completed_cb, |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 126 | PipelineStatus status); |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 127 | void ReinitializeVideoRenderer(DemuxerStream* stream, |
| 128 | base::TimeDelta time, |
| 129 | base::OnceClosure restart_completed_cb); |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 130 | void OnVideoRendererReinitialized(DemuxerStream* stream, |
| 131 | base::TimeDelta time, |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 132 | base::OnceClosure restart_completed_cb, |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 133 | PipelineStatus status); |
| 134 | |
| 135 | // Restart audio/video renderer playback after a demuxer stream switch or |
| 136 | // after a demuxer stream has been disabled and re-enabled. The |stream| |
| 137 | // parameter specifies which stream needs to be restarted. The |time| |
| 138 | // parameter specifies the position on the media timeline where the playback |
| 139 | // needs to be restarted. It is necessary for demuxers with independent |
| 140 | // streams (e.g. MSE / ChunkDemuxer) to synchronize data reading between those |
| 141 | // streams. |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 142 | void RestartAudioRenderer(DemuxerStream* stream, |
| 143 | base::TimeDelta time, |
| 144 | base::OnceClosure restart_completed_cb); |
| 145 | void RestartVideoRenderer(DemuxerStream* stream, |
| 146 | base::TimeDelta time, |
| 147 | base::OnceClosure restart_completed_cb); |
| 148 | |
| 149 | // Fix state booleans after the stream switching is finished. |
| 150 | void CleanUpTrackChange(base::RepeatingClosure on_finished, |
| 151 | bool* pending_change, |
| 152 | bool* ended, |
| 153 | bool* playing); |
servolk | f25ceed | 2016-07-01 03:44:38 | [diff] [blame] | 154 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 155 | // Callback executed by filters to update statistics. |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 156 | void OnStatisticsUpdate(const PipelineStatistics& stats); |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 157 | |
| 158 | // Collection of callback methods and helpers for tracking changes in |
| 159 | // buffering state and transition from paused/underflow states and playing |
| 160 | // states. |
| 161 | // |
| 162 | // While in the kPlaying state: |
| 163 | // - A waiting to non-waiting transition indicates preroll has completed |
| 164 | // and StartPlayback() should be called |
| 165 | // - A non-waiting to waiting transition indicates underflow has occurred |
| 166 | // and PausePlayback() should be called |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 167 | void OnBufferingStateChange(DemuxerStream::Type type, |
| 168 | BufferingState new_buffering_state); |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 169 | |
servolk | f25ceed | 2016-07-01 03:44:38 | [diff] [blame] | 170 | // Handles the buffering notifications that we might get while an audio or a |
| 171 | // video stream is being restarted. In those cases we don't want to report |
| 172 | // underflows immediately and instead give decoders a chance to catch up with |
| 173 | // currently playing stream. Returns true if the buffering nofication has been |
| 174 | // handled and no further processing is necessary, returns false to indicate |
| 175 | // that we should fall back to the regular OnBufferingStateChange logic. |
| 176 | bool HandleRestartedStreamBufferingChanges( |
| 177 | DemuxerStream::Type type, |
| 178 | BufferingState new_buffering_state); |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 179 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 180 | bool WaitingForEnoughData() const; |
| 181 | void PausePlayback(); |
| 182 | void StartPlayback(); |
| 183 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 184 | // Callbacks executed when a renderer has ended. |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 185 | void OnRendererEnded(DemuxerStream::Type type); |
scherkus | ece8945 | 2014-09-09 23:13:38 | [diff] [blame] | 186 | bool PlaybackHasEnded() const; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 187 | void RunEndedCallbackIfNeeded(); |
| 188 | |
| 189 | // Callback executed when a runtime error happens. |
| 190 | void OnError(PipelineStatus error); |
Chris Cunningham | 038548b | 2017-07-10 22:36:30 | [diff] [blame] | 191 | |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 192 | void OnWaitingForDecryptionKey(); |
alokp | 5d86e9b | 2016-05-17 20:20:41 | [diff] [blame] | 193 | void OnVideoNaturalSizeChange(const gfx::Size& size); |
Chris Cunningham | 038548b | 2017-07-10 22:36:30 | [diff] [blame] | 194 | void OnAudioConfigChange(const AudioDecoderConfig& config); |
| 195 | void OnVideoConfigChange(const VideoDecoderConfig& config); |
alokp | 5d86e9b | 2016-05-17 20:20:41 | [diff] [blame] | 196 | void OnVideoOpacityChange(bool opaque); |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 197 | |
servolk | bff54a2 | 2017-01-11 01:39:00 | [diff] [blame] | 198 | void OnStreamRestartCompleted(); |
| 199 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 200 | State state_; |
| 201 | |
| 202 | // Task runner used to execute pipeline tasks. |
| 203 | scoped_refptr<base::SingleThreadTaskRunner> task_runner_; |
| 204 | |
servolk | cfc91f15 | 2017-02-02 05:11:23 | [diff] [blame] | 205 | MediaResource* media_resource_; |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 206 | RendererClient* client_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 207 | |
| 208 | // Temporary callback used for Initialize() and Flush(). |
dalecurtis | 4704611 | 2015-01-23 22:58:20 | [diff] [blame] | 209 | PipelineStatusCB init_cb_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 210 | base::Closure flush_cb_; |
| 211 | |
alokp | 16bbeea | 2016-05-12 23:32:36 | [diff] [blame] | 212 | std::unique_ptr<RendererClientInternal> audio_renderer_client_; |
| 213 | std::unique_ptr<RendererClientInternal> video_renderer_client_; |
danakj | 4d43bc2 | 2016-04-26 03:36:04 | [diff] [blame] | 214 | std::unique_ptr<AudioRenderer> audio_renderer_; |
| 215 | std::unique_ptr<VideoRenderer> video_renderer_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 216 | |
servolk | 16e8bdf8 | 2017-04-11 17:00:39 | [diff] [blame] | 217 | DemuxerStream* current_audio_stream_; |
| 218 | DemuxerStream* current_video_stream_; |
| 219 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 220 | // Renderer-provided time source used to control playback. |
| 221 | TimeSource* time_source_; |
danakj | 4d43bc2 | 2016-04-26 03:36:04 | [diff] [blame] | 222 | std::unique_ptr<WallClockTimeSource> wall_clock_time_source_; |
scherkus | ece8945 | 2014-09-09 23:13:38 | [diff] [blame] | 223 | bool time_ticking_; |
a.berwal | 338bf00 | 2015-04-22 11:14:50 | [diff] [blame] | 224 | double playback_rate_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 225 | |
| 226 | // The time to start playback from after starting/seeking has completed. |
| 227 | base::TimeDelta start_time_; |
| 228 | |
| 229 | BufferingState audio_buffering_state_; |
| 230 | BufferingState video_buffering_state_; |
| 231 | |
| 232 | // Whether we've received the audio/video ended events. |
| 233 | bool audio_ended_; |
| 234 | bool video_ended_; |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 235 | bool audio_playing_; |
| 236 | bool video_playing_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 237 | |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 238 | CdmContext* cdm_context_; |
xhwang | 97de420 | 2014-11-25 08:44:01 | [diff] [blame] | 239 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 240 | bool underflow_disabled_for_testing_; |
scherkus | ece8945 | 2014-09-09 23:13:38 | [diff] [blame] | 241 | bool clockless_video_playback_enabled_for_testing_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 242 | |
dalecurtis | c11e7bb | 2015-04-03 05:07:08 | [diff] [blame] | 243 | // Used to defer underflow for video when audio is present. |
servolk | f25ceed | 2016-07-01 03:44:38 | [diff] [blame] | 244 | base::CancelableClosure deferred_video_underflow_cb_; |
| 245 | |
| 246 | // Used to defer underflow for audio when restarting audio playback. |
| 247 | base::CancelableClosure deferred_audio_restart_underflow_cb_; |
dalecurtis | c11e7bb | 2015-04-03 05:07:08 | [diff] [blame] | 248 | |
| 249 | // The amount of time to wait before declaring underflow if the video renderer |
| 250 | // runs out of data but the audio renderer still has enough. |
| 251 | base::TimeDelta video_underflow_threshold_; |
| 252 | |
servolk | 9dd6cc8 | 2017-05-24 05:39:02 | [diff] [blame] | 253 | // Lock used to protect access to the |restarting_audio_| flag and |
| 254 | // |restarting_audio_time_|. |
| 255 | // TODO(servolk): Get rid of the lock and replace restarting_audio_ with |
| 256 | // std::atomic<bool> when atomics are unbanned in Chromium. |
| 257 | base::Lock restarting_audio_lock_; |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 258 | bool pending_audio_track_change_ = false; |
servolk | 9dd6cc8 | 2017-05-24 05:39:02 | [diff] [blame] | 259 | base::TimeDelta restarting_audio_time_ = kNoTimestamp; |
| 260 | |
Ted Meyer | da82b60 | 2018-04-19 00:36:56 | [diff] [blame^] | 261 | bool pending_video_track_change_ = false; |
Dale Curtis | 3defa54 | 2017-11-07 00:52:32 | [diff] [blame] | 262 | |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 263 | base::WeakPtr<RendererImpl> weak_this_; |
dmichael | 284c5e9 | 2014-12-09 20:02:47 | [diff] [blame] | 264 | base::WeakPtrFactory<RendererImpl> weak_factory_; |
xhwang | be9da70 | 2014-08-23 21:44:55 | [diff] [blame] | 265 | |
| 266 | DISALLOW_COPY_AND_ASSIGN(RendererImpl); |
| 267 | }; |
| 268 | |
| 269 | } // namespace media |
| 270 | |
servolk | f54f5c8f | 2015-02-24 20:32:39 | [diff] [blame] | 271 | #endif // MEDIA_RENDERERS_RENDERER_IMPL_H_ |