Expand suspension of idle media players to all platforms.

media/blink/webmediaplayer_impl.cc

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "media/blink/webmediaplayer_impl.h"
 
 #include <algorithm>
 #include <cmath>
 #include <limits>
 #include <string>
@@ skipping 87 matching lines @@
                             const url::Origin& security_origin,
                             const SwitchOutputDeviceCB& callback) {
   if (sink->GetOutputDevice()) {
     sink->GetOutputDevice()->SwitchOutputDevice(device_id, security_origin,
                                                 callback);
   } else {
     callback.Run(OUTPUT_DEVICE_STATUS_ERROR_INTERNAL);
   }
 }
 
+bool IsSuspendUponHiddenEnabled() {
+#if !defined(OS_ANDROID)
+  // Suspend/Resume is only enabled by default on Android.
+  return base::CommandLine::ForCurrentProcess()->HasSwitch(
+      switches::kEnableMediaSuspend);
+#else
+  return !base::CommandLine::ForCurrentProcess()->HasSwitch(
+      switches::kDisableMediaSuspend);
+#endif
+}
+
 }  // namespace
 
 class BufferedDataSourceHostImpl;
 
 STATIC_ASSERT_ENUM(WebMediaPlayer::CORSModeUnspecified,
                    UrlData::CORS_UNSPECIFIED);
 STATIC_ASSERT_ENUM(WebMediaPlayer::CORSModeAnonymous, UrlData::CORS_ANONYMOUS);
 STATIC_ASSERT_ENUM(WebMediaPlayer::CORSModeUseCredentials,
                    UrlData::CORS_USE_CREDENTIALS);
 
@@ skipping 214 matching lines @@
   DVLOG(1) << __FUNCTION__;
   DCHECK(main_task_runner_->BelongsToCurrentThread());
 
 #if defined(OS_ANDROID)  // WMPI_CAST
   if (isRemote()) {
     cast_impl_.play();
     return;
   }
 #endif
 
+  const bool was_paused = paused_;
   paused_ = false;
   pipeline_.SetPlaybackRate(playback_rate_);
 
   if (data_source_)
     data_source_->MediaIsPlaying();
 
   media_log_->AddEvent(media_log_->CreateEvent(MediaLogEvent::PLAY));
 
-  if (playback_rate_ > 0) {
+  if (playback_rate_ > 0 && was_paused) {
     NotifyPlaybackStarted();
 
-    // Resume the player if playback was initiated in the foreground. Resume()
-    // will do nothing if the pipeline is not suspended state, but will clear
-    // some internal pending state, so it should always be called.
-    if (delegate_ && !delegate_->IsHidden())
+    // Resume the player if allowed. We always call Resume() in case there is a
+    // pending suspend that should be aborted. If the pipeline is not suspended,
+    // Resume() will have no effect.
+    if (IsAutomaticResumeAllowed())
       pipeline_controller_.Resume();
   }
 }
 
 void WebMediaPlayerImpl::pause() {
   DVLOG(1) << __FUNCTION__;
   DCHECK(main_task_runner_->BelongsToCurrentThread());
 
   const bool was_already_paused = paused_ || playback_rate_ == 0;
   paused_ = true;
@@ skipping 68 matching lines @@
     }
     return;
   }
 
   seeking_ = true;
   seek_time_ = time;
   if (paused_)
     paused_time_ = time;
   pipeline_controller_.Seek(time, time_updated);
 
-  // Resume the pipeline if the seek is initiated in the foreground so that
-  // the correct frame is displayed. If the pipeline is not suspended, Resume()
-  // will do nothing but clear some pending state.
-  if (delegate_ && !delegate_->IsHidden())
+  // Resume the pipeline if allowed so that the correct frame is displayed. We
+  // always call Resume() in case there is a pending suspend that should be
+  // aborted. If the pipeline is not suspended, Resume() will have no effect.
+  if (IsAutomaticResumeAllowed())
     pipeline_controller_.Resume();
 }
 
 void WebMediaPlayerImpl::setRate(double rate) {
   DVLOG(1) << __FUNCTION__ << "(" << rate << ")";
   DCHECK(main_task_runner_->BelongsToCurrentThread());
 
   // TODO(kylep): Remove when support for negatives is added. Also, modify the
   // following checks so rewind uses reasonable values also.
   if (rate < 0.0)
@@ skipping 392 matching lines @@
 void WebMediaPlayerImpl::OnPipelineSuspended() {
 #if defined(OS_ANDROID)
   if (isRemote()) {
     scoped_refptr<VideoFrame> frame = cast_impl_.GetCastingBanner();
     if (frame) {
       compositor_->PaintFrameUsingOldRenderingPath(frame);
     }
   }
 #endif
 
-  if (delegate_)
-    delegate_->PlayerGone(delegate_id_);
   memory_usage_reporting_timer_.Stop();
   ReportMemoryUsage();
 
   if (pending_suspend_resume_cycle_) {
     pending_suspend_resume_cycle_ = false;
     pipeline_controller_.Resume();
     return;
   }
 }
 
 void WebMediaPlayerImpl::OnPipelineResumed() {
-  if (playback_rate_ > 0 && !paused_)
+  if (playback_rate_ > 0 && !paused_) {
     NotifyPlaybackStarted();
+  } else if (!playback_rate_ || paused_ || ended_) {
+    // Resend our paused notification so the pipeline is considered for idle
+    // resource reclamation; duplicate pause notifications are ignored.
+    NotifyPlaybackPaused();
+  }
 }
 
 void WebMediaPlayerImpl::OnPipelineEnded() {
   DVLOG(1) << __FUNCTION__;
   DCHECK(main_task_runner_->BelongsToCurrentThread());
 
   // Ignore state changes until we've completed all outstanding operations.
   if (!pipeline_controller_.IsStable())
     return;
 
@@ skipping 43 matching lines @@
     }
 
     video_weblayer_.reset(new cc_blink::WebLayerImpl(layer));
     video_weblayer_->layer()->SetContentsOpaque(opaque_);
     video_weblayer_->SetContentsOpaqueIsFixed(true);
     client_->setWebLayer(video_weblayer_.get());
 
     // If there is video and the frame is hidden, then it may be time to suspend
     // playback.
     if (delegate_ && delegate_->IsHidden())
-      OnHidden(false);
+      OnHidden();
   }
 }
 
 void WebMediaPlayerImpl::OnPipelineBufferingStateChanged(
     BufferingState buffering_state) {
   DVLOG(1) << __FUNCTION__ << "(" << buffering_state << ")";
 
   // Ignore buffering state changes until we've completed all outstanding
   // operations.
   if (!pipeline_controller_.IsStable())
@@ skipping 40 matching lines @@
 
   scoped_ptr<WebInbandTextTrackImpl> web_inband_text_track(
       new WebInbandTextTrackImpl(web_kind, web_label, web_language, web_id));
 
   scoped_ptr<TextTrack> text_track(new TextTrackImpl(
       main_task_runner_, client_, std::move(web_inband_text_track)));
 
   done_cb.Run(std::move(text_track));
 }
 
