Allow suspension prior to reaching kHaveFutureData.

media/blink/webmediaplayer_impl_unittest.cc

 // Copyright 2016 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 <stdint.h>
 
 #include <memory>
 
@@ skipping 17 matching lines @@
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/WebKit/public/platform/WebMediaPlayerClient.h"
 #include "third_party/WebKit/public/platform/WebSecurityOrigin.h"
 #include "third_party/WebKit/public/platform/WebSize.h"
 #include "third_party/WebKit/public/web/WebFrameClient.h"
 #include "third_party/WebKit/public/web/WebLocalFrame.h"
 #include "third_party/WebKit/public/web/WebView.h"
 #include "url/gurl.h"
 
+using ::testing::AnyNumber;
 using ::testing::InSequence;
 using ::testing::Return;
 using ::testing::_;
 
 namespace media {
 
 int64_t OnAdjustAllocatedMemory(int64_t delta) {
   return 0;
 }
 
@@ skipping 65 matching lines @@
       : media_thread_("MediaThreadForTest"),
         web_view_(blink::WebView::create(nullptr,
                                          blink::WebPageVisibilityStateVisible)),
         web_local_frame_(
             blink::WebLocalFrame::create(blink::WebTreeScopeType::Document,
                                          &web_frame_client_)),
         media_log_(new MediaLog()),
         audio_parameters_(TestAudioParameters::Normal()) {
     web_view_->setMainFrame(web_local_frame_);
     media_thread_.StartAndWaitForTesting();
+  }
 
+  void InitializeDefaultWebMediaPlayerImpl() {
+    InitializeWebMediaPlayerImpl(delegate_.AsWeakPtr());
+  }
+
+  void InitializeWebMediaPlayerImpl(
+      base::WeakPtr<MockWebMediaPlayerDelegate> delegate) {
     wmpi_.reset(new WebMediaPlayerImpl(
-        web_local_frame_, &client_, nullptr, delegate_.AsWeakPtr(),
+        web_local_frame_, &client_, nullptr, delegate,
         base::MakeUnique<DefaultRendererFactory>(
             media_log_, nullptr, DefaultRendererFactory::GetGpuFactoriesCB()),
         url_index_,
         WebMediaPlayerParams(
             WebMediaPlayerParams::DeferLoadCB(),
             scoped_refptr<SwitchableAudioRendererSink>(), media_log_,
             media_thread_.task_runner(), message_loop_.task_runner(),
             message_loop_.task_runner(), WebMediaPlayerParams::Context3DCB(),
             base::Bind(&OnAdjustAllocatedMemory), nullptr, nullptr, nullptr)));
   }
@@ skipping 54 matching lines @@
     wmpi_->must_suspend_ = false;
     return wmpi_->UpdatePlayState_ComputePlayState(false, false, true);
   }
 
   WebMediaPlayerImpl::PlayState ComputeIdlePlayState() {
     wmpi_->is_idle_ = true;
     wmpi_->must_suspend_ = false;
     return wmpi_->UpdatePlayState_ComputePlayState(false, false, false);
   }
 
+  WebMediaPlayerImpl::PlayState ComputeIdleSuspendedPlayState() {
+    wmpi_->is_idle_ = true;
+    wmpi_->must_suspend_ = false;
+    return wmpi_->UpdatePlayState_ComputePlayState(false, true, false);
+  }
+
   WebMediaPlayerImpl::PlayState ComputeMustSuspendPlayState() {
     wmpi_->is_idle_ = false;
     wmpi_->must_suspend_ = true;
     return wmpi_->UpdatePlayState_ComputePlayState(false, false, false);
   }
 
