Implement writing mic audio input data to file for debugging purposes.

content/browser/renderer_host/media/audio_input_renderer_host.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 "content/browser/renderer_host/media/audio_input_renderer_host.h"
 
 #include "base/bind.h"
+#include "base/files/file.h"
+#include "base/memory/ref_counted.h"
 #include "base/memory/shared_memory.h"
 #include "base/metrics/histogram.h"
 #include "base/numerics/safe_math.h"
 #include "base/process/process.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
 #include "content/browser/media/capture/web_contents_audio_input_stream.h"
 #include "content/browser/media/capture/web_contents_capture_util.h"
 #include "content/browser/media/media_internals.h"
+#include "content/browser/media/webrtc_internals.h"
+#include "content/browser/renderer_host/media/audio_input_debug_writer.h"
 #include "content/browser/renderer_host/media/audio_input_device_manager.h"
 #include "content/browser/renderer_host/media/audio_input_sync_writer.h"
 #include "content/browser/renderer_host/media/media_stream_manager.h"
+#include "content/public/browser/render_process_host.h"
 #include "media/audio/audio_manager_base.h"
 #include "media/base/audio_bus.h"
 
+namespace content {
+
 namespace {
 
+const char kDebugRecordingFileNameAddition[] = "source_input";
+const char kDebugRecordingFileNameExtension[] = "pcm";
+
 void LogMessage(int stream_id, const std::string& msg, bool add_prefix) {
   std::ostringstream oss;
   oss << "[stream_id=" << stream_id << "] ";
   if (add_prefix)
     oss << "AIRH::";
   oss << msg;
   content::MediaStreamManager::SendMessageToNativeLog(oss.str());
   DVLOG(1) << oss.str();
 }
 
+base::File CreateDebugRecordingFile(base::FilePath file_path) {
+  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  base::File recording_file(
+      file_path, base::File::FLAG_OPEN_ALWAYS | base::File::FLAG_APPEND);
+  PLOG_IF(ERROR, !recording_file.IsValid())
+      << "Could not open debug recording file, error="
+      << recording_file.error_details();
+  return recording_file.Pass();
+}
+
+void CloseFile(base::File file) {
+  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  // |file| must be closed and destroyed on FILE thread.
+}
+
+void DeleteInputDebugWriterOnFileThread(
+    scoped_ptr<AudioInputDebugWriter> writer) {
+  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  // |writer| must be closed and destroyed on FILE thread.
+}
+
 }  // namespace
 
-namespace content {
-
 struct AudioInputRendererHost::AudioEntry {
   AudioEntry();
   ~AudioEntry();
 
   // The AudioInputController that manages the audio input stream.
   scoped_refptr<media::AudioInputController> controller;
 
   // The audio input stream ID in the render view.
   int stream_id;
 
   // Shared memory for transmission of the audio data. It has
   // |shared_memory_segment_count| equal lengthed segments.
   base::SharedMemory shared_memory;
   int shared_memory_segment_count;
 
   // The synchronous writer to be used by the controller. We have the
   // ownership of the writer.
   scoped_ptr<media::AudioInputController::SyncWriter> writer;
 
+  // Must be deleted on the file thread. Must be posted for deletion and nulled
+  // before the AudioEntry is deleted.
+  scoped_ptr<AudioInputDebugWriter> input_debug_writer;
+
   // Set to true after we called Close() for the controller.
   bool pending_close;
 
   // If this entry's layout has a keyboard mic channel.
-  bool has_keyboard_mic_;
+  bool has_keyboard_mic;
 };
 
 AudioInputRendererHost::AudioEntry::AudioEntry()
     : stream_id(0),
       shared_memory_segment_count(0),
       pending_close(false),
-      has_keyboard_mic_(false) {
+      has_keyboard_mic(false) {
 }
 
-AudioInputRendererHost::AudioEntry::~AudioEntry() {}
+AudioInputRendererHost::AudioEntry::~AudioEntry() {
+  DCHECK(!input_debug_writer.get());
+}
 
 AudioInputRendererHost::AudioInputRendererHost(
     int render_process_id,
+    RenderProcessHost* render_process_host,
     media::AudioManager* audio_manager,
     MediaStreamManager* media_stream_manager,
     AudioMirroringManager* audio_mirroring_manager,
     media::UserInputMonitor* user_input_monitor)
     : BrowserMessageFilter(AudioMsgStart),
       render_process_id_(render_process_id),
+      render_process_host_(render_process_host),

[nasko, 2015/08/19 22:04:15]

Why pass the full RenderProcessHost object? It is only used to get an ID and it
already has an immutable ID, regardless of which underlying OS process is
associated with it.

[Henrik Grunell, 2015/08/20 07:26:18]

Actually, I think it's better to get the pid in RPHI instead of here so I did
that removed this ptr.

[nasko, 2015/08/20 19:08:56]

What happens if the process crashes though? The RPH will stay the same, but the
underlying process will be different next time it is used, so the PID will
change.

[Henrik Grunell, 2015/08/20 20:03:49]

Each time the recording is enabled it constructs the filename including getting
the pid. So it will get the current correct pid. (See RPH)

[nasko, 2015/08/20 20:56:13]

Do we stop recording if the renderer process dies? I don't see it in the diff
here and it isn't obvious that we do.

[Henrik Grunell, 2015/08/21 13:51:03]

Yes, then the channel closes and in AudioInputRendererHost::OnChannelClosing all
entries are deleted, i.e. all streams are closed and deleted which stops the
recording.

       audio_manager_(audio_manager),
       media_stream_manager_(media_stream_manager),
       audio_mirroring_manager_(audio_mirroring_manager),
       user_input_monitor_(user_input_monitor),
       audio_log_(MediaInternals::GetInstance()->CreateAudioLog(
-          media::AudioLogFactory::AUDIO_INPUT_CONTROLLER)) {}
+          media::AudioLogFactory::AUDIO_INPUT_CONTROLLER)),
+      weak_factory_(this) {}
 
 AudioInputRendererHost::~AudioInputRendererHost() {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   DCHECK(audio_entries_.empty());
 }
 
+void AudioInputRendererHost::EnableDebugRecording(const base::FilePath& file) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  base::FilePath file_with_extensions =
+      GetDebugRecordingFilePathWithExtensions(file);
+  for (const auto& entry : audio_entries_)
+    EnabledDebugRecordingForId(file_with_extensions, entry.first);
+}
+
+void AudioInputRendererHost::DisableDebugRecording() {
+  for (const auto& entry : audio_entries_) {
+    entry.second->controller->DisableDebugRecording(
+        base::Bind(&AudioInputRendererHost::DeleteDebugWriter,
+                   this,
+                   entry.first));
+  }
+}
+
 void AudioInputRendererHost::OnChannelClosing() {
   // Since the IPC sender is gone, close all requested audio streams.
   DeleteEntries();
 }
 
 void AudioInputRendererHost::OnDestruct() const {
   BrowserThread::DeleteOnIOThread::Destruct(this);
 }
 
 void AudioInputRendererHost::OnCreated(
@@ skipping 299 matching lines @@
 
   if (!entry->controller.get()) {
     SendErrorMessage(stream_id, STREAM_CREATE_ERROR);
     MaybeUnregisterKeyboardMicStream(config);
     return;
   }
 
 #if defined(OS_CHROMEOS)
   if (config.params.channel_layout() ==
           media::CHANNEL_LAYOUT_STEREO_AND_KEYBOARD_MIC) {
-    entry->has_keyboard_mic_ = true;
+    entry->has_keyboard_mic = true;
   }
 #endif
 
   MediaStreamManager::SendMessageToNativeLog(oss.str());
   DVLOG(1) << oss.str();
 
   // Since the controller was created successfully, create an entry and add it
   // to the map.
   entry->stream_id = stream_id;
   audio_entries_.insert(std::make_pair(stream_id, entry.release()));
   audio_log_->OnCreated(stream_id, audio_params, device_id);
   MediaInternals::GetInstance()->SetWebContentsTitleForAudioLogEntry(
       stream_id, render_process_id_, render_frame_id, audio_log_.get());
+
+  BrowserThread::PostTask(
+      BrowserThread::UI,
+      FROM_HERE,
+      base::Bind(
+          &AudioInputRendererHost::MaybeEnableDebugRecordingForId,
+          this,
+          stream_id));
 }
 
 void AudioInputRendererHost::OnRecordStream(int stream_id) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   LogMessage(stream_id, "OnRecordStream", true);
 
   AudioEntry* entry = LookupById(stream_id);
   if (!entry) {
     SendErrorMessage(stream_id, INVALID_AUDIO_ENTRY);
     return;
@@ skipping 55 matching lines @@
     entry->pending_close = true;
     audio_log_->OnClosed(entry->stream_id);
   }
 }
 
 void AudioInputRendererHost::DeleteEntry(AudioEntry* entry) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   LogMessage(entry->stream_id, "DeleteEntry: stream is now closed", true);
 
 #if defined(OS_CHROMEOS)
