Pass delay and timestamp to AudioSourceCallback::OnMoreData.

media/audio/win/audio_output_win_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 <windows.h>
 #include <mmsystem.h>
 #include <stddef.h>
 #include <stdint.h>
 
 #include <memory>
 
 #include "base/base_paths.h"
 #include "base/memory/aligned_memory.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/sync_socket.h"
+#include "base/time/time.h"
 #include "base/win/scoped_com_initializer.h"
 #include "base/win/windows_version.h"
 #include "media/audio/audio_io.h"
 #include "media/audio/audio_manager.h"
 #include "media/audio/audio_unittest_util.h"
 #include "media/audio/mock_audio_source_callback.h"
 #include "media/audio/simple_sources.h"
 #include "media/base/limits.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using ::testing::_;
 using ::testing::AnyNumber;
 using ::testing::DoAll;
 using ::testing::Field;
 using ::testing::Invoke;
 using ::testing::InSequence;
 using ::testing::NiceMock;
 using ::testing::NotNull;
 using ::testing::Return;
 
 namespace media {
 
-static int ClearData(AudioBus* audio_bus,
-                     uint32_t total_bytes_delay,
-                     uint32_t frames_skipped) {
-  audio_bus->Zero();
-  return audio_bus->frames();
+static int ClearData(base::TimeDelta /* delay */,
+                     base::TimeTicks /* delay_timestamp */,
+                     int /* prior_frames_skipped */,
+                     AudioBus* dest) {
+  dest->Zero();
+  return dest->frames();
 }
 
 // This class allows to find out if the callbacks are occurring as
 // expected and if any error has been reported.
 class TestSourceBasic : public AudioOutputStream::AudioSourceCallback {
  public:
   TestSourceBasic()
       : callback_count_(0),
         had_error_(0) {
   }
   // AudioSourceCallback::OnMoreData implementation:
-  int OnMoreData(AudioBus* audio_bus,
-                 uint32_t total_bytes_delay,
-                 uint32_t frames_skipped) override {
+  int OnMoreData(base::TimeDelta /* delay */,
+                 base::TimeTicks /* delay_timestamp */,
+                 int /* prior_frames_skipped */,
+                 AudioBus* dest) override {
     ++callback_count_;
     // Touch the channel memory value to make sure memory is good.
-    audio_bus->Zero();
-    return audio_bus->frames();
+    dest->Zero();
+    return dest->frames();
   }
   // AudioSourceCallback::OnError implementation:
   void OnError(AudioOutputStream* stream) override { ++had_error_; }
   // Returns how many times OnMoreData() has been called.
   int callback_count() const {
     return callback_count_;
   }
   // Returns how many times the OnError callback was called.
   int had_error() const {
     return had_error_;
   }
 
   void set_error(bool error) {
     had_error_ += error ? 1 : 0;
   }
 
  private:
   int callback_count_;
   int had_error_;
 };
 
 const int kMaxNumBuffers = 3;
 // Specializes TestSourceBasic to simulate a source that blocks for some time
 // in the OnMoreData callback.
 class TestSourceLaggy : public TestSourceBasic {
  public:
   explicit TestSourceLaggy(int lag_in_ms)
       : lag_in_ms_(lag_in_ms) {
   }
-  int OnMoreData(AudioBus* audio_bus,
-                 uint32_t total_bytes_delay,
-                 uint32_t frames_skipped) override {
+  int OnMoreData(base::TimeDelta delay,
+                 base::TimeTicks delay_timestamp,
+                 int prior_frames_skipped,
+                 AudioBus* dest) override {
     // Call the base, which increments the callback_count_.
-    TestSourceBasic::OnMoreData(audio_bus, total_bytes_delay, frames_skipped);
+    TestSourceBasic::OnMoreData(delay, delay_timestamp, prior_frames_skipped,
+                                dest);
     if (callback_count() > kMaxNumBuffers) {
       ::Sleep(lag_in_ms_);
     }
-    return audio_bus->frames();
+    return dest->frames();
   }
  private:
   int lag_in_ms_;
 };
 
 // Helper class to memory map an entire file. The mapping is read-only. Don't
 // use for gigabyte-sized files. Attempts to write to this memory generate
 // memory access violations.
 class ReadOnlyMappedFile {
  public:
@@ skipping 369 matching lines @@
   uint32_t samples_100_ms = AudioParameters::kAudioCDSampleRate / 10;
   AudioOutputStream* oas = audio_manager_->MakeAudioOutputStream(
       AudioParameters(AudioParameters::AUDIO_PCM_LINEAR, CHANNEL_LAYOUT_MONO,
                       AudioParameters::kAudioCDSampleRate, 16, samples_100_ms),
       std::string(), AudioManager::LogCallback());
   ASSERT_TRUE(NULL != oas);
 
   NiceMock<MockAudioSourceCallback> source;
   EXPECT_TRUE(oas->Open());
 
-  uint32_t bytes_100_ms = samples_100_ms * 2;
+  const base::TimeDelta delay_100_ms = base::TimeDelta::FromMilliseconds(100);
+  const base::TimeDelta delay_200_ms = base::TimeDelta::FromMilliseconds(200);
 
-  // Audio output stream has either a double or triple buffer scheme.
-  // We expect the amount of pending bytes will reaching up to 2 times of
-  // |bytes_100_ms| depending on number of buffers used.
+  // Audio output stream has either a double or triple buffer scheme. We expect
+  // the delay to reach up to 200 ms depending on the number of buffers used.
   // From that it would decrease as we are playing the data but not providing
   // new one. And then we will try to provide zero data so the amount of
   // pending bytes will go down and eventually read zero.
   InSequence s;
 
-  EXPECT_CALL(source, OnMoreData(NotNull(), 0, 0)).WillOnce(Invoke(ClearData));
+  EXPECT_CALL(source, OnMoreData(base::TimeDelta(), _, 0, NotNull()))
+      .WillOnce(Invoke(ClearData));
 
   // Note: If AudioManagerWin::NumberOfWaveOutBuffers() ever changes, or if this
   // test is run on Vista, these expectations will fail.
-  EXPECT_CALL(source, OnMoreData(NotNull(), bytes_100_ms, 0))
+  EXPECT_CALL(source, OnMoreData(delay_100_ms, _, 0, NotNull()))
       .WillOnce(Invoke(ClearData));
-  EXPECT_CALL(source, OnMoreData(NotNull(), 2 * bytes_100_ms, 0))
+  EXPECT_CALL(source, OnMoreData(delay_200_ms, _, 0, NotNull()))
       .WillOnce(Invoke(ClearData));
-  EXPECT_CALL(source, OnMoreData(NotNull(), 2 * bytes_100_ms, 0))
+  EXPECT_CALL(source, OnMoreData(delay_200_ms, _, 0, NotNull()))
       .Times(AnyNumber())
       .WillRepeatedly(Return(0));
-  EXPECT_CALL(source, OnMoreData(NotNull(), bytes_100_ms, 0))
+  EXPECT_CALL(source, OnMoreData(delay_100_ms, _, 0, NotNull()))
       .Times(AnyNumber())
       .WillRepeatedly(Return(0));
-  EXPECT_CALL(source, OnMoreData(NotNull(), 0, 0))
+  EXPECT_CALL(source, OnMoreData(base::TimeDelta(), _, 0, NotNull()))
       .Times(AnyNumber())
       .WillRepeatedly(Return(0));
 
   oas->Start(&source);
   ::Sleep(500);
   oas->Stop();
   oas->Close();
 }
 
 // Simple source that uses a SyncSocket to retrieve the audio data
 // from a potentially remote thread.
 class SyncSocketSource : public AudioOutputStream::AudioSourceCallback {
  public:
   SyncSocketSource(base::SyncSocket* socket, const AudioParameters& params)
-      : socket_(socket) {
+      : socket_(socket), params_(params) {
     // Setup AudioBus wrapping data we'll receive over the sync socket.
     data_size_ = AudioBus::CalculateMemorySize(params);
     data_.reset(static_cast<float*>(
         base::AlignedAlloc(data_size_, AudioBus::kChannelAlignment)));
     audio_bus_ = AudioBus::WrapMemory(params, data_.get());
   }
   ~SyncSocketSource() override {}
 
   // AudioSourceCallback::OnMoreData implementation:
-  int OnMoreData(AudioBus* audio_bus,
-                 uint32_t total_bytes_delay,
-                 uint32_t frames_skipped) override {
+  int OnMoreData(base::TimeDelta delay,
+                 base::TimeTicks /* delay_timestamp */,
+                 int /* prior_frames_skipped */,
+                 AudioBus* dest) override {
+    uint32_t total_bytes_delay =
+        delay.InSecondsF() * params_.GetBytesPerSecond();
     socket_->Send(&total_bytes_delay, sizeof(total_bytes_delay));
     uint32_t size = socket_->Receive(data_.get(), data_size_);
     DCHECK_EQ(static_cast<size_t>(size) % sizeof(*audio_bus_->channel(0)), 0U);
-    audio_bus_->CopyTo(audio_bus);
+    audio_bus_->CopyTo(dest);
     return audio_bus_->frames();
   }
 
   // AudioSourceCallback::OnError implementation:
   void OnError(AudioOutputStream* stream) override {}
 
  private:
   base::SyncSocket* socket_;
+  const AudioParameters params_;
   int data_size_;
   std::unique_ptr<float, base::AlignedFreeDeleter> data_;
   std::unique_ptr<AudioBus> audio_bus_;
 };
 
 struct SyncThreadContext {
   base::SyncSocket* socket;
   int sample_rate;
   int channels;
   int frames;
   double sine_freq;
   uint32_t packet_size_bytes;
+  int bytes_per_second;
 };
 
 // This thread provides the data that the SyncSocketSource above needs
 // using the other end of a SyncSocket. The protocol is as follows:
 //
 // SyncSocketSource ---send 4 bytes ------------> SyncSocketThread
 //                  <--- audio packet ----------
 //
 DWORD __stdcall SyncSocketThread(void* context) {
   SyncThreadContext& ctx = *(reinterpret_cast<SyncThreadContext*>(context));
 
   // Setup AudioBus wrapping data we'll pass over the sync socket.
   std::unique_ptr<float, base::AlignedFreeDeleter> data(static_cast<float*>(
       base::AlignedAlloc(ctx.packet_size_bytes, AudioBus::kChannelAlignment)));
   std::unique_ptr<AudioBus> audio_bus =
       AudioBus::WrapMemory(ctx.channels, ctx.frames, data.get());
 
   SineWaveAudioSource sine(1, ctx.sine_freq, ctx.sample_rate);
   const int kTwoSecFrames = ctx.sample_rate * 2;
 
   uint32_t total_bytes_delay = 0;
   int times = 0;
   for (int ix = 0; ix < kTwoSecFrames; ix += ctx.frames) {
     if (ctx.socket->Receive(&total_bytes_delay, sizeof(total_bytes_delay)) == 0)
       break;
     if ((times > 0) && (total_bytes_delay < 1000)) __debugbreak();
-    sine.OnMoreData(audio_bus.get(), total_bytes_delay, 0);
+    base::TimeDelta delay = base::TimeDelta::FromSecondsD(
+        static_cast<double>(total_bytes_delay) / ctx.bytes_per_second);
+    sine.OnMoreData(delay, base::TimeTicks::Now(), 0, audio_bus.get());
     ctx.socket->Send(data.get(), ctx.packet_size_bytes);
     ++times;
   }
 
   return 0;
 }
 
 // Test the basic operation of AudioOutputStream used with a SyncSocket.
 // The emphasis is to verify that it is possible to feed data to the audio
 // layer using a source based on SyncSocket. In a real situation we would
@@ skipping 21 matching lines @@
 
   SyncSocketSource source(&sockets[0], params);
 
   SyncThreadContext thread_context;
   thread_context.sample_rate = params.sample_rate();
   thread_context.sine_freq = 200.0;
   thread_context.packet_size_bytes = AudioBus::CalculateMemorySize(params);
   thread_context.frames = params.frames_per_buffer();
   thread_context.channels = params.channels();
   thread_context.socket = &sockets[1];
+  thread_context.bytes_per_second = params.GetBytesPerSecond();
 
   HANDLE thread = ::CreateThread(NULL, 0, SyncSocketThread,
                                  &thread_context, 0, NULL);
 
   oas->Start(&source);
 
   ::WaitForSingleObject(thread, INFINITE);
   ::CloseHandle(thread);
 
   oas->Stop();
   oas->Close();
 }
 
 }  // namespace media