Simplified AudioOutputStream interface.

media/audio/linux/alsa_output_unittest.cc

 // Copyright (c) 2010 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/message_loop.h"
 #include "base/string_util.h"
 #include "media/audio/linux/alsa_output.h"
 #include "media/audio/linux/alsa_wrapper.h"
 #include "media/audio/linux/audio_manager_linux.h"
 #include "media/base/data_buffer.h"
@@ skipping 52 matching lines @@
   MOCK_METHOD1(PcmStart, int(snd_pcm_t* handle));
 
   MOCK_METHOD1(StrError, const char*(int errnum));
 };
 
 class MockAudioSourceCallback : public AudioOutputStream::AudioSourceCallback {
  public:
   MOCK_METHOD4(OnMoreData, uint32(AudioOutputStream* stream,
                                   uint8* dest, uint32 max_size,
                                   AudioBuffersState buffers_state));
-  MOCK_METHOD1(OnClose, void(AudioOutputStream* stream));
   MOCK_METHOD2(OnError, void(AudioOutputStream* stream, int code));
 };
 
 class MockAudioManagerLinux : public AudioManagerLinux {
  public:
   MOCK_METHOD0(Init, void());
   MOCK_METHOD0(HasAudioOutputDevices, bool());
   MOCK_METHOD0(HasAudioInputDevices, bool());
   MOCK_METHOD1(MakeAudioOutputStream, AudioOutputStream*(
       AudioParameters params));
   MOCK_METHOD5(MakeAudioInputStream, AudioInputStream*(
       AudioParameters::Format format,
       int channels,
       int sample_rate,
       char bits_per_sample,
       uint32 samples_per_packet));
   MOCK_METHOD0(MuteAll, void());
   MOCK_METHOD0(UnMuteAll, void());
 
   MOCK_METHOD1(ReleaseOutputStream, void(AlsaPcmOutputStream* stream));
 };
 
 class AlsaPcmOutputStreamTest : public testing::Test {
  protected:
   AlsaPcmOutputStreamTest() {
-    test_stream_ = CreateStreamWithChannels(kTestChannels);
+    test_stream_ = CreateStream(kTestChannels);
   }
 
   virtual ~AlsaPcmOutputStreamTest() {
     test_stream_ = NULL;
   }
 
-  AlsaPcmOutputStream* CreateStreamWithChannels(int channels) {
+  AlsaPcmOutputStream* CreateStream(int channels) {
+    return CreateStream(channels, kTestFramesPerPacket);
+  }
+
+  AlsaPcmOutputStream* CreateStream(int channels, int32 samples_per_packet) {
     AudioParameters params(kTestFormat, channels, kTestSampleRate,
-                           kTestBitsPerSample);
+                           kTestBitsPerSample, samples_per_packet);
     return new AlsaPcmOutputStream(kTestDeviceName,
                                    params,
                                    &mock_alsa_wrapper_,
                                    &mock_manager_,
                                    &message_loop_);
   }
 
   // Helper function to malloc the string returned by DeviceNameHint for NAME.
   static char* EchoHint(const void* name, Unused) {
     return strdup(static_cast<const char*>(name));
@@ skipping 71 matching lines @@
 char AlsaPcmOutputStreamTest::kSurround71[] = "surround71:CARD=foo,DEV=0";
 void* AlsaPcmOutputStreamTest::kFakeHints[] = {
     kSurround40, kSurround41, kSurround50, kSurround51,
     kSurround70, kSurround71, NULL };
 
 TEST_F(AlsaPcmOutputStreamTest, ConstructedState) {
   EXPECT_EQ(AlsaPcmOutputStream::kCreated,
             test_stream_->shared_data_.state());
 
   // Should support mono.
-  test_stream_ = CreateStreamWithChannels(1);
+  test_stream_ = CreateStream(1);
   EXPECT_EQ(AlsaPcmOutputStream::kCreated,
             test_stream_->shared_data_.state());
 
   // Should support multi-channel.
-  test_stream_ = CreateStreamWithChannels(3);
+  test_stream_ = CreateStream(3);
   EXPECT_EQ(AlsaPcmOutputStream::kCreated,
             test_stream_->shared_data_.state());
 
   // Bad bits per sample.
   AudioParameters bad_bps_params(kTestFormat, kTestChannels,
-                                 kTestSampleRate, kTestBitsPerSample - 1);
+                                 kTestSampleRate, kTestBitsPerSample - 1,
+                                 kTestFramesPerPacket);
   test_stream_ = new AlsaPcmOutputStream(kTestDeviceName,
                                          bad_bps_params,
                                          &mock_alsa_wrapper_,
                                          &mock_manager_,
                                          &message_loop_);
   EXPECT_EQ(AlsaPcmOutputStream::kInError,
             test_stream_->shared_data_.state());
 
   // Bad format.
   AudioParameters bad_format_params(
       AudioParameters::AUDIO_LAST_FORMAT, kTestChannels,
-      kTestSampleRate, kTestBitsPerSample);
+      kTestSampleRate, kTestBitsPerSample, kTestFramesPerPacket);
   test_stream_ = new AlsaPcmOutputStream(kTestDeviceName,
                                          bad_format_params,
                                          &mock_alsa_wrapper_,
                                          &mock_manager_,
                                          &message_loop_);
   EXPECT_EQ(AlsaPcmOutputStream::kInError,
             test_stream_->shared_data_.state());
 }
 
 TEST_F(AlsaPcmOutputStreamTest, LatencyFloor) {
   const double kMicrosPerFrame =
       static_cast<double>(1000000) / kTestSampleRate;
   const double kPacketFramesInMinLatency =
       AlsaPcmOutputStream::kMinLatencyMicros / kMicrosPerFrame / 2.0;
-  const int kMinLatencyPacketSize =
-      static_cast<int>(kPacketFramesInMinLatency * kTestBytesPerFrame);
 
   // Test that packets which would cause a latency under less than
   // AlsaPcmOutputStream::kMinLatencyMicros will get clipped to
   // AlsaPcmOutputStream::kMinLatencyMicros,
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, _, _, _))
       .WillOnce(DoAll(SetArgumentPointee<0>(kFakeHandle),
                       Return(0)));
   EXPECT_CALL(mock_alsa_wrapper_,
               PcmSetParams(_, _, _, _, _, _,
                            AlsaPcmOutputStream::kMinLatencyMicros))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmGetParams(_, _, _))
       .WillOnce(DoAll(SetArgumentPointee<1>(kTestFramesPerPacket),
                       SetArgumentPointee<2>(kTestFramesPerPacket / 2),
                       Return(0)));
 
