Audio output debug recording.

media/audio/audio_manager_base.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_manager_base.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "build/build_config.h"
+#include "media/audio/audio_debug_recording_helper.h"
 #include "media/audio/audio_device_description.h"
 #include "media/audio/audio_output_dispatcher_impl.h"
 #include "media/audio/audio_output_proxy.h"
 #include "media/audio/audio_output_resampler.h"
 #include "media/audio/fake_audio_input_stream.h"
 #include "media/audio/fake_audio_output_stream.h"
 #include "media/base/media_switches.h"
 
 namespace media {
 namespace {
 
 const int kStreamCloseDelaySeconds = 5;
 
 // Default maximum number of output streams that can be open simultaneously
 // for all platforms.
 const int kDefaultMaxOutputStreams = 32;
 
 // Default maximum number of input streams that can be open simultaneously
 // for all platforms.
 const int kDefaultMaxInputStreams = 32;
 
 const int kMaxInputChannels = 3;
 
+#if defined(OS_WIN)
+#define IntToStringType base::IntToString16
+#else
+#define IntToStringType base::IntToString
+#endif
+
+// Helper function.
+base::FilePath GetOutputDebugRecordingFileNameWithExtensions(
+    const base::FilePath& file_name,
+    int id) {
+  return file_name.AddExtension("output").AddExtension(IntToStringType(id));
+}
+
 }  // namespace
 
 struct AudioManagerBase::DispatcherParams {
   DispatcherParams(const AudioParameters& input,
                    const AudioParameters& output,
                    const std::string& output_device_id)
       : input_params(input),
         output_params(output),
         output_device_id(output_device_id) {}
   ~DispatcherParams() {}
@@ skipping 22 matching lines @@
             dispatcher_->output_device_id == dispatcher_in->output_device_id);
   }
 
  private:
   const DispatcherParams* dispatcher_;
 };
 
 AudioManagerBase::AudioManagerBase(
     scoped_refptr<base::SingleThreadTaskRunner> task_runner,
     scoped_refptr<base::SingleThreadTaskRunner> worker_task_runner,
-    AudioLogFactory* audio_log_factory)
+    AudioLogFactory* audio_log_factory,
+    CreateAudioFileWriterCallback create_audio_file_writer_callback)
     : AudioManager(std::move(task_runner), std::move(worker_task_runner)),
       max_num_output_streams_(kDefaultMaxOutputStreams),
       max_num_input_streams_(kDefaultMaxInputStreams),
       num_output_streams_(0),
       // TODO(dalecurtis): Switch this to an base::ObserverListThreadSafe, so we
-      // don't
-      // block the UI thread when swapping devices.
+      // don't block the UI thread when swapping devices.
       output_listeners_(
           base::ObserverList<AudioDeviceListener>::NOTIFY_EXISTING_ONLY),
-      audio_log_factory_(audio_log_factory) {}
+      audio_log_factory_(audio_log_factory),
+      create_audio_file_writer_callback_(
+          std::move(create_audio_file_writer_callback)) {
+  DCHECK(create_audio_file_writer_callback_);
+}
 
 AudioManagerBase::~AudioManagerBase() {
   DCHECK(GetTaskRunner()->BelongsToCurrentThread());
 
   // All the output streams should have been deleted.
   CHECK_EQ(0, num_output_streams_);
   // All the input streams should have been deleted.
   CHECK(input_streams_.empty());
 }
 