+  bool IsSuspended() { return wmpi_->pipeline_controller_.IsSuspended(); }
+
+  void AddBufferedRanges() {
+    wmpi_->buffered_data_source_host_.AddBufferedByteRange(0, 1);
+  }
+
   void SetupForResumingBackgroundVideo() {
 #if !defined(OS_ANDROID)
     // Need to enable media suspend to test resuming background videos.
     base::CommandLine::ForCurrentProcess()->AppendSwitch(
         switches::kEnableMediaSuspend);
 #endif  // !defined(OS_ANDROID)
     std::unique_ptr<base::FeatureList> feature_list(new base::FeatureList);
     feature_list->InitializeFromCommandLine(kResumeBackgroundVideo.name, "");
     base::FeatureList::ClearInstanceForTesting();
     base::FeatureList::SetInstance(std::move(feature_list));
@@ skipping 14 matching lines @@
   scoped_refptr<MediaLog> media_log_;
   linked_ptr<media::UrlIndex> url_index_;
 
   // Audio hardware configuration.
   AudioParameters audio_parameters_;
 
   // The client interface used by |wmpi_|. Just a dummy for now, but later we
   // may want a mock or intelligent fake.
   DummyWebMediaPlayerClient client_;
 
-  MockWebMediaPlayerDelegate delegate_;
+  testing::NiceMock<MockWebMediaPlayerDelegate> delegate_;
 
   // The WebMediaPlayerImpl instance under test.
   std::unique_ptr<WebMediaPlayerImpl> wmpi_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(WebMediaPlayerImplTest);
 };
 
-TEST_F(WebMediaPlayerImplTest, ConstructAndDestroy) {}
+TEST_F(WebMediaPlayerImplTest, ConstructAndDestroy) {
+  InitializeDefaultWebMediaPlayerImpl();
+}
+
+TEST_F(WebMediaPlayerImplTest, DidLoadingProgressClearsIdle) {
+  testing::StrictMock<MockWebMediaPlayerDelegate> strict_delegate;
+  EXPECT_CALL(strict_delegate, AddObserver(_));
+  EXPECT_CALL(strict_delegate, IsPlayingBackgroundVideo()).Times(AnyNumber());
+  InitializeWebMediaPlayerImpl(strict_delegate.AsWeakPtr());
+  EXPECT_FALSE(IsSuspended());
+  EXPECT_CALL(strict_delegate, PlayerGone(0));
+  wmpi_->OnSuspendRequested(false);
+  base::RunLoop().RunUntilIdle();
+  EXPECT_TRUE(IsSuspended());
+  AddBufferedRanges();
+  EXPECT_CALL(strict_delegate, PlayerGone(0));
+  wmpi_->didLoadingProgress();
+  base::RunLoop().RunUntilIdle();
+  EXPECT_FALSE(IsSuspended());
+}
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_AfterConstruction) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
 
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
+  state = ComputeIdlePlayState();
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
+  EXPECT_FALSE(state.is_memory_reporting_enabled);
+  EXPECT_TRUE(state.is_suspended);
+
   state = ComputeBackgroundedPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
-  EXPECT_FALSE(state.is_suspended);
+  EXPECT_TRUE(state.is_suspended);
 
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_AfterMetadata) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
 
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
+  state = ComputeIdlePlayState();
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
+  EXPECT_FALSE(state.is_memory_reporting_enabled);
+  EXPECT_TRUE(state.is_suspended);
+
   state = ComputeBackgroundedPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_AfterMetadata_AudioOnly) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, false);
 
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
+  state = ComputeIdlePlayState();
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
+  EXPECT_FALSE(state.is_memory_reporting_enabled);
+  EXPECT_TRUE(state.is_suspended);
+
   SetPaused(false);
   state = ComputeBackgroundedPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_AfterFutureData) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
 
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   state = ComputeBackgroundedPlayState();
@@ skipping 11 matching lines @@
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_Playing) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
   SetPaused(false);
 
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PLAYING, state.delegate_state);
   EXPECT_TRUE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   state = ComputeBackgroundedPlayState();
   if (base::FeatureList::IsEnabled(kResumeBackgroundVideo))
     EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   else
     EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_PlayingThenUnderflow) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
   SetPaused(false);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveCurrentData);
 
   // Underflow should not trigger idle suspend. The user is still playing the
   // the video, just waiting on the network.
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PLAYING, state.delegate_state);
@@ skipping 10 matching lines @@
   EXPECT_TRUE(state.is_suspended);
 
   // Forced suspend should still be possible during underflow.
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_Playing_AudioOnly) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, false);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
   SetPaused(false);
 
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PLAYING, state.delegate_state);
   EXPECT_TRUE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
@@ skipping 11 matching lines @@
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 
   state = ComputeMustSuspendPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_Paused_Seek) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
   SetSeeking(true);
 
   state = ComputePlayState();
-  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED_BUT_NOT_IDLE,
-            state.delegate_state);
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_Paused_Fullscreen) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
   SetFullscreen(true);
 
   state = ComputePlayState();
