From c2ae4c8a37ca4460787cd5718356b0c01b8ba470 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Per=20=C3=85hgren?= Date: Wed, 20 Jan 2021 15:42:13 +0100 Subject: [PATCH] Allow separate dump sets for the data dumper in APM MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This CL allows separate dump sets to be used when dumping internal APM data using audioproc_f, opening up for reducing the amount of data to be dumped. Bug: webrtc:5298 Change-Id: I8286933ceed10db074f2064414cc08e8b12653fa Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/196089 Commit-Queue: Per Åhgren Reviewed-by: Gustaf Ullberg Cr-Commit-Position: refs/heads/master@{#33047} --- modules/audio_processing/BUILD.gn | 1 + .../logging/apm_data_dumper.cc | 1 + .../logging/apm_data_dumper.h | 146 +++++++++++++++--- .../test/audio_processing_simulator.cc | 3 + .../test/audio_processing_simulator.h | 1 + .../test/audioproc_float_impl.cc | 7 + 6 files changed, 139 insertions(+), 20 deletions(-) diff --git a/modules/audio_processing/BUILD.gn b/modules/audio_processing/BUILD.gn index f2f28a7bd6..529327e88a 100644 --- a/modules/audio_processing/BUILD.gn +++ b/modules/audio_processing/BUILD.gn @@ -291,6 +291,7 @@ rtc_library("apm_logging") { "../../rtc_base:checks", "../../rtc_base:rtc_base_approved", ] + absl_deps = [ "//third_party/abseil-cpp/absl/types:optional" ] defines = [] } diff --git a/modules/audio_processing/logging/apm_data_dumper.cc b/modules/audio_processing/logging/apm_data_dumper.cc index 917df60c9c..445248b0bf 100644 --- a/modules/audio_processing/logging/apm_data_dumper.cc +++ b/modules/audio_processing/logging/apm_data_dumper.cc @@ -61,6 +61,7 @@ ApmDataDumper::~ApmDataDumper() = default; #if WEBRTC_APM_DEBUG_DUMP == 1 bool ApmDataDumper::recording_activated_ = false; +absl::optional ApmDataDumper::dump_set_to_use_; char ApmDataDumper::output_dir_[] = ""; FILE* ApmDataDumper::GetRawFile(const char* name) { diff --git a/modules/audio_processing/logging/apm_data_dumper.h b/modules/audio_processing/logging/apm_data_dumper.h index 1824fdd2a9..6d32b32ab5 100644 --- a/modules/audio_processing/logging/apm_data_dumper.h +++ b/modules/audio_processing/logging/apm_data_dumper.h @@ -21,6 +21,7 @@ #include #endif +#include "absl/types/optional.h" #include "api/array_view.h" #if WEBRTC_APM_DEBUG_DUMP == 1 #include "common_audio/wav_file.h" @@ -64,6 +65,18 @@ class ApmDataDumper { #endif } + // Default dump set. + static constexpr size_t kDefaultDumpSet = 0; + + // Specifies what dump set to use. All dump commands with a different dump set + // than the one specified will be discarded. If not specificed, all dump sets + // will be used. + static void SetDumpSetToUse(int dump_set_to_use) { +#if WEBRTC_APM_DEBUG_DUMP == 1 + dump_set_to_use_ = dump_set_to_use; +#endif + } + // Set an optional output directory. static void SetOutputDirectory(const std::string& output_dir) { #if WEBRTC_APM_DEBUG_DUMP == 1 @@ -82,8 +95,11 @@ class ApmDataDumper { // Methods for performing dumping of data of various types into // various formats. - void DumpRaw(const char* name, double v) { + void DumpRaw(const char* name, double v, int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(&v, sizeof(v), 1, file); @@ -91,8 +107,14 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, size_t v_length, const double* v) { + void DumpRaw(const char* name, + size_t v_length, + const double* v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(v, sizeof(v[0]), v_length, file); @@ -100,16 +122,24 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, rtc::ArrayView v) { + void DumpRaw(const char* name, + rtc::ArrayView v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpRaw(name, v.size(), v.data()); } #endif } - void DumpRaw(const char* name, float v) { + void DumpRaw(const char* name, float v, int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(&v, sizeof(v), 1, file); @@ -117,8 +147,14 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, size_t v_length, const float* v) { + void DumpRaw(const char* name, + size_t v_length, + const float* v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(v, sizeof(v[0]), v_length, file); @@ -126,24 +162,38 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, rtc::ArrayView v) { + void DumpRaw(const char* name, + rtc::ArrayView v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpRaw(name, v.size(), v.data()); } #endif } - void DumpRaw(const char* name, bool v) { + void DumpRaw(const char* name, bool v, int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpRaw(name, static_cast(v)); } #endif } - void DumpRaw(const char* name, size_t v_length, const bool* v) { + void DumpRaw(const char* name, + size_t v_length, + const bool* v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); for (size_t k = 0; k < v_length; ++k) { @@ -154,16 +204,24 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, rtc::ArrayView v) { + void DumpRaw(const char* name, + rtc::ArrayView v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpRaw(name, v.size(), v.data()); } #endif } - void DumpRaw(const char* name, int16_t v) { + void DumpRaw(const char* name, int16_t v, int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(&v, sizeof(v), 1, file); @@ -171,8 +229,14 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, size_t v_length, const int16_t* v) { + void DumpRaw(const char* name, + size_t v_length, + const int16_t* v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(v, sizeof(v[0]), v_length, file); @@ -180,16 +244,24 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, rtc::ArrayView v) { + void DumpRaw(const char* name, + rtc::ArrayView v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpRaw(name, v.size(), v.data()); } #endif } - void DumpRaw(const char* name, int32_t v) { + void DumpRaw(const char* name, int32_t v, int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(&v, sizeof(v), 1, file); @@ -197,8 +269,14 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, size_t v_length, const int32_t* v) { + void DumpRaw(const char* name, + size_t v_length, + const int32_t* v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(v, sizeof(v[0]), v_length, file); @@ -206,8 +284,11 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, size_t v) { + void DumpRaw(const char* name, size_t v, int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(&v, sizeof(v), 1, file); @@ -215,8 +296,14 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, size_t v_length, const size_t* v) { + void DumpRaw(const char* name, + size_t v_length, + const size_t* v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { FILE* file = GetRawFile(name); fwrite(v, sizeof(v[0]), v_length, file); @@ -224,16 +311,26 @@ class ApmDataDumper { #endif } - void DumpRaw(const char* name, rtc::ArrayView v) { + void DumpRaw(const char* name, + rtc::ArrayView v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpRaw(name, v.size(), v.data()); } #endif } - void DumpRaw(const char* name, rtc::ArrayView v) { + void DumpRaw(const char* name, + rtc::ArrayView v, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + DumpRaw(name, v.size(), v.data()); #endif } @@ -242,8 +339,12 @@ class ApmDataDumper { size_t v_length, const float* v, int sample_rate_hz, - int num_channels) { + int num_channels, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { WavWriter* file = GetWavFile(name, sample_rate_hz, num_channels, WavFile::SampleFormat::kFloat); @@ -255,8 +356,12 @@ class ApmDataDumper { void DumpWav(const char* name, rtc::ArrayView v, int sample_rate_hz, - int num_channels) { + int num_channels, + int dump_set = kDefaultDumpSet) { #if WEBRTC_APM_DEBUG_DUMP == 1 + if (dump_set_to_use_ && *dump_set_to_use_ != dump_set) + return; + if (recording_activated_) { DumpWav(name, v.size(), v.data(), sample_rate_hz, num_channels); } @@ -266,6 +371,7 @@ class ApmDataDumper { private: #if WEBRTC_APM_DEBUG_DUMP == 1 static bool recording_activated_; + static absl::optional dump_set_to_use_; static constexpr size_t kOutputDirMaxLength = 1024; static char output_dir_[kOutputDirMaxLength]; const int instance_index_; diff --git a/modules/audio_processing/test/audio_processing_simulator.cc b/modules/audio_processing/test/audio_processing_simulator.cc index 1c8e0a5ba9..7497bf21ed 100644 --- a/modules/audio_processing/test/audio_processing_simulator.cc +++ b/modules/audio_processing/test/audio_processing_simulator.cc @@ -123,6 +123,9 @@ AudioProcessingSimulator::AudioProcessingSimulator( worker_queue_("file_writer_task_queue") { RTC_CHECK(!settings_.dump_internal_data || WEBRTC_APM_DEBUG_DUMP == 1); ApmDataDumper::SetActivated(settings_.dump_internal_data); + if (settings_.dump_set_to_use) { + ApmDataDumper::SetDumpSetToUse(*settings_.dump_set_to_use); + } if (settings_.dump_internal_data_output_dir.has_value()) { ApmDataDumper::SetOutputDirectory( settings_.dump_internal_data_output_dir.value()); diff --git a/modules/audio_processing/test/audio_processing_simulator.h b/modules/audio_processing/test/audio_processing_simulator.h index 84f8ce41e5..08ac6fe526 100644 --- a/modules/audio_processing/test/audio_processing_simulator.h +++ b/modules/audio_processing/test/audio_processing_simulator.h @@ -138,6 +138,7 @@ struct SimulationSettings { bool dump_internal_data = false; WavFile::SampleFormat wav_output_format = WavFile::SampleFormat::kInt16; absl::optional dump_internal_data_output_dir; + absl::optional dump_set_to_use; absl::optional call_order_input_filename; absl::optional call_order_output_filename; absl::optional aec_settings_filename; diff --git a/modules/audio_processing/test/audioproc_float_impl.cc b/modules/audio_processing/test/audioproc_float_impl.cc index 2002e2efea..2d93e5f344 100644 --- a/modules/audio_processing/test/audioproc_float_impl.cc +++ b/modules/audio_processing/test/audioproc_float_impl.cc @@ -247,6 +247,11 @@ ABSL_FLAG(std::string, dump_data_output_dir, "", "Internal data dump output directory"); +ABSL_FLAG(int, + dump_set_to_use, + kParameterNotSpecifiedValue, + "Specifies the dump set to use (if not all the dump sets will " + "be used"); ABSL_FLAG(bool, float_wav_output, false, @@ -436,6 +441,8 @@ SimulationSettings CreateSettings() { settings.dump_internal_data = absl::GetFlag(FLAGS_dump_data); SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_data_output_dir), &settings.dump_internal_data_output_dir); + SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_set_to_use), + &settings.dump_set_to_use); settings.wav_output_format = absl::GetFlag(FLAGS_float_wav_output) ? WavFile::SampleFormat::kFloat : WavFile::SampleFormat::kInt16;