@@ skipping 176 matching lines @@
                    CompareByParams(dispatcher_params));
   if (it != output_dispatchers_.end()) {
     delete dispatcher_params;
     return (*it)->dispatcher->CreateStreamProxy();
   }
 
   const base::TimeDelta kCloseDelay =
       base::TimeDelta::FromSeconds(kStreamCloseDelaySeconds);
   std::unique_ptr<AudioOutputDispatcher> dispatcher;
   if (output_params.format() != AudioParameters::AUDIO_FAKE) {
-    dispatcher = base::MakeUnique<AudioOutputResampler>(
-        this, params, output_params, output_device_id, kCloseDelay);
+    std::unique_ptr<AudioOutputResampler> resampler =
+        base::MakeUnique<AudioOutputResampler>(this, params, output_params,
+                                               output_device_id, kCloseDelay);
+
+    resampler->SetDebugRecordingCallbacks(
+        base::Bind(&AudioManagerBase::RegisterDebugRecordingSource,
+                   base::Unretained(this)),
+        base::Bind(&AudioManagerBase::UnregisterDebugRecordingSource,
+                   base::Unretained(this)),
+        base::Bind(&AudioManagerBase::OnDebugRecordingData,
+                   base::Unretained(this)));
+
+    dispatcher = std::move(resampler);
   } else {
     dispatcher = base::MakeUnique<AudioOutputDispatcherImpl>(
         this, output_params, output_device_id, kCloseDelay);
   }
 
   dispatcher_params->dispatcher = std::move(dispatcher);
   output_dispatchers_.push_back(dispatcher_params);
   return dispatcher_params->dispatcher->CreateStreamProxy();
 }
 
@@ skipping 126 matching lines @@
     return buffer_size;
 
   return 0;
 }
 
 std::unique_ptr<AudioLog> AudioManagerBase::CreateAudioLog(
     AudioLogFactory::AudioComponent component) {
   return audio_log_factory_->CreateAudioLog(component);
 }
 
+void AudioManagerBase::EnableOutputDebugRecording(
+    const base::FilePath& base_file_name) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  for (const auto& it : debug_recording_helpers_) {
+    it.second->EnableDebugRecording(
+        GetOutputDebugRecordingFileNameWithExtensions(base_file_name,
+                                                      it.first));
+  }
+  debug_recording_base_file_name_ = base_file_name;
+}
+
+void AudioManagerBase::DisableOutputDebugRecording() {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  for (const auto& it : debug_recording_helpers_)
+    it.second->DisableDebugRecording();
+  debug_recording_base_file_name_.clear();
+}
+
+void AudioManagerBase::RegisterDebugRecordingSource(

[o1ka, 2017/01/25 17:47:00]

If keeping this logic, could you move it into a helper object? AudioManager
takes care of too much stuff.

[Henrik Grunell, 2017/01/26 10:25:09]

Yep, agree.

+    int id,
+    const AudioParameters& params) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  DCHECK(debug_recording_helpers_.find(id) == debug_recording_helpers_.end());
+  debug_recording_helpers_[id] = base::MakeUnique<AudioDebugRecordingHelper>(
+      params, create_audio_file_writer_callback_, GetTaskRunner());
+  if (!debug_recording_base_file_name_.empty()) {
+    debug_recording_helpers_[id]->EnableDebugRecording(
+        GetOutputDebugRecordingFileNameWithExtensions(
+            debug_recording_base_file_name_, id));
+  }
+}
+
+void AudioManagerBase::UnregisterDebugRecordingSource(int id) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  auto it = debug_recording_helpers_.find(id);
+  DCHECK(it != debug_recording_helpers_.end());
+  it->second->DisableDebugRecording();
+  debug_recording_helpers_.erase(id);
+}
+
+void AudioManagerBase::OnDebugRecordingData(int id, AudioBus* data) {
+  // TODO BEFORE COMMIT: Comment on why accessing |debug_recording_helpers_|
+  // here is safe.

[o1ka, 2017/01/25 17:47:00]

This does not looks like a good separation of concerns to me. Could AudioManager
create a debug recorder object which takes care of everything and pass it into
resampler?

[Henrik Grunell, 2017/01/26 10:25:09]

Yes, will do.

+  auto it = debug_recording_helpers_.find(id);
+  DCHECK(it != debug_recording_helpers_.end());
+  it->second->MaybeWrite(data);
+}
+
 void AudioManagerBase::SetMaxStreamCountForTesting(int max_input,
                                                    int max_output) {
   max_num_output_streams_ = max_output;
   max_num_input_streams_ = max_input;
 }
 
 }  // namespace media