blob: ec637c1dcbac7b52524be152492901518062bd50 [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"
andrew@webrtc.org08df9b22014-12-16 20:57:15 +000030
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020031constexpr int kParameterNotSpecifiedValue = -10000;
32
33ABSL_FLAG(std::string, dump_input, "", "Aec dump input filename");
34ABSL_FLAG(std::string, dump_output, "", "Aec dump output filename");
35ABSL_FLAG(std::string, i, "", "Forward stream input wav filename");
36ABSL_FLAG(std::string, o, "", "Forward stream output wav filename");
37ABSL_FLAG(std::string, ri, "", "Reverse stream input wav filename");
38ABSL_FLAG(std::string, ro, "", "Reverse stream output wav filename");
39ABSL_FLAG(std::string,
40 artificial_nearend,
41 "",
42 "Artificial nearend wav filename");
Per Åhgrenc20a19c2019-11-13 11:12:29 +010043ABSL_FLAG(std::string, linear_aec_output, "", "Linear AEC output wav filename");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +020044ABSL_FLAG(int,
45 output_num_channels,
46 kParameterNotSpecifiedValue,
47 "Number of forward stream output channels");
48ABSL_FLAG(int,
49 reverse_output_num_channels,
50 kParameterNotSpecifiedValue,
51 "Number of Reverse stream output channels");
52ABSL_FLAG(int,
53 output_sample_rate_hz,
54 kParameterNotSpecifiedValue,
55 "Forward stream output sample rate in Hz");
56ABSL_FLAG(int,
57 reverse_output_sample_rate_hz,
58 kParameterNotSpecifiedValue,
59 "Reverse stream output sample rate in Hz");
60ABSL_FLAG(bool,
61 fixed_interface,
62 false,
63 "Use the fixed interface when operating on wav files");
64ABSL_FLAG(int,
65 aec,
66 kParameterNotSpecifiedValue,
67 "Activate (1) or deactivate(0) the echo canceller");
68ABSL_FLAG(int,
69 aecm,
70 kParameterNotSpecifiedValue,
71 "Activate (1) or deactivate(0) the mobile echo controller");
72ABSL_FLAG(int,
73 ed,
74 kParameterNotSpecifiedValue,
75 "Activate (1) or deactivate (0) the residual echo detector");
76ABSL_FLAG(std::string,
77 ed_graph,
78 "",
79 "Output filename for graph of echo likelihood");
80ABSL_FLAG(int,
81 agc,
82 kParameterNotSpecifiedValue,
83 "Activate (1) or deactivate(0) the AGC");
84ABSL_FLAG(int,
85 agc2,
86 kParameterNotSpecifiedValue,
87 "Activate (1) or deactivate(0) the AGC2");
88ABSL_FLAG(int,
89 pre_amplifier,
90 kParameterNotSpecifiedValue,
91 "Activate (1) or deactivate(0) the pre amplifier");
92ABSL_FLAG(int,
93 hpf,
94 kParameterNotSpecifiedValue,
95 "Activate (1) or deactivate(0) the high-pass filter");
96ABSL_FLAG(int,
97 ns,
98 kParameterNotSpecifiedValue,
99 "Activate (1) or deactivate(0) the noise suppressor");
100ABSL_FLAG(int,
101 ts,
102 kParameterNotSpecifiedValue,
103 "Activate (1) or deactivate(0) the transient suppressor");
104ABSL_FLAG(int,
Per Åhgren0695df12020-01-13 14:43:13 +0100105 analog_agc,
106 kParameterNotSpecifiedValue,
107 "Activate (1) or deactivate(0) the transient suppressor");
108ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200109 vad,
110 kParameterNotSpecifiedValue,
111 "Activate (1) or deactivate(0) the voice activity detector");
112ABSL_FLAG(int,
113 le,
114 kParameterNotSpecifiedValue,
115 "Activate (1) or deactivate(0) the level estimator");
116ABSL_FLAG(bool,
117 all_default,
118 false,
119 "Activate all of the default components (will be overridden by any "
120 "other settings)");
121ABSL_FLAG(int,
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100122 use_legacy_ns,
123 kParameterNotSpecifiedValue,
Per Åhgren62ea0aa2019-12-09 10:18:44 +0100124 "Activate (1) or deactivate(0) the legacy NS");
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100125ABSL_FLAG(int,
Per Åhgren0695df12020-01-13 14:43:13 +0100126 analog_agc_disable_digital_adaptive,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200127 kParameterNotSpecifiedValue,
128 "Force-deactivate (1) digital adaptation in "
129 "experimental AGC. Digital adaptation is active by default (0).");
130ABSL_FLAG(int,
Per Åhgren0695df12020-01-13 14:43:13 +0100131 analog_agc_agc2_level_estimator,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200132 kParameterNotSpecifiedValue,
133 "AGC2 level estimation"
134 " in the experimental AGC. AGC1 level estimation is the default (0)");
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200135ABSL_FLAG(int,
136 agc_mode,
137 kParameterNotSpecifiedValue,
138 "Specify the AGC mode (0-2)");
139ABSL_FLAG(int,
140 agc_target_level,
141 kParameterNotSpecifiedValue,
142 "Specify the AGC target level (0-31)");
143ABSL_FLAG(int,
144 agc_limiter,
145 kParameterNotSpecifiedValue,
146 "Activate (1) or deactivate(0) the level estimator");
147ABSL_FLAG(int,
148 agc_compression_gain,
149 kParameterNotSpecifiedValue,
150 "Specify the AGC compression gain (0-90)");
151ABSL_FLAG(int,
152 agc2_enable_adaptive_gain,
153 kParameterNotSpecifiedValue,
154 "Activate (1) or deactivate(0) the AGC2 adaptive gain");
155ABSL_FLAG(float,
156 agc2_fixed_gain_db,
157 kParameterNotSpecifiedValue,
158 "AGC2 fixed gain (dB) to apply");
159ABSL_FLAG(std::string,
160 agc2_adaptive_level_estimator,
161 "RMS",
162 "AGC2 adaptive digital level estimator to use [RMS, peak]");
163ABSL_FLAG(float,
164 pre_amplifier_gain_factor,
165 kParameterNotSpecifiedValue,
166 "Pre-amplifier gain factor (linear) to apply");
167ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200168 ns_level,
169 kParameterNotSpecifiedValue,
170 "Specify the NS level (0-3)");
171ABSL_FLAG(int,
Per Åhgren2e8e1c62019-12-20 00:42:22 +0100172 ns_analysis_on_linear_aec_output,
173 kParameterNotSpecifiedValue,
174 "Specifies whether the noise suppression analysis is done on the "
175 "linear AEC output");
176ABSL_FLAG(int,
Per Åhgrenfcbe4072019-09-15 00:27:58 +0200177 maximum_internal_processing_rate,
178 kParameterNotSpecifiedValue,
179 "Set a maximum internal processing rate (32000 or 48000) to override "
180 "the default rate");
181ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200182 stream_delay,
183 kParameterNotSpecifiedValue,
184 "Specify the stream delay in ms to use");
185ABSL_FLAG(int,
186 use_stream_delay,
187 kParameterNotSpecifiedValue,
188 "Activate (1) or deactivate(0) reporting the stream delay");
189ABSL_FLAG(int,
190 stream_drift_samples,
191 kParameterNotSpecifiedValue,
192 "Specify the number of stream drift samples to use");
193ABSL_FLAG(int, initial_mic_level, 100, "Initial mic level (0-255)");
194ABSL_FLAG(int,
195 simulate_mic_gain,
196 0,
197 "Activate (1) or deactivate(0) the analog mic gain simulation");
198ABSL_FLAG(int,
Per Åhgrene14cb992019-11-27 09:34:22 +0100199 multi_channel_render,
Sam Zackrissonfeee1e42019-09-20 07:50:35 +0200200 kParameterNotSpecifiedValue,
Per Åhgrene14cb992019-11-27 09:34:22 +0100201 "Activate (1) or deactivate(0) multi-channel render processing in "
202 "APM pipeline");
203ABSL_FLAG(int,
204 multi_channel_capture,
205 kParameterNotSpecifiedValue,
206 "Activate (1) or deactivate(0) multi-channel capture processing in "
207 "APM pipeline");
Sam Zackrissonfeee1e42019-09-20 07:50:35 +0200208ABSL_FLAG(int,
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200209 simulated_mic_kind,
210 kParameterNotSpecifiedValue,
211 "Specify which microphone kind to use for microphone simulation");
212ABSL_FLAG(bool, performance_report, false, "Report the APM performance ");
213ABSL_FLAG(std::string,
214 performance_report_output_file,
215 "",
216 "Generate a CSV file with the API call durations");
217ABSL_FLAG(bool, verbose, false, "Produce verbose output");
218ABSL_FLAG(bool,
219 quiet,
220 false,
221 "Avoid producing information about the progress.");
222ABSL_FLAG(bool,
223 bitexactness_report,
224 false,
225 "Report bitexactness for aec dump result reproduction");
226ABSL_FLAG(bool,
227 discard_settings_in_aecdump,
228 false,
229 "Discard any config settings specified in the aec dump");
230ABSL_FLAG(bool,
231 store_intermediate_output,
232 false,
233 "Creates new output files after each init");
234ABSL_FLAG(std::string,
235 custom_call_order_file,
236 "",
237 "Custom process API call order file");
238ABSL_FLAG(std::string,
239 output_custom_call_order_file,
240 "",
241 "Generate custom process API call order file from AEC dump");
242ABSL_FLAG(bool,
243 print_aec_parameter_values,
244 false,
245 "Print parameter values used in AEC in JSON-format");
246ABSL_FLAG(std::string,
247 aec_settings,
248 "",
249 "File in JSON-format with custom AEC settings");
250ABSL_FLAG(bool,
251 dump_data,
252 false,
253 "Dump internal data during the call (requires build flag)");
254ABSL_FLAG(std::string,
255 dump_data_output_dir,
256 "",
257 "Internal data dump output directory");
258
peah60a189f2016-05-24 20:54:40 -0700259namespace webrtc {
260namespace test {
Peter Kasting69558702016-01-12 16:26:35 -0800261namespace {
262
peah60a189f2016-05-24 20:54:40 -0700263const char kUsageDescription[] =
264 "Usage: audioproc_f [options] -i <input.wav>\n"
265 " or\n"
266 " audioproc_f [options] -dump_input <aec_dump>\n"
267 "\n\n"
268 "Command-line tool to simulate a call using the audio "
269 "processing module, either based on wav files or "
oprypin6e09d872017-08-31 03:21:39 -0700270 "protobuf debug dump recordings.\n";
peah60a189f2016-05-24 20:54:40 -0700271
Alessio Bazzica68170382018-11-20 12:27:20 +0100272std::vector<std::string> GetAgc2AdaptiveLevelEstimatorNames() {
273 return {"RMS", "peak"};
274}
peah60a189f2016-05-24 20:54:40 -0700275
Alex Loiko890988c2017-08-31 10:25:48 +0200276void SetSettingIfSpecified(const std::string& value,
Danil Chapovalovdb9f7ab2018-06-19 10:50:11 +0200277 absl::optional<std::string>* parameter) {
peah60a189f2016-05-24 20:54:40 -0700278 if (value.compare("") != 0) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100279 *parameter = value;
peah60a189f2016-05-24 20:54:40 -0700280 }
281}
282
Danil Chapovalovdb9f7ab2018-06-19 10:50:11 +0200283void SetSettingIfSpecified(int value, absl::optional<int>* parameter) {
peah60a189f2016-05-24 20:54:40 -0700284 if (value != kParameterNotSpecifiedValue) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100285 *parameter = value;
peah60a189f2016-05-24 20:54:40 -0700286 }
287}
288
Per Åhgrenef349602019-04-12 16:26:34 +0200289void SetSettingIfSpecified(float value, absl::optional<float>* parameter) {
290 constexpr float kFloatParameterNotSpecifiedValue =
291 kParameterNotSpecifiedValue;
292 if (value != kFloatParameterNotSpecifiedValue) {
293 *parameter = value;
294 }
295}
296
Danil Chapovalovdb9f7ab2018-06-19 10:50:11 +0200297void SetSettingIfFlagSet(int32_t flag, absl::optional<bool>* parameter) {
peah60a189f2016-05-24 20:54:40 -0700298 if (flag == 0) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100299 *parameter = false;
peah60a189f2016-05-24 20:54:40 -0700300 } else if (flag == 1) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100301 *parameter = true;
peah60a189f2016-05-24 20:54:40 -0700302 }
303}
304
Alessio Bazzica68170382018-11-20 12:27:20 +0100305AudioProcessing::Config::GainController2::LevelEstimator
306MapAgc2AdaptiveLevelEstimator(absl::string_view name) {
307 if (name.compare("RMS") == 0) {
308 return AudioProcessing::Config::GainController2::LevelEstimator::kRms;
309 }
310 if (name.compare("peak") == 0) {
311 return AudioProcessing::Config::GainController2::LevelEstimator::kPeak;
312 }
313 auto concat_strings =
314 [](const std::vector<std::string>& strings) -> std::string {
315 rtc::StringBuilder ss;
316 for (const auto& s : strings) {
317 ss << " " << s;
318 }
319 return ss.Release();
320 };
321 RTC_CHECK(false)
322 << "Invalid value for agc2_adaptive_level_estimator, valid options:"
323 << concat_strings(GetAgc2AdaptiveLevelEstimatorNames()) << ".";
324}
325
peah60a189f2016-05-24 20:54:40 -0700326SimulationSettings CreateSettings() {
327 SimulationSettings settings;
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200328 if (absl::GetFlag(FLAGS_all_default)) {
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100329 settings.use_le = true;
330 settings.use_vad = true;
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100331 settings.use_ts = true;
Per Åhgren0695df12020-01-13 14:43:13 +0100332 settings.use_analog_agc = true;
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100333 settings.use_ns = true;
334 settings.use_hpf = true;
335 settings.use_agc = true;
336 settings.use_agc2 = false;
Alex Loiko5feb30e2018-04-16 13:52:32 +0200337 settings.use_pre_amplifier = false;
Oskar Sundbomaa8b67d2017-11-17 14:34:48 +0100338 settings.use_aec = true;
339 settings.use_aecm = false;
340 settings.use_ed = false;
peah60a189f2016-05-24 20:54:40 -0700341 }
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200342 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_input),
343 &settings.aec_dump_input_filename);
344 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_output),
345 &settings.aec_dump_output_filename);
346 SetSettingIfSpecified(absl::GetFlag(FLAGS_i), &settings.input_filename);
347 SetSettingIfSpecified(absl::GetFlag(FLAGS_o), &settings.output_filename);
348 SetSettingIfSpecified(absl::GetFlag(FLAGS_ri),
349 &settings.reverse_input_filename);
350 SetSettingIfSpecified(absl::GetFlag(FLAGS_ro),
351 &settings.reverse_output_filename);
352 SetSettingIfSpecified(absl::GetFlag(FLAGS_artificial_nearend),
peahdf80fd12016-12-09 02:43:40 -0800353 &settings.artificial_nearend_filename);
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100354 SetSettingIfSpecified(absl::GetFlag(FLAGS_linear_aec_output),
355 &settings.linear_aec_output_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200356 SetSettingIfSpecified(absl::GetFlag(FLAGS_output_num_channels),
peah60a189f2016-05-24 20:54:40 -0700357 &settings.output_num_channels);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200358 SetSettingIfSpecified(absl::GetFlag(FLAGS_reverse_output_num_channels),
peah60a189f2016-05-24 20:54:40 -0700359 &settings.reverse_output_num_channels);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200360 SetSettingIfSpecified(absl::GetFlag(FLAGS_output_sample_rate_hz),
peah60a189f2016-05-24 20:54:40 -0700361 &settings.output_sample_rate_hz);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200362 SetSettingIfSpecified(absl::GetFlag(FLAGS_reverse_output_sample_rate_hz),
peah60a189f2016-05-24 20:54:40 -0700363 &settings.reverse_output_sample_rate_hz);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200364 SetSettingIfFlagSet(absl::GetFlag(FLAGS_aec), &settings.use_aec);
365 SetSettingIfFlagSet(absl::GetFlag(FLAGS_aecm), &settings.use_aecm);
366 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ed), &settings.use_ed);
367 SetSettingIfSpecified(absl::GetFlag(FLAGS_ed_graph),
368 &settings.ed_graph_output_filename);
369 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc), &settings.use_agc);
370 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc2), &settings.use_agc2);
371 SetSettingIfFlagSet(absl::GetFlag(FLAGS_pre_amplifier),
372 &settings.use_pre_amplifier);
373 SetSettingIfFlagSet(absl::GetFlag(FLAGS_hpf), &settings.use_hpf);
374 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ns), &settings.use_ns);
375 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ts), &settings.use_ts);
Per Åhgren0695df12020-01-13 14:43:13 +0100376 SetSettingIfFlagSet(absl::GetFlag(FLAGS_analog_agc),
377 &settings.use_analog_agc);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200378 SetSettingIfFlagSet(absl::GetFlag(FLAGS_vad), &settings.use_vad);
379 SetSettingIfFlagSet(absl::GetFlag(FLAGS_le), &settings.use_le);
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100380 SetSettingIfFlagSet(absl::GetFlag(FLAGS_use_legacy_ns),
381 &settings.use_legacy_ns);
Per Åhgren0695df12020-01-13 14:43:13 +0100382 SetSettingIfFlagSet(absl::GetFlag(FLAGS_analog_agc_disable_digital_adaptive),
383 &settings.analog_agc_disable_digital_adaptive);
384 SetSettingIfFlagSet(absl::GetFlag(FLAGS_analog_agc_agc2_level_estimator),
385 &settings.use_analog_agc_agc2_level_estimator);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200386 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc_mode), &settings.agc_mode);
387 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc_target_level),
388 &settings.agc_target_level);
389 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc_limiter),
390 &settings.use_agc_limiter);
391 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc_compression_gain),
peah60a189f2016-05-24 20:54:40 -0700392 &settings.agc_compression_gain);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200393 SetSettingIfFlagSet(absl::GetFlag(FLAGS_agc2_enable_adaptive_gain),
Per Åhgrene4d23b12018-10-02 23:40:07 +0200394 &settings.agc2_use_adaptive_gain);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200395 SetSettingIfSpecified(absl::GetFlag(FLAGS_agc2_fixed_gain_db),
396 &settings.agc2_fixed_gain_db);
397 settings.agc2_adaptive_level_estimator = MapAgc2AdaptiveLevelEstimator(
398 absl::GetFlag(FLAGS_agc2_adaptive_level_estimator));
399 SetSettingIfSpecified(absl::GetFlag(FLAGS_pre_amplifier_gain_factor),
Per Åhgrenef349602019-04-12 16:26:34 +0200400 &settings.pre_amplifier_gain_factor);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200401 SetSettingIfSpecified(absl::GetFlag(FLAGS_ns_level), &settings.ns_level);
Per Åhgren2e8e1c62019-12-20 00:42:22 +0100402 SetSettingIfFlagSet(absl::GetFlag(FLAGS_ns_analysis_on_linear_aec_output),
403 &settings.ns_analysis_on_linear_aec_output);
Per Åhgrenfcbe4072019-09-15 00:27:58 +0200404 SetSettingIfSpecified(absl::GetFlag(FLAGS_maximum_internal_processing_rate),
405 &settings.maximum_internal_processing_rate);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200406 SetSettingIfSpecified(absl::GetFlag(FLAGS_stream_delay),
407 &settings.stream_delay);
408 SetSettingIfFlagSet(absl::GetFlag(FLAGS_use_stream_delay),
409 &settings.use_stream_delay);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200410 SetSettingIfSpecified(absl::GetFlag(FLAGS_custom_call_order_file),
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100411 &settings.call_order_input_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200412 SetSettingIfSpecified(absl::GetFlag(FLAGS_output_custom_call_order_file),
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100413 &settings.call_order_output_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200414 SetSettingIfSpecified(absl::GetFlag(FLAGS_aec_settings),
415 &settings.aec_settings_filename);
416 settings.initial_mic_level = absl::GetFlag(FLAGS_initial_mic_level);
Per Åhgrene14cb992019-11-27 09:34:22 +0100417 SetSettingIfFlagSet(absl::GetFlag(FLAGS_multi_channel_render),
418 &settings.multi_channel_render);
419 SetSettingIfFlagSet(absl::GetFlag(FLAGS_multi_channel_capture),
420 &settings.multi_channel_capture);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200421 settings.simulate_mic_gain = absl::GetFlag(FLAGS_simulate_mic_gain);
422 SetSettingIfSpecified(absl::GetFlag(FLAGS_simulated_mic_kind),
423 &settings.simulated_mic_kind);
424 settings.report_performance = absl::GetFlag(FLAGS_performance_report);
425 SetSettingIfSpecified(absl::GetFlag(FLAGS_performance_report_output_file),
Per Åhgrenada9b892019-04-03 16:06:42 +0200426 &settings.performance_report_output_filename);
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200427 settings.use_verbose_logging = absl::GetFlag(FLAGS_verbose);
428 settings.use_quiet_output = absl::GetFlag(FLAGS_quiet);
429 settings.report_bitexactness = absl::GetFlag(FLAGS_bitexactness_report);
430 settings.discard_all_settings_in_aecdump =
431 absl::GetFlag(FLAGS_discard_settings_in_aecdump);
432 settings.fixed_interface = absl::GetFlag(FLAGS_fixed_interface);
433 settings.store_intermediate_output =
434 absl::GetFlag(FLAGS_store_intermediate_output);
435 settings.print_aec_parameter_values =
436 absl::GetFlag(FLAGS_print_aec_parameter_values);
437 settings.dump_internal_data = absl::GetFlag(FLAGS_dump_data);
438 SetSettingIfSpecified(absl::GetFlag(FLAGS_dump_data_output_dir),
Alessio Bazzica4bc60452018-11-20 12:44:15 +0100439 &settings.dump_internal_data_output_dir);
peah60a189f2016-05-24 20:54:40 -0700440
441 return settings;
442}
443
Alex Loiko890988c2017-08-31 10:25:48 +0200444void ReportConditionalErrorAndExit(bool condition, const std::string& message) {
peah60a189f2016-05-24 20:54:40 -0700445 if (condition) {
446 std::cerr << message << std::endl;
447 exit(1);
448 }
449}
450
451void PerformBasicParameterSanityChecks(const SimulationSettings& settings) {
452 if (settings.input_filename || settings.reverse_input_filename) {
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200453 ReportConditionalErrorAndExit(
454 !!settings.aec_dump_input_filename,
455 "Error: The aec dump file cannot be specified "
456 "together with input wav files!\n");
457
458 ReportConditionalErrorAndExit(
459 !!settings.aec_dump_input_string,
460 "Error: The aec dump input string cannot be specified "
461 "together with input wav files!\n");
peah60a189f2016-05-24 20:54:40 -0700462
peahdf80fd12016-12-09 02:43:40 -0800463 ReportConditionalErrorAndExit(!!settings.artificial_nearend_filename,
464 "Error: The artificial nearend cannot be "
465 "specified together with input wav files!\n");
466
peah60a189f2016-05-24 20:54:40 -0700467 ReportConditionalErrorAndExit(!settings.input_filename,
468 "Error: When operating at wav files, the "
469 "input wav filename must be "
470 "specified!\n");
471
472 ReportConditionalErrorAndExit(
473 settings.reverse_output_filename && !settings.reverse_input_filename,
474 "Error: When operating at wav files, the reverse input wav filename "
475 "must be specified if the reverse output wav filename is specified!\n");
476 } else {
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200477 ReportConditionalErrorAndExit(
478 !settings.aec_dump_input_filename && !settings.aec_dump_input_string,
479 "Error: Either the aec dump input file, the wav "
480 "input file or the aec dump input string must be specified!\n");
481 ReportConditionalErrorAndExit(
482 settings.aec_dump_input_filename && settings.aec_dump_input_string,
483 "Error: The aec dump input file cannot be specified together with the "
484 "aec dump input string!\n");
peah60a189f2016-05-24 20:54:40 -0700485 }
486
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100487 ReportConditionalErrorAndExit(settings.use_aec && !(*settings.use_aec) &&
488 settings.linear_aec_output_filename,
489 "Error: The linear AEC ouput filename cannot "
490 "be specified without the AEC being active");
491
492 ReportConditionalErrorAndExit(
peah60a189f2016-05-24 20:54:40 -0700493 settings.use_aec && *settings.use_aec && settings.use_aecm &&
494 *settings.use_aecm,
495 "Error: The AEC and the AECM cannot be activated at the same time!\n");
496
497 ReportConditionalErrorAndExit(
498 settings.output_sample_rate_hz && *settings.output_sample_rate_hz <= 0,
499 "Error: --output_sample_rate_hz must be positive!\n");
500
501 ReportConditionalErrorAndExit(
502 settings.reverse_output_sample_rate_hz &&
503 settings.output_sample_rate_hz &&
504 *settings.output_sample_rate_hz <= 0,
505 "Error: --reverse_output_sample_rate_hz must be positive!\n");
506
507 ReportConditionalErrorAndExit(
508 settings.output_num_channels && *settings.output_num_channels <= 0,
509 "Error: --output_num_channels must be positive!\n");
510
511 ReportConditionalErrorAndExit(
512 settings.reverse_output_num_channels &&
513 *settings.reverse_output_num_channels <= 0,
514 "Error: --reverse_output_num_channels must be positive!\n");
515
peah60a189f2016-05-24 20:54:40 -0700516 ReportConditionalErrorAndExit(
peah60a189f2016-05-24 20:54:40 -0700517 settings.agc_target_level && ((*settings.agc_target_level) < 0 ||
518 (*settings.agc_target_level) > 31),
519 "Error: --agc_target_level must be specified between 0 and 31.\n");
520
521 ReportConditionalErrorAndExit(
522 settings.agc_compression_gain && ((*settings.agc_compression_gain) < 0 ||
523 (*settings.agc_compression_gain) > 90),
524 "Error: --agc_compression_gain must be specified between 0 and 90.\n");
525
526 ReportConditionalErrorAndExit(
Per Åhgren6ee75fd2019-04-26 11:33:37 +0200527 settings.agc2_fixed_gain_db && ((*settings.agc2_fixed_gain_db) < 0 ||
528 (*settings.agc2_fixed_gain_db) > 90),
Alessio Bazzica270f7b52017-10-13 11:05:17 +0200529 "Error: --agc2_fixed_gain_db must be specified between 0 and 90.\n");
530
531 ReportConditionalErrorAndExit(
peah60a189f2016-05-24 20:54:40 -0700532 settings.ns_level &&
533 ((*settings.ns_level) < 0 || (*settings.ns_level) > 3),
534 "Error: --ns_level must be specified between 0 and 3.\n");
535
536 ReportConditionalErrorAndExit(
537 settings.report_bitexactness && !settings.aec_dump_input_filename,
538 "Error: --bitexactness_report can only be used when operating on an "
539 "aecdump\n");
540
peah5ad5de32016-12-09 03:18:22 -0800541 ReportConditionalErrorAndExit(
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100542 settings.call_order_input_filename && settings.aec_dump_input_filename,
peah5ad5de32016-12-09 03:18:22 -0800543 "Error: --custom_call_order_file cannot be used when operating on an "
544 "aecdump\n");
545
Alessio Bazzicaca90a552017-09-27 11:51:10 +0200546 ReportConditionalErrorAndExit(
547 (settings.initial_mic_level < 0 || settings.initial_mic_level > 255),
548 "Error: --initial_mic_level must be specified between 0 and 255.\n");
549
550 ReportConditionalErrorAndExit(
551 settings.simulated_mic_kind && !settings.simulate_mic_gain,
552 "Error: --simulated_mic_kind cannot be specified when mic simulation is "
553 "disabled\n");
554
555 ReportConditionalErrorAndExit(
556 !settings.simulated_mic_kind && settings.simulate_mic_gain,
557 "Error: --simulated_mic_kind must be specified when mic simulation is "
558 "enabled\n");
559
peah60a189f2016-05-24 20:54:40 -0700560 auto valid_wav_name = [](const std::string& wav_file_name) {
561 if (wav_file_name.size() < 5) {
562 return false;
563 }
564 if ((wav_file_name.compare(wav_file_name.size() - 4, 4, ".wav") == 0) ||
565 (wav_file_name.compare(wav_file_name.size() - 4, 4, ".WAV") == 0)) {
566 return true;
567 }
568 return false;
569 };
570
571 ReportConditionalErrorAndExit(
572 settings.input_filename && (!valid_wav_name(*settings.input_filename)),
573 "Error: --i must be a valid .wav file name.\n");
574
575 ReportConditionalErrorAndExit(
576 settings.output_filename && (!valid_wav_name(*settings.output_filename)),
577 "Error: --o must be a valid .wav file name.\n");
578
579 ReportConditionalErrorAndExit(
580 settings.reverse_input_filename &&
581 (!valid_wav_name(*settings.reverse_input_filename)),
582 "Error: --ri must be a valid .wav file name.\n");
583
584 ReportConditionalErrorAndExit(
585 settings.reverse_output_filename &&
586 (!valid_wav_name(*settings.reverse_output_filename)),
587 "Error: --ro must be a valid .wav file name.\n");
peahdf80fd12016-12-09 02:43:40 -0800588
589 ReportConditionalErrorAndExit(
590 settings.artificial_nearend_filename &&
591 !valid_wav_name(*settings.artificial_nearend_filename),
592 "Error: --artifical_nearend must be a valid .wav file name.\n");
Per Åhgren7a95e0f2018-10-25 09:56:49 +0200593
594 ReportConditionalErrorAndExit(
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100595 settings.linear_aec_output_filename &&
596 (!valid_wav_name(*settings.linear_aec_output_filename)),
597 "Error: --linear_aec_output must be a valid .wav file name.\n");
598
599 ReportConditionalErrorAndExit(
Per Åhgren7a95e0f2018-10-25 09:56:49 +0200600 WEBRTC_APM_DEBUG_DUMP == 0 && settings.dump_internal_data,
601 "Error: --dump_data cannot be set without proper build support.\n");
Alessio Bazzica4bc60452018-11-20 12:44:15 +0100602
603 ReportConditionalErrorAndExit(
604 !settings.dump_internal_data &&
605 settings.dump_internal_data_output_dir.has_value(),
606 "Error: --dump_data_output_dir cannot be set without --dump_data.\n");
Ivo Creusen9a66d5e2019-03-13 13:55:12 +0100607
608 ReportConditionalErrorAndExit(
609 !settings.aec_dump_input_filename &&
610 settings.call_order_output_filename.has_value(),
611 "Error: --output_custom_call_order_file needs an AEC dump input file.\n");
Per Åhgrenef349602019-04-12 16:26:34 +0200612
613 ReportConditionalErrorAndExit(
614 (!settings.use_pre_amplifier || !(*settings.use_pre_amplifier)) &&
615 settings.pre_amplifier_gain_factor.has_value(),
616 "Error: --pre_amplifier_gain_factor needs --pre_amplifier to be "
617 "specified and set.\n");
Peter Kasting69558702016-01-12 16:26:35 -0800618}
619
620} // namespace
621
Ivo Creusen2cb41052018-03-15 12:22:52 +0100622int AudioprocFloatImpl(std::unique_ptr<AudioProcessingBuilder> ap_builder,
623 int argc,
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200624 char* argv[],
625 absl::string_view input_aecdump,
626 std::vector<float>* processed_capture_samples) {
Mirko Bonadei2ab97f62019-07-18 13:44:12 +0200627 std::vector<char*> args = absl::ParseCommandLine(argc, argv);
628 if (args.size() != 1) {
oprypin6e09d872017-08-31 03:21:39 -0700629 printf("%s", kUsageDescription);
oprypin6e09d872017-08-31 03:21:39 -0700630 return 1;
631 }
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000632
peah60a189f2016-05-24 20:54:40 -0700633 SimulationSettings settings = CreateSettings();
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200634 if (!input_aecdump.empty()) {
635 settings.aec_dump_input_string = input_aecdump;
636 settings.processed_capture_samples = processed_capture_samples;
637 RTC_CHECK(settings.processed_capture_samples);
638 }
peah60a189f2016-05-24 20:54:40 -0700639 PerformBasicParameterSanityChecks(settings);
640 std::unique_ptr<AudioProcessingSimulator> processor;
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000641
Sonia-Florina Horchidanb75d14c2019-08-12 09:57:01 +0200642 if (settings.aec_dump_input_filename || settings.aec_dump_input_string) {
Ivo Creusen8c812f32018-03-09 17:33:04 +0100643 processor.reset(new AecDumpBasedSimulator(settings, std::move(ap_builder)));
aluebsb0ad43b2015-11-20 00:11:53 -0800644 } else {
Ivo Creusen8c812f32018-03-09 17:33:04 +0100645 processor.reset(new WavBasedSimulator(settings, std::move(ap_builder)));
andrewbdafe312015-10-29 23:42:54 -0700646 }
647
peah60a189f2016-05-24 20:54:40 -0700648 processor->Process();
aluebsb0ad43b2015-11-20 00:11:53 -0800649
peah60a189f2016-05-24 20:54:40 -0700650 if (settings.report_performance) {
Per Åhgrenada9b892019-04-03 16:06:42 +0200651 processor->GetApiCallStatistics().PrintReport();
652 }
653 if (settings.performance_report_output_filename) {
654 processor->GetApiCallStatistics().WriteReportToFile(
655 *settings.performance_report_output_filename);
peah60a189f2016-05-24 20:54:40 -0700656 }
657
658 if (settings.report_bitexactness && settings.aec_dump_input_filename) {
659 if (processor->OutputWasBitexact()) {
660 std::cout << "The processing was bitexact.";
661 } else {
662 std::cout << "The processing was not bitexact.";
663 }
Alejandro Luebs5d22c002015-04-15 11:26:40 -0700664 }
aluebsb0ad43b2015-11-20 00:11:53 -0800665
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000666 return 0;
667}
668
peah60a189f2016-05-24 20:54:40 -0700669} // namespace test
andrew@webrtc.org08df9b22014-12-16 20:57:15 +0000670} // namespace webrtc