blob: f8d3d92971c93bd5570e7654e7728279c358d71b [file] [log] [blame]
andrew@webrtc.org08df9b22014-12-16 20:57:15 +00001/*
2 * Copyright (c) 2014 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Per Åhgren6ee75fd2019-04-26 11:33:37 +020011#include "modules/audio_processing/test/audioproc_float_impl.h"
12
Ivo Creusen2cb41052018-03-15 12:22:52 +010013#include <string.h>
14
aluebsb0ad43b2015-11-20 00:11:53 -080015#include <iostream>
kwiberg62eaacf2016-02-17 06:39:05 -080016#include <memory>
Ivo Creusen2cb41052018-03-15 12:22:52 +010017#include <string>
18#include <utility>
Alessio Bazzica68170382018-11-20 12:27:20 +010019#include <vector>
andrew@webrtc.org08df9b22014-12-16 20:57:15 +000020
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020021#include "absl/flags/flag.h"
22#include "absl/flags/parse.h"
Alessio Bazzica68170382018-11-20 12:27:20 +010023#include "absl/strings/string_view.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020024#include "modules/audio_processing/include/audio_processing.h"
25#include "modules/audio_processing/test/aec_dump_based_simulator.h"
26#include "modules/audio_processing/test/audio_processing_simulator.h"
27#include "modules/audio_processing/test/wav_based_simulator.h"
Alessio Bazzica68170382018-11-20 12:27:20 +010028#include "rtc_base/checks.h"
Alessio Bazzica68170382018-11-20 12:27:20 +010029#include "rtc_base/strings/string_builder.h"
saza0cf99ce2020-04-01 17:42:01 +020030#include "system_wrappers/include/field_trial.h"
andrew@webrtc.org08df9b22014-12-16 20:57:15 +000031
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020032constexpr int kParameterNotSpecifiedValue = -10000;
33
34ABSL_FLAG(std::string, dump_input, "", "Aec dump input filename");
35ABSL_FLAG(std::string, dump_output, "", "Aec dump output filename");
36ABSL_FLAG(std::string, i, "", "Forward stream input wav filename");
37ABSL_FLAG(std::string, o, "", "Forward stream output wav filename");
38ABSL_FLAG(std::string, ri, "", "Reverse stream input wav filename");
39ABSL_FLAG(std::string, ro, "", "Reverse stream output wav filename");
40ABSL_FLAG(std::string,
41 artificial_nearend,
42 "",
43 "Artificial nearend wav filename");
Per Åhgrenc20a19c2019-11-13 11:12:29 +010044ABSL_FLAG(std::string, linear_aec_output, "", "Linear AEC output wav filename");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020045ABSL_FLAG(int,
46 output_num_channels,
47 kParameterNotSpecifiedValue,
48 "Number of forward stream output channels");
49ABSL_FLAG(int,
50 reverse_output_num_channels,
51 kParameterNotSpecifiedValue,
52 "Number of Reverse stream output channels");
53ABSL_FLAG(int,
54 output_sample_rate_hz,
55 kParameterNotSpecifiedValue,
56 "Forward stream output sample rate in Hz");
57ABSL_FLAG(int,
58 reverse_output_sample_rate_hz,
59 kParameterNotSpecifiedValue,
60 "Reverse stream output sample rate in Hz");
61ABSL_FLAG(bool,
62 fixed_interface,
63 false,
64 "Use the fixed interface when operating on wav files");
65ABSL_FLAG(int,
66 aec,
67 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +010068 "Activate (1) or deactivate (0) the echo canceller");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020069ABSL_FLAG(int,
70 aecm,
71 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +010072 "Activate (1) or deactivate (0) the mobile echo controller");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020073ABSL_FLAG(int,
74 ed,
75 kParameterNotSpecifiedValue,
76 "Activate (1) or deactivate (0) the residual echo detector");
77ABSL_FLAG(std::string,
78 ed_graph,
79 "",
80 "Output filename for graph of echo likelihood");
81ABSL_FLAG(int,
82 agc,
83 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +010084 "Activate (1) or deactivate (0) the AGC");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020085ABSL_FLAG(int,
86 agc2,
87 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +010088 "Activate (1) or deactivate (0) the AGC2");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020089ABSL_FLAG(int,
90 pre_amplifier,
91 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +010092 "Activate (1) or deactivate (0) the pre amplifier");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020093ABSL_FLAG(int,
94 hpf,
95 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +010096 "Activate (1) or deactivate (0) the high-pass filter");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020097ABSL_FLAG(int,
98 ns,
99 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100100 "Activate (1) or deactivate (0) the noise suppressor");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200101ABSL_FLAG(int,
102 ts,
103 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100104 "Activate (1), deactivate (0) or activate the transient suppressor "
105 "with continuous key events (2)");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200106ABSL_FLAG(int,
Per Åhgren0695df12020-01-13 14:43:13 +0100107 analog_agc,
108 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100109 "Activate (1) or deactivate (0) the analog AGC");
Per Åhgren0695df12020-01-13 14:43:13 +0100110ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200111 vad,
112 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100113 "Activate (1) or deactivate (0) the voice activity detector");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200114ABSL_FLAG(int,
115 le,
116 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100117 "Activate (1) or deactivate (0) the level estimator");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200118ABSL_FLAG(bool,
119 all_default,
120 false,
121 "Activate all of the default components (will be overridden by any "
122 "other settings)");
123ABSL_FLAG(int,
Per Åhgren0695df12020-01-13 14:43:13 +0100124 analog_agc_disable_digital_adaptive,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200125 kParameterNotSpecifiedValue,
126 "Force-deactivate (1) digital adaptation in "
127 "experimental AGC. Digital adaptation is active by default (0).");
128ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200129 agc_mode,
130 kParameterNotSpecifiedValue,
131 "Specify the AGC mode (0-2)");
132ABSL_FLAG(int,
133 agc_target_level,
134 kParameterNotSpecifiedValue,
135 "Specify the AGC target level (0-31)");
136ABSL_FLAG(int,
137 agc_limiter,
138 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100139 "Activate (1) or deactivate (0) the level estimator");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200140ABSL_FLAG(int,
141 agc_compression_gain,
142 kParameterNotSpecifiedValue,
143 "Specify the AGC compression gain (0-90)");
144ABSL_FLAG(int,
145 agc2_enable_adaptive_gain,
146 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100147 "Activate (1) or deactivate (0) the AGC2 adaptive gain");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200148ABSL_FLAG(float,
149 agc2_fixed_gain_db,
150 kParameterNotSpecifiedValue,
151 "AGC2 fixed gain (dB) to apply");
152ABSL_FLAG(std::string,
153 agc2_adaptive_level_estimator,
154 "RMS",
155 "AGC2 adaptive digital level estimator to use [RMS, peak]");
156ABSL_FLAG(float,
157 pre_amplifier_gain_factor,
158 kParameterNotSpecifiedValue,
159 "Pre-amplifier gain factor (linear) to apply");
160ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200161 ns_level,
162 kParameterNotSpecifiedValue,
163 "Specify the NS level (0-3)");
164ABSL_FLAG(int,
Per Åhgren2e8e1c62019-12-20 00:42:22 +0100165 ns_analysis_on_linear_aec_output,
166 kParameterNotSpecifiedValue,
167 "Specifies whether the noise suppression analysis is done on the "
168 "linear AEC output");
169ABSL_FLAG(int,
Per Åhgrenfcbe4072019-09-15 00:27:58 +0200170 maximum_internal_processing_rate,
171 kParameterNotSpecifiedValue,
172 "Set a maximum internal processing rate (32000 or 48000) to override "
173 "the default rate");
174ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200175 stream_delay,
176 kParameterNotSpecifiedValue,
177 "Specify the stream delay in ms to use");
178ABSL_FLAG(int,
179 use_stream_delay,
180 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100181 "Activate (1) or deactivate (0) reporting the stream delay");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200182ABSL_FLAG(int,
183 stream_drift_samples,
184 kParameterNotSpecifiedValue,
185 "Specify the number of stream drift samples to use");
186ABSL_FLAG(int, initial_mic_level, 100, "Initial mic level (0-255)");
187ABSL_FLAG(int,
188 simulate_mic_gain,
189 0,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100190 "Activate (1) or deactivate (0) the analog mic gain simulation");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200191ABSL_FLAG(int,
Per Åhgrene14cb992019-11-27 09:34:22 +0100192 multi_channel_render,
Sam Zackrissonfeee1e42019-09-20 07:50:35 +0200193 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100194 "Activate (1) or deactivate (0) multi-channel render processing in "
Per Åhgrene14cb992019-11-27 09:34:22 +0100195 "APM pipeline");
196ABSL_FLAG(int,
197 multi_channel_capture,
198 kParameterNotSpecifiedValue,
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100199 "Activate (1) or deactivate (0) multi-channel capture processing in "
Per Åhgrene14cb992019-11-27 09:34:22 +0100200 "APM pipeline");
Sam Zackrissonfeee1e42019-09-20 07:50:35 +0200201ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200202 simulated_mic_kind,
203 kParameterNotSpecifiedValue,
204 "Specify which microphone kind to use for microphone simulation");
Per Åhgren34fdc922021-03-10 09:51:52 +0000205ABSL_FLAG(int,
206 frame_for_sending_capture_output_used_false,
207 kParameterNotSpecifiedValue,
208 "Capture frame index for sending a runtime setting for that the "
209 "capture output is not used.");
210ABSL_FLAG(int,
211 frame_for_sending_capture_output_used_true,
212 kParameterNotSpecifiedValue,
213 "Capture frame index for sending a runtime setting for that the "
214 "capture output is used.");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200215ABSL_FLAG(bool, performance_report, false, "Report the APM performance ");
216ABSL_FLAG(std::string,
217 performance_report_output_file,
218 "",
219 "Generate a CSV file with the API call durations");
220ABSL_FLAG(bool, verbose, false, "Produce verbose output");
221ABSL_FLAG(bool,
222 quiet,
223 false,
224 "Avoid producing information about the progress.");
225ABSL_FLAG(bool,
226 bitexactness_report,
227 false,
228 "Report bitexactness for aec dump result reproduction");
229ABSL_FLAG(bool,
230 discard_settings_in_aecdump,
231 false,
232 "Discard any config settings specified in the aec dump");
233ABSL_FLAG(bool,
234 store_intermediate_output,
235 false,
236 "Creates new output files after each init");
237ABSL_FLAG(std::string,
238 custom_call_order_file,
239 "",
240 "Custom process API call order file");
241ABSL_FLAG(std::string,
242 output_custom_call_order_file,
243 "",
244 "Generate custom process API call order file from AEC dump");
245ABSL_FLAG(bool,
246 print_aec_parameter_values,
247 false,
248 "Print parameter values used in AEC in JSON-format");
249ABSL_FLAG(std::string,
250 aec_settings,
251 "",
252 "File in JSON-format with custom AEC settings");
253ABSL_FLAG(bool,
254 dump_data,
255 false,
256 "Dump internal data during the call (requires build flag)");
257ABSL_FLAG(std::string,
258 dump_data_output_dir,
259 "",
260 "Internal data dump output directory");
Per Åhgrenc2ae4c82021-01-20 15:42:13 +0100261ABSL_FLAG(int,
262 dump_set_to_use,
263 kParameterNotSpecifiedValue,
264 "Specifies the dump set to use (if not all the dump sets will "
265 "be used");
Per Åhgren5dca3f12020-01-28 09:08:11 +0100266ABSL_FLAG(bool,
Per Åhgren879d33b2021-01-21 10:08:15 +0100267 analyze,
268 false,
269 "Only analyze the call setup behavior (no processing)");
270ABSL_FLAG(float,
271 dump_start_seconds,
272 kParameterNotSpecifiedValue,
273 "Start of when to dump data (seconds).");
274ABSL_FLAG(float,
275 dump_end_seconds,
276 kParameterNotSpecifiedValue,
277 "End of when to dump data (seconds).");
278ABSL_FLAG(int,
279 dump_start_frame,
280 kParameterNotSpecifiedValue,
281 "Start of when to dump data (frames).");
282ABSL_FLAG(int,
283 dump_end_frame,
284 kParameterNotSpecifiedValue,
285 "End of when to dump data (frames).");
286ABSL_FLAG(int,
287 init_to_process,
288 kParameterNotSpecifiedValue,
289 "Init index to process.");
290
291ABSL_FLAG(bool,
Per Åhgren5dca3f12020-01-28 09:08:11 +0100292 float_wav_output,
293 false,
294 "Produce floating point wav output files.");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200295
saza0cf99ce2020-04-01 17:42:01 +0200296ABSL_FLAG(std::string,
297 force_fieldtrials,
298 "",
299 "Field trials control experimental feature code which can be forced. "
300 "E.g. running with --force_fieldtrials=WebRTC-FooFeature/Enable/"
301 " will assign the group Enable to field trial WebRTC-FooFeature.");
302
peah60a189f2016-05-24 20:54:40 -0700303namespace webrtc {
304namespace test {
Peter Kasting69558702016-01-12 16:26:35 -0800305namespace {
306
peah60a189f2016-05-24 20:54:40 -0700307const char kUsageDescription[] =
308 "Usage: audioproc_f [options] -i <input.wav>\n"
309 " or\n"
310 " audioproc_f [options] -dump_input <aec_dump>\n"
311 "\n\n"
312 "Command-line tool to simulate a call using the audio "
313 "processing module, either based on wav files or "
oprypin6e09d872017-08-31 03:21:39 -0700314 "protobuf debug dump recordings.\n";
peah60a189f2016-05-24 20:54:40 -0700315
Alessio Bazzica68170382018-11-20 12:27:20 +0100316std::vector<std::string> GetAgc2AdaptiveLevelEstimatorNames() {
317 return {"RMS", "peak"};
318}
peah60a189f2016-05-24 20:54:40 -0700319
Alex Loiko890988c2017-08-31 10:25:48 +0200320void SetSettingIfSpecified(const std::string& value,
Danil Chapovalovdb9f7ab2018-06-19 10:50:11 +0200321 absl::optional<std::string>* parameter) {
peah60a189f2016-05-24 20:54:40 -0700322 if (value.compare("") != 0) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100323 *parameter = value;
peah60a189f2016-05-24 20:54:40 -0700324 }
325}
326
Danil Chapovalovdb9f7ab2018-06-19 10:50:11 +0200327void SetSettingIfSpecified(int value, absl::optional<int>* parameter) {
peah60a189f2016-05-24 20:54:40 -0700328 if (value != kParameterNotSpecifiedValue) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100329 *parameter = value;
peah60a189f2016-05-24 20:54:40 -0700330 }
331}
332
Per Åhgrenef349602019-04-12 16:26:34 +0200333void SetSettingIfSpecified(float value, absl::optional<float>* parameter) {
334 constexpr float kFloatParameterNotSpecifiedValue =
335 kParameterNotSpecifiedValue;
336 if (value != kFloatParameterNotSpecifiedValue) {
337 *parameter = value;
338 }
339}
340
Danil Chapovalovdb9f7ab2018-06-19 10:50:11 +0200341void SetSettingIfFlagSet(int32_t flag, absl::optional<bool>* parameter) {
peah60a189f2016-05-24 20:54:40 -0700342 if (flag == 0) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100343 *parameter = false;
peah60a189f2016-05-24 20:54:40 -0700344 } else if (flag == 1) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100345 *parameter = true;
peah60a189f2016-05-24 20:54:40 -0700346 }
347}
348
Alessio Bazzica68170382018-11-20 12:27:20 +0100349AudioProcessing::Config::GainController2::LevelEstimator
350MapAgc2AdaptiveLevelEstimator(absl::string_view name) {
351 if (name.compare("RMS") == 0) {
352 return AudioProcessing::Config::GainController2::LevelEstimator::kRms;
353 }
354 if (name.compare("peak") == 0) {
355 return AudioProcessing::Config::GainController2::LevelEstimator::kPeak;
356 }
357 auto concat_strings =
358 [](const std::vector<std::string>& strings) -> std::string {
359 rtc::StringBuilder ss;
360 for (const auto& s : strings) {
361 ss << " " << s;
362 }
363 return ss.Release();
364 };
365 RTC_CHECK(false)
366 << "Invalid value for agc2_adaptive_level_estimator, valid options:"
367 << concat_strings(GetAgc2AdaptiveLevelEstimatorNames()) << ".";
368}
369
peah60a189f2016-05-24 20:54:40 -0700370SimulationSettings CreateSettings() {
371 SimulationSettings settings;
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200372 if (absl::GetFlag(FLAGS_all_default)) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100373 settings.use_le = true;
374 settings.use_vad = true;
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100375 settings.use_ts = true;
Per Åhgren0695df12020-01-13 14:43:13 +0100376 settings.use_analog_agc = true;
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100377 settings.use_ns = true;
378 settings.use_hpf = true;
379 settings.use_agc = true;
380 settings.use_agc2 = false;
Alex Loiko5feb30e2018-04-16 13:52:32 +0200381 settings.use_pre_amplifier = false;
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100382 settings.use_aec = true;
383 settings.use_aecm = false;
384 settings.use_ed = false;
peah60a189f2016-05-24 20:54:40 -0700385 }
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200386 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_input),
387 &settings.aec_dump_input_filename);
388 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_output),
389 &settings.aec_dump_output_filename);
390 SetSettingIfSpecified(absl::GetFlag(FLAGS_i), &settings.input_filename);
391 SetSettingIfSpecified(absl::GetFlag(FLAGS_o), &settings.output_filename);
392 SetSettingIfSpecified(absl::GetFlag(FLAGS_ri),
393 &settings.reverse_input_filename);
394 SetSettingIfSpecified(absl::GetFlag(FLAGS_ro),
395 &settings.reverse_output_filename);
396 SetSettingIfSpecified(absl::GetFlag(FLAGS_artificial_nearend),
peahdf80fd12016-12-09 02:43:40 -0800397 &settings.artificial_nearend_filename);
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100398 SetSettingIfSpecified(absl::GetFlag(FLAGS_linear_aec_output),
399 &settings.linear_aec_output_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200400 SetSettingIfSpecified(absl::GetFlag(FLAGS_output_num_channels),
peah60a189f2016-05-24 20:54:40 -0700401 &settings.output_num_channels);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200402 SetSettingIfSpecified(absl::GetFlag(FLAGS_reverse_output_num_channels),
peah60a189f2016-05-24 20:54:40 -0700403 &settings.reverse_output_num_channels);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200404 SetSettingIfSpecified(absl::GetFlag(FLAGS_output_sample_rate_hz),
peah60a189f2016-05-24 20:54:40 -0700405 &settings.output_sample_rate_hz);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200406 SetSettingIfSpecified(absl::GetFlag(FLAGS_reverse_output_sample_rate_hz),
peah60a189f2016-05-24 20:54:40 -0700407 &settings.reverse_output_sample_rate_hz);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200408 SetSettingIfFlagSet(absl::GetFlag(FLAGS_aec), &settings.use_aec);
409 SetSettingIfFlagSet(absl::GetFlag(FLAGS_aecm), &settings.use_aecm);
410 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ed), &settings.use_ed);
411 SetSettingIfSpecified(absl::GetFlag(FLAGS_ed_graph),
412 &settings.ed_graph_output_filename);
413 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc), &settings.use_agc);
414 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc2), &settings.use_agc2);
415 SetSettingIfFlagSet(absl::GetFlag(FLAGS_pre_amplifier),
416 &settings.use_pre_amplifier);
417 SetSettingIfFlagSet(absl::GetFlag(FLAGS_hpf), &settings.use_hpf);
418 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ns), &settings.use_ns);
Gustaf Ullbergfdd60992021-03-15 14:26:40 +0100419 SetSettingIfSpecified(absl::GetFlag(FLAGS_ts), &settings.use_ts);
Per Åhgren0695df12020-01-13 14:43:13 +0100420 SetSettingIfFlagSet(absl::GetFlag(FLAGS_analog_agc),
421 &settings.use_analog_agc);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200422 SetSettingIfFlagSet(absl::GetFlag(FLAGS_vad), &settings.use_vad);
423 SetSettingIfFlagSet(absl::GetFlag(FLAGS_le), &settings.use_le);
Per Åhgren0695df12020-01-13 14:43:13 +0100424 SetSettingIfFlagSet(absl::GetFlag(FLAGS_analog_agc_disable_digital_adaptive),
425 &settings.analog_agc_disable_digital_adaptive);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200426 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc_mode), &settings.agc_mode);
427 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc_target_level),
428 &settings.agc_target_level);
429 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc_limiter),
430 &settings.use_agc_limiter);
431 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc_compression_gain),
peah60a189f2016-05-24 20:54:40 -0700432 &settings.agc_compression_gain);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200433 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc2_enable_adaptive_gain),
Per Åhgrene4d23b12018-10-02 23:40:07 +0200434 &settings.agc2_use_adaptive_gain);
Per Åhgren879d33b2021-01-21 10:08:15 +0100435
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200436 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc2_fixed_gain_db),
437 &settings.agc2_fixed_gain_db);
438 settings.agc2_adaptive_level_estimator = MapAgc2AdaptiveLevelEstimator(
439 absl::GetFlag(FLAGS_agc2_adaptive_level_estimator));
440 SetSettingIfSpecified(absl::GetFlag(FLAGS_pre_amplifier_gain_factor),
Per Åhgrenef349602019-04-12 16:26:34 +0200441 &settings.pre_amplifier_gain_factor);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200442 SetSettingIfSpecified(absl::GetFlag(FLAGS_ns_level), &settings.ns_level);
Per Åhgren2e8e1c62019-12-20 00:42:22 +0100443 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ns_analysis_on_linear_aec_output),
444 &settings.ns_analysis_on_linear_aec_output);
Per Åhgrenfcbe4072019-09-15 00:27:58 +0200445 SetSettingIfSpecified(absl::GetFlag(FLAGS_maximum_internal_processing_rate),
446 &settings.maximum_internal_processing_rate);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200447 SetSettingIfSpecified(absl::GetFlag(FLAGS_stream_delay),
448 &settings.stream_delay);
449 SetSettingIfFlagSet(absl::GetFlag(FLAGS_use_stream_delay),
450 &settings.use_stream_delay);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200451 SetSettingIfSpecified(absl::GetFlag(FLAGS_custom_call_order_file),
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100452 &settings.call_order_input_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200453 SetSettingIfSpecified(absl::GetFlag(FLAGS_output_custom_call_order_file),
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100454 &settings.call_order_output_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200455 SetSettingIfSpecified(absl::GetFlag(FLAGS_aec_settings),
456 &settings.aec_settings_filename);
457 settings.initial_mic_level = absl::GetFlag(FLAGS_initial_mic_level);
Per Åhgrene14cb992019-11-27 09:34:22 +0100458 SetSettingIfFlagSet(absl::GetFlag(FLAGS_multi_channel_render),
459 &settings.multi_channel_render);
460 SetSettingIfFlagSet(absl::GetFlag(FLAGS_multi_channel_capture),
461 &settings.multi_channel_capture);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200462 settings.simulate_mic_gain = absl::GetFlag(FLAGS_simulate_mic_gain);
463 SetSettingIfSpecified(absl::GetFlag(FLAGS_simulated_mic_kind),
464 &settings.simulated_mic_kind);
Per Åhgren34fdc922021-03-10 09:51:52 +0000465 SetSettingIfSpecified(
466 absl::GetFlag(FLAGS_frame_for_sending_capture_output_used_false),
467 &settings.frame_for_sending_capture_output_used_false);
468 SetSettingIfSpecified(
469 absl::GetFlag(FLAGS_frame_for_sending_capture_output_used_true),
470 &settings.frame_for_sending_capture_output_used_true);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200471 settings.report_performance = absl::GetFlag(FLAGS_performance_report);
472 SetSettingIfSpecified(absl::GetFlag(FLAGS_performance_report_output_file),
Per Åhgrenada9b892019-04-03 16:06:42 +0200473 &settings.performance_report_output_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200474 settings.use_verbose_logging = absl::GetFlag(FLAGS_verbose);
475 settings.use_quiet_output = absl::GetFlag(FLAGS_quiet);
476 settings.report_bitexactness = absl::GetFlag(FLAGS_bitexactness_report);
477 settings.discard_all_settings_in_aecdump =
478 absl::GetFlag(FLAGS_discard_settings_in_aecdump);
479 settings.fixed_interface = absl::GetFlag(FLAGS_fixed_interface);
480 settings.store_intermediate_output =
481 absl::GetFlag(FLAGS_store_intermediate_output);
482 settings.print_aec_parameter_values =
483 absl::GetFlag(FLAGS_print_aec_parameter_values);
484 settings.dump_internal_data = absl::GetFlag(FLAGS_dump_data);
485 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_data_output_dir),
Alessio Bazzica4bc60452018-11-20 12:44:15 +0100486 &settings.dump_internal_data_output_dir);
Per Åhgrenc2ae4c82021-01-20 15:42:13 +0100487 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_set_to_use),
488 &settings.dump_set_to_use);
Per Åhgren5dca3f12020-01-28 09:08:11 +0100489 settings.wav_output_format = absl::GetFlag(FLAGS_float_wav_output)
490 ? WavFile::SampleFormat::kFloat
491 : WavFile::SampleFormat::kInt16;
peah60a189f2016-05-24 20:54:40 -0700492
Per Åhgren879d33b2021-01-21 10:08:15 +0100493 settings.analysis_only = absl::GetFlag(FLAGS_analyze);
494
495 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_start_frame),
496 &settings.dump_start_frame);
497 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_end_frame),
498 &settings.dump_end_frame);
499
500 constexpr int kFramesPerSecond = 100;
501 absl::optional<float> start_seconds;
502 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_start_seconds),
503 &start_seconds);
504 if (start_seconds) {
505 settings.dump_start_frame = *start_seconds * kFramesPerSecond;
506 }
507
508 absl::optional<float> end_seconds;
509 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_end_seconds), &end_seconds);
510 if (end_seconds) {
511 settings.dump_end_frame = *end_seconds * kFramesPerSecond;
512 }
513
514 SetSettingIfSpecified(absl::GetFlag(FLAGS_init_to_process),
515 &settings.init_to_process);
516
peah60a189f2016-05-24 20:54:40 -0700517 return settings;
518}
519
Alex Loiko890988c2017-08-31 10:25:48 +0200520void ReportConditionalErrorAndExit(bool condition, const std::string& message) {
peah60a189f2016-05-24 20:54:40 -0700521 if (condition) {
522 std::cerr << message << std::endl;
523 exit(1);
524 }
525}
526
Per Åhgrene9cd6172020-05-19 12:52:08 +0200527void PerformBasicParameterSanityChecks(
528 const SimulationSettings& settings,
529 bool pre_constructed_ap_provided,
530 bool pre_constructed_ap_builder_provided) {
peah60a189f2016-05-24 20:54:40 -0700531 if (settings.input_filename || settings.reverse_input_filename) {
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200532 ReportConditionalErrorAndExit(
533 !!settings.aec_dump_input_filename,
534 "Error: The aec dump file cannot be specified "
535 "together with input wav files!\n");
536
537 ReportConditionalErrorAndExit(
538 !!settings.aec_dump_input_string,
539 "Error: The aec dump input string cannot be specified "
540 "together with input wav files!\n");
peah60a189f2016-05-24 20:54:40 -0700541
peahdf80fd12016-12-09 02:43:40 -0800542 ReportConditionalErrorAndExit(!!settings.artificial_nearend_filename,
543 "Error: The artificial nearend cannot be "
544 "specified together with input wav files!\n");
545
peah60a189f2016-05-24 20:54:40 -0700546 ReportConditionalErrorAndExit(!settings.input_filename,
547 "Error: When operating at wav files, the "
548 "input wav filename must be "
549 "specified!\n");
550
551 ReportConditionalErrorAndExit(
552 settings.reverse_output_filename && !settings.reverse_input_filename,
553 "Error: When operating at wav files, the reverse input wav filename "
554 "must be specified if the reverse output wav filename is specified!\n");
555 } else {
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200556 ReportConditionalErrorAndExit(
557 !settings.aec_dump_input_filename && !settings.aec_dump_input_string,
558 "Error: Either the aec dump input file, the wav "
559 "input file or the aec dump input string must be specified!\n");
560 ReportConditionalErrorAndExit(
561 settings.aec_dump_input_filename && settings.aec_dump_input_string,
562 "Error: The aec dump input file cannot be specified together with the "
563 "aec dump input string!\n");
peah60a189f2016-05-24 20:54:40 -0700564 }
565
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100566 ReportConditionalErrorAndExit(settings.use_aec && !(*settings.use_aec) &&
567 settings.linear_aec_output_filename,
568 "Error: The linear AEC ouput filename cannot "
569 "be specified without the AEC being active");
570
571 ReportConditionalErrorAndExit(
peah60a189f2016-05-24 20:54:40 -0700572 settings.use_aec && *settings.use_aec && settings.use_aecm &&
573 *settings.use_aecm,
574 "Error: The AEC and the AECM cannot be activated at the same time!\n");
575
576 ReportConditionalErrorAndExit(
577 settings.output_sample_rate_hz && *settings.output_sample_rate_hz <= 0,
578 "Error: --output_sample_rate_hz must be positive!\n");
579
580 ReportConditionalErrorAndExit(
581 settings.reverse_output_sample_rate_hz &&
582 settings.output_sample_rate_hz &&
583 *settings.output_sample_rate_hz <= 0,
584 "Error: --reverse_output_sample_rate_hz must be positive!\n");
585
586 ReportConditionalErrorAndExit(
587 settings.output_num_channels && *settings.output_num_channels <= 0,
588 "Error: --output_num_channels must be positive!\n");
589
590 ReportConditionalErrorAndExit(
591 settings.reverse_output_num_channels &&
592 *settings.reverse_output_num_channels <= 0,
593 "Error: --reverse_output_num_channels must be positive!\n");
594
peah60a189f2016-05-24 20:54:40 -0700595 ReportConditionalErrorAndExit(
peah60a189f2016-05-24 20:54:40 -0700596 settings.agc_target_level && ((*settings.agc_target_level) < 0 ||
597 (*settings.agc_target_level) > 31),
598 "Error: --agc_target_level must be specified between 0 and 31.\n");
599
600 ReportConditionalErrorAndExit(
601 settings.agc_compression_gain && ((*settings.agc_compression_gain) < 0 ||
602 (*settings.agc_compression_gain) > 90),
603 "Error: --agc_compression_gain must be specified between 0 and 90.\n");
604
605 ReportConditionalErrorAndExit(
Per Åhgren6ee75fd2019-04-26 11:33:37 +0200606 settings.agc2_fixed_gain_db && ((*settings.agc2_fixed_gain_db) < 0 ||
607 (*settings.agc2_fixed_gain_db) > 90),
Alessio Bazzica270f7b52017-10-13 11:05:17 +0200608 "Error: --agc2_fixed_gain_db must be specified between 0 and 90.\n");
609
610 ReportConditionalErrorAndExit(
peah60a189f2016-05-24 20:54:40 -0700611 settings.ns_level &&
612 ((*settings.ns_level) < 0 || (*settings.ns_level) > 3),
613 "Error: --ns_level must be specified between 0 and 3.\n");
614
615 ReportConditionalErrorAndExit(
616 settings.report_bitexactness && !settings.aec_dump_input_filename,
617 "Error: --bitexactness_report can only be used when operating on an "
618 "aecdump\n");
619
peah5ad5de32016-12-09 03:18:22 -0800620 ReportConditionalErrorAndExit(
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100621 settings.call_order_input_filename && settings.aec_dump_input_filename,
peah5ad5de32016-12-09 03:18:22 -0800622 "Error: --custom_call_order_file cannot be used when operating on an "
623 "aecdump\n");
624
Alessio Bazzicaca90a552017-09-27 11:51:10 +0200625 ReportConditionalErrorAndExit(
626 (settings.initial_mic_level < 0 || settings.initial_mic_level > 255),
627 "Error: --initial_mic_level must be specified between 0 and 255.\n");
628
629 ReportConditionalErrorAndExit(
630 settings.simulated_mic_kind && !settings.simulate_mic_gain,
631 "Error: --simulated_mic_kind cannot be specified when mic simulation is "
632 "disabled\n");
633
634 ReportConditionalErrorAndExit(
635 !settings.simulated_mic_kind && settings.simulate_mic_gain,
636 "Error: --simulated_mic_kind must be specified when mic simulation is "
637 "enabled\n");
638
peah60a189f2016-05-24 20:54:40 -0700639 auto valid_wav_name = [](const std::string& wav_file_name) {
640 if (wav_file_name.size() < 5) {
641 return false;
642 }
643 if ((wav_file_name.compare(wav_file_name.size() - 4, 4, ".wav") == 0) ||
644 (wav_file_name.compare(wav_file_name.size() - 4, 4, ".WAV") == 0)) {
645 return true;
646 }
647 return false;
648 };
649
650 ReportConditionalErrorAndExit(
651 settings.input_filename && (!valid_wav_name(*settings.input_filename)),
652 "Error: --i must be a valid .wav file name.\n");
653
654 ReportConditionalErrorAndExit(
655 settings.output_filename && (!valid_wav_name(*settings.output_filename)),
656 "Error: --o must be a valid .wav file name.\n");
657
658 ReportConditionalErrorAndExit(
659 settings.reverse_input_filename &&
660 (!valid_wav_name(*settings.reverse_input_filename)),
661 "Error: --ri must be a valid .wav file name.\n");
662
663 ReportConditionalErrorAndExit(
664 settings.reverse_output_filename &&
665 (!valid_wav_name(*settings.reverse_output_filename)),
666 "Error: --ro must be a valid .wav file name.\n");
peahdf80fd12016-12-09 02:43:40 -0800667
668 ReportConditionalErrorAndExit(
669 settings.artificial_nearend_filename &&
670 !valid_wav_name(*settings.artificial_nearend_filename),
671 "Error: --artifical_nearend must be a valid .wav file name.\n");
Per Åhgren7a95e0f2018-10-25 09:56:49 +0200672
673 ReportConditionalErrorAndExit(
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100674 settings.linear_aec_output_filename &&
675 (!valid_wav_name(*settings.linear_aec_output_filename)),
676 "Error: --linear_aec_output must be a valid .wav file name.\n");
677
678 ReportConditionalErrorAndExit(
Per Åhgren7a95e0f2018-10-25 09:56:49 +0200679 WEBRTC_APM_DEBUG_DUMP == 0 && settings.dump_internal_data,
680 "Error: --dump_data cannot be set without proper build support.\n");
Alessio Bazzica4bc60452018-11-20 12:44:15 +0100681
Per Åhgren879d33b2021-01-21 10:08:15 +0100682 ReportConditionalErrorAndExit(settings.init_to_process &&
683 *settings.init_to_process != 1 &&
684 !settings.aec_dump_input_filename,
685 "Error: --init_to_process must be set to 1 for "
686 "wav-file based simulations.\n");
687
688 ReportConditionalErrorAndExit(
689 !settings.init_to_process &&
690 (settings.dump_start_frame || settings.dump_end_frame),
691 "Error: --init_to_process must be set when specifying a start and/or end "
692 "frame for when to dump internal data.\n");
693
Alessio Bazzica4bc60452018-11-20 12:44:15 +0100694 ReportConditionalErrorAndExit(
695 !settings.dump_internal_data &&
696 settings.dump_internal_data_output_dir.has_value(),
697 "Error: --dump_data_output_dir cannot be set without --dump_data.\n");
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100698
699 ReportConditionalErrorAndExit(
700 !settings.aec_dump_input_filename &&
701 settings.call_order_output_filename.has_value(),
702 "Error: --output_custom_call_order_file needs an AEC dump input file.\n");
Per Åhgrenef349602019-04-12 16:26:34 +0200703
704 ReportConditionalErrorAndExit(
705 (!settings.use_pre_amplifier || !(*settings.use_pre_amplifier)) &&
706 settings.pre_amplifier_gain_factor.has_value(),
707 "Error: --pre_amplifier_gain_factor needs --pre_amplifier to be "
708 "specified and set.\n");
Per Åhgrene9cd6172020-05-19 12:52:08 +0200709
710 ReportConditionalErrorAndExit(
711 pre_constructed_ap_provided && pre_constructed_ap_builder_provided,
712 "Error: The AudioProcessing and the AudioProcessingBuilder cannot both "
713 "be specified at the same time.\n");
714
715 ReportConditionalErrorAndExit(
716 settings.aec_settings_filename && pre_constructed_ap_provided,
717 "Error: The aec_settings_filename cannot be specified when a "
718 "pre-constructed audio processing object is provided.\n");
719
720 ReportConditionalErrorAndExit(
721 settings.aec_settings_filename && pre_constructed_ap_provided,
722 "Error: The print_aec_parameter_values cannot be set when a "
723 "pre-constructed audio processing object is provided.\n");
724
725 if (settings.linear_aec_output_filename && pre_constructed_ap_provided) {
726 std::cout << "Warning: For the linear AEC output to be stored, this must "
727 "be configured in the AEC that is part of the provided "
728 "AudioProcessing object."
729 << std::endl;
730 }
Peter Kasting69558702016-01-12 16:26:35 -0800731}
732
Per Åhgrene9cd6172020-05-19 12:52:08 +0200733int RunSimulation(rtc::scoped_refptr<AudioProcessing> audio_processing,
734 std::unique_ptr<AudioProcessingBuilder> ap_builder,
735 int argc,
736 char* argv[],
737 absl::string_view input_aecdump,
738 std::vector<float>* processed_capture_samples) {
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200739 std::vector<char*> args = absl::ParseCommandLine(argc, argv);
740 if (args.size() != 1) {
oprypin6e09d872017-08-31 03:21:39 -0700741 printf("%s", kUsageDescription);
oprypin6e09d872017-08-31 03:21:39 -0700742 return 1;
743 }
saza0cf99ce2020-04-01 17:42:01 +0200744 // InitFieldTrialsFromString stores the char*, so the char array must
745 // outlive the application.
746 const std::string field_trials = absl::GetFlag(FLAGS_force_fieldtrials);
747 webrtc::field_trial::InitFieldTrialsFromString(field_trials.c_str());
748
peah60a189f2016-05-24 20:54:40 -0700749 SimulationSettings settings = CreateSettings();
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200750 if (!input_aecdump.empty()) {
751 settings.aec_dump_input_string = input_aecdump;
752 settings.processed_capture_samples = processed_capture_samples;
753 RTC_CHECK(settings.processed_capture_samples);
754 }
Per Åhgrene9cd6172020-05-19 12:52:08 +0200755 PerformBasicParameterSanityChecks(settings, !!audio_processing, !!ap_builder);
peah60a189f2016-05-24 20:54:40 -0700756 std::unique_ptr<AudioProcessingSimulator> processor;
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000757
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200758 if (settings.aec_dump_input_filename || settings.aec_dump_input_string) {
Per Åhgrene9cd6172020-05-19 12:52:08 +0200759 processor.reset(new AecDumpBasedSimulator(
760 settings, std::move(audio_processing), std::move(ap_builder)));
aluebsb0ad43b2015-11-20 00:11:53 -0800761 } else {
Per Åhgrene9cd6172020-05-19 12:52:08 +0200762 processor.reset(new WavBasedSimulator(settings, std::move(audio_processing),
763 std::move(ap_builder)));
andrewbdafe312015-10-29 23:42:54 -0700764 }
765
Per Åhgren879d33b2021-01-21 10:08:15 +0100766 if (settings.analysis_only) {
767 processor->Analyze();
768 } else {
769 processor->Process();
770 }
aluebsb0ad43b2015-11-20 00:11:53 -0800771
peah60a189f2016-05-24 20:54:40 -0700772 if (settings.report_performance) {
Per Åhgrenada9b892019-04-03 16:06:42 +0200773 processor->GetApiCallStatistics().PrintReport();
774 }
775 if (settings.performance_report_output_filename) {
776 processor->GetApiCallStatistics().WriteReportToFile(
777 *settings.performance_report_output_filename);
peah60a189f2016-05-24 20:54:40 -0700778 }
779
780 if (settings.report_bitexactness && settings.aec_dump_input_filename) {
781 if (processor->OutputWasBitexact()) {
782 std::cout << "The processing was bitexact.";
783 } else {
784 std::cout << "The processing was not bitexact.";
785 }
Alejandro Luebs5d22c002015-04-15 11:26:40 -0700786 }
aluebsb0ad43b2015-11-20 00:11:53 -0800787
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000788 return 0;
789}
790
Per Åhgrene9cd6172020-05-19 12:52:08 +0200791} // namespace
792
793int AudioprocFloatImpl(rtc::scoped_refptr<AudioProcessing> audio_processing,
794 int argc,
795 char* argv[]) {
796 return RunSimulation(
797 std::move(audio_processing), /*ap_builder=*/nullptr, argc, argv,
798 /*input_aecdump=*/"", /*processed_capture_samples=*/nullptr);
799}
800
801int AudioprocFloatImpl(std::unique_ptr<AudioProcessingBuilder> ap_builder,
802 int argc,
803 char* argv[],
804 absl::string_view input_aecdump,
805 std::vector<float>* processed_capture_samples) {
806 return RunSimulation(/*audio_processing=*/nullptr, std::move(ap_builder),
807 argc, argv, input_aecdump, processed_capture_samples);
808}
809
peah60a189f2016-05-24 20:54:40 -0700810} // namespace test
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000811} // namespace webrtc