-  if (entry->has_keyboard_mic_) {
+  if (entry->has_keyboard_mic) {
     media_stream_manager_->audio_input_device_manager()
         ->UnregisterKeyboardMicStream();
   }
 #endif
 
+  if (entry->input_debug_writer.get()) {
+    BrowserThread::PostTask(
+        BrowserThread::FILE,
+        FROM_HERE,
+        base::Bind(&DeleteInputDebugWriterOnFileThread,
+                   base::Passed(entry->input_debug_writer.Pass())));
+    entry->input_debug_writer.reset();

[tommi (sloooow) - chröme, 2015/08/19 20:06:34]

should be no need for this since you've already called Pass()

[Henrik Grunell, 2015/08/20 07:26:18]

Done.

+  }
+
   // Delete the entry when this method goes out of scope.
   scoped_ptr<AudioEntry> entry_deleter(entry);
 
   // Erase the entry from the map.
   audio_entries_.erase(entry->stream_id);
 }
 
 void AudioInputRendererHost::DeleteEntryOnError(AudioEntry* entry,
     ErrorCode error_code) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
@@ skipping 32 matching lines @@
     const AudioInputHostMsg_CreateStream_Config& config) {
 #if defined(OS_CHROMEOS)
   if (config.params.channel_layout() ==
       media::CHANNEL_LAYOUT_STEREO_AND_KEYBOARD_MIC) {
     media_stream_manager_->audio_input_device_manager()
         ->UnregisterKeyboardMicStream();
   }
 #endif
 }
 
