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