Move AudioDebugFileWriter from content/ to media/.

media/audio/audio_debug_file_writer.cc

-// Copyright 2015 The Chromium Authors. All rights reserved.
+// Copyright 2017 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_debug_file_writer.h"
+#include "media/audio/audio_debug_file_writer.h"
 
 #include <stdint.h>
 #include <array>
 #include <utility>
 
+#include "base/bind.h"
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
 #include "base/sys_byteorder.h"
-#include "content/public/browser/browser_thread.h"
 #include "media/base/audio_bus.h"
 
-namespace content {
+namespace media {
 
 namespace {
 
 // Windows WAVE format header
 // Byte order: Little-endian
 // Offset Length  Content
 //  0      4     "RIFF"
 //  4      4     <file length - 8>
 //  8      4     "WAVE"
 // 12      4     "fmt "
@@ skipping 28 matching lines @@
  public:
   CharBufferWriter(char* buf, int max_size)
       : buf_(buf), max_size_(max_size), size_(0) {}
 
   void Write(const char* data, int data_size) {
     CHECK_LE(size_ + data_size, max_size_);
     memcpy(&buf_[size_], data, data_size);
     size_ += data_size;
   }
 
-  void Write(const char(&data)[4]) { Write(static_cast<const char*>(data), 4); }
+  void Write(const char (&data)[4]) {
+    Write(static_cast<const char*>(data), 4);
+  }
 
   void WriteLE16(uint16_t data) {
     uint16_t val = base::ByteSwapToLE16(data);
     Write(reinterpret_cast<const char*>(&val), sizeof(val));
   }
 
   void WriteLE32(uint32_t data) {
     uint32_t val = base::ByteSwapToLE32(data);
     Write(reinterpret_cast<const char*>(&val), sizeof(val));
   }
@@ skipping 46 matching lines @@
   writer.WriteLE32(sample_rate);
   writer.WriteLE32(byte_rate);
   writer.WriteLE16(block_align);
   writer.WriteLE16(kBytesPerSample * 8);
   writer.Write(kData);
   writer.WriteLE32(bytes_in_payload);
 }
 
 }  // namespace
 
 // Manages the debug recording file and writes to it. Can be created on any

[DaleCurtis, 2017/02/21 18:00:58]

Do we still need this inner class setup?

[Henrik Grunell, 2017/02/21 21:07:52]

I don't think that has changed because of the move, or am I missing something?

-// thread. All the operations must be executed on FILE thread. Must be destroyed
-// on FILE thread.
+// thread. All the operations must be executed on |task_runner_|. Must be
+// destroyed on |task_runner_|.
 class AudioDebugFileWriter::AudioFileWriter {
  public:
-  static AudioFileWriterUniquePtr Create(const base::FilePath& file_name,
-                                         const media::AudioParameters& params);
+  static AudioFileWriterUniquePtr Create(
+      const base::FilePath& file_name,
+      const AudioParameters& params,
+      scoped_refptr<base::SingleThreadTaskRunner> task_runner);
 
   ~AudioFileWriter();
 
   // Write data from |data| to file.
-  void Write(const media::AudioBus* data);
+  void Write(const AudioBus* data);
+
+  scoped_refptr<base::SingleThreadTaskRunner> task_runner() {
+    return task_runner_;
+  }
 
  private:
-  AudioFileWriter(const media::AudioParameters& params);
+  AudioFileWriter(const AudioParameters& params,
+                  scoped_refptr<base::SingleThreadTaskRunner> task_runner);
 
-  // Write wave header to file. Called on the FILE thread twice: on construction
+  // Write wave header to file. Called on the |task_runner_| twice: on
+  // construction
   // of AudioFileWriter size of the wave data is unknown, so the header is
   // written with zero sizes; then on destruction it is re-written with the
   // actual size info accumulated throughout the object lifetime.
   void WriteHeader();
 
   void CreateRecordingFile(const base::FilePath& file_name);
 
   // The file to write to.
   base::File file_;
 
   // Number of written samples.
   uint64_t samples_;
 
   // Input audio parameters required to build wave header.
-  const media::AudioParameters params_;
+  const AudioParameters params_;
 
   // Intermediate buffer to be written to file. Interleaved 16 bit audio data.
   std::unique_ptr<int16_t[]> interleaved_data_;
   int interleaved_data_size_;
+
+  // The task runner this class operates on.
+  scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
 };
 
+// AudioFileWriter deleter. Inspired by
+// content::BrowserThread::DeleteOnFileThread.
+void AudioDebugFileWriter::DeleteOnFileThread::operator()(
+    AudioFileWriter* ptr) const {
+  if (!ptr->task_runner()->DeleteSoon(FROM_HERE, ptr)) {
+#if defined(UNIT_TEST)
+    // Only logged under unit testing because leaks at shutdown
+    // are acceptable under normal circumstances.
+    LOG(ERROR) << "DeleteSoon failed for AudioDebugFileWriter::AudioFileWriter";
+#endif
+  }
+}
+
 // static
 AudioDebugFileWriter::AudioFileWriterUniquePtr
 AudioDebugFileWriter::AudioFileWriter::Create(
     const base::FilePath& file_name,
-    const media::AudioParameters& params) {
-  AudioFileWriterUniquePtr file_writer(new AudioFileWriter(params));
+    const AudioParameters& params,
+    scoped_refptr<base::SingleThreadTaskRunner> task_runner) {
+  AudioFileWriterUniquePtr file_writer(
+      new AudioFileWriter(params, task_runner));
 
-  // base::Unretained is safe, because destructor is called on FILE thread or on
-  // FILE message loop destruction.
-  BrowserThread::PostTask(
-      BrowserThread::FILE, FROM_HERE,
-      base::Bind(&AudioFileWriter::CreateRecordingFile,
-                 base::Unretained(file_writer.get()), file_name));
+  // base::Unretained is safe, because destructor is called on
+  // |task_runner|.
+  task_runner->PostTask(
+      FROM_HERE, base::Bind(&AudioFileWriter::CreateRecordingFile,
+                            base::Unretained(file_writer.get()), file_name));
   return file_writer;
 }
 
 AudioDebugFileWriter::AudioFileWriter::AudioFileWriter(
-    const media::AudioParameters& params)
-    : samples_(0), params_(params), interleaved_data_size_(0) {
+    const AudioParameters& params,
+    scoped_refptr<base::SingleThreadTaskRunner> task_runner)
+    : samples_(0),
+      params_(params),
+      interleaved_data_size_(0),
+      task_runner_(std::move(task_runner)) {
   DCHECK_EQ(params.bits_per_sample(), kBytesPerSample * 8);
 }
 
 AudioDebugFileWriter::AudioFileWriter::~AudioFileWriter() {
-  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  DCHECK(task_runner_->BelongsToCurrentThread());
   if (file_.IsValid())
     WriteHeader();
 }
 
-void AudioDebugFileWriter::AudioFileWriter::Write(
-    const media::AudioBus* data) {
-  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+void AudioDebugFileWriter::AudioFileWriter::Write(const AudioBus* data) {
+  DCHECK(task_runner_->BelongsToCurrentThread());
   if (!file_.IsValid())
     return;
 
   // Convert to 16 bit audio and write to file.
   int data_size = data->frames() * data->channels();
   if (!interleaved_data_ || interleaved_data_size_ < data_size) {
     interleaved_data_.reset(new int16_t[data_size]);
     interleaved_data_size_ = data_size;
   }
   samples_ += data_size;
   data->ToInterleaved(data->frames(), sizeof(interleaved_data_[0]),
                       interleaved_data_.get());
 
 #ifndef ARCH_CPU_LITTLE_ENDIAN
   static_assert(sizeof(interleaved_data_[0]) == sizeof(uint16_t),
                 "Only 2 bytes per channel is supported.");
   for (int i = 0; i < data_size; ++i)
     interleaved_data_[i] = base::ByteSwapToLE16(interleaved_data_[i]);
 #endif
 
   file_.WriteAtCurrentPos(reinterpret_cast<char*>(interleaved_data_.get()),
                           data_size * sizeof(interleaved_data_[0]));
 }
 
 void AudioDebugFileWriter::AudioFileWriter::WriteHeader() {
-  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  DCHECK(task_runner_->BelongsToCurrentThread());
   if (!file_.IsValid())
     return;
   WavHeaderBuffer buf;
   WriteWavHeader(&buf, params_.channels(), params_.sample_rate(), samples_);
   file_.Write(0, &buf[0], kWavHeaderSize);
 
   // Write() does not move the cursor if file is not in APPEND mode; Seek() so
   // that the header is not overwritten by the following writes.
   file_.Seek(base::File::FROM_BEGIN, kWavHeaderSize);
 }
 
 void AudioDebugFileWriter::AudioFileWriter::CreateRecordingFile(
     const base::FilePath& file_name) {
-  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  DCHECK(task_runner_->BelongsToCurrentThread());
   DCHECK(!file_.IsValid());
 
   file_ = base::File(file_name,
                      base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
 
   if (file_.IsValid()) {
     WriteHeader();
     return;
   }
 
   // Note that we do not inform AudioDebugFileWriter that the file creation
   // fails, so it will continue to post data to be recorded, which won't
   // be written to the file. This also won't be reflected in WillWrite(). It's
   // fine, because this situation is rare, and all the posting is expected to
   // happen in case of success anyways. This allows us to save on thread hops
   // for error reporting and to avoid dealing with lifetime issues. It also
   // means file_.IsValid() should always be checked before issuing writes to it.
   PLOG(ERROR) << "Could not open debug recording file, error="
               << file_.error_details();
 }
 
 AudioDebugFileWriter::AudioDebugFileWriter(
-    const media::AudioParameters& params)
-    : params_(params) {
+    const AudioParameters& params,
+    scoped_refptr<base::SingleThreadTaskRunner> file_task_runner)
+    : params_(params), file_task_runner_(std::move(file_task_runner)) {
   client_sequence_checker_.DetachFromSequence();
 }
 
 AudioDebugFileWriter::~AudioDebugFileWriter() {
-  // |file_writer_| will be deleted on FILE thread.
+  // |file_writer_| will be deleted on |task_runner_|.
 }
 
 void AudioDebugFileWriter::Start(const base::FilePath& file_name) {
   DCHECK(client_sequence_checker_.CalledOnValidSequence());
   DCHECK(!file_writer_);
-  file_writer_ = AudioFileWriter::Create(file_name, params_);
+  file_writer_ = AudioFileWriter::Create(file_name, params_, file_task_runner_);
 }
 
 void AudioDebugFileWriter::Stop() {
   DCHECK(client_sequence_checker_.CalledOnValidSequence());
   // |file_writer_| is deleted on FILE thread.
   file_writer_.reset();
   client_sequence_checker_.DetachFromSequence();
 }
 
-void AudioDebugFileWriter::Write(std::unique_ptr<media::AudioBus> data) {
+void AudioDebugFileWriter::Write(std::unique_ptr<AudioBus> data) {
   DCHECK(client_sequence_checker_.CalledOnValidSequence());
   if (!file_writer_)
     return;
 
   // base::Unretained for |file_writer_| is safe, see the destructor.
-  BrowserThread::PostTask(
-      BrowserThread::FILE, FROM_HERE,
+  file_task_runner_->PostTask(
+      FROM_HERE,
       // Callback takes ownership of |data|:
       base::Bind(&AudioFileWriter::Write, base::Unretained(file_writer_.get()),
                  base::Owned(data.release())));
 }
 
 bool AudioDebugFileWriter::WillWrite() {
   // Note that if this is called from any place other than
   // |client_sequence_checker_| then there is a data race here, but it's fine,
   // because Write() will check for |file_writer_|. So, we are not very precise
   // here, but it's fine: we can afford missing some data or scheduling some
   // no-op writes.
   return !!file_writer_;
 }
 
-}  // namspace content
+}  // namspace media