-  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED_BUT_NOT_IDLE,
-            state.delegate_state);
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_Ended) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
   SetEnded(true);
 
   // The pipeline is not suspended immediately on ended.
   state = ComputePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::ENDED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   state = ComputeIdlePlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::ENDED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_Suspended) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
 
   // Suspended players should be resumed unless we have reached the appropriate
   // ready state and are not seeking.
   SetPaused(true);
   state = ComputePlayStateSuspended();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
+  // Paused players in the idle state are allowed to remain suspended.
+  state = ComputeIdleSuspendedPlayState();
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
+  EXPECT_FALSE(state.is_memory_reporting_enabled);
+  EXPECT_TRUE(state.is_suspended);
+
   SetPaused(false);
   state = ComputePlayStateSuspended();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::GONE, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
 
   // Paused players should stay suspended.
   SetPaused(true);
   state = ComputePlayStateSuspended();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 
   // Playing players should resume into the playing state.
   SetPaused(false);
   state = ComputePlayStateSuspended();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PLAYING, state.delegate_state);
   EXPECT_TRUE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   // If seeking, the previously suspended state does not matter; the player
   // should always be resumed.
   SetSeeking(true);
 
   SetPaused(true);
   state = ComputePlayStateSuspended();
-  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED_BUT_NOT_IDLE,
-            state.delegate_state);
+  EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 
   SetPaused(false);
   state = ComputePlayStateSuspended();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PLAYING, state.delegate_state);
   EXPECT_TRUE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 }
 
 TEST_F(WebMediaPlayerImplTest, NaturalSizeChange) {
+  InitializeDefaultWebMediaPlayerImpl();
   PipelineMetadata metadata;
   metadata.has_video = true;
   metadata.natural_size = gfx::Size(320, 240);
 
   OnMetadata(metadata);
   ASSERT_EQ(blink::WebSize(320, 240), wmpi_->naturalSize());
 
   // TODO(sandersd): Verify that the client is notified of the size change?
   OnVideoNaturalSizeChange(gfx::Size(1920, 1080));
   ASSERT_EQ(blink::WebSize(1920, 1080), wmpi_->naturalSize());
 }
 
 TEST_F(WebMediaPlayerImplTest, NaturalSizeChange_Rotated) {
+  InitializeDefaultWebMediaPlayerImpl();
   PipelineMetadata metadata;
   metadata.has_video = true;
   metadata.natural_size = gfx::Size(320, 240);
   metadata.video_rotation = VIDEO_ROTATION_90;
 
   // For 90/270deg rotations, the natural size should be transposed.
   OnMetadata(metadata);
   ASSERT_EQ(blink::WebSize(240, 320), wmpi_->naturalSize());
 
   OnVideoNaturalSizeChange(gfx::Size(1920, 1080));
   ASSERT_EQ(blink::WebSize(1080, 1920), wmpi_->naturalSize());
 }
 
 // Audible backgrounded videos are not suspended if delegate_ allows it.
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_BackgroundedVideoPlaying) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
 
   SetupForResumingBackgroundVideo();
 
   EXPECT_CALL(delegate_, IsPlayingBackgroundVideo())
       .WillRepeatedly(Return(true));
   EXPECT_CALL(delegate_, IsHidden()).WillRepeatedly(Return(true));
 
   SetPaused(false);
   state = ComputeBackgroundedPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PLAYING, state.delegate_state);
   EXPECT_TRUE(state.is_memory_reporting_enabled);
   EXPECT_FALSE(state.is_suspended);
 }
 
 // Backgrounding audible videos should suspend them and report as paused, not
 // gone.
 TEST_F(WebMediaPlayerImplTest, ComputePlayState_BackgroundedVideoPaused) {
+  InitializeDefaultWebMediaPlayerImpl();
   WebMediaPlayerImpl::PlayState state;
   SetMetadata(true, true);
   SetReadyState(blink::WebMediaPlayer::ReadyStateHaveFutureData);
 
   SetupForResumingBackgroundVideo();
 
   EXPECT_CALL(delegate_, IsPlayingBackgroundVideo()).WillOnce(Return(false));
   EXPECT_CALL(delegate_, IsHidden()).WillRepeatedly(Return(true));
 
   state = ComputeBackgroundedPlayState();
   EXPECT_EQ(WebMediaPlayerImpl::DelegateState::PAUSED, state.delegate_state);
   EXPECT_FALSE(state.is_memory_reporting_enabled);
   EXPECT_TRUE(state.is_suspended);
 }
 
 }  // namespace media