Audio output debug recording.

media/audio/audio_output_resampler.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 "media/audio/audio_output_resampler.h"
 
 #include <stdint.h>
 
 #include <algorithm>
 #include <string>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/metrics/sparse_histogram.h"
 #include "base/numerics/safe_conversions.h"
 #include "base/single_thread_task_runner.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/trace_event/trace_event.h"
 #include "build/build_config.h"
+#include "media/audio/audio_debug_recording_helper.h"
 #include "media/audio/audio_output_proxy.h"
 #include "media/audio/sample_rates.h"
 #include "media/base/audio_converter.h"
 #include "media/base/audio_timestamp_helper.h"
 #include "media/base/limits.h"
 
 namespace media {
 
+namespace {
+
+// Running id to append to debug recording filename.
+int g_next_debug_recording_filename_id = 1;
+
+#if defined(OS_WIN)
+#define IntToStringType base::IntToString16
+#else
+#define IntToStringType base::IntToString
+#endif
+
+// Adds debug recording filename running id as an extension.
+base::FilePath AddDebugRecordingFilenameId(const base::FilePath& file_name) {
+  return file_name.AddExtension(
+      IntToStringType(g_next_debug_recording_filename_id++));
+}
+
+}  // namespace
+
 class OnMoreDataConverter
     : public AudioOutputStream::AudioSourceCallback,
       public AudioConverter::InputCallback {
  public:
-  OnMoreDataConverter(const AudioParameters& input_params,
-                      const AudioParameters& output_params);
+  OnMoreDataConverter(
+      const AudioParameters& input_params,
+      const AudioParameters& output_params,
+      std::unique_ptr<AudioDebugRecordingHelper> debug_recording_helper);
   ~OnMoreDataConverter() override;
 
   // AudioSourceCallback interface.
   int OnMoreData(base::TimeDelta delay,
                  base::TimeTicks delay_timestamp,
                  int prior_frames_skipped,
                  AudioBus* dest) override;
   void OnError(AudioOutputStream* stream) override;
 
   // Sets |source_callback_|.  If this is not a new object, then Stop() must be
   // called before Start().
   void Start(AudioOutputStream::AudioSourceCallback* callback);
 
   // Clears |source_callback_| and flushes the resampler.
   void Stop();
 
+  // Controls debug recording.
+  void EnableDebugRecording(const base::FilePath& file_name);
+  void DisableDebugRecording();
+
   bool started() const { return source_callback_ != nullptr; }
 
   bool error_occurred() const { return error_occurred_; }
 
  private:
   // AudioConverter::InputCallback implementation.
   double ProvideInput(AudioBus* audio_bus, uint32_t frames_delayed) override;
 
   // Ratio of input bytes to output bytes used to correct playback delay with
   // regard to buffering and resampling.
@@ skipping 14 matching lines @@
   AudioConverter audio_converter_;
 
   // True if OnError() was ever called.  Should only be read if the underlying
   // stream has been stopped.
   bool error_occurred_;
 
   // Information about input and output buffer sizes to be traced.
   const int input_buffer_size_;
   const int output_buffer_size_;
 
+  // Used for audio debug recordings.
+  std::unique_ptr<AudioDebugRecordingHelper> debug_recording_helper_;
+  AudioParameters output_params_;
+
   DISALLOW_COPY_AND_ASSIGN(OnMoreDataConverter);
 };
 
 // Record UMA statistics for hardware output configuration.
 static void RecordStats(const AudioParameters& output_params) {
   // Note the 'PRESUBMIT_IGNORE_UMA_MAX's below, these silence the PRESUBMIT.py
   // check for uma enum max usage, since we're abusing UMA_HISTOGRAM_ENUMERATION
   // to report a discrete value.
   UMA_HISTOGRAM_ENUMERATION(
       "Media.HardwareAudioBitsPerChannel",
@@ skipping 117 matching lines @@
   Initialize();
 #endif
 }
 
 AudioOutputResampler::AudioOutputResampler(AudioManager* audio_manager,
                                            const AudioParameters& input_params,
                                            const AudioParameters& output_params,
                                            const std::string& output_device_id,
                                            const base::TimeDelta& close_delay)
     : AudioOutputDispatcher(audio_manager, input_params, output_device_id),
+      audio_manager_(audio_manager),
       close_delay_(close_delay),
       output_params_(output_params),
       original_output_params_(output_params),
       streams_opened_(false),
       reinitialize_timer_(FROM_HERE,
                           close_delay_,
                           base::Bind(&AudioOutputResampler::Reinitialize,
                                      base::Unretained(this)),
                           false),
       weak_factory_(this) {
@@ skipping 100 matching lines @@
 }
 
 bool AudioOutputResampler::StartStream(
     AudioOutputStream::AudioSourceCallback* callback,
     AudioOutputProxy* stream_proxy) {
   DCHECK(task_runner_->BelongsToCurrentThread());
 
   OnMoreDataConverter* resampler_callback = nullptr;
   CallbackMap::iterator it = callbacks_.find(stream_proxy);
   if (it == callbacks_.end()) {
-    resampler_callback = new OnMoreDataConverter(params_, output_params_);
+    resampler_callback = new OnMoreDataConverter(
+        params_, output_params_,
+        base::MakeUnique<AudioDebugRecordingHelper>(
+            audio_manager_, audio_manager_->GetTaskRunner()));
     callbacks_[stream_proxy] =
         base::WrapUnique<OnMoreDataConverter>(resampler_callback);
+
+    // If debug recording is enabled, enable it on the new OnMoreDataConverter.
+    if (!debug_recording_file_name_.empty())
+      resampler_callback->EnableDebugRecording(
+          AddDebugRecordingFilenameId(debug_recording_file_name_));
   } else {
     resampler_callback = it->second.get();
   }
 
   resampler_callback->Start(callback);
   bool result = dispatcher_->StartStream(resampler_callback, stream_proxy);
   if (!result)
     resampler_callback->Stop();
   return result;
 }
@@ skipping 23 matching lines @@
 
   // Start the reinitialization timer if there are no active proxies and we're
   // not using the originally requested output parameters.  This allows us to
   // recover from transient output creation errors.
   if (!dispatcher_->HasOutputProxies() && callbacks_.empty() &&
       !output_params_.Equals(original_output_params_)) {
     reinitialize_timer_.Reset();
   }
 }
 
+void AudioOutputResampler::EnableDebugRecording(
+    const base::FilePath& file_name) {
+  DCHECK(task_runner_->BelongsToCurrentThread());
+  for (const auto& item : callbacks_)
+    item.second->EnableDebugRecording(AddDebugRecordingFilenameId(file_name));
+  debug_recording_file_name_ = file_name;
+}
+
+void AudioOutputResampler::DisableDebugRecording() {
+  DCHECK(task_runner_->BelongsToCurrentThread());
+  for (const auto& item : callbacks_)
+    item.second->DisableDebugRecording();
+  debug_recording_file_name_.clear();
+}
+
 void AudioOutputResampler::StopStreamInternal(
     const CallbackMap::value_type& item) {
   AudioOutputProxy* stream_proxy = item.first;
   OnMoreDataConverter* callback = item.second.get();
   DCHECK(callback->started());
 
   // Stop the underlying physical stream.
   dispatcher_->StopStream(stream_proxy);
 
   // Now that StopStream() has completed the underlying physical stream should
   // be stopped and no longer calling OnMoreData(), making it safe to Stop() the
   // OnMoreDataConverter.
   callback->Stop();
 
   // Destroy idle streams if any errors occurred during output; this ensures
   // bad streams will not be reused.  Note: Errors may occur during the Stop()
   // call above.
   if (callback->error_occurred())
     dispatcher_->CloseAllIdleStreams();
 }
 
-OnMoreDataConverter::OnMoreDataConverter(const AudioParameters& input_params,
-                                         const AudioParameters& output_params)
+OnMoreDataConverter::OnMoreDataConverter(
+    const AudioParameters& input_params,
+    const AudioParameters& output_params,
+    std::unique_ptr<AudioDebugRecordingHelper> debug_recording_helper)
     : io_ratio_(static_cast<double>(input_params.GetBytesPerSecond()) /
                 output_params.GetBytesPerSecond()),
       source_callback_(nullptr),
       input_samples_per_second_(input_params.sample_rate()),
       audio_converter_(input_params, output_params, false),
       error_occurred_(false),
       input_buffer_size_(input_params.frames_per_buffer()),
-      output_buffer_size_(output_params.frames_per_buffer()) {
+      output_buffer_size_(output_params.frames_per_buffer()),
+      debug_recording_helper_(std::move(debug_recording_helper)),
+      output_params_(output_params) {
   RecordRebufferingStats(input_params, output_params);
 }
 
 OnMoreDataConverter::~OnMoreDataConverter() {
   // Ensure Stop() has been called so we don't end up with an AudioOutputStream
   // calling back into OnMoreData() after destruction.
   CHECK(!source_callback_);
 }
 
 void OnMoreDataConverter::Start(
@@ skipping 16 matching lines @@
 int OnMoreDataConverter::OnMoreData(base::TimeDelta delay,
                                     base::TimeTicks delay_timestamp,
                                     int /* prior_frames_skipped */,
                                     AudioBus* dest) {
   TRACE_EVENT2("audio", "OnMoreDataConverter::OnMoreData", "input buffer size",
                input_buffer_size_, "output buffer size", output_buffer_size_);
   current_delay_ = delay;
   current_delay_timestamp_ = delay_timestamp;
   audio_converter_.Convert(dest);
 
+  debug_recording_helper_->MaybeWrite(dest);
+
   // Always return the full number of frames requested, ProvideInput()
   // will pad with silence if it wasn't able to acquire enough data.
   return dest->frames();
 }
 
 double OnMoreDataConverter::ProvideInput(AudioBus* dest,
                                          uint32_t frames_delayed) {
   base::TimeDelta new_delay =
       current_delay_ + AudioTimestampHelper::FramesToTime(
                            frames_delayed, input_samples_per_second_);
   // Retrieve data from the original callback.
   const int frames = source_callback_->OnMoreData(
       new_delay, current_delay_timestamp_, 0, dest);
 
   // Zero any unfilled frames if anything was filled, otherwise we'll just
   // return a volume of zero and let AudioConverter drop the output.
   if (frames > 0 && frames < dest->frames())
     dest->ZeroFramesPartial(frames, dest->frames() - frames);
   return frames > 0 ? 1 : 0;
 }
 
 void OnMoreDataConverter::OnError(AudioOutputStream* stream) {
   error_occurred_ = true;
   source_callback_->OnError(stream);
 }
 
+void OnMoreDataConverter::EnableDebugRecording(
+    const base::FilePath& file_name) {
+  debug_recording_helper_->EnableDebugRecording(output_params_, file_name);
+}
+
+void OnMoreDataConverter::DisableDebugRecording() {
+  debug_recording_helper_->DisableDebugRecording();
+}
+
 }  // namespace media