-void WebMediaPlayerImpl::OnHidden(bool must_suspend) {
+void WebMediaPlayerImpl::OnHidden() {
   DCHECK(main_task_runner_->BelongsToCurrentThread());
+  if (!IsSuspendUponHiddenEnabled())
+    return;
 
-#if !defined(OS_ANDROID)
-  // Suspend/Resume is enabled by default on Android.
-  if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
-          switches::kEnableMediaSuspend)) {
-    return;
-  }
-#endif  // !defined(OS_ANDROID)
-
-  if (base::CommandLine::ForCurrentProcess()->HasSwitch(
-          switches::kDisableMediaSuspend)) {
-    return;
-  }
-
-#if defined(OS_ANDROID)
+#if defined(OS_ANDROID)  // WMPI_CAST
   // If we're remote, the pipeline should already be suspended.
   if (isRemote())
     return;
 #endif
 
-  if (must_suspend || (paused_ && ended_) || hasVideo())
-    pipeline_controller_.Suspend();
+  // Don't suspend players which only have audio and have not completed
+  // playback. The user can still control these players via the MediaSession UI.
+  // If the player has never started playback, OnSuspendRequested() will handle
+  // release of any idle resources.
+  if (!hasVideo() && !paused_ && !ended_)
+    return;
+
+  pipeline_controller_.Suspend();
+  if (delegate_)
+    delegate_->PlayerGone(delegate_id_);
 }
 
 void WebMediaPlayerImpl::OnShown() {
   DCHECK(main_task_runner_->BelongsToCurrentThread());
+  if (!IsSuspendUponHiddenEnabled())
+    return;
 
-#if !defined(OS_ANDROID)
-  // Suspend/Resume is enabled by default on Android.
-  if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
-          switches::kEnableMediaSuspend)) {
-    return;
-  }
-#endif  // !defined(OS_ANDROID)
-
-  if (base::CommandLine::ForCurrentProcess()->HasSwitch(
-          switches::kDisableMediaSuspend)) {
-    return;
-  }
-
-#if defined(OS_ANDROID)
+#if defined(OS_ANDROID)  // WMPI_CAST
   // If we're remote, the pipeline should stay suspended.
   if (isRemote())
     return;
 #endif
 
   if (!ended_ && !paused_)
     pipeline_controller_.Resume();
 }
 
+void WebMediaPlayerImpl::OnSuspendRequested(bool must_suspend) {
+  DCHECK(main_task_runner_->BelongsToCurrentThread());
+
+#if defined(OS_ANDROID)  // WMPI_CAST
+  // If we're remote, the pipeline should already be suspended.
+  if (isRemote())
+    return;
+#endif
+
+  // Suspend should never be requested unless required or we're already in an
+  // idle state (paused or ended).
+  DCHECK(must_suspend || paused_ || ended_);
+
+  // Always suspend, but only notify the delegate if we must; this allows any
+  // exposed UI for player controls to continue to function even though the
+  // player has now been suspended.
+  pipeline_controller_.Suspend();
+  if (must_suspend && delegate_)
+    delegate_->PlayerGone(delegate_id_);
+}
+
 void WebMediaPlayerImpl::OnPlay() {
   play();
   client_->playbackStateChanged();
 }
 
 void WebMediaPlayerImpl::OnPause() {
   pause();
   client_->playbackStateChanged();
 }
 
@@ skipping 365 matching lines @@
   DVLOG(2) << "Memory Usage -- Audio: " << stats.audio_memory_usage
            << ", Video: " << stats.video_memory_usage << ", DataSource: "
            << (data_source_ ? data_source_->GetMemoryUsage() : 0)
            << ", Demuxer: " << demuxer_memory_usage;
 
   const int64_t delta = current_memory_usage - last_reported_memory_usage_;
   last_reported_memory_usage_ = current_memory_usage;
   adjust_allocated_memory_cb_.Run(delta);
 }
 
+bool WebMediaPlayerImpl::IsAutomaticResumeAllowed() {
+#if defined(OS_ANDROID)
+  return !hasVideo() || (delegate_ && !delegate_->IsHidden());
+#else
+  // On non-Android platforms Resume() is always allowed.
+  return true;
+#endif
+}
+
 }  // namespace media