Make AudioOutputDevice restartable and reinitializable

media/audio/audio_output_device_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 <stdint.h>
 
 #include <vector>
 
 #include "base/at_exit.h"
 #include "base/bind_helpers.h"
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/memory/shared_memory.h"
 #include "base/message_loop/message_loop.h"
 #include "base/process/process_handle.h"
 #include "base/sync_socket.h"
+#include "base/synchronization/waitable_event.h"
 #include "base/task_runner.h"
 #include "base/test/test_timeouts.h"
+#include "base/threading/thread.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "media/audio/audio_output_device.h"
 #include "media/audio/sample_rates.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gmock_mutant.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using base::CancelableSyncSocket;
 using base::SharedMemory;
 using base::SyncSocket;
@@ skipping 56 matching lines @@
 
 }  // namespace.
 
 class AudioOutputDeviceTest
     : public testing::Test,
       public testing::WithParamInterface<bool> {
  public:
   AudioOutputDeviceTest();
   ~AudioOutputDeviceTest();
 
+  void SetDevice(const std::string& device_id);
   void ReceiveAuthorization(OutputDeviceStatus device_status);
+  void InitializeAudioDevice(const AudioParameters& params);
   void StartAudioDevice();
   void CreateStream();
   void ExpectRenderCallback();
   void WaitUntilRenderCallback();
   void StopAudioDevice();
-  void SetDevice(const std::string& device_id);
+  void GetOutputDeviceInfo(base::WaitableEvent* event);
+  void SetDeviceInfoToGarbage();
 
  protected:
   // Used to clean up TLS pointers that the test(s) will initialize.
   // Must remain the first member of this class.
   base::ShadowingAtExitManager at_exit_manager_;
   base::MessageLoopForIO io_loop_;
   AudioParameters default_audio_parameters_;
   StrictMock<MockRenderCallback> callback_;
   MockAudioOutputIPC* audio_output_ipc_;  // owned by audio_device_
   scoped_refptr<AudioOutputDevice> audio_device_;
   OutputDeviceStatus device_status_;
+  OutputDeviceInfo device_info_;
+  std::unique_ptr<CancelableSyncSocket> browser_socket_;
+  std::unique_ptr<CancelableSyncSocket> renderer_socket_;
 
  private:
   int CalculateMemorySize();
 
-  SharedMemory shared_memory_;
-  CancelableSyncSocket browser_socket_;
-  CancelableSyncSocket renderer_socket_;
+  std::unique_ptr<SharedMemory> shared_memory_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioOutputDeviceTest);
 };
 
 int AudioOutputDeviceTest::CalculateMemorySize() {
   // Calculate output memory size.
   return sizeof(AudioOutputBufferParameters) +
          AudioBus::CalculateMemorySize(default_audio_parameters_);
 }
 
 AudioOutputDeviceTest::AudioOutputDeviceTest()