-  ASSERT_TRUE(test_stream_->Open(kMinLatencyPacketSize));
+  test_stream_ = CreateStream(kTestChannels, kPacketFramesInMinLatency);
+  ASSERT_TRUE(test_stream_->Open());
   message_loop_.RunAllPending();
 
   // Now close it and test that everything was released.
   EXPECT_CALL(mock_alsa_wrapper_, PcmClose(kFakeHandle)).WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmName(kFakeHandle))
       .WillOnce(Return(kTestDeviceName));
   EXPECT_CALL(mock_manager_, ReleaseOutputStream(test_stream_.get()));
   test_stream_->Close();
   message_loop_.RunAllPending();
 
   Mock::VerifyAndClear(&mock_alsa_wrapper_);
   Mock::VerifyAndClear(&mock_manager_);
 
   // Test that having more packets ends up with a latency based on packet size.
-  const int kOverMinLatencyPacketSize =
-      (kPacketFramesInMinLatency + 1) * kTestBytesPerFrame;
-  int64 expected_micros = 2 *
-      AlsaPcmOutputStream::FramesToMicros(
-          kOverMinLatencyPacketSize / kTestBytesPerFrame,
-          kTestSampleRate);
-
-  // Recreate the stream to reset the state.
-  test_stream_ = CreateStreamWithChannels(kTestChannels);
+  const int kOverMinLatencyPacketSize = kPacketFramesInMinLatency + 1;
+  int64 expected_micros = 2 * AlsaPcmOutputStream::FramesToMicros(
+      kOverMinLatencyPacketSize, kTestSampleRate);
 
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, _, _, _))
       .WillOnce(DoAll(SetArgumentPointee<0>(kFakeHandle), Return(0)));
   EXPECT_CALL(mock_alsa_wrapper_,
               PcmSetParams(_, _, _, _, _, _, expected_micros))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmGetParams(_, _, _))
       .WillOnce(DoAll(SetArgumentPointee<1>(kTestFramesPerPacket),
                       SetArgumentPointee<2>(kTestFramesPerPacket / 2),
                       Return(0)));
 
-  ASSERT_TRUE(test_stream_->Open(kOverMinLatencyPacketSize));
+  test_stream_ = CreateStream(kTestChannels, kOverMinLatencyPacketSize);
+  ASSERT_TRUE(test_stream_->Open());
   message_loop_.RunAllPending();
 
   // Now close it and test that everything was released.
   EXPECT_CALL(mock_alsa_wrapper_, PcmClose(kFakeHandle))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmName(kFakeHandle))
       .WillOnce(Return(kTestDeviceName));
   EXPECT_CALL(mock_manager_, ReleaseOutputStream(test_stream_.get()));
   test_stream_->Close();
   message_loop_.RunAllPending();
