1 // Copyright 2013 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_MEDIA_WEB_MEDIA_PLAYER_IMPL_H_
6 #define THIRD_PARTY_BLINK_RENDERER_PLATFORM_MEDIA_WEB_MEDIA_PLAYER_IMPL_H_
14 #include "base/cancelable_callback.h"
15 #include "base/compiler_specific.h"
16 #include "base/memory/memory_pressure_listener.h"
17 #include "base/memory/ref_counted.h"
18 #include "base/memory/scoped_refptr.h"
19 #include "base/memory/weak_ptr.h"
20 #include "base/threading/thread.h"
21 #include "base/time/default_tick_clock.h"
22 #include "base/time/time.h"
23 #include "base/timer/elapsed_timer.h"
24 #include "base/timer/timer.h"
25 #include "build/build_config.h"
26 #include "media/base/cdm_config.h"
27 #include "media/base/encryption_scheme.h"
28 #include "media/base/media_observer.h"
29 #include "media/base/media_tracks.h"
30 #include "media/base/overlay_info.h"
31 #include "media/base/pipeline_impl.h"
32 #include "media/base/renderer_factory_selector.h"
33 #include "media/base/routing_token_callback.h"
34 #include "media/base/simple_watch_timer.h"
35 #include "media/base/text_track.h"
36 #include "media/mojo/mojom/media_metrics_provider.mojom.h"
37 #include "media/mojo/mojom/playback_events_recorder.mojom.h"
38 #include "media/renderers/paint_canvas_video_renderer.h"
39 #include "mojo/public/cpp/bindings/pending_remote.h"
40 #include "mojo/public/cpp/bindings/remote.h"
41 #include "services/media_session/public/cpp/media_position.h"
42 #include "third_party/abseil-cpp/absl/types/optional.h"
43 #include "third_party/blink/public/platform/media/video_frame_compositor.h"
44 #include "third_party/blink/public/platform/media/web_media_player_builder.h"
45 #include "third_party/blink/public/platform/media/webmediaplayer_delegate.h"
46 #include "third_party/blink/public/platform/web_audio_source_provider.h"
47 #include "third_party/blink/public/platform/web_content_decryption_module_result.h"
48 #include "third_party/blink/public/platform/web_media_player.h"
49 #include "third_party/blink/public/platform/web_surface_layer_bridge.h"
50 #include "third_party/blink/public/web/modules/media/webmediaplayer_util.h"
51 #include "third_party/blink/renderer/platform/media/learning_experiment_helper.h"
52 #include "third_party/blink/renderer/platform/media/multi_buffer_data_source.h"
53 #include "third_party/blink/renderer/platform/media/smoothness_helper.h"
54 #include "third_party/blink/renderer/platform/platform_export.h"
58 class SingleThreadTaskRunner;
71 class LearningTaskController;
80 class MemoryDumpProviderProxy;
81 class PipelineController;
82 class SwitchableAudioRendererSink;
86 class RasterContextProvider;
90 class BufferedDataSourceHostImpl;
91 class PowerStatusHelper;
92 class ThreadSafeBrowserInterfaceBrokerProxy;
94 class VideoDecodeStatsReporter;
95 class VideoFrameCompositor;
96 class WatchTimeReporter;
97 class WebAudioSourceProviderImpl;
98 class WebContentDecryptionModule;
100 class WebMediaPlayerClient;
101 class WebMediaPlayerEncryptedMediaClient;
103 // The canonical implementation of WebMediaPlayer that's backed by
104 // Pipeline. Handles normal resource loading, Media Source, and
106 class PLATFORM_EXPORT WebMediaPlayerImpl
107 : public WebMediaPlayer,
108 public WebMediaPlayerDelegate::Observer,
109 public media::Pipeline::Client,
110 public media::MediaObserverClient,
111 public WebSurfaceLayerBridgeObserver,
112 public SmoothnessHelper::Client {
114 // Constructs a WebMediaPlayer implementation using Chromium's media stack.
115 // |delegate| and |renderer_factory_selector| must not be null.
117 WebLocalFrame* frame,
118 WebMediaPlayerClient* client,
119 WebMediaPlayerEncryptedMediaClient* encrypted_client,
120 WebMediaPlayerDelegate* delegate,
121 std::unique_ptr<media::RendererFactorySelector> renderer_factory_selector,
123 std::unique_ptr<VideoFrameCompositor> compositor,
124 std::unique_ptr<media::MediaLog> media_log,
125 media::MediaPlayerLoggingID player_id,
126 WebMediaPlayerBuilder::DeferLoadCB defer_load_cb,
127 scoped_refptr<media::SwitchableAudioRendererSink> audio_renderer_sink,
128 scoped_refptr<base::SingleThreadTaskRunner> media_task_runner,
129 scoped_refptr<base::TaskRunner> worker_task_runner,
130 scoped_refptr<base::SingleThreadTaskRunner> compositor_task_runner,
131 scoped_refptr<base::SingleThreadTaskRunner>
132 video_frame_compositor_task_runner,
133 WebMediaPlayerBuilder::AdjustAllocatedMemoryCB adjust_allocated_memory_cb,
134 WebContentDecryptionModule* initial_cdm,
135 media::RequestRoutingTokenCallback request_routing_token_cb,
136 base::WeakPtr<media::MediaObserver> media_observer,
137 bool enable_instant_source_buffer_gc,
138 bool embedded_media_experience_enabled,
139 mojo::PendingRemote<media::mojom::MediaMetricsProvider> metrics_provider,
140 CreateSurfaceLayerBridgeCB create_bridge_callback,
141 scoped_refptr<viz::RasterContextProvider> raster_context_provider,
142 #if defined(TIZEN_VIDEO_HOLE)
145 bool use_surface_layer,
146 bool is_background_suspend_enabled,
147 bool is_background_video_play_enabled,
148 bool is_background_video_track_optimization_supported,
149 std::unique_ptr<media::Demuxer> demuxer_override,
150 scoped_refptr<ThreadSafeBrowserInterfaceBrokerProxy> remote_interfaces);
151 WebMediaPlayerImpl(const WebMediaPlayerImpl&) = delete;
152 WebMediaPlayerImpl& operator=(const WebMediaPlayerImpl&) = delete;
153 ~WebMediaPlayerImpl() override;
155 // WebSurfaceLayerBridgeObserver implementation.
156 void OnWebLayerUpdated() override;
157 void RegisterContentsLayer(cc::Layer* layer) override;
158 void UnregisterContentsLayer(cc::Layer* layer) override;
159 void OnSurfaceIdUpdated(viz::SurfaceId surface_id) override;
161 WebMediaPlayer::LoadTiming Load(LoadType load_type,
162 const WebMediaPlayerSource& source,
164 bool is_cache_disabled) override;
166 // Playback controls.
167 void Play() override;
168 void Pause() override;
169 void Seek(double seconds) override;
170 void SetRate(double rate) override;
171 void SetVolume(double volume) override;
172 void SetLatencyHint(double seconds) override;
173 void SetPreservesPitch(bool preserves_pitch) override;
174 void SetWasPlayedWithUserActivation(
175 bool was_played_with_user_activation) override;
176 void OnRequestPictureInPicture() override;
177 void OnTimeUpdate() override;
178 bool SetSinkId(const WebString& sink_id,
179 WebSetSinkIdCompleteCallback completion_callback) override;
180 void SetPoster(const WebURL& poster) override;
181 void SetPreload(WebMediaPlayer::Preload preload) override;
182 WebTimeRanges Buffered() const override;
183 WebTimeRanges Seekable() const override;
185 void OnFrozen() override;
187 // paint() the current video frame into |canvas|. This is used to support
188 // various APIs and functionalities, including but not limited to: <canvas>,
189 // ImageBitmap, printing and capturing capabilities.
190 void Paint(cc::PaintCanvas* canvas,
191 const gfx::Rect& rect,
192 cc::PaintFlags& flags) override;
193 scoped_refptr<media::VideoFrame> GetCurrentFrameThenUpdate() override;
194 absl::optional<int> CurrentFrameId() const override;
195 media::PaintCanvasVideoRenderer* GetPaintCanvasVideoRenderer() override;
197 // True if the loaded media has a playable video/audio track.
198 bool HasVideo() const override;
199 bool HasAudio() const override;
201 void EnabledAudioTracksChanged(
202 const WebVector<WebMediaPlayer::TrackId>& enabledTrackIds) override;
203 void SelectedVideoTrackChanged(
204 WebMediaPlayer::TrackId* selectedTrackId) override;
206 // Dimensions of the video.
207 gfx::Size NaturalSize() const override;
209 gfx::Size VisibleSize() const override;
211 // Getters of playback state.
212 bool Paused() const override;
213 bool Seeking() const override;
214 double Duration() const override;
215 virtual double timelineOffset() const;
216 double CurrentTime() const override;
217 bool IsEnded() const override;
219 bool PausedWhenHidden() const override;
221 // Internal states of loading and network.
222 // TODO(hclam): Ask the pipeline about the state rather than having reading
223 // them from members which would cause race conditions.
224 WebMediaPlayer::NetworkState GetNetworkState() const override;
225 WebMediaPlayer::ReadyState GetReadyState() const override;
227 WebString GetErrorMessage() const override;
228 bool DidLoadingProgress() override;
229 bool WouldTaintOrigin() const override;
231 double MediaTimeForTimeValue(double timeValue) const override;
233 unsigned DecodedFrameCount() const override;
234 unsigned DroppedFrameCount() const override;
235 uint64_t AudioDecodedByteCount() const override;
236 uint64_t VideoDecodedByteCount() const override;
238 bool PassedTimingAllowOriginCheck() const override;
240 void SetVolumeMultiplier(double multiplier) override;
241 void SetPersistentState(bool persistent) override;
242 void SetPowerExperimentState(bool state) override;
243 void SuspendForFrameClosed() override;
245 bool HasAvailableVideoFrame() const override;
247 scoped_refptr<WebAudioSourceProviderImpl> GetAudioSourceProvider() override;
249 void SetContentDecryptionModule(
250 WebContentDecryptionModule* cdm,
251 WebContentDecryptionModuleResult result) override;
253 void EnteredFullscreen() override;
254 void ExitedFullscreen() override;
255 void BecameDominantVisibleContent(bool is_dominant) override;
256 void SetIsEffectivelyFullscreen(
257 WebFullscreenVideoStatus fullscreen_video_status) override;
258 void OnHasNativeControlsChanged(bool) override;
259 void OnDisplayTypeChanged(DisplayType display_type) override;
261 // WebMediaPlayerDelegate::Observer implementation.
262 void OnFrameHidden() override;
263 void OnFrameShown() override;
264 void OnIdleTimeout() override;
265 void RequestRemotePlaybackDisabled(bool disabled) override;
267 #if BUILDFLAG(IS_ANDROID)
268 // TODO(https://crbug.com/839651): Rename Flinging[Started/Stopped] to
269 // RemotePlayback[Started/Stopped] once the other RemotePlayback methods have
271 void FlingingStarted() override;
272 void FlingingStopped() override;
274 // Called when the play/pause state of media playing on a remote cast device
275 // changes, and WMPI wasn't the originator of that change (e.g. a phone on the
276 // same network paused the cast device via the casting notification).
277 // This is only used by the FlingingRenderer/FlingingRendererClient, when we
278 // are flinging media (a.k.a. RemotePlayback).
279 // The consistency between the WMPI state and the cast device state is not
280 // guaranteed, and it a best effort, which can always be fixed by the user by
281 // tapping play/pause once. Attempts to enfore stronger consistency guarantees
282 // have lead to unstable states, and a worse user experience.
283 void OnRemotePlayStateChange(media::MediaStatus::State state);
286 // media::MediaObserverClient implementation.
287 void SwitchToRemoteRenderer(
288 const std::string& remote_device_friendly_name) override;
289 void SwitchToLocalRenderer(
290 media::MediaObserverClient::ReasonToSwitchToLocal reason) override;
291 void UpdateRemotePlaybackCompatibility(bool is_compatible) override;
293 // Test helper methods for exercising media suspension. Once called, when
294 // |target_state| is reached or exceeded the stale flag will be set when
295 // computing the play state, which will trigger suspend if the player is
296 // paused; see UpdatePlayState_ComputePlayState() for the exact details.
297 void ForceStaleStateForTesting(ReadyState target_state) override;
298 bool IsSuspendedForTesting() override;
299 bool DidLazyLoad() const override;
300 void OnBecameVisible() override;
301 bool IsOpaque() const override;
302 int GetDelegateId() override;
303 absl::optional<viz::SurfaceId> GetSurfaceId() override;
304 GURL GetSrcAfterRedirects() override;
305 void RequestVideoFrameCallback() override;
306 std::unique_ptr<WebMediaPlayer::VideoFramePresentationMetadata>
307 GetVideoFramePresentationMetadata() override;
308 void UpdateFrameIfStale() override;
310 base::WeakPtr<WebMediaPlayer> AsWeakPtr() override;
311 void RegisterFrameSinkHierarchy() override;
312 void UnregisterFrameSinkHierarchy() override;
314 bool IsBackgroundMediaSuspendEnabled() const {
315 return is_background_suspend_enabled_;
318 // Distinct states that |delegate_| can be in. (Public for testing.)
319 enum class DelegateState {
325 // Playback state variables computed together in UpdatePlayState().
326 // (Public for testing.)
328 DelegateState delegate_state;
330 bool is_memory_reporting_enabled;
334 // Allow background video tracks with ~5 second keyframes (rounding down) to
335 // be disabled to save resources.
336 enum { kMaxKeyframeDistanceToDisableBackgroundVideoMs = 5500 };
339 friend class WebMediaPlayerImplTest;
340 friend class WebMediaPlayerImplBackgroundBehaviorTest;
342 void EnableOverlay();
343 void DisableOverlay();
345 // Do we have overlay information? For CVV, this is a surface id. For
346 // AndroidOverlay, this is the routing token.
347 bool HaveOverlayInfo();
349 // Send OverlayInfo to the decoder.
351 // If we've requested but not yet received the surface id or routing token, or
352 // if there's no decoder-provided callback to send the overlay info, then this
353 // call will do nothing.
354 void MaybeSendOverlayInfoToDecoder();
356 void OnPipelineSuspended();
357 void OnBeforePipelineResume();
358 void OnPipelineResumed();
359 void OnPipelineSeeked(bool time_updated);
360 void OnDemuxerOpened();
362 // media::Pipeline::Client overrides.
363 void OnError(media::PipelineStatus status) override;
364 void OnFallback(media::PipelineStatus status) override;
365 void OnEnded() override;
366 void OnMetadata(const media::PipelineMetadata& metadata) override;
367 void OnBufferingStateChange(
368 media::BufferingState state,
369 media::BufferingStateChangeReason reason) override;
370 void OnDurationChange() override;
371 void OnAddTextTrack(const media::TextTrackConfig& config,
372 media::AddTextTrackDoneCB done_cb) override;
373 void OnWaiting(media::WaitingReason reason) override;
374 void OnAudioConfigChange(const media::AudioDecoderConfig& config) override;
375 void OnVideoConfigChange(const media::VideoDecoderConfig& config) override;
376 void OnVideoNaturalSizeChange(const gfx::Size& size) override;
377 void OnVideoOpacityChange(bool opaque) override;
378 void OnVideoFrameRateChange(absl::optional<int> fps) override;
379 void OnVideoAverageKeyframeDistanceUpdate() override;
380 void OnAudioPipelineInfoChange(const media::AudioPipelineInfo& info) override;
381 void OnVideoPipelineInfoChange(const media::VideoPipelineInfo& info) override;
383 // Simplified watch time reporting.
384 void OnSimpleWatchTimerTick();
386 // Actually seek. Avoids causing |should_notify_time_changed_| to be set when
387 // |time_updated| is false.
388 void DoSeek(base::TimeDelta time, bool time_updated);
390 // Called after |defer_load_cb_| has decided to allow the load. If
391 // |defer_load_cb_| is null this is called immediately.
392 void DoLoad(LoadType load_type,
395 bool is_cache_disabled);
397 // Called after asynchronous initialization of a data source completed.
398 void DataSourceInitialized(bool success);
400 // Called if the |MultiBufferDataSource| is redirected.
401 void OnDataSourceRedirected();
403 // Called when the data source is downloading or paused.
404 void NotifyDownloading(bool is_downloading);
406 // Called by RenderFrameImpl with the overlay routing token, if we request it.
407 void OnOverlayRoutingToken(const base::UnguessableToken& token);
409 // Called by GpuVideoDecoder on Android to request a surface to render to (if
411 void OnOverlayInfoRequested(
412 bool decoder_requires_restart_for_overlay,
413 media::ProvideOverlayInfoCB provide_overlay_info_cb);
415 // Creates a Renderer via the |renderer_factory_selector_|. If the
416 // |renderer_type| is absl::nullopt, create the base Renderer. Otherwise, set
417 // the base type to be |renderer_type| and create a Renderer of that type.
418 std::unique_ptr<media::Renderer> CreateRenderer(
419 absl::optional<media::RendererType> renderer_type);
421 // Finishes starting the pipeline due to a call to load().
422 void StartPipeline();
424 // Restart the player/pipeline as soon as possible. This will destroy the
425 // current renderer, if any, and create a new one via the RendererFactory; and
426 // then seek to resume playback at the current position.
427 void ScheduleRestart();
429 // Helpers that set the network/ready state and notifies the client if
431 void SetNetworkState(WebMediaPlayer::NetworkState state);
432 void SetReadyState(WebMediaPlayer::ReadyState state);
434 // Returns the current video frame from |compositor_|, and asks the compositor
435 // to update its frame if it is stale.
436 // Can return a nullptr.
437 scoped_refptr<media::VideoFrame> GetCurrentFrameFromCompositor() const;
439 // Called when the demuxer encounters encrypted streams.
440 void OnEncryptedMediaInitData(media::EmeInitDataType init_data_type,
441 const std::vector<uint8_t>& init_data);
443 // Called when the FFmpegDemuxer encounters new media tracks. This is only
444 // invoked when using FFmpegDemuxer, since MSE/ChunkDemuxer handle media
445 // tracks separately in WebSourceBufferImpl.
446 void OnFFmpegMediaTracksUpdated(std::unique_ptr<media::MediaTracks> tracks);
448 // Sets CdmContext from |cdm| on the pipeline and calls OnCdmAttached()
450 void SetCdmInternal(WebContentDecryptionModule* cdm);
452 // Called when a CDM has been attached to the |pipeline_|.
453 void OnCdmAttached(bool success);
455 // Inspects the current playback state and:
456 // - notifies |delegate_|,
457 // - toggles the memory usage reporting timer, and
458 // - toggles suspend/resume as necessary.
460 // This method should be called any time its dependent values change. These
464 // - delegate_->IsHidden(),
465 // - network_state_, ready_state_,
466 // - is_idle_, must_suspend_,
467 // - paused_, ended_,
468 // - pending_suspend_resume_cycle_,
469 // - enter_pip_callback_,
470 void UpdatePlayState();
472 // Methods internal to UpdatePlayState().
473 PlayState UpdatePlayState_ComputePlayState(bool is_flinging,
474 bool can_auto_suspend,
476 bool is_backgrounded,
477 bool is_in_picture_in_picture);
478 void SetDelegateState(DelegateState new_state, bool is_idle);
479 void SetMemoryReportingState(bool is_memory_reporting_enabled);
480 void SetSuspendState(bool is_suspended);
482 void SetDemuxer(std::unique_ptr<media::Demuxer> demuxer);
484 // Called at low frequency to tell external observers how much memory we're
485 // using for video playback. Called by |memory_usage_reporting_timer_|.
486 // Memory usage reporting is done in two steps, because |demuxer_| must be
487 // accessed on the media thread.
488 void ReportMemoryUsage();
489 void FinishMemoryUsageReport(int64_t demuxer_memory_usage);
491 void OnMainThreadMemoryDump(int32_t id,
492 const base::trace_event::MemoryDumpArgs& args,
493 base::trace_event::ProcessMemoryDump* pmd);
494 static void OnMediaThreadMemoryDump(
496 media::Demuxer* demuxer,
497 const base::trace_event::MemoryDumpArgs& args,
498 base::trace_event::ProcessMemoryDump* pmd);
500 void OnMemoryPressure(
501 base::MemoryPressureListener::MemoryPressureLevel memory_pressure_level);
503 // Called during OnHidden() when we want a suspended player to enter the
504 // paused state after some idle timeout.
505 void ScheduleIdlePauseTimer();
507 // Returns |true| before HaveFutureData whenever there has been loading
508 // progress and we have not been resumed for at least kLoadingToIdleTimeout
511 // This is used to delay suspension long enough for preroll to complete, which
512 // is necessay because play() will not be called before HaveFutureData (and
513 // thus we think we are idle forever).
514 bool IsPrerollAttemptNeeded();
516 void CreateWatchTimeReporter();
517 void UpdateSecondaryProperties();
519 void CreateVideoDecodeStatsReporter();
521 // Returns true if the player is hidden.
522 bool IsHidden() const;
524 // Returns true if the player's source is streaming.
525 bool IsStreaming() const;
527 // Return whether |pipeline_metadata_| is compatible with an overlay. This
528 // is intended for android.
529 bool DoesOverlaySupportMetadata() const;
531 // Whether the playback should be paused when hidden. Uses metadata so has
532 // meaning only after the pipeline has started, otherwise returns false.
533 // Doesn't check if the playback can actually be paused depending on the
535 bool ShouldPausePlaybackWhenHidden() const;
537 // Whether the video track should be disabled when hidden. Uses metadata so
538 // has meaning only after the pipeline has started, otherwise returns false.
539 // Doesn't check if the video track can actually be disabled depending on the
541 bool ShouldDisableVideoWhenHidden() const;
543 // Whether the video is suitable for background playback optimizations (either
544 // pausing it or disabling the video track). Uses metadata so has meaning only
545 // after the pipeline has started, otherwise returns false.
546 // The logical OR between the two methods above that is also used as their
547 // common implementation.
548 bool IsBackgroundOptimizationCandidate() const;
550 // If enabling or disabling background video optimization has been delayed,
551 // because of the pipeline not running, seeking or resuming, this method
552 // needs to be called to update the optimization state.
553 void UpdateBackgroundVideoOptimizationState();
555 // Pauses a hidden video only player to save power if possible.
556 // Must be called when either of the following happens:
557 // - right after the video was hidden,
558 // - right ater the pipeline has resumed if the video is hidden.
559 void PauseVideoIfNeeded();
561 // Disables the video track to save power if possible.
562 // Must be called when either of the following happens:
563 // - right after the video was hidden,
564 // - right after the pipeline has started (|seeking_| is used to detect the
565 // when pipeline started) if the video is hidden,
566 // - right ater the pipeline has resumed if the video is hidden.
567 void DisableVideoTrackIfNeeded();
569 // Enables the video track if it was disabled before to save power.
570 // Must be called when either of the following happens:
571 // - right after the video was shown,
572 // - right before the pipeline is requested to resume
573 // (see https://crbug.com/678374),
574 // - right after the pipeline has resumed if the video is not hidden.
575 void EnableVideoTrackIfNeeded();
577 // Overrides the pipeline statistics returned by GetPiplineStatistics() for
579 void SetPipelineStatisticsForTest(const media::PipelineStatistics& stats);
581 // Returns the pipeline statistics or the value overridden by tests.
582 media::PipelineStatistics GetPipelineStatistics() const;
584 // Overrides the pipeline media duration returned by
585 // GetPipelineMediaDuration() for tests.
586 void SetPipelineMediaDurationForTest(base::TimeDelta duration);
588 // Returns the pipeline media duration or the value overridden by tests.
589 base::TimeDelta GetPipelineMediaDuration() const;
591 media::MediaContentType GetMediaContentType() const;
593 // Records |duration| to the appropriate metric based on whether we're
594 // handling a src= or MSE based playback.
595 void RecordUnderflowDuration(base::TimeDelta duration);
597 // Called by the data source (for src=) or demuxer (for mse) when loading
599 // Can be called quite often.
602 // Returns true when we estimate that we can play the rest of the media
603 // without buffering.
604 bool CanPlayThrough();
606 // Internal implementation of Pipeline::Client::OnBufferingStateChange(). When
607 // |for_suspended_start| is true, the given state will be set even if the
608 // pipeline is not currently stable.
609 void OnBufferingStateChangeInternal(media::BufferingState state,
610 media::BufferingStateChangeReason reason,
611 bool for_suspended_start = false);
613 // Records |natural_size| to MediaLog and video height to UMA.
614 void RecordVideoNaturalSize(const gfx::Size& natural_size);
616 void SetTickClockForTest(const base::TickClock* tick_clock);
618 // Returns the current time without clamping to Duration() as required by
619 // HTMLMediaElement for handling ended. This method will never return a
620 // negative or kInfiniteDuration value. See http://crbug.com/409280,
621 // http://crbug.com/645998, and http://crbug.com/751823 for reasons why.
622 base::TimeDelta GetCurrentTimeInternal() const;
624 // Called by the compositor the very first time a frame is received.
625 void OnFirstFrame(base::TimeTicks frame_time);
627 // Records timing metrics for three UMA metrics: #key.SRC, #key.MSE, and
628 // #key.EME. The SRC and MSE ones are mutually exclusive based on the presence
629 // of |chunk_demuxer_|, while the EME one is only recorded if |is_encrypted_|.
630 void RecordTimingUMA(const std::string& key, base::TimeDelta elapsed);
632 // Records the encryption scheme used by the stream |stream_name|. This is
633 // only recorded when metadata is available.
634 void RecordEncryptionScheme(const std::string& stream_name,
635 media::EncryptionScheme encryption_scheme);
637 // Returns whether the player is currently displayed in Picture-in-Picture.
638 // It will return true even if the player is in AutoPIP mode.
639 // The player MUST have a `client_` when this call happen.
640 bool IsInPictureInPicture() const;
642 // Sets the UKM container name if needed.
643 void MaybeSetContainerNameForMetrics();
645 // Switch to SurfaceLayer, either initially or from VideoLayer.
646 void ActivateSurfaceLayerForVideo();
648 // Called by |compositor_| upon presenting a frame, after
649 // RequestAnimationFrame() is called.
650 void OnNewFramePresentedCallback();
652 // Notifies |mb_data_source_| of playback and rate changes which may increase
653 // the amount of data the DataSource buffers. Does nothing prior to reaching
654 // kReadyStateHaveEnoughData for the first time.
655 void MaybeUpdateBufferSizesForPlayback();
657 // Create / recreate |smoothness_helper_|, with current features. Will take
658 // no action if we already have a smoothness helper with the same features
659 // that we want now. Will destroy the helper if we shouldn't be measuring
660 // smoothness right now.
661 void UpdateSmoothnessHelper();
663 // Get the LearningTaskController for |task_name|.
664 std::unique_ptr<media::learning::LearningTaskController>
665 GetLearningTaskController(const char* task_name);
667 // Returns whether the player has an audio track and whether it should be
668 // allowed to play it.
669 bool HasUnmutedAudio() const;
671 // Returns true if the video frame from this player are being captured.
672 bool IsVideoBeingCaptured() const;
674 #if defined(TIZEN_VIDEO_HOLE)
675 bool ShouldUseVideoHole() const;
676 void CreateVideoHoleFrame();
677 void OnDrawableContentRectChanged(gfx::Rect rect, bool is_video);
678 bool UpdateBoundaryRectangle();
679 void StartLayerBoundUpdateTimer();
680 void StopLayerBoundUpdateTimer();
681 void OnLayerBoundUpdateTimerFired();
684 // Report UMAs when this object instance is destroyed.
685 void ReportSessionUMAs() const;
687 WebLocalFrame* const frame_;
689 WebMediaPlayer::NetworkState network_state_ =
690 WebMediaPlayer::kNetworkStateEmpty;
691 WebMediaPlayer::ReadyState ready_state_ =
692 WebMediaPlayer::kReadyStateHaveNothing;
693 WebMediaPlayer::ReadyState highest_ready_state_ =
694 WebMediaPlayer::kReadyStateHaveNothing;
696 // Preload state for when |data_source_| is created after setPreload().
697 MultiBufferDataSource::Preload preload_ = MultiBufferDataSource::METADATA;
699 // Poster state (for UMA reporting).
700 bool has_poster_ = false;
702 // Task runner for posting tasks on Chrome's main thread. Also used
703 // for DCHECKs so methods calls won't execute in the wrong thread.
704 const scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
705 const scoped_refptr<base::SingleThreadTaskRunner> media_task_runner_;
706 const scoped_refptr<base::TaskRunner> worker_task_runner_;
708 // This is the ID that is used within the internals of the media element
709 // primarily for correlating logs.
710 const media::MediaPlayerLoggingID media_player_id_;
712 std::unique_ptr<media::MediaLog> media_log_;
714 // |pipeline_controller_| owns an instance of Pipeline.
715 std::unique_ptr<media::PipelineController> pipeline_controller_;
717 // The LoadType passed in the |load_type| parameter of the load() call.
718 LoadType load_type_ = kLoadTypeURL;
720 // Cache of metadata for answering hasAudio(), hasVideo(), and naturalSize().
721 media::PipelineMetadata pipeline_metadata_;
723 // Whether the video is known to be opaque or not.
724 bool opaque_ = false;
728 // TODO(scherkus): we have these because Pipeline favours the simplicity of a
729 // single "playback rate" over worrying about paused/stopped etc... It forces
730 // all clients to manage the pause+playback rate externally, but is that
731 // really a bad thing?
733 // TODO(scherkus): since SetPlaybackRate(0) is asynchronous and we don't want
734 // to hang the render thread during pause(), we record the time at the same
735 // time we pause and then return that value in currentTime(). Otherwise our
736 // clock can creep forward a little bit while the asynchronous
737 // SetPlaybackRate(0) is being executed.
738 double playback_rate_ = 0.0;
740 // Counter that limits spam to |media_log_| of |playback_rate_| changes.
741 int num_playback_rate_logs_ = 0;
743 // Set while paused. |paused_time_| is only valid when |paused_| is true.
745 base::TimeDelta paused_time_;
747 // Set if paused automatically when hidden and need to resume when visible.
748 // Reset if paused for any other reason.
749 bool paused_when_hidden_ = false;
751 // Set when starting, seeking, and resuming (all of which require a Pipeline
752 // seek). |seek_time_| is only valid when |seeking_| is true.
753 bool seeking_ = false;
754 base::TimeDelta seek_time_;
756 // Set when doing a restart (a suspend and resume in sequence) of the pipeline
757 // in order to destruct and reinitialize the decoders. This is separate from
758 // |pending_resume_| and |pending_suspend_| because they can be elided in
759 // certain cases, whereas for a restart they must happen.
760 // TODO(sandersd,watk): Create a simpler interface for a pipeline restart.
761 bool pending_suspend_resume_cycle_ = false;
763 // TODO(scherkus): Replace with an explicit ended signal to HTMLMediaElement,
764 // see http://crbug.com/409280
767 // Tracks whether to issue time changed notifications during buffering state
769 bool should_notify_time_changed_ = false;
771 bool overlay_enabled_ = false;
773 // Whether the current decoder requires a restart on overlay transitions.
774 bool decoder_requires_restart_for_overlay_ = false;
776 WebMediaPlayerClient* const client_;
777 WebMediaPlayerEncryptedMediaClient* const encrypted_client_;
779 // WebMediaPlayer notifies the |delegate_| of playback state changes using
780 // |delegate_id_|; an id provided after registering with the delegate. The
781 // WebMediaPlayer may also receive directives (play, pause) from the delegate
782 // via the WebMediaPlayerDelegate::Observer interface after registration.
784 // NOTE: HTMLMediaElement is a ExecutionContextLifecycleObserver, and
785 // will receive a call to contextDestroyed() when Document::shutdown()
786 // is called. Document::shutdown() is called before the frame detaches (and
787 // before the frame is destroyed). RenderFrameImpl owns |delegate_| and is
788 // guaranteed to outlive |this|; thus it is safe to store |delegate_| as a raw
790 WebMediaPlayerDelegate* delegate_;
791 int delegate_id_ = 0;
793 // The playback state last reported to |delegate_|, to avoid setting duplicate
795 // TODO(sandersd): The delegate should be implementing deduplication.
796 DelegateState delegate_state_ = DelegateState::GONE;
797 bool delegate_has_audio_ = false;
799 WebMediaPlayerBuilder::DeferLoadCB defer_load_cb_;
801 // Members for notifying upstream clients about internal memory usage. The
802 // |adjust_allocated_memory_cb_| must only be called on |main_task_runner_|.
803 base::RepeatingTimer memory_usage_reporting_timer_;
804 WebMediaPlayerBuilder::AdjustAllocatedMemoryCB adjust_allocated_memory_cb_;
805 int64_t last_reported_memory_usage_ = 0;
806 std::unique_ptr<media::MemoryDumpProviderProxy> main_thread_mem_dumper_;
807 std::unique_ptr<media::MemoryDumpProviderProxy> media_thread_mem_dumper_;
809 // Routes audio playback to either AudioRendererSink or WebAudio.
810 scoped_refptr<WebAudioSourceProviderImpl> audio_source_provider_;
812 // These two are mutually exclusive:
813 // |data_source_| is used for regular resource loads.
814 // |chunk_demuxer_| is used for Media Source resource loads.
816 // |demuxer_| will contain the appropriate demuxer based on which resource
817 // load strategy we're using.
818 MultiBufferDataSource* mb_data_source_ = nullptr;
819 std::unique_ptr<media::DataSource> data_source_;
820 std::unique_ptr<media::Demuxer> demuxer_;
821 media::ChunkDemuxer* chunk_demuxer_ = nullptr;
823 std::unique_ptr<base::MemoryPressureListener> memory_pressure_listener_;
825 const base::TickClock* tick_clock_ = nullptr;
827 std::unique_ptr<BufferedDataSourceHostImpl> buffered_data_source_host_;
828 UrlIndex* const url_index_;
829 scoped_refptr<viz::RasterContextProvider> raster_context_provider_;
831 // Video rendering members.
832 // The |compositor_| runs on the compositor thread, or if
833 // kEnableSurfaceLayerForVideo is enabled, the media thread. This task runner
834 // posts tasks for the |compositor_| on the correct thread.
835 scoped_refptr<base::SingleThreadTaskRunner> vfc_task_runner_;
836 std::unique_ptr<VideoFrameCompositor>
837 compositor_; // Deleted on |vfc_task_runner_|.
838 media::PaintCanvasVideoRenderer video_renderer_;
840 // The compositor layer for displaying the video content when using composited
842 scoped_refptr<cc::VideoLayer> video_layer_;
844 std::unique_ptr<WebContentDecryptionModuleResult> set_cdm_result_;
846 // If a CdmContext is attached keep a reference to the CdmContextRef, so that
847 // it is not destroyed until after the pipeline is done with it.
848 std::unique_ptr<media::CdmContextRef> cdm_context_ref_;
850 // Keep track of the CdmContextRef while it is in the process of attaching to
852 std::unique_ptr<media::CdmContextRef> pending_cdm_context_ref_;
854 // True when encryption is detected, either by demuxer or by presence of a
855 // ContentDecyprtionModule (CDM).
856 bool is_encrypted_ = false;
858 // Captured once the cdm is provided to SetCdmInternal(). Used in creation of
859 // |video_decode_stats_reporter_|.
860 absl::optional<media::CdmConfig> cdm_config_;
862 // Tracks if we are currently flinging a video (e.g. in a RemotePlayback
863 // session). Used to prevent videos from being paused when hidden.
864 // TODO(https://crbug.com/839651): remove or rename this flag, when removing
866 bool is_flinging_ = false;
868 // Tracks if we are currently using a remote renderer. See
869 // SwitchToRemoteRenderer().
870 bool is_remote_rendering_ = false;
872 // The last volume received by setVolume() and the last volume multiplier from
873 // SetVolumeMultiplier(). The multiplier is typical 1.0, but may be less
874 // if the WebMediaPlayerDelegate has requested a volume reduction (ducking)
875 // for a transient sound. Playout volume is derived by volume * multiplier.
876 double volume_ = 1.0;
877 double volume_multiplier_ = 1.0;
879 std::unique_ptr<media::RendererFactorySelector> renderer_factory_selector_;
881 // For canceling AndroidOverlay routing token requests.
882 base::CancelableOnceCallback<void(const base::UnguessableToken&)>
885 // If overlay info is requested before we have it, then the request is saved
886 // and satisfied once the overlay info is available. If the decoder does not
887 // require restart to change surfaces, this is callback is kept until cleared
889 media::ProvideOverlayInfoCB provide_overlay_info_cb_;
891 // On Android an overlay surface means using
892 // SurfaceView instead of SurfaceTexture.
894 // Allow overlays for all video on android.
895 bool always_enable_overlays_ = false;
897 // Suppresses calls to OnPipelineError() after destruction / shutdown has been
898 // started; prevents us from spuriously logging errors that are transient or
900 bool suppress_destruction_errors_ = false;
902 // TODO(dalecurtis): The following comment is inaccurate as this value is also
903 // used for, for example, data URLs.
904 // Used for HLS playback and in certain fallback paths (e.g. on older devices
905 // that can't support the unified media pipeline).
908 // NOTE: |using_media_player_renderer_| is set based on the usage of a
909 // MediaResource::Type::URL in StartPipeline(). This works because
910 // MediaPlayerRendererClientFactory is the only factory that uses
911 // MediaResource::Type::URL for now.
912 bool using_media_player_renderer_ = false;
914 #if BUILDFLAG(IS_ANDROID)
915 // Set during the initial DoLoad() call. Used to determine whether to allow
916 // credentials or not for MediaPlayerRenderer.
917 bool allow_media_player_renderer_credentials_ = false;
920 // Stores the current position state of the media.
921 media_session::MediaPosition media_position_state_;
923 // Set whenever the demuxer encounters an HLS file.
924 // This flag is distinct from |using_media_player_renderer_|, because on older
925 // devices we might use MediaPlayerRenderer for non HLS playback.
926 bool demuxer_found_hls_ = false;
928 // Called sometime after the media is suspended in a playing state in
929 // OnFrameHidden(), causing the state to change to paused.
930 base::OneShotTimer background_pause_timer_;
932 // Monitors the watch time of the played content.
933 std::unique_ptr<WatchTimeReporter> watch_time_reporter_;
934 media::AudioDecoderType audio_decoder_type_ =
935 media::AudioDecoderType::kUnknown;
936 media::VideoDecoderType video_decoder_type_ =
937 media::VideoDecoderType::kUnknown;
939 // The time at which DoLoad() is executed.
940 base::TimeTicks load_start_time_;
942 // Time elapsed time from |load_start_time_| to OnMetadata(). Used to later
943 // adjust |load_start_time_| if a suspended startup occurred.
944 base::TimeDelta time_to_metadata_;
945 bool skip_metrics_due_to_startup_suspend_ = false;
947 bool have_reported_time_to_play_ready_ = false;
949 // Records pipeline statistics for describing media capabilities.
950 std::unique_ptr<VideoDecodeStatsReporter> video_decode_stats_reporter_;
952 // Elapsed time since we've last reached BUFFERING_HAVE_NOTHING.
953 std::unique_ptr<base::ElapsedTimer> underflow_timer_;
955 // Used to track loading progress, used by IsPrerollAttemptNeeded().
956 // |preroll_attempt_pending_| indicates that the clock has been reset
957 // (awaiting a resume to start), while |preroll_attempt_start_time_| tracks
958 // when a preroll attempt began.
959 bool preroll_attempt_pending_ = false;
960 base::TimeTicks preroll_attempt_start_time_;
962 // Monitors the player events.
963 base::WeakPtr<media::MediaObserver> observer_;
965 // Owns the weblayer and obtains/maintains SurfaceIds.
966 std::unique_ptr<WebSurfaceLayerBridge> bridge_;
968 // The maximum video keyframe distance that allows triggering background
969 // playback optimizations (non-MSE).
970 base::TimeDelta max_keyframe_distance_to_disable_background_video_;
972 // The maximum video keyframe distance that allows triggering background
973 // playback optimizations (MSE).
974 base::TimeDelta max_keyframe_distance_to_disable_background_video_mse_;
976 // When MSE memory pressure based garbage collection is enabled, the
977 // |enable_instant_source_buffer_gc| controls whether the GC is done
978 // immediately on memory pressure notification or during the next SourceBuffer
979 // append (slower, but MSE spec compliant).
980 bool enable_instant_source_buffer_gc_ = false;
982 // Whether disabled the video track as an optimization.
983 bool video_track_disabled_ = false;
985 // Whether the pipeline is being resumed at the moment.
986 bool is_pipeline_resuming_ = false;
988 // When this is true, pipeline will not be auto suspended.
989 bool disable_pipeline_auto_suspend_ = false;
991 // Pipeline statistics overridden by tests.
992 absl::optional<media::PipelineStatistics> pipeline_statistics_for_test_;
994 // Pipeline media duration overridden by tests.
995 absl::optional<base::TimeDelta> pipeline_media_duration_for_test_;
997 // Whether the video requires a user gesture to resume after it was paused in
998 // the background. Affects the value of ShouldPausePlaybackWhenHidden().
999 bool video_locked_when_paused_when_hidden_ = false;
1001 // Whether embedded media experience is currently enabled.
1002 bool embedded_media_experience_enabled_ = false;
1004 // When should we use SurfaceLayer for video?
1005 bool use_surface_layer_ = false;
1007 // Whether surface layer is currently in use to display frames.
1008 bool surface_layer_for_video_enabled_ = false;
1010 CreateSurfaceLayerBridgeCB create_bridge_callback_;
1012 bool initial_video_height_recorded_ = false;
1014 enum class OverlayMode {
1015 // All overlays are turned off.
1018 // Use AndroidOverlay for overlays.
1022 OverlayMode overlay_mode_ = OverlayMode::kNoOverlays;
1024 // Optional callback to request the routing token for AndroidOverlay.
1025 media::RequestRoutingTokenCallback request_routing_token_cb_;
1027 // If |overlay_routing_token_is_pending_| is false, then
1028 // |overlay_routing_token_| contains the routing token we should send, if any.
1029 // Otherwise, |overlay_routing_token_| is undefined. We set the flag while
1030 // we have a request for the token that hasn't been answered yet; i.e., it
1031 // means that we don't know what, if any, token we should be using.
1032 bool overlay_routing_token_is_pending_ = false;
1033 media::OverlayInfo::RoutingToken overlay_routing_token_;
1035 media::OverlayInfo overlay_info_;
1037 base::CancelableOnceClosure update_background_status_cb_;
1039 // We cannot use `update_background_status_cb_.IsCancelled()` as that changes
1040 // when the callback is run, even if not explicitly cancelled. This is
1041 // initialized to true to keep in line with the existing behavior of
1042 // base::CancellableOnceClosure.
1043 bool is_background_status_change_cancelled_ = true;
1045 mojo::Remote<media::mojom::MediaMetricsProvider> media_metrics_provider_;
1046 mojo::Remote<media::mojom::PlaybackEventsRecorder> playback_events_recorder_;
1048 absl::optional<ReadyState> stale_state_override_for_testing_;
1050 // True if we attempt to start the media pipeline in a suspended state for
1051 // preload=metadata. Cleared upon pipeline startup.
1052 bool attempting_suspended_start_ = false;
1054 // True if a frame has ever been rendered.
1055 bool has_first_frame_ = false;
1057 // True if we have not yet rendered a first frame, but one is needed. Set back
1058 // to false as soon as |has_first_frame_| is set to true.
1059 bool needs_first_frame_ = false;
1061 // True if StartPipeline() completed a lazy load startup.
1062 bool did_lazy_load_ = false;
1064 // Whether the renderer should automatically suspend media playback in
1066 bool is_background_suspend_enabled_ = false;
1068 // If disabled, video will be auto paused when in background. Affects the
1069 // value of ShouldPausePlaybackWhenHidden().
1070 bool is_background_video_playback_enabled_ = true;
1072 // Whether background video optimization is supported on current platform.
1073 bool is_background_video_track_optimization_supported_ = true;
1075 bool was_suspended_for_frame_closed_ = false;
1077 base::CancelableOnceClosure have_enough_after_lazy_load_cb_;
1079 media::RendererType renderer_type_ = media::RendererType::kDefault;
1080 media::SimpleWatchTimer simple_watch_timer_;
1082 LearningExperimentHelper will_play_helper_;
1084 #if defined(TIZEN_VIDEO_HOLE)
1085 bool is_video_hole_;
1086 gfx::RectF last_computed_rect_;
1087 base::RepeatingTimer layer_bound_update_timer_;
1090 // Stores the optional override Demuxer until it is used in DoLoad().
1091 std::unique_ptr<media::Demuxer> demuxer_override_;
1093 std::unique_ptr<PowerStatusHelper> power_status_helper_;
1095 // Created while playing, deleted otherwise.
1096 std::unique_ptr<SmoothnessHelper> smoothness_helper_;
1097 absl::optional<int> last_reported_fps_;
1099 // Time of the last call to GetCurrentFrameFromCompositor(). Used to prevent
1100 // background optimizations from being applied when capturing is active.
1101 base::TimeTicks last_frame_request_time_;
1103 // Count the number of times a video frame is being readback.
1104 unsigned video_frame_readback_count_ = 0;
1106 base::WeakPtr<WebMediaPlayerImpl> weak_this_;
1107 base::WeakPtrFactory<WebMediaPlayerImpl> weak_factory_{this};
1110 } // namespace blink
1112 #endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_MEDIA_WEB_MEDIA_PLAYER_IMPL_H_