Tab Audio Capture: Browser-side connect/disconnect functionality.

content/browser/renderer_host/media/audio_renderer_host_unittest.cc

 // Copyright (c) 2012 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 "base/bind.h"
 #include "base/environment.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
 #include "base/process_util.h"
 #include "base/sync_socket.h"
 #include "content/browser/browser_thread_impl.h"
 #include "content/browser/renderer_host/media/audio_renderer_host.h"
 #include "content/browser/renderer_host/media/mock_media_observer.h"
 #include "content/common/media/audio_messages.h"
 #include "ipc/ipc_message_utils.h"
 #include "media/audio/audio_manager.h"
 #include "media/audio/fake_audio_output_stream.h"
 #include "net/url_request/url_request_context.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using ::testing::_;
 using ::testing::AtLeast;
 using ::testing::DoAll;
 using ::testing::InSequence;
-using ::testing::InvokeWithoutArgs;
+using ::testing::Invoke;
+using ::testing::NotNull;
 using ::testing::Return;
 using ::testing::SaveArg;
 using ::testing::SetArgumentPointee;
 
 namespace content {
 
+static const int kRenderProcessId = 1;
+static const int kRenderViewId = 4;
 static const int kStreamId = 50;
 
 static bool IsRunningHeadless() {
   scoped_ptr<base::Environment> env(base::Environment::Create());
   if (env->HasVar("CHROME_HEADLESS"))
     return true;
   return false;
 }
 
 class MockAudioRendererHost : public AudioRendererHost {
  public:
   explicit MockAudioRendererHost(
       media::AudioManager* audio_manager,
       MediaObserver* media_observer)
-      : AudioRendererHost(audio_manager, media_observer),
+      : AudioRendererHost(kRenderProcessId, audio_manager, media_observer),
         shared_memory_length_(0) {
   }
 
   // A list of mock methods.
   MOCK_METHOD2(OnStreamCreated,
                void(int stream_id, int length));
   MOCK_METHOD1(OnStreamPlaying, void(int stream_id));
   MOCK_METHOD1(OnStreamPaused, void(int stream_id));
   MOCK_METHOD1(OnStreamError, void(int stream_id));
   MOCK_METHOD2(OnStreamVolume, void(int stream_id, double volume));
 
  private:
   virtual ~MockAudioRendererHost() {
     // Make sure all audio streams have been deleted.
     EXPECT_TRUE(audio_entries_.empty());
+    // Make sure no mirroring sessions are active.
+    EXPECT_TRUE(mirror_sessions_.empty());
   }
 
   // This method is used to dispatch IPC messages to the renderer. We intercept
   // these messages here and dispatch to our mock methods to verify the
   // conversation between this object and the renderer.
   virtual bool Send(IPC::Message* message) {
     CHECK(message);
 
     // In this method we dispatch the messages to the according handlers as if
     // we are the renderer.
@@ skipping 56 matching lines @@
     }
   }
 
   scoped_ptr<base::SharedMemory> shared_memory_;
   scoped_ptr<base::SyncSocket> sync_socket_;
   uint32 shared_memory_length_;
 
   DISALLOW_COPY_AND_ASSIGN(MockAudioRendererHost);
 };
 