@@ skipping 23 matching lines @@
                            kTestSampleRate,
                            1,
                            expected_micros))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmGetParams(kFakeHandle, _, _))
       .WillOnce(DoAll(SetArgumentPointee<1>(kTestFramesPerPacket),
                       SetArgumentPointee<2>(kTestFramesPerPacket / 2),
                       Return(0)));
 
   // Open the stream.
-  ASSERT_TRUE(test_stream_->Open(kTestPacketSize));
+  ASSERT_TRUE(test_stream_->Open());
   message_loop_.RunAllPending();
 
   EXPECT_EQ(AlsaPcmOutputStream::kIsOpened,
             test_stream_->shared_data_.state());
   EXPECT_EQ(kFakeHandle, test_stream_->playback_handle_);
   EXPECT_EQ(kTestFramesPerPacket, test_stream_->frames_per_packet_);
   EXPECT_TRUE(test_stream_->buffer_.get());
   EXPECT_FALSE(test_stream_->stop_stream_);
 
   // Now close it and test that everything was released.
@@ skipping 10 matching lines @@
   EXPECT_TRUE(test_stream_->stop_stream_);
 }
 
 TEST_F(AlsaPcmOutputStreamTest, PcmOpenFailed) {
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, _, _, _))
       .WillOnce(Return(kTestFailedErrno));
   EXPECT_CALL(mock_alsa_wrapper_, StrError(kTestFailedErrno))
       .WillOnce(Return(kDummyMessage));
 
   // Open still succeeds since PcmOpen is delegated to another thread.
-  ASSERT_TRUE(test_stream_->Open(kTestPacketSize));
+  ASSERT_TRUE(test_stream_->Open());
   ASSERT_EQ(AlsaPcmOutputStream::kIsOpened,
             test_stream_->shared_data_.state());
   ASSERT_FALSE(test_stream_->stop_stream_);
   message_loop_.RunAllPending();
 
   // Ensure internal state is set for a no-op stream if PcmOpen() failes.
   EXPECT_EQ(AlsaPcmOutputStream::kIsOpened,
             test_stream_->shared_data_.state());
   EXPECT_TRUE(test_stream_->stop_stream_);
   EXPECT_TRUE(test_stream_->playback_handle_ == NULL);
@@ skipping 13 matching lines @@
       .WillOnce(Return(kTestFailedErrno));
   EXPECT_CALL(mock_alsa_wrapper_, PcmClose(kFakeHandle))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmName(kFakeHandle))
       .WillOnce(Return(kTestDeviceName));
   EXPECT_CALL(mock_alsa_wrapper_, StrError(kTestFailedErrno))
       .WillOnce(Return(kDummyMessage));
 
   // If open fails, the stream stays in kCreated because it has effectively had
   // no changes.
-  ASSERT_TRUE(test_stream_->Open(kTestPacketSize));
+  ASSERT_TRUE(test_stream_->Open());
   EXPECT_EQ(AlsaPcmOutputStream::kIsOpened,
             test_stream_->shared_data_.state());
   ASSERT_FALSE(test_stream_->stop_stream_);
   message_loop_.RunAllPending();
 
   // Ensure internal state is set for a no-op stream if PcmSetParams() failes.
   EXPECT_EQ(AlsaPcmOutputStream::kIsOpened,
             test_stream_->shared_data_.state());
   EXPECT_TRUE(test_stream_->stop_stream_);
   EXPECT_TRUE(test_stream_->playback_handle_ == NULL);
@@ skipping 13 matching lines @@
       .WillOnce(DoAll(SetArgumentPointee<0>(kFakeHandle),
                       Return(0)));
   EXPECT_CALL(mock_alsa_wrapper_, PcmSetParams(_, _, _, _, _, _, _))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmGetParams(_, _, _))
       .WillOnce(DoAll(SetArgumentPointee<1>(kTestFramesPerPacket),
                       SetArgumentPointee<2>(kTestFramesPerPacket / 2),
                       Return(0)));
 
   // Open the stream.
-  ASSERT_TRUE(test_stream_->Open(kTestPacketSize));
+  ASSERT_TRUE(test_stream_->Open());
   message_loop_.RunAllPending();
 
   // Expect Device setup.
   EXPECT_CALL(mock_alsa_wrapper_, PcmDrop(kFakeHandle))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmPrepare(kFakeHandle))
       .WillOnce(Return(0));
 
   // Expect the pre-roll.
   MockAudioSourceCallback mock_callback;
