Make AudioDebugFileWriter::AudioFileWriter use a SequencedTaskRunner

media/audio/audio_debug_file_writer.cc

 // Copyright 2015 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_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 "base/threading/thread_restrictions.h"
 #include "media/base/audio_bus.h"
 #include "media/base/audio_sample_types.h"
 
 namespace media {
 
 namespace {
 
 // Windows WAVE format header
 // Byte order: Little-endian
 // Offset Length  Content
@@ skipping 102 matching lines @@
   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
-// thread. All the operations must be executed on |task_runner_|. Must be
-// destroyed on |task_runner_|.
+// thread. All the operations must be executed on a thread that has IO
+// permissions.
 class AudioDebugFileWriter::AudioFileWriter {
  public:
   static AudioFileWriterUniquePtr Create(
       const base::FilePath& file_name,
       const AudioParameters& params,
-      scoped_refptr<base::SingleThreadTaskRunner> task_runner);
+      scoped_refptr<base::SequencedTaskRunner> task_runner);
 
   ~AudioFileWriter();
 
   // Write data from |data| to file.
   void Write(const AudioBus* data);
 
-  scoped_refptr<base::SingleThreadTaskRunner> task_runner() {
-    return task_runner_;
-  }
-
  private:
-  AudioFileWriter(const AudioParameters& params,
-                  scoped_refptr<base::SingleThreadTaskRunner> task_runner);
+  AudioFileWriter(const AudioParameters& params);
 
   // 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_;
 
   // Audio parameters required to build wave header. Number of channels and
   // sample rate are used.
   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_;
+  SEQUENCE_CHECKER(sequence_checker_);
 };
 
-AudioDebugFileWriter::OnThreadDeleter::OnThreadDeleter() {}
+AudioDebugFileWriter::OnSequenceDeleter::OnSequenceDeleter() {}
 
-AudioDebugFileWriter::OnThreadDeleter::OnThreadDeleter(
-    const OnThreadDeleter& other)
+AudioDebugFileWriter::OnSequenceDeleter::OnSequenceDeleter(
+    const OnSequenceDeleter& other)
     : task_runner_(other.task_runner_) {}
 
-AudioDebugFileWriter::OnThreadDeleter::OnThreadDeleter(
-    scoped_refptr<base::SingleThreadTaskRunner> task_runner)
+AudioDebugFileWriter::OnSequenceDeleter::OnSequenceDeleter(
+    scoped_refptr<base::SequencedTaskRunner> task_runner)
     : task_runner_(task_runner) {}

[gab, 2017/05/18 20:38:17]

std::move(task_runner)

[Sébastien Marchand, 2017/05/18 21:24:25]

Done.

 
-AudioDebugFileWriter::OnThreadDeleter::~OnThreadDeleter() {}
+AudioDebugFileWriter::OnSequenceDeleter::~OnSequenceDeleter() {}
 
-// AudioFileWriter deleter. Inspired by
-// content::BrowserThread::DeleteOnFileThread.
-void AudioDebugFileWriter::OnThreadDeleter::operator()(
+// AudioFileWriter deleter.
+void AudioDebugFileWriter::OnSequenceDeleter::operator()(
     AudioDebugFileWriter::AudioFileWriter* ptr) const {
   if (!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 AudioParameters& params,
-    scoped_refptr<base::SingleThreadTaskRunner> task_runner) {
-  AudioFileWriterUniquePtr file_writer(new AudioFileWriter(params, task_runner),
-                                       OnThreadDeleter(task_runner));
+    scoped_refptr<base::SequencedTaskRunner> task_runner) {
+  AudioFileWriterUniquePtr file_writer(new AudioFileWriter(params),
+                                       OnSequenceDeleter(task_runner));
 
   // 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 AudioParameters& params,
-    scoped_refptr<base::SingleThreadTaskRunner> task_runner)
-    : samples_(0),
-      params_(params),
-      interleaved_data_size_(0),
-      task_runner_(std::move(task_runner)) {}
+    const AudioParameters& params)
+    : samples_(0), params_(params), interleaved_data_size_(0) {
+  DETACH_FROM_SEQUENCE(sequence_checker_);
+}
 
 AudioDebugFileWriter::AudioFileWriter::~AudioFileWriter() {
-  DCHECK(task_runner_->BelongsToCurrentThread());
+  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
   if (file_.IsValid())
     WriteHeader();
 }
 
 void AudioDebugFileWriter::AudioFileWriter::Write(const AudioBus* data) {
-  DCHECK(task_runner_->BelongsToCurrentThread());
+  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
   DCHECK_EQ(params_.channels(), data->channels());
   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<media::SignedInt16SampleTypeTraits>(
       data->frames(), 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(task_runner_->BelongsToCurrentThread());
+  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
   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(task_runner_->BelongsToCurrentThread());
+  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
+  base::ThreadRestrictions::AssertIOAllowed();
   DCHECK(!file_.IsValid());
 
   file_ = base::File(file_name,
                      base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
 
   if (file_.IsValid()) {
     WriteHeader();
     return;
   }
 
@@ skipping 52 matching lines @@
   // here, but it's fine: we can afford missing some data or scheduling some
   // no-op writes.
   return !!file_writer_;
 }
 
 const base::FilePath::CharType* AudioDebugFileWriter::GetFileNameExtension() {
   return FILE_PATH_LITERAL("wav");
 }
 
 }  // namspace media