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/thread_task_runner_handle.h"
+#include "base/threading/thread.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;
 using testing::_;
@@ skipping 55 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();
   void StartAudioDevice();
   void CreateStream();
   void ExpectRenderCallback();
   void WaitUntilRenderCallback();
   void StopAudioDevice();
-  void SetDevice(const std::string& device_id);
+  void GetOutputDeviceInfo(base::WaitableEvent* event);
 
  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_;
 
  private:
   int CalculateMemorySize();
 
   SharedMemory shared_memory_;
   CancelableSyncSocket browser_socket_;
   CancelableSyncSocket renderer_socket_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioOutputDeviceTest);
 };
@@ skipping 25 matching lines @@
   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();
 }
 
 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() {
+  audio_device_->Initialize(default_audio_parameters_, &callback_);
+}
+
 void AudioOutputDeviceTest::CreateStream() {
   const int kMemorySize = CalculateMemorySize();
 
   ASSERT_TRUE(shared_memory_.CreateAndMapAnonymous(kMemorySize));
   memset(shared_memory_.memory(), 0xff, kMemorySize);
 
   ASSERT_TRUE(CancelableSyncSocket::CreatePair(&browser_socket_,
                                                &renderer_socket_));
 
   // Create duplicates of the handles we pass to AudioOutputDevice since
@@ skipping 43 matching lines @@
 }
 
 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();
+}
+
 TEST_P(AudioOutputDeviceTest, Initialize) {
   // Tests that the object can be constructed, initialized and destructed
   // without having ever been started.
   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) {
   StartAudioDevice();
   StopAudioDevice();
 }
 
 // AudioOutputDevice supports multiple start/stop sequences.
 TEST_P(AudioOutputDeviceTest, StartStopStartStop) {
   StartAudioDevice();
   StopAudioDevice();
+  InitializeAudioDevice();
   StartAudioDevice();
   StopAudioDevice();
 }
 
 // Simulate receiving OnStreamCreated() prior to processing ShutDownOnIOThread()
 // on the IO loop.
 TEST_P(AudioOutputDeviceTest, StopBeforeRender) {
   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) {
   StartAudioDevice();
   ExpectRenderCallback();
   CreateStream();
   WaitUntilRenderCallback();
   StopAudioDevice();
 }
 
 // Full test with output only with nondefault device.
 TEST_P(AudioOutputDeviceTest, NonDefaultCreateStream) {
+  StopAudioDevice();

[o1ka, 2016/05/03 15:47:32]

Here and below: this does not look like a natural usage sequence. Remove
SetDevice() call from constructor instead?

[Henrik Grunell, 2016/05/04 09:05:12]

Agree. A general note on this file is that I wasn't not done with it yet, so it
could have been rough in places.

Done.

   SetDevice(kNonDefaultDeviceId);
   StartAudioDevice();
   ExpectRenderCallback();
   CreateStream();
   WaitUntilRenderCallback();
   StopAudioDevice();
 }
 
 // Multiple start/stop with nondefault device
 TEST_P(AudioOutputDeviceTest, NonDefaultStartStopStartStop) {
+  StopAudioDevice();
   SetDevice(kNonDefaultDeviceId);
   StartAudioDevice();
   StopAudioDevice();
+  InitializeAudioDevice();
 
   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) {
+  StopAudioDevice();
   SetDevice(kUnauthorizedDeviceId);
   StartAudioDevice();
   StopAudioDevice();
 }
 
+TEST_P(AudioOutputDeviceTest, GetOutputDeviceInfo) {
+  // AudioOutputDevice::GetOutputDeviceInfo must be called on a different thread
+  // than the task runner given to it.

[o1ka, 2016/05/03 15:47:32]

Comment is a bit unclear. GetOutputDeviceInfo must not be called on which task
runner?

[Henrik Grunell, 2016/05/04 09:05:12]

Done.

+  base::WaitableEvent event(true, false);
+  base::Thread thread("get_output_device_info");
+  thread.Start();
+

[o1ka, 2016/05/03 15:47:32]

Probably you should initialize device_info_ with some garbage here, to make sure
it's really updated?

[Henrik Grunell, 2016/05/04 09:05:12]

Good point. Done.

+  // 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) {
+  StopAudioDevice();
+  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) {
+  StopAudioDevice();
+  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_));
+
+  device_info_ = OutputDeviceInfo();
+  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.