@@ skipping 17 matching lines @@
       .WillOnce(Return(kTestFramesPerPacket))  // Buffer is empty.
       .WillOnce(Return(kTestFramesPerPacket))
       .WillRepeatedly(DoAll(InvokeWithoutArgs(&message_loop_,
                                               &MessageLoop::QuitNow),
                              Return(0)));  // Buffer is full.
 
   test_stream_->Start(&mock_callback);
   message_loop_.RunAllPending();
 
   EXPECT_CALL(mock_manager_, ReleaseOutputStream(test_stream_.get()));
-  EXPECT_CALL(mock_callback, OnClose(test_stream_.get()));
   EXPECT_CALL(mock_alsa_wrapper_, PcmClose(kFakeHandle))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, PcmName(kFakeHandle))
       .WillOnce(Return(kTestDeviceName));
   test_stream_->Close();
   message_loop_.RunAllPending();
 }
 
 TEST_F(AlsaPcmOutputStreamTest, WritePacket_FinishedPacket) {
   InitBuffer();
@@ skipping 194 matching lines @@
         .WillOnce(Return(0));
 
     // The parameters are specified by ALSA documentation, and are in constants
     // in the implementation files.
     EXPECT_CALL(mock_alsa_wrapper_, DeviceNameGetHint(_, StrEq("IOID")))
         .WillRepeatedly(Invoke(OutputHint));
     EXPECT_CALL(mock_alsa_wrapper_, DeviceNameGetHint(_, StrEq("NAME")))
         .WillRepeatedly(Invoke(EchoHint));
 
 
-    test_stream_ = CreateStreamWithChannels(i);
+    test_stream_ = CreateStream(i);
     EXPECT_TRUE(test_stream_->AutoSelectDevice(i));
     EXPECT_EQ(kExpectedDownmix[i], test_stream_->should_downmix_);
 
     Mock::VerifyAndClearExpectations(&mock_alsa_wrapper_);
     Mock::VerifyAndClearExpectations(&mock_manager_);
   }
 }
 
 TEST_F(AlsaPcmOutputStreamTest, AutoSelectDevice_FallbackDevices) {
   using std::string;
@@ skipping 29 matching lines @@
   InSequence s;
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, StrEq(first_try.c_str()), _, _))
       .WillOnce(Return(kTestFailedErrno));
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, StrEq(second_try.c_str()), _, _))
       .WillOnce(Return(kTestFailedErrno));
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, StrEq(third_try.c_str()), _, _))
       .WillOnce(Return(kTestFailedErrno));
   EXPECT_CALL(mock_alsa_wrapper_, PcmOpen(_, StrEq(fourth_try.c_str()), _, _))
       .WillOnce(Return(kTestFailedErrno));
 
-  test_stream_ = CreateStreamWithChannels(5);
+  test_stream_ = CreateStream(5);
   EXPECT_FALSE(test_stream_->AutoSelectDevice(5));
 }
 
 TEST_F(AlsaPcmOutputStreamTest, AutoSelectDevice_HintFail) {
   // Should get |kDefaultDevice|, and force a 2-channel downmix on a failure to
   // enumerate devices.
   EXPECT_CALL(mock_alsa_wrapper_, DeviceNameHint(_, _, _))
       .WillRepeatedly(Return(kTestFailedErrno));
   EXPECT_CALL(mock_alsa_wrapper_,
               PcmOpen(_, StrEq(AlsaPcmOutputStream::kDefaultDevice), _, _))
       .WillOnce(DoAll(SetArgumentPointee<0>(kFakeHandle), Return(0)));
   EXPECT_CALL(mock_alsa_wrapper_,
               PcmSetParams(kFakeHandle, _, _, 2, _, _, _))
       .WillOnce(Return(0));
   EXPECT_CALL(mock_alsa_wrapper_, StrError(kTestFailedErrno))
       .WillOnce(Return(kDummyMessage));
 
-  test_stream_ = CreateStreamWithChannels(5);
+  test_stream_ = CreateStream(5);
   EXPECT_TRUE(test_stream_->AutoSelectDevice(5));
   EXPECT_TRUE(test_stream_->should_downmix_);
 }
 
 TEST_F(AlsaPcmOutputStreamTest, BufferPacket_StopStream) {
   InitBuffer();
   test_stream_->stop_stream_ = true;
   bool source_exhausted;
   test_stream_->BufferPacket(&source_exhausted);
   EXPECT_EQ(0u, test_stream_->buffer_->forward_bytes());
@@ skipping 30 matching lines @@
 
   test_stream_->stop_stream_ = true;
   test_stream_->ScheduleNextWrite(true);
 
   // TODO(ajwong): Find a way to test whether or not another task has been
   // posted so we can verify that the Alsa code will indeed break the task
   // posting loop.
 
   test_stream_->shared_data_.TransitionTo(AlsaPcmOutputStream::kIsClosed);
 }