+void AudioInputRendererHost::MaybeEnableDebugRecordingForId(int stream_id) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  if (WebRTCInternals::GetInstance()->IsAudioDebugRecordingsEnabled()) {
+    BrowserThread::PostTask(
+        BrowserThread::IO,
+        FROM_HERE,
+        base::Bind(
+            &AudioInputRendererHost::EnabledDebugRecordingForId,
+            this,
+            GetDebugRecordingFilePathWithExtensions(
+                WebRTCInternals::GetInstance()->
+                    GetAudioDebugRecordingsFilePath()),
+            stream_id));
+  }
+}
+
+#if defined(OS_WIN)
+#define IntToStringType base::IntToString16
+#else
+#define IntToStringType base::IntToString
+#endif
+
+base::FilePath AudioInputRendererHost::GetDebugRecordingFilePathWithExtensions(
+    const base::FilePath& file) {
+  return file.AddExtension(kDebugRecordingFileNameAddition).AddExtension(
+      IntToStringType(base::GetProcId(render_process_host_->GetHandle())));

[nasko, 2015/08/19 22:04:15]

This is not allowed. From what I can see in this file, this method is called on
the IO thread, where render_process_host_ cannot be accessed.

[Henrik Grunell, 2015/08/20 07:26:18]

As above comment, this is removed now.

+}
+
+void AudioInputRendererHost::EnabledDebugRecordingForId(
+    const base::FilePath& file,
+    int stream_id) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  BrowserThread::PostTaskAndReplyWithResult(
+      BrowserThread::FILE,
+      FROM_HERE,
+      base::Bind(
+          &CreateDebugRecordingFile,
+          file.AddExtension(IntToStringType(stream_id))
+              .AddExtension(
+                  FILE_PATH_LITERAL(kDebugRecordingFileNameExtension))),
+      base::Bind(
+          &AudioInputRendererHost::DoEnableDebugRecording,
+          weak_factory_.GetWeakPtr(),
+          stream_id));
+}
+
+#undef IntToStringType
+
+void AudioInputRendererHost::DoEnableDebugRecording(
+    int stream_id,
+    base::File file) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  if (!file.IsValid())
+    return;
+  AudioEntry* entry = LookupById(stream_id);
+  if (!entry) {
+    BrowserThread::PostTask(
+        BrowserThread::FILE,
+        FROM_HERE,
+        base::Bind(
+            &CloseFile,
+            Passed(file.Pass())));
+    return;
+  }
+  entry->input_debug_writer.reset(new AudioInputDebugWriter(file.Pass()));
+  entry->controller->EnableDebugRecording(entry->input_debug_writer.get());
+}
+
+void AudioInputRendererHost::DeleteDebugWriter(int stream_id) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  AudioEntry* entry = LookupById(stream_id);
+  if (!entry) {
+    // This happens if DisableDebugRecording is called right after
+    // DeleteEntries.
+    return;
+  }
+
+  if (entry->input_debug_writer.get()) {
+    BrowserThread::PostTask(
+        BrowserThread::FILE,
+        FROM_HERE,
+        base::Bind(&DeleteInputDebugWriterOnFileThread,
+                   base::Passed(entry->input_debug_writer.Pass())));
+    entry->input_debug_writer.reset();

[tommi (sloooow) - chröme, 2015/08/19 20:06:34]

ditto

[Henrik Grunell, 2015/08/20 07:26:18]

Done.

+  }
+}
+
 }  // namespace content