+class MockMirroringDestination
+    : public AudioRendererHost::MirroringDestination {
+ public:
+  MockMirroringDestination() {}
+
+  MOCK_METHOD2(AddInput,
+               void(media::AudioOutputStream::AudioSourceCallback* callback,
+                    const media::AudioParameters& params));
+  MOCK_METHOD2(RemoveInput,
+               void(media::AudioOutputStream::AudioSourceCallback* callback,
+                    const base::Closure& done));
+
+  void SimulateRemoveInput(
+      media::AudioOutputStream::AudioSourceCallback* callback,
+      const base::Closure& done) {
+    done.Run();
+  }
+
+ private:
+  virtual ~MockMirroringDestination() {}
+
+  DISALLOW_COPY_AND_ASSIGN(MockMirroringDestination);
+};
+
 ACTION_P(QuitMessageLoop, message_loop) {
   message_loop->PostTask(FROM_HERE, MessageLoop::QuitClosure());
 }
 
 class AudioRendererHostTest : public testing::Test {
  public:
   AudioRendererHostTest()
       : mock_stream_(true) {
   }
 
  protected:
   virtual void SetUp() {
     // Create a message loop so AudioRendererHost can use it.
     message_loop_.reset(new MessageLoop(MessageLoop::TYPE_IO));
 
     // Claim to be on both the UI and IO threads to pass all the DCHECKS.
     io_thread_.reset(new BrowserThreadImpl(BrowserThread::IO,
                                            message_loop_.get()));
     ui_thread_.reset(new BrowserThreadImpl(BrowserThread::UI,
                                            message_loop_.get()));
     audio_manager_.reset(media::AudioManager::Create());
     observer_.reset(new MockMediaObserver());
     host_ = new MockAudioRendererHost(audio_manager_.get(), observer_.get());
-
-    // Expect the audio stream will be deleted.
-    EXPECT_CALL(*observer_, OnDeleteAudioStream(_, kStreamId));
+    destination_ = new MockMirroringDestination();
+    another_destination_ = new MockMirroringDestination();
 
     // Simulate IPC channel connected.
     host_->OnChannelConnected(base::GetCurrentProcId());
+
+    if (!IsRunningHeadless())
+      EnableRealDevice();
   }
 
   virtual void TearDown() {
     // Simulate closing the IPC channel.
     host_->OnChannelClosing();
 
-    // Release the reference to the mock object.  The object will be destructed
-    // on message_loop_.
+    // Release the reference to the mock objects.  The MockAudioRendererHost
+    // will be destroyed on message_loop_.
+    another_destination_ = NULL;
+    destination_ = NULL;
     host_ = NULL;
 
     // We need to continue running message_loop_ to complete all destructions.
     SyncWithAudioThread();
 
     audio_manager_.reset();
 
     io_thread_.reset();
     ui_thread_.reset();
   }
@@ skipping 15 matching lines @@
 
     media::AudioParameters params(
         format, media::CHANNEL_LAYOUT_STEREO,
         media::AudioParameters::kAudioCDSampleRate, 16,
         media::AudioParameters::kAudioCDSampleRate / 10);
 
     // Send a create stream message to the audio output stream and wait until
     // we receive the created message.
     host_->OnCreateStream(kStreamId, params, 0);
     message_loop_->Run();
+
+    // Simulate the renderer process associating a stream with a render view.
+    host_->OnAssociateStreamWithProducer(kStreamId, kRenderViewId);
+    message_loop_->RunUntilIdle();
+
+    // Expect the audio stream will be deleted at some later point.
+    EXPECT_CALL(*observer_, OnDeleteAudioStream(_, kStreamId));
   }
 
   void Close() {
     EXPECT_CALL(*observer_,
                 OnSetAudioStreamStatus(_, kStreamId, "closed"));
 
     // Send a message to AudioRendererHost to tell it we want to close the
     // stream.
     host_->OnCloseStream(kStreamId);
     message_loop_->RunUntilIdle();
@@ skipping 20 matching lines @@
   }
 
   void SetVolume(double volume) {
     EXPECT_CALL(*observer_,
                 OnSetAudioStreamVolume(_, kStreamId, volume));
 
     host_->OnSetVolume(kStreamId, volume);
     message_loop_->RunUntilIdle();
   }
 
+  void StartMirroringTo(MockMirroringDestination* dest,
+                        int expected_inputs_seen) {
+    if (expected_inputs_seen > 0) {
+      EXPECT_CALL(*dest, AddInput(NotNull(), _))
+          .Times(expected_inputs_seen);
+      EXPECT_CALL(*dest, RemoveInput(NotNull(), _))
+          .Times(expected_inputs_seen)
+          .WillRepeatedly(
+              Invoke(dest, &MockMirroringDestination::SimulateRemoveInput));
+    }
+
+    AudioRendererHost::StartMirroring(kRenderProcessId, kRenderViewId, dest);
+    message_loop_->RunUntilIdle();
+  }
+
+  void StopMirroringTo(MockMirroringDestination* dest) {
+    AudioRendererHost::StopMirroring(kRenderProcessId, kRenderViewId, dest);
+    message_loop_->RunUntilIdle();
+  }
+
   void SimulateError() {
     EXPECT_CALL(*observer_,
                 OnSetAudioStreamStatus(_, kStreamId, "error"));
     // Find the first AudioOutputController in the AudioRendererHost.
     CHECK(host_->audio_entries_.size())
         << "Calls Create() before calling this method";
     media::AudioOutputController* controller =
         host_->LookupControllerByIdForTesting(kStreamId);
     CHECK(controller) << "AudioOutputController not found";
 
@@ skipping 29 matching lines @@
     // to the thread that itself owns.
     message_loop_->PostTask(
         FROM_HERE, base::Bind(&PostQuitOnAudioThread,
             base::Unretained(audio_manager_.get()),
             message_loop_.get()));
     message_loop_->Run();
   }
 
   void EnableRealDevice() { mock_stream_ = false; }
 
+ protected:
+  // Accessors for testing mirroring to one or two destinations.
+  MockMirroringDestination* destination() const {
+    return destination_;
+  }
+  MockMirroringDestination* another_destination() const {
+    return another_destination_;
+  }
+
  private:
   bool mock_stream_;
   scoped_ptr<MockMediaObserver> observer_;
   scoped_refptr<MockAudioRendererHost> host_;
