Implement one-shot audio focus inside MediaSession

content/browser/media/session/media_session_impl_browsertest.cc

 // Copyright 2015 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 "content/browser/media/session/media_session_impl.h"
 
 #include <stddef.h>
 
 #include <list>
 #include <vector>
@@ skipping 15 matching lines @@
 using content::WebContents;
 using content::MediaSession;
 using content::MediaSessionImpl;
 using content::MediaSessionObserver;
 using content::AudioFocusDelegate;
 using content::MediaSessionPlayerObserver;
 using content::MediaSessionUmaHelper;
 using content::MockMediaSessionPlayerObserver;
 
 using ::testing::Expectation;
+using ::testing::_;
 
 namespace {
 
 const double kDefaultVolumeMultiplier = 1.0;
 const double kDuckingVolumeMultiplier = 0.2;
 
 class MockAudioFocusDelegate : public AudioFocusDelegate {
  public:
-  bool RequestAudioFocus(content::AudioFocusManager::AudioFocusType) override {
-    return true;
+  MockAudioFocusDelegate() {
+    ON_CALL(*this, RequestAudioFocus(_)).WillByDefault(::testing::Return(true));
   }
 
-  void AbandonAudioFocus() override {}
+  MOCK_METHOD1(RequestAudioFocus,
+               bool(content::AudioFocusManager::AudioFocusType));
+  MOCK_METHOD0(AbandonAudioFocus, void());
 };
 
 class MockMediaSessionObserver : public MediaSessionObserver {
  public:
   MockMediaSessionObserver(MediaSession* media_session)
       : MediaSessionObserver(media_session) {}
 
   MOCK_METHOD2(MediaSessionStateChanged,
                void(bool is_controllable, bool is_suspended));
   MOCK_METHOD0(MediaSessionDestroyed, void());
 };
 
 }  // namespace
 
 class MediaSessionImplBrowserTest : public content::ContentBrowserTest {
  protected:
   MediaSessionImplBrowserTest() = default;
 
   void SetUpOnMainThread() override {
     ContentBrowserTest::SetUpOnMainThread();
 
     media_session_ = MediaSessionImpl::Get(shell()->web_contents());
     mock_media_session_observer_.reset(
         new MockMediaSessionObserver(media_session_));
+    mock_audio_focus_delegate_ = new MockAudioFocusDelegate();
     media_session_->SetDelegateForTests(
-        std::unique_ptr<AudioFocusDelegate>(new MockAudioFocusDelegate()));
+        std::unique_ptr<AudioFocusDelegate>(mock_audio_focus_delegate_));
     ASSERT_TRUE(media_session_);
   }
 
   void TearDownOnMainThread() override {
     mock_media_session_observer_.reset();
 
     media_session_->RemoveAllPlayersForTest();
     media_session_ = nullptr;
 
     ContentBrowserTest::TearDownOnMainThread();
@@ skipping 52 matching lines @@
   }
 
   void SystemStartDucking() { media_session_->StartDucking(); }
 
   void SystemStopDucking() { media_session_->StopDucking(); }
 
   MockMediaSessionObserver* mock_media_session_observer() {
     return mock_media_session_observer_.get();
   }
 
+  MockAudioFocusDelegate* mock_audio_focus_delegate() {
+    return mock_audio_focus_delegate_;
+  }
+
   std::unique_ptr<MediaSessionImpl> CreateDummyMediaSession() {
     return std::unique_ptr<MediaSessionImpl>(new MediaSessionImpl(nullptr));
   }
 
   MediaSessionUmaHelper* GetMediaSessionUMAHelper() {
     return media_session_->uma_helper_for_test();
   }
 
  protected:
   MediaSessionImpl* media_session_;
   std::unique_ptr<MockMediaSessionObserver> mock_media_session_observer_;
+  MockAudioFocusDelegate* mock_audio_focus_delegate_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaSessionImplBrowserTest);
 };
 
 IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
                        PlayersFromSameObserverDoNotStopEachOtherInSameSession) {
   std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
       new MockMediaSessionPlayerObserver);
 
   StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
@@ skipping 713 matching lines @@
 
   StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
   UISuspend();
   UIResume();
 
   EXPECT_TRUE(IsControllable());
   EXPECT_FALSE(IsSuspended());
 }
 
 IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