-    : device_status_(OUTPUT_DEVICE_STATUS_ERROR_INTERNAL) {
+    : device_status_(OUTPUT_DEVICE_STATUS_ERROR_INTERNAL),
+      browser_socket_(new base::CancelableSyncSocket()),
+      renderer_socket_(new base::CancelableSyncSocket()) {
   default_audio_parameters_.Reset(AudioParameters::AUDIO_PCM_LINEAR,
                                   CHANNEL_LAYOUT_STEREO, 48000, 16, 1024);
-  SetDevice(kDefaultDeviceId);
+  SetDeviceInfoToGarbage();
 }
 
 AudioOutputDeviceTest::~AudioOutputDeviceTest() {
   audio_device_ = NULL;
 }
 
 void AudioOutputDeviceTest::SetDevice(const std::string& device_id) {
   audio_output_ipc_ = new MockAudioOutputIPC();
   audio_device_ = new AudioOutputDevice(base::WrapUnique(audio_output_ipc_),
                                         io_loop_.task_runner(), 0, device_id,
                                         url::Origin());
   EXPECT_CALL(*audio_output_ipc_,
               RequestDeviceAuthorization(audio_device_.get(), 0, device_id, _));
   audio_device_->RequestDeviceAuthorization();
   io_loop_.RunUntilIdle();
 
   // Simulate response from browser
   OutputDeviceStatus device_status =
       (device_id == kUnauthorizedDeviceId)
           ? OUTPUT_DEVICE_STATUS_ERROR_NOT_AUTHORIZED
           : OUTPUT_DEVICE_STATUS_OK;
   ReceiveAuthorization(device_status);
 
-  audio_device_->Initialize(default_audio_parameters_,
-                            &callback_);
+  InitializeAudioDevice(default_audio_parameters_);
 }
 
 void AudioOutputDeviceTest::ReceiveAuthorization(OutputDeviceStatus status) {
   device_status_ = status;
   if (device_status_ != OUTPUT_DEVICE_STATUS_OK)
     EXPECT_CALL(*audio_output_ipc_, CloseStream());
 
   audio_device_->OnDeviceAuthorized(device_status_, default_audio_parameters_,
                                     kDefaultDeviceId);
   io_loop_.RunUntilIdle();
 }
 
 void AudioOutputDeviceTest::StartAudioDevice() {
   if (device_status_ == OUTPUT_DEVICE_STATUS_OK)
     EXPECT_CALL(*audio_output_ipc_, CreateStream(audio_device_.get(), _));
   else
     EXPECT_CALL(callback_, OnRenderError());
 
   audio_device_->Start();
   io_loop_.RunUntilIdle();
 }
 
+void AudioOutputDeviceTest::InitializeAudioDevice(
+    const AudioParameters& params) {
+  audio_device_->Initialize(params, &callback_);
+}
+
 void AudioOutputDeviceTest::CreateStream() {
   const int kMemorySize = CalculateMemorySize();
 
-  ASSERT_TRUE(shared_memory_.CreateAndMapAnonymous(kMemorySize));
-  memset(shared_memory_.memory(), 0xff, kMemorySize);
+  shared_memory_.reset(new SharedMemory());
 
-  ASSERT_TRUE(CancelableSyncSocket::CreatePair(&browser_socket_,
-                                               &renderer_socket_));
+  ASSERT_TRUE(shared_memory_->CreateAndMapAnonymous(kMemorySize));
+  memset(shared_memory_->memory(), 0xff, kMemorySize);
+
+  ASSERT_TRUE(CancelableSyncSocket::CreatePair(browser_socket_.get(),
+                                               renderer_socket_.get()));
 
   // Create duplicates of the handles we pass to AudioOutputDevice since
   // ownership will be transferred and AudioOutputDevice is responsible for
   // freeing.
   SyncSocket::TransitDescriptor audio_device_socket_descriptor;
-  ASSERT_TRUE(renderer_socket_.PrepareTransitDescriptor(
+  ASSERT_TRUE(renderer_socket_->PrepareTransitDescriptor(
       base::GetCurrentProcessHandle(), &audio_device_socket_descriptor));
   base::SharedMemoryHandle duplicated_memory_handle;
-  ASSERT_TRUE(shared_memory_.ShareToProcess(base::GetCurrentProcessHandle(),
-                                            &duplicated_memory_handle));
+  ASSERT_TRUE(shared_memory_->ShareToProcess(base::GetCurrentProcessHandle(),
+                                             &duplicated_memory_handle));
 
   audio_device_->OnStreamCreated(
       duplicated_memory_handle,
       SyncSocket::UnwrapHandle(audio_device_socket_descriptor), kMemorySize);
   io_loop_.RunUntilIdle();
 }
 
 void AudioOutputDeviceTest::ExpectRenderCallback() {
   // We should get a 'play' notification when we call OnStreamCreated().
   // Respond by asking for some audio data.  This should ask our callback
   // to provide some audio data that AudioOutputDevice then writes into the
   // shared memory section.
   const int kMemorySize = CalculateMemorySize();
 
+  ASSERT_TRUE(browser_socket_.get());
   EXPECT_CALL(*audio_output_ipc_, PlayStream())
-      .WillOnce(SendPendingBytes(&browser_socket_, kMemorySize));
+      .WillOnce(SendPendingBytes(browser_socket_.get(), kMemorySize));
 
   // We expect calls to our audio renderer callback, which returns the number
   // of frames written to the memory section.
   // Here's the second place where it gets hacky:  There's no way for us to
   // know (without using a sleep loop!) when the AudioOutputDevice has finished
   // writing the interleaved audio data into the shared memory section.
   // So, for the sake of this test, we consider the call to Render a sign
   // of success and quit the loop.
   const int kNumberOfFramesToProcess = 0;
   EXPECT_CALL(callback_, Render(_, _, _))
       .WillOnce(DoAll(QuitLoop(io_loop_.task_runner()),
                       Return(kNumberOfFramesToProcess)));
 }
 
 void AudioOutputDeviceTest::WaitUntilRenderCallback() {
   // Don't hang the test if we never get the Render() callback.
   io_loop_.PostDelayedTask(FROM_HERE, base::MessageLoop::QuitWhenIdleClosure(),
                            TestTimeouts::action_timeout());
   io_loop_.Run();
 }
 
 void AudioOutputDeviceTest::StopAudioDevice() {
   if (device_status_ == OUTPUT_DEVICE_STATUS_OK)
     EXPECT_CALL(*audio_output_ipc_, CloseStream());
 
   audio_device_->Stop();
   io_loop_.RunUntilIdle();
 }
 
+void AudioOutputDeviceTest::GetOutputDeviceInfo(base::WaitableEvent* event) {
+  device_info_ = audio_device_->GetOutputDeviceInfo();
+  event->Signal();
+}
+
+void AudioOutputDeviceTest::SetDeviceInfoToGarbage() {
+  device_info_ =
+      OutputDeviceInfo("qwertyuiop", OUTPUT_DEVICE_STATUS_ERROR_INTERNAL,
+                       AudioParameters(AudioParameters::AUDIO_FAKE,
+                                       CHANNEL_LAYOUT_NONE, 1, 2, 3));
+}
+
 TEST_P(AudioOutputDeviceTest, Initialize) {
   // Tests that the object can be constructed, initialized and destructed
   // without having ever been started.
+  SetDevice(kDefaultDeviceId);
   StopAudioDevice();
 }
 
 // Calls Start() followed by an immediate Stop() and check for the basic message
 // filter messages being sent in that case.
 TEST_P(AudioOutputDeviceTest, StartStop) {
+  SetDevice(kDefaultDeviceId);
   StartAudioDevice();
   StopAudioDevice();
 }
 
-// AudioOutputDevice supports multiple start/stop sequences.
-TEST_P(AudioOutputDeviceTest, StartStopStartStop) {
+TEST_P(AudioOutputDeviceTest, StartStopStop) {
+  SetDevice(kDefaultDeviceId);
   StartAudioDevice();
   StopAudioDevice();
+
+  // Stop again, but don't expect a CloseStream() IPC call as StopAudioDevice()
+  // does.
+  audio_device_->Stop();
+  io_loop_.RunUntilIdle();
+}
+
+// AudioOutputDevice supports multiple intialize/start/stop sequences.
+TEST_P(AudioOutputDeviceTest, StartStopStartStop) {
+  SetDevice(kDefaultDeviceId);
   StartAudioDevice();
   StopAudioDevice();
+  InitializeAudioDevice(default_audio_parameters_);
+  EXPECT_CALL(*audio_output_ipc_,
+              RequestDeviceAuthorization(audio_device_.get(), 0, _, _));
+  StartAudioDevice();
+  // Simulate reply from browser
+  ReceiveAuthorization(OUTPUT_DEVICE_STATUS_OK);
+  StopAudioDevice();
 }
 
 // Simulate receiving OnStreamCreated() prior to processing ShutDownOnIOThread()
 // on the IO loop.
 TEST_P(AudioOutputDeviceTest, StopBeforeRender) {
+  SetDevice(kDefaultDeviceId);
   StartAudioDevice();
 
   // Call Stop() but don't run the IO loop yet.
   audio_device_->Stop();
 
-  // Expect us to shutdown IPC but not to render anything despite the stream
-  // getting created.
+  // Expect to play the stream and to shutdown IPC but not to render anything
+  // despite the stream getting created.
+  EXPECT_CALL(*audio_output_ipc_, PlayStream());
   EXPECT_CALL(*audio_output_ipc_, CloseStream());
   CreateStream();
 }
 
 // Full test with output only.
 TEST_P(AudioOutputDeviceTest, CreateStream) {
+  SetDevice(kDefaultDeviceId);
   StartAudioDevice();
   ExpectRenderCallback();
   CreateStream();
   WaitUntilRenderCallback();
   StopAudioDevice();
 }
 
+// Full test with output only.
+TEST_P(AudioOutputDeviceTest, CreateStreamMultipleStop) {
+  SetDevice(kDefaultDeviceId);
+  StartAudioDevice();
+  ExpectRenderCallback();
+  CreateStream();
+  WaitUntilRenderCallback();
+  StopAudioDevice();
+
+  // Stop again, but don't expect a CloseStream() IPC call as StopAudioDevice()
+  // does.
+  audio_device_->Stop();
+  io_loop_.RunUntilIdle();
+}
+
 // Full test with output only with nondefault device.
 TEST_P(AudioOutputDeviceTest, NonDefaultCreateStream) {
   SetDevice(kNonDefaultDeviceId);
   StartAudioDevice();
   ExpectRenderCallback();
   CreateStream();
   WaitUntilRenderCallback();
   StopAudioDevice();
 }
 
+TEST_P(AudioOutputDeviceTest, MultipleCreateStream) {
+  SetDevice(kDefaultDeviceId);
+  StartAudioDevice();
+  ExpectRenderCallback();
+  CreateStream();
+  WaitUntilRenderCallback();
+  StopAudioDevice();
+
+  // Create a new pair of sockets and keep the old ones so that new handles
+  // are used, otherwise AudioDeviceThread will keep an old socket with the same
+  // handle as the new one, ending up closing the new socket instead of the old.
+  std::unique_ptr<base::CancelableSyncSocket> new_browser_socket(
+      new base::CancelableSyncSocket());
+  std::unique_ptr<base::CancelableSyncSocket> new_renderer_socket(
+      new base::CancelableSyncSocket());
+  browser_socket_.swap(new_browser_socket);
+  renderer_socket_.swap(new_renderer_socket);
+
+  InitializeAudioDevice(default_audio_parameters_);
+  EXPECT_CALL(*audio_output_ipc_,
+              RequestDeviceAuthorization(audio_device_.get(), 0, _, _));
+  StartAudioDevice();
+  // Simulate reply from browser
+  ReceiveAuthorization(OUTPUT_DEVICE_STATUS_OK);
+
+  ExpectRenderCallback();
+  CreateStream();
+  WaitUntilRenderCallback();
+  StopAudioDevice();
+}
+
 // Multiple start/stop with nondefault device
 TEST_P(AudioOutputDeviceTest, NonDefaultStartStopStartStop) {
   SetDevice(kNonDefaultDeviceId);
   StartAudioDevice();
   StopAudioDevice();
-
+  InitializeAudioDevice(default_audio_parameters_);
   EXPECT_CALL(*audio_output_ipc_,
               RequestDeviceAuthorization(audio_device_.get(), 0, _, _));
   StartAudioDevice();
   // Simulate reply from browser
   ReceiveAuthorization(OUTPUT_DEVICE_STATUS_OK);
-
   StopAudioDevice();
 }
 
 TEST_P(AudioOutputDeviceTest, UnauthorizedDevice) {
   SetDevice(kUnauthorizedDeviceId);
   StartAudioDevice();
   StopAudioDevice();
 }
 
+TEST_P(AudioOutputDeviceTest, MultipleStartStopDifferentParameters) {
+  SetDevice(kDefaultDeviceId);
+  StartAudioDevice();
+  StopAudioDevice();
+
+  // Initialize with different parameters.
+  AudioParameters params(AudioParameters::AUDIO_PCM_LINEAR, CHANNEL_LAYOUT_MONO,
+                         16000, 16, 512);
+  InitializeAudioDevice(params);
+  EXPECT_CALL(*audio_output_ipc_,
+              RequestDeviceAuthorization(audio_device_.get(), 0, _, _));
+  StartAudioDevice();
+  // Simulate reply from browser
+  ReceiveAuthorization(OUTPUT_DEVICE_STATUS_OK);
+  StopAudioDevice();
+
+  // Back to default parameters.
+  InitializeAudioDevice(default_audio_parameters_);
+  EXPECT_CALL(*audio_output_ipc_,
+              RequestDeviceAuthorization(audio_device_.get(), 0, _, _));
+  StartAudioDevice();
+  // Simulate reply from browser
+  ReceiveAuthorization(OUTPUT_DEVICE_STATUS_OK);
+  StopAudioDevice();
+}
+
+TEST_P(AudioOutputDeviceTest, MultipleStartStopDifferentDevices) {
+  SetDevice(kDefaultDeviceId);
+  StartAudioDevice();
+  StopAudioDevice();
+
+  SetDevice(kNonDefaultDeviceId);
+  StartAudioDevice();
+  StopAudioDevice();
+
+  SetDevice(kUnauthorizedDeviceId);
+  StartAudioDevice();
+  StopAudioDevice();
+
+  SetDevice(kDefaultDeviceId);
+  StartAudioDevice();
+  StopAudioDevice();
+}
+
+// Test getting output device info.
+// GetOutputDeviceInfo() must be called on a different thread than the IO task
+// runner we hand to the AudioOutputDevice. Since we use the task runner for the
+// thread the test runs on as the IO task runner, we must spin up a new thread
+// and call GetOutputDeviceInfo() on that.
+TEST_P(AudioOutputDeviceTest, GetOutputDeviceInfo) {
+  SetDevice(kDefaultDeviceId);
+
+  base::WaitableEvent event(true, false);
+  base::Thread thread("get_output_device_info");
+  thread.Start();
+
+  // Get device info on the other thread and wait until finished.
+  thread.task_runner()->PostTask(
+      FROM_HERE, base::Bind(&AudioOutputDeviceTest::GetOutputDeviceInfo,
+                            base::Unretained(this), &event));
+  event.Wait();
+
+  EXPECT_EQ(kDefaultDeviceId, device_info_.device_id());
+  EXPECT_EQ(OUTPUT_DEVICE_STATUS_OK, device_info_.device_status());
+  EXPECT_TRUE(device_info_.output_params().Equals(default_audio_parameters_));
+
+  StopAudioDevice();
+}
+
+TEST_P(AudioOutputDeviceTest, NonDefaultGetOutputDeviceInfo) {
+  SetDevice(kNonDefaultDeviceId);
+
+  // AudioOutputDevice::GetOutputDeviceInfo must be called on a different thread
+  // than the task runner given to it.
+  base::WaitableEvent event(true, false);
+  base::Thread thread("get_output_device_info");
+  thread.Start();
+
+  // Get device info on the other thread and wait until finished.
+  thread.task_runner()->PostTask(
+      FROM_HERE, base::Bind(&AudioOutputDeviceTest::GetOutputDeviceInfo,
+                            base::Unretained(this), &event));
+  event.Wait();
+
+  EXPECT_EQ(kNonDefaultDeviceId, device_info_.device_id());
+  EXPECT_EQ(OUTPUT_DEVICE_STATUS_OK, device_info_.device_status());
+  EXPECT_TRUE(device_info_.output_params().Equals(default_audio_parameters_));
+
+  StopAudioDevice();
+}
+
+TEST_P(AudioOutputDeviceTest, MultipleNonDefaultGetOutputDeviceInfo) {
+  SetDevice(kNonDefaultDeviceId);
+
+  // AudioOutputDevice::GetOutputDeviceInfo must be called on a different thread
+  // than the task runner given to it.
+  base::WaitableEvent event(true, false);
+  base::Thread thread("get_output_device_info");
+  thread.Start();
+
+  // Get device info on the other thread and wait until finished.
+  thread.task_runner()->PostTask(
+      FROM_HERE, base::Bind(&AudioOutputDeviceTest::GetOutputDeviceInfo,
+                            base::Unretained(this), &event));
+  event.Wait();
+
+  EXPECT_EQ(kNonDefaultDeviceId, device_info_.device_id());
+  EXPECT_EQ(OUTPUT_DEVICE_STATUS_OK, device_info_.device_status());
+  EXPECT_TRUE(device_info_.output_params().Equals(default_audio_parameters_));
+
+  SetDeviceInfoToGarbage();
+  event.Reset();
+
+  // Get device info on the other thread and wait until finished.
+  thread.task_runner()->PostTask(
+      FROM_HERE, base::Bind(&AudioOutputDeviceTest::GetOutputDeviceInfo,
+                            base::Unretained(this), &event));
+  event.Wait();
+
+  EXPECT_EQ(kNonDefaultDeviceId, device_info_.device_id());
+  EXPECT_EQ(OUTPUT_DEVICE_STATUS_OK, device_info_.device_status());
+  EXPECT_TRUE(device_info_.output_params().Equals(default_audio_parameters_));
+
+  StopAudioDevice();
+}
+
 INSTANTIATE_TEST_CASE_P(Render, AudioOutputDeviceTest, Values(false));
 
 }  // namespace media.