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"
@@ skipping 60 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)),
+      next_filename_id_(1) {
+  CHECK(!create_audio_file_writer_callback_.Equals(

[Max Morin, 2017/01/20 07:49:09]

is it enough with CHECK(create_audio_file_writer_callback_) or
CHECK(!create_audio_file_writer_callback_.is_null())?

[Henrik Grunell, 2017/01/20 10:38:56]

No, it can still be "empty".
There's no is_null() function.

[Henrik Grunell, 2017/01/25 11:50:49]

Oh, I missed the base class. Changed.

+      CreateAudioFileWriterCallback()));
+}
 
 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.
+  // All the output and input streams should have been deleted.
+  CHECK(output_streams_.empty());
   CHECK(input_streams_.empty());
 }
 
 base::string16 AudioManagerBase::GetAudioInputDeviceModel() {
   return base::string16();
 }
 
 void AudioManagerBase::GetAudioInputDeviceDescriptions(
     AudioDeviceDescriptions* device_descriptions) {
   CHECK(GetTaskRunner()->BelongsToCurrentThread());
@@ skipping 19 matching lines @@
 }
 
 AudioOutputStream* AudioManagerBase::MakeAudioOutputStream(
     const AudioParameters& params,
     const std::string& device_id,
     const LogCallback& log_callback) {
   CHECK(GetTaskRunner()->BelongsToCurrentThread());
 
   if (!params.IsValid()) {
     DLOG(ERROR) << "Audio parameters are invalid";
-    return NULL;
+    return nullptr;
   }
 
   // Limit the number of audio streams opened. This is to prevent using
   // excessive resources for a large number of audio streams. More
   // importantly it prevents instability on certain systems.
   // See bug: http://crbug.com/30242.
-  if (num_output_streams_ >= max_num_output_streams_) {
+  if (output_stream_count() >= max_num_output_streams_) {
     DLOG(ERROR) << "Number of opened output audio streams "
-                << num_output_streams_
-                << " exceed the max allowed number "
+                << output_stream_count() << " exceed the max allowed number "
                 << max_num_output_streams_;
-    return NULL;
+    return nullptr;
   }
 
   AudioOutputStream* stream;
   switch (params.format()) {
     case AudioParameters::AUDIO_PCM_LINEAR:
       DCHECK(AudioDeviceDescription::IsDefaultDevice(device_id))
           << "AUDIO_PCM_LINEAR supports only the default device.";
       stream = MakeLinearOutputStream(params, log_callback);
       break;
     case AudioParameters::AUDIO_PCM_LOW_LATENCY:
       stream = MakeLowLatencyOutputStream(params, device_id, log_callback);
       break;
     case AudioParameters::AUDIO_BITSTREAM_AC3:
     case AudioParameters::AUDIO_BITSTREAM_EAC3:
       // TODO(tsunghung): create passthrough output stream.
       NOTREACHED();
       stream = nullptr;
       break;
     case AudioParameters::AUDIO_FAKE:
       stream = FakeAudioOutputStream::MakeFakeStream(this, params);
       break;
     default:
-      stream = NULL;
+      stream = nullptr;
       break;
   }
 
   if (stream) {
-    ++num_output_streams_;
+    output_streams_.insert(stream);
+
+    // Debug recording is enabled if the file name is non-empty. If so, also
+    // enable it on the new stream.
+    if (!debug_recording_base_file_name_.empty()) {
+      stream->EnableDebugRecording(GetDebugRecordingFileNameWithExtensions(
+          debug_recording_base_file_name_));
+    }
   }
 
   return stream;
 }
 
 AudioInputStream* AudioManagerBase::MakeAudioInputStream(
     const AudioParameters& params,
     const std::string& device_id,
     const LogCallback& log_callback) {
   CHECK(GetTaskRunner()->BelongsToCurrentThread());
@@ skipping 115 matching lines @@
     AudioDeviceNames* device_names) {
 }
 
 void AudioManagerBase::GetAudioOutputDeviceNames(
     AudioDeviceNames* device_names) {
 }
 
 void AudioManagerBase::ReleaseOutputStream(AudioOutputStream* stream) {
   CHECK(GetTaskRunner()->BelongsToCurrentThread());
   DCHECK(stream);
-  CHECK_GT(num_output_streams_, 0);
-  // TODO(xians) : Have a clearer destruction path for the AudioOutputStream.
+  stream->DisableDebugRecording();
+  // TODO(grunell): Have a clearer destruction path for the AudioOutputStream.
   // For example, pass the ownership to AudioManager so it can delete the
   // streams.
-  --num_output_streams_;
+  CHECK_EQ(1u, output_streams_.erase(stream));
   delete stream;
 }
 
 void AudioManagerBase::ReleaseInputStream(AudioInputStream* stream) {
   CHECK(GetTaskRunner()->BelongsToCurrentThread());
   DCHECK(stream);
-  // TODO(xians) : Have a clearer destruction path for the AudioInputStream.
+  // TODO(grunell): Have a clearer destruction path for the AudioInputStream.
   CHECK_EQ(1u, input_streams_.erase(stream));
   delete stream;
 }
 
 void AudioManagerBase::Shutdown() {
   DCHECK(GetTaskRunner()->BelongsToCurrentThread());
 
   // Close all output streams.
   output_dispatchers_.clear();
 
@@ skipping 90 matching lines @@
     return buffer_size;
 
   return 0;
 }
 
 std::unique_ptr<AudioLog> AudioManagerBase::CreateAudioLog(
     AudioLogFactory::AudioComponent component) {
   return audio_log_factory_->CreateAudioLog(component);
 }
 
+std::unique_ptr<AudioFileWriter> AudioManagerBase::CreateAudioFileWriter(
+    const AudioParameters& params) {
+  return create_audio_file_writer_callback_.Run(params);
+}
+
+void AudioManagerBase::EnableOutputDebugRecording(
+    const base::FilePath& base_file_name) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  for (auto it : output_streams_) {
+    it->EnableDebugRecording(
+        GetDebugRecordingFileNameWithExtensions(base_file_name));
+  }
+  debug_recording_base_file_name_ = base_file_name;
+}
+
+void AudioManagerBase::DisableOutputDebugRecording() {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  for (auto it : output_streams_)
+    it->DisableDebugRecording();
+  debug_recording_base_file_name_.clear();
+}
+
+#if defined(OS_WIN)
+#define IntToStringType base::IntToString16
+#else
+#define IntToStringType base::IntToString
+#endif
+
+base::FilePath AudioManagerBase::GetDebugRecordingFileNameWithExtensions(
+    const base::FilePath& file_name) {
+  return file_name.AddExtension("output").AddExtension(
+      IntToStringType(next_filename_id_++));
+}
+
 void AudioManagerBase::SetMaxStreamCountForTesting(int max_input,
                                                    int max_output) {
   max_num_output_streams_ = max_output;
   max_num_input_streams_ = max_input;
 }
 
 }  // namespace media