+  scoped_refptr<MockMirroringDestination> destination_;
+  scoped_refptr<MockMirroringDestination> another_destination_;
   scoped_ptr<MessageLoop> message_loop_;
   scoped_ptr<BrowserThreadImpl> io_thread_;
   scoped_ptr<BrowserThreadImpl> ui_thread_;
   scoped_ptr<media::AudioManager> audio_manager_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioRendererHostTest);
 };
 
 TEST_F(AudioRendererHostTest, CreateAndClose) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Close();
 }
 
 // Simulate the case where a stream is not properly closed.
 TEST_F(AudioRendererHostTest, CreateAndShutdown) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
 }
 
 TEST_F(AudioRendererHostTest, CreatePlayAndClose) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Play();
   Close();
 }
 
 TEST_F(AudioRendererHostTest, CreatePlayPauseAndClose) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Play();
   Pause();
   Close();
 }
 
 TEST_F(AudioRendererHostTest, SetVolume) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   SetVolume(0.5);
   Play();
   Pause();
   Close();
 }
 
 // Simulate the case where a stream is not properly closed.
 TEST_F(AudioRendererHostTest, CreatePlayAndShutdown) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Play();
 }
 
 // Simulate the case where a stream is not properly closed.
 TEST_F(AudioRendererHostTest, CreatePlayPauseAndShutdown) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Play();
   Pause();
 }
 
+TEST_F(AudioRendererHostTest, MirroringOfNothing) {
+  StartMirroringTo(destination(), 0);
+  StopMirroringTo(destination());
+}
+
+TEST_F(AudioRendererHostTest, StreamLifetimeAroundMirroringSession) {
+  Create();
+  Play();
+  StartMirroringTo(destination(), 1);
+  StopMirroringTo(destination());
+  Close();
+}
+
+TEST_F(AudioRendererHostTest, PauseStreamDuringMirroringSession) {
+  Create();
+  Play();
+  StartMirroringTo(destination(), 1);
+  Pause();
+  StopMirroringTo(destination());
+  Close();
+}
+
+TEST_F(AudioRendererHostTest, StreamLifetimeWithinMirroringSession) {
+  StartMirroringTo(destination(), 1);
+  Create();
+  Play();
+  Close();
+  StopMirroringTo(destination());
+}
+
+TEST_F(AudioRendererHostTest, StreamLifetimeAroundTwoMirroringSessions) {
+  Create();
+  Play();
+  StartMirroringTo(destination(), 1);
+  StopMirroringTo(destination());
+  StartMirroringTo(another_destination(), 1);
+  StopMirroringTo(another_destination());
+  Close();
+}
+
+TEST_F(AudioRendererHostTest, StreamLifetimeWithinTwoMirroringSessions) {
+  StartMirroringTo(destination(), 1);
+  Create();
+  Play();
+  StopMirroringTo(destination());
+  StartMirroringTo(another_destination(), 1);
+  Close();
+  StopMirroringTo(another_destination());
+}
+
+TEST_F(AudioRendererHostTest, StreamSwitchesMirroringSessions) {
+  StartMirroringTo(destination(), 1);
+  Create();
+  Play();
+  StartMirroringTo(another_destination(), 1);
+  Close();
+  StopMirroringTo(another_destination());
+  StopMirroringTo(destination());  // This should be a no-op.
+}
+
+TEST_F(AudioRendererHostTest, SwitchMirroringDestinationNoStreams) {
+  StartMirroringTo(destination(), 0);
+  StartMirroringTo(another_destination(), 0);
+  StopMirroringTo(another_destination());
+}
+
+// Simulate the case where mirroring was not stopped before shutdown.
+TEST_F(AudioRendererHostTest, StartMirroringNothingAndShutdown) {
+  StartMirroringTo(destination(), 0);
+}
+
+// Simulate the case where mirroring was not stopped before shutdown, and a
+// stream was being mirrored.
+TEST_F(AudioRendererHostTest, StartMirroringSomethingAndShutdown) {
+  StartMirroringTo(destination(), 1);
+  Create();
+  Play();
+}
+
 TEST_F(AudioRendererHostTest, SimulateError) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Play();
   SimulateError();
 }
 
 // Simulate the case when an error is generated on the browser process,
 // the audio device is closed but the render process try to close the
 // audio stream again.
 TEST_F(AudioRendererHostTest, SimulateErrorAndClose) {
-  if (!IsRunningHeadless())
-    EnableRealDevice();
-
   Create();
   Play();
   SimulateError();
   Close();
 }
 
 // TODO(hclam): Add tests for data conversation in low latency mode.
 
 }  // namespace content