+                       ControlsDontShowWhenOneShotIsPresent) {
+  EXPECT_CALL(*mock_media_session_observer(),
+              MediaSessionStateChanged(false, false));
+
+  std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
+      new MockMediaSessionPlayerObserver);
+
+  StartNewPlayer(player_observer.get(), media::MediaContentType::OneShot);
+
+  EXPECT_FALSE(IsControllable());
+  EXPECT_FALSE(IsSuspended());
+
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Transient);
+  EXPECT_FALSE(IsControllable());
+  EXPECT_FALSE(IsSuspended());
+
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
+  EXPECT_FALSE(IsControllable());
+  EXPECT_FALSE(IsSuspended());
+}
+
+IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
+                       ControlsShowAfterRemoveOneShot) {
+  Expectation uncontrollable = EXPECT_CALL(
+      *mock_media_session_observer(), MediaSessionStateChanged(false, false));
+
+  EXPECT_CALL(*mock_media_session_observer(),
+              MediaSessionStateChanged(true, false))
+      .After(uncontrollable);
+
+  std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
+      new MockMediaSessionPlayerObserver);
+
+  StartNewPlayer(player_observer.get(), media::MediaContentType::OneShot);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Transient);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
+
+  RemovePlayer(player_observer.get(), 0);
+
+  EXPECT_TRUE(IsControllable());
+  EXPECT_FALSE(IsSuspended());
+}
+
+IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
+                       DontSuspendWhenOneShotIsPresent) {
+  std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
+      new MockMediaSessionPlayerObserver);
+
+  StartNewPlayer(player_observer.get(), media::MediaContentType::OneShot);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Transient);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
+
+  SystemSuspend(false);
+
+  EXPECT_FALSE(IsControllable());
+  EXPECT_FALSE(IsSuspended());
+
+  EXPECT_EQ(0, player_observer->received_suspend_calls());
+}
+
+IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
                        DontResumeBySystemUISuspendedSessions) {
   std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
       new MockMediaSessionPlayerObserver);
   StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
 
   UISuspend();
   EXPECT_TRUE(IsControllable());
   EXPECT_TRUE(IsSuspended());
 
   SystemResume();
@@ skipping 37 matching lines @@
 
   SystemSuspend(true);
   EXPECT_TRUE(IsControllable());
   EXPECT_TRUE(IsSuspended());
 
   SystemResume();
   EXPECT_TRUE(IsControllable());
   EXPECT_FALSE(IsSuspended());
 }
 
+IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest, OneShotTakesGainFocus) {
+  std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
+      new MockMediaSessionPlayerObserver);
+  EXPECT_CALL(
+      *mock_audio_focus_delegate(),
+      RequestAudioFocus(content::AudioFocusManager::AudioFocusType::Gain))
+      .Times(1);
+  EXPECT_CALL(*mock_audio_focus_delegate(),
+              RequestAudioFocus(::testing::Ne(
+                  content::AudioFocusManager::AudioFocusType::Gain)))
+      .Times(0);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::OneShot);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Transient);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
+}
+
+IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest, RemovingOneShotDropsFocus) {
+  std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
+      new MockMediaSessionPlayerObserver);
+  EXPECT_CALL(*mock_audio_focus_delegate(), AbandonAudioFocus());
+  StartNewPlayer(player_observer.get(), media::MediaContentType::OneShot);
+  RemovePlayer(player_observer.get(), 0);
+}
+
+IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
+                       RemovingOneWhileStillHavingOtherPlayersKeepsFocus) {
+  std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
+      new MockMediaSessionPlayerObserver);
+  EXPECT_CALL(*mock_audio_focus_delegate(), AbandonAudioFocus()).Times(0);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::OneShot);
+  StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
+  RemovePlayer(player_observer.get(), 0);
+}
+
 IN_PROC_BROWSER_TEST_F(MediaSessionImplBrowserTest,
                        UMA_Suspended_SystemTransient) {
   std::unique_ptr<MockMediaSessionPlayerObserver> player_observer(
       new MockMediaSessionPlayerObserver);
   base::HistogramTester tester;
 
   StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
   SystemSuspend(true);
 
   std::unique_ptr<base::HistogramSamples> samples(
@@ skipping 279 matching lines @@
   StartNewPlayer(player_observer.get(), media::MediaContentType::Persistent);
   clock->Advance(base::TimeDelta::FromMilliseconds(1000));
   media_session_->Stop(MediaSession::SuspendType::UI);
 
   std::unique_ptr<base::HistogramSamples> samples(
       tester.GetHistogramSamplesSinceCreation("Media.Session.ActiveTime"));
   EXPECT_EQ(2, samples->TotalCount());
   EXPECT_EQ(1, samples->GetCount(1000));
   EXPECT_EQ(1, samples->GetCount(10000));
 }