| // 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 |
| // 0 4 "RIFF" |
| // 4 4 <file length - 8> |
| // 8 4 "WAVE" |
| // 12 4 "fmt " |
| // 16 4 <length of the fmt data> (=16) |
| // 20 2 <WAVE file encoding tag> |
| // 22 2 <channels> |
| // 24 4 <sample rate> |
| // 28 4 <bytes per second> (sample rate * block align) |
| // 32 2 <block align> (channels * bits per sample / 8) |
| // 34 2 <bits per sample> |
| // 36 4 "data" |
| // 40 4 <sample data size(n)> |
| // 44 (n) <sample data> |
| |
| // We write 16 bit PCM only. |
| static const uint16_t kBytesPerSample = 2; |
| |
| static const uint32_t kWavHeaderSize = 44; |
| static const uint32_t kFmtChunkSize = 16; |
| // 4 bytes for ID + 4 bytes for size. |
| static const uint32_t kChunkHeaderSize = 8; |
| static const uint16_t kWavFormatPcm = 1; |
| |
| static const char kRiff[] = {'R', 'I', 'F', 'F'}; |
| static const char kWave[] = {'W', 'A', 'V', 'E'}; |
| static const char kFmt[] = {'f', 'm', 't', ' '}; |
| static const char kData[] = {'d', 'a', 't', 'a'}; |
| |
| typedef std::array<char, kWavHeaderSize> WavHeaderBuffer; |
| |
| class CharBufferWriter { |
| 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 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)); |
| } |
| |
| private: |
| char* buf_; |
| const int max_size_; |
| int size_; |
| |
| DISALLOW_COPY_AND_ASSIGN(CharBufferWriter); |
| }; |
| |
| // Writes Wave header to the specified address, there should be at least |
| // kWavHeaderSize bytes allocated for it. |
| void WriteWavHeader(WavHeaderBuffer* buf, |
| uint32_t channels, |
| uint32_t sample_rate, |
| uint64_t samples) { |
| // We'll need to add (kWavHeaderSize - kChunkHeaderSize) to payload to |
| // calculate Riff chunk size. |
| static const uint32_t kMaxBytesInPayload = |
| std::numeric_limits<uint32_t>::max() - |
| (kWavHeaderSize - kChunkHeaderSize); |
| const uint64_t bytes_in_payload_64 = samples * kBytesPerSample; |
| |
| // In case payload is too large and causes uint32_t overflow, we just specify |
| // the maximum possible value; all the payload above that count will be |
| // interpreted as garbage. |
| const uint32_t bytes_in_payload = bytes_in_payload_64 > kMaxBytesInPayload |
| ? kMaxBytesInPayload |
| : bytes_in_payload_64; |
| LOG_IF(WARNING, bytes_in_payload < bytes_in_payload_64) |
| << "Number of samples is too large and will be clipped by Wave header," |
| << " all the data above " << kMaxBytesInPayload |
| << " bytes will appear as junk"; |
| const uint32_t block_align = channels * kBytesPerSample; |
| const uint32_t byte_rate = channels * sample_rate * kBytesPerSample; |
| const uint32_t riff_chunk_size = |
| bytes_in_payload + kWavHeaderSize - kChunkHeaderSize; |
| |
| CharBufferWriter writer(&(*buf)[0], kWavHeaderSize); |
| |
| writer.Write(kRiff); |
| writer.WriteLE32(riff_chunk_size); |
| writer.Write(kWave); |
| writer.Write(kFmt); |
| writer.WriteLE32(kFmtChunkSize); |
| writer.WriteLE16(kWavFormatPcm); |
| writer.WriteLE16(channels); |
| 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 |
| // 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::SequencedTaskRunner> task_runner); |
| |
| ~AudioFileWriter(); |
| |
| // Write data from |data| to file. |
| void Write(const AudioBus* data); |
| |
| private: |
| 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_; |
| |
| SEQUENCE_CHECKER(sequence_checker_); |
| }; |
| |
| AudioDebugFileWriter::OnSequenceDeleter::OnSequenceDeleter() {} |
| |
| AudioDebugFileWriter::OnSequenceDeleter::OnSequenceDeleter( |
| AudioDebugFileWriter::OnSequenceDeleter&& other) = default; |
| |
| AudioDebugFileWriter::OnSequenceDeleter& |
| AudioDebugFileWriter::OnSequenceDeleter::operator=( |
| AudioDebugFileWriter::OnSequenceDeleter&&) = default; |
| |
| AudioDebugFileWriter::OnSequenceDeleter::OnSequenceDeleter( |
| scoped_refptr<base::SequencedTaskRunner> task_runner) |
| : task_runner_(std::move(task_runner)) {} |
| |
| AudioDebugFileWriter::OnSequenceDeleter::~OnSequenceDeleter() {} |
| |
| // 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::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) |
| : samples_(0), params_(params), interleaved_data_size_(0) { |
| DETACH_FROM_SEQUENCE(sequence_checker_); |
| } |
| |
| AudioDebugFileWriter::AudioFileWriter::~AudioFileWriter() { |
| DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_); |
| if (file_.IsValid()) |
| WriteHeader(); |
| } |
| |
| void AudioDebugFileWriter::AudioFileWriter::Write(const AudioBus* data) { |
| 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_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_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; |
| } |
| |
| // 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 AudioParameters& params) |
| : params_(params) { |
| client_sequence_checker_.DetachFromSequence(); |
| } |
| |
| AudioDebugFileWriter::~AudioDebugFileWriter() { |
| // |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_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<AudioBus> data) { |
| DCHECK(client_sequence_checker_.CalledOnValidSequence()); |
| if (!file_writer_) |
| return; |
| |
| // base::Unretained for |file_writer_| is safe, see the destructor. |
| 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_; |
| } |
| |
| const base::FilePath::CharType* AudioDebugFileWriter::GetFileNameExtension() { |
| return FILE_PATH_LITERAL("wav"); |
| } |
| |
| } // namspace media |