blob: 47dd62ed02ce13df044a45a088a1c528ba0891d0 [file] [log] [blame]
niklase@google.com470e71d2011-07-07 08:21:25 +00001/*
andrew@webrtc.org6f9f8172012-03-06 19:03:39 +00002 * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
niklase@google.com470e71d2011-07-07 08:21:25 +00003 *
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
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#ifndef MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_
12#define MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_
niklase@google.com470e71d2011-07-07 08:21:25 +000013
Per Åhgren09e9a832020-05-11 11:03:47 +020014#include <stdio.h>
15
niklase@google.com470e71d2011-07-07 08:21:25 +000016#include <list>
kwiberg88788ad2016-02-19 07:04:49 -080017#include <memory>
Per Åhgren09e9a832020-05-11 11:03:47 +020018#include <string>
Michael Graczyk86c6d332015-07-23 11:41:39 -070019#include <vector>
niklase@google.com470e71d2011-07-07 08:21:25 +000020
Alessio Bazzicabab12852022-02-03 16:30:25 +010021#include "api/array_view.h"
Artem Titov741daaf2019-03-21 14:37:36 +010022#include "api/function_view.h"
saza1d600522019-10-18 13:29:43 +020023#include "modules/audio_processing/aec3/echo_canceller3.h"
24#include "modules/audio_processing/agc/agc_manager_direct.h"
Hanna Silen529131d2021-10-29 14:55:45 +020025#include "modules/audio_processing/agc/analog_gain_stats_reporter.h"
Sam Zackrisson41478c72019-10-15 10:10:26 +020026#include "modules/audio_processing/agc/gain_control.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020027#include "modules/audio_processing/audio_buffer.h"
Per Åhgrendb5d7282021-03-15 16:31:04 +000028#include "modules/audio_processing/capture_levels_adjuster/capture_levels_adjuster.h"
saza1d600522019-10-18 13:29:43 +020029#include "modules/audio_processing/echo_control_mobile_impl.h"
saza1d600522019-10-18 13:29:43 +020030#include "modules/audio_processing/gain_control_impl.h"
31#include "modules/audio_processing/gain_controller2.h"
32#include "modules/audio_processing/high_pass_filter.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020033#include "modules/audio_processing/include/aec_dump.h"
Per Åhgren71652f42020-03-17 13:23:58 +010034#include "modules/audio_processing/include/audio_frame_proxies.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020035#include "modules/audio_processing/include/audio_processing.h"
Sam Zackrissonb24c00f2018-11-26 16:18:25 +010036#include "modules/audio_processing/include/audio_processing_statistics.h"
Per Åhgren0cbb58e2019-10-29 22:59:44 +010037#include "modules/audio_processing/ns/noise_suppressor.h"
Sam Zackrissonb37e59d2020-04-27 08:39:33 +020038#include "modules/audio_processing/optionally_built_submodule_creators.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020039#include "modules/audio_processing/render_queue_item_verifier.h"
40#include "modules/audio_processing/rms_level.h"
saza1d600522019-10-18 13:29:43 +020041#include "modules/audio_processing/transient/transient_suppressor.h"
42#include "modules/audio_processing/voice_detection.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020043#include "rtc_base/gtest_prod_util.h"
44#include "rtc_base/ignore_wundef.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020045#include "rtc_base/swap_queue.h"
Markus Handell0df0fae2020-07-07 15:53:34 +020046#include "rtc_base/synchronization/mutex.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020047#include "rtc_base/thread_annotations.h"
peahdf3efa82015-11-28 12:35:15 -080048
niklase@google.com470e71d2011-07-07 08:21:25 +000049namespace webrtc {
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +000050
Per Åhgren13735822018-02-12 21:42:56 +010051class ApmDataDumper;
ekmeyerson60d9b332015-08-14 10:35:55 -070052class AudioConverter;
Michael Graczykdfa36052015-03-25 16:37:27 -070053
Henrik Lundin8a9aa552022-02-08 09:15:12 +000054constexpr int RuntimeSettingQueueSize() {
55 return 100;
56}
57
niklase@google.com470e71d2011-07-07 08:21:25 +000058class AudioProcessingImpl : public AudioProcessing {
59 public:
peahdf3efa82015-11-28 12:35:15 -080060 // Methods forcing APM to run in a single-threaded manner.
61 // Acquires both the render and capture locks.
Alessio Bazzicabe1b8982021-09-17 08:26:10 +020062 AudioProcessingImpl();
Alessio Bazzica20a9ac62021-10-14 10:55:08 +020063 AudioProcessingImpl(const AudioProcessing::Config& config,
64 std::unique_ptr<CustomProcessing> capture_post_processor,
Alex Loiko5825aa62017-12-18 16:02:40 +010065 std::unique_ptr<CustomProcessing> render_pre_processor,
Gustaf Ullberg002ef282017-10-12 15:13:17 +020066 std::unique_ptr<EchoControlFactory> echo_control_factory,
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +020067 rtc::scoped_refptr<EchoDetector> echo_detector,
68 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer);
kwiberg83ffe452016-08-29 14:46:07 -070069 ~AudioProcessingImpl() override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000070 int Initialize() override;
Michael Graczyk86c6d332015-07-23 11:41:39 -070071 int Initialize(const ProcessingConfig& processing_config) override;
peah88ac8532016-09-12 16:47:25 -070072 void ApplyConfig(const AudioProcessing::Config& config) override;
Per Åhgren09e9a832020-05-11 11:03:47 +020073 bool CreateAndAttachAecDump(const std::string& file_name,
74 int64_t max_log_size_bytes,
75 rtc::TaskQueue* worker_queue) override;
76 bool CreateAndAttachAecDump(FILE* handle,
77 int64_t max_log_size_bytes,
78 rtc::TaskQueue* worker_queue) override;
79 // TODO(webrtc:5298) Deprecated variant.
aleloi868f32f2017-05-23 07:20:05 -070080 void AttachAecDump(std::unique_ptr<AecDump> aec_dump) override;
81 void DetachAecDump() override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020082 void SetRuntimeSetting(RuntimeSetting setting) override;
Per Åhgren0a144a72021-02-09 08:47:51 +010083 bool PostRuntimeSetting(RuntimeSetting setting) override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020084
peahdf3efa82015-11-28 12:35:15 -080085 // Capture-side exclusive methods possibly running APM in a
86 // multi-threaded manner. Acquire the capture lock.
Per Åhgren645f24c2020-03-16 12:06:02 +010087 int ProcessStream(const int16_t* const src,
88 const StreamConfig& input_config,
89 const StreamConfig& output_config,
Per Åhgrendc5522b2020-03-19 14:55:58 +010090 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000091 int ProcessStream(const float* const* src,
Michael Graczyk86c6d332015-07-23 11:41:39 -070092 const StreamConfig& input_config,
93 const StreamConfig& output_config,
94 float* const* dest) override;
Per Åhgrenc20a19c2019-11-13 11:12:29 +010095 bool GetLinearAecOutput(
96 rtc::ArrayView<std::array<float, 160>> linear_output) const override;
peahdf3efa82015-11-28 12:35:15 -080097 void set_output_will_be_muted(bool muted) override;
Per Åhgren0a144a72021-02-09 08:47:51 +010098 void HandleCaptureOutputUsedSetting(bool capture_output_used)
99 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800100 int set_stream_delay_ms(int delay) override;
peahdf3efa82015-11-28 12:35:15 -0800101 void set_stream_key_pressed(bool key_pressed) override;
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100102 void set_stream_analog_level(int level) override;
Markus Handell02ba1d22020-05-14 14:31:18 +0200103 int recommended_stream_analog_level() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200104 RTC_LOCKS_EXCLUDED(mutex_capture_) override;
peahdf3efa82015-11-28 12:35:15 -0800105
106 // Render-side exclusive methods possibly running APM in a
107 // multi-threaded manner. Acquire the render lock.
Per Åhgren645f24c2020-03-16 12:06:02 +0100108 int ProcessReverseStream(const int16_t* const src,
109 const StreamConfig& input_config,
110 const StreamConfig& output_config,
111 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000112 int AnalyzeReverseStream(const float* const* data,
Gustaf Ullberg8c51f2e2019-10-22 15:21:31 +0200113 const StreamConfig& reverse_config) override;
ekmeyerson60d9b332015-08-14 10:35:55 -0700114 int ProcessReverseStream(const float* const* src,
peahde65ddc2016-09-16 15:02:15 -0700115 const StreamConfig& input_config,
116 const StreamConfig& output_config,
ekmeyerson60d9b332015-08-14 10:35:55 -0700117 float* const* dest) override;
peahdf3efa82015-11-28 12:35:15 -0800118
119 // Methods only accessed from APM submodules or
120 // from AudioProcessing tests in a single-threaded manner.
121 // Hence there is no need for locks in these.
122 int proc_sample_rate_hz() const override;
123 int proc_split_sample_rate_hz() const override;
Peter Kasting69558702016-01-12 16:26:35 -0800124 size_t num_input_channels() const override;
125 size_t num_proc_channels() const override;
126 size_t num_output_channels() const override;
127 size_t num_reverse_channels() const override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000128 int stream_delay_ms() const override;
peahdf3efa82015-11-28 12:35:15 -0800129
Per Åhgrencf4c8722019-12-30 14:32:14 +0100130 AudioProcessingStats GetStatistics(bool has_remote_tracks) override {
131 return GetStatistics();
132 }
133 AudioProcessingStats GetStatistics() override {
134 return stats_reporter_.GetStatistics();
135 }
ivoc3e9a5372016-10-28 07:55:33 -0700136
henrik.lundinadf06352017-04-05 05:48:24 -0700137 AudioProcessing::Config GetConfig() const override;
peah8271d042016-11-22 07:24:52 -0800138
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000139 protected:
andrew@webrtc.orga8b97372014-03-10 22:26:12 +0000140 // Overridden in a mock.
Per Åhgren0ade9832020-09-01 23:57:20 +0200141 virtual void InitializeLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200142 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Niels Möller5b747232021-07-26 17:16:25 +0200143 void AssertLockedForTest()
144 RTC_ASSERT_EXCLUSIVE_LOCK(mutex_render_, mutex_capture_) {
145 mutex_render_.AssertHeld();
146 mutex_capture_.AssertHeld();
147 }
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000148
niklase@google.com470e71d2011-07-07 08:21:25 +0000149 private:
peahc19f3122016-10-07 14:54:10 -0700150 // TODO(peah): These friend classes should be removed as soon as the new
151 // parameter setting scheme allows.
152 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, DefaultBehavior);
153 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, ValidConfigBehavior);
154 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, InValidConfigBehavior);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200155 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
156 ToggleTransientSuppressor);
157 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
158 ReinitializeTransientSuppressor);
159 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
160 BitexactWithDisabledModules);
161
Markus Handell02ba1d22020-05-14 14:31:18 +0200162 int recommended_stream_analog_level_locked() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200163 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200164
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200165 void OverrideSubmoduleCreationForTesting(
166 const ApmSubmoduleCreationOverrides& overrides);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200167
168 // Class providing thread-safe message pipe functionality for
Artem Titov0b489302021-07-28 20:50:03 +0200169 // `runtime_settings_`.
Alessio Bazzicac054e782018-04-16 12:10:09 +0200170 class RuntimeSettingEnqueuer {
171 public:
172 explicit RuntimeSettingEnqueuer(
173 SwapQueue<RuntimeSetting>* runtime_settings);
174 ~RuntimeSettingEnqueuer();
Per Åhgren0a144a72021-02-09 08:47:51 +0100175
176 // Enqueue setting and return whether the setting was successfully enqueued.
177 bool Enqueue(RuntimeSetting setting);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200178
179 private:
Alessio Bazzica33444dc2018-04-20 13:16:55 +0200180 SwapQueue<RuntimeSetting>& runtime_settings_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200181 };
Alex Loiko73ec0192018-05-15 10:52:28 +0200182
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100183 const std::unique_ptr<ApmDataDumper> data_dumper_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200184 static int instance_count_;
Per Åhgrenb2b58d82019-12-02 14:59:40 +0100185 const bool use_setup_specific_default_aec3_config_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200186
Alessio Bazzica0441bb62021-08-10 15:23:23 +0200187 const bool use_denormal_disabler_;
188
Alex Loiko73ec0192018-05-15 10:52:28 +0200189 SwapQueue<RuntimeSetting> capture_runtime_settings_;
190 SwapQueue<RuntimeSetting> render_runtime_settings_;
191
192 RuntimeSettingEnqueuer capture_runtime_settings_enqueuer_;
193 RuntimeSettingEnqueuer render_runtime_settings_enqueuer_;
Alessio Bazzicac054e782018-04-16 12:10:09 +0200194
Gustaf Ullberg002ef282017-10-12 15:13:17 +0200195 // EchoControl factory.
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100196 const std::unique_ptr<EchoControlFactory> echo_control_factory_;
Gustaf Ullbergd8579e02017-10-11 16:29:02 +0200197
saza1d600522019-10-18 13:29:43 +0200198 class SubmoduleStates {
peah2ace3f92016-09-10 04:42:27 -0700199 public:
saza1d600522019-10-18 13:29:43 +0200200 SubmoduleStates(bool capture_post_processor_enabled,
201 bool render_pre_processor_enabled,
202 bool capture_analyzer_enabled);
peah2ace3f92016-09-10 04:42:27 -0700203 // Updates the submodule state and returns true if it has changed.
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200204 bool Update(bool high_pass_filter_enabled,
peah2ace3f92016-09-10 04:42:27 -0700205 bool mobile_echo_controller_enabled,
206 bool noise_suppressor_enabled,
peah2ace3f92016-09-10 04:42:27 -0700207 bool adaptive_gain_controller_enabled,
alessiob3ec96df2017-05-22 06:57:06 -0700208 bool gain_controller2_enabled,
Per Åhgrendb5d7282021-03-15 16:31:04 +0000209 bool gain_adjustment_enabled,
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200210 bool echo_controller_enabled,
Sam Zackrisson0824c6f2019-10-07 14:03:56 +0200211 bool voice_detector_enabled,
peah2ace3f92016-09-10 04:42:27 -0700212 bool transient_suppressor_enabled);
213 bool CaptureMultiBandSubModulesActive() const;
Gustaf Ullberg8675eee2019-10-09 13:34:36 +0200214 bool CaptureMultiBandProcessingPresent() const;
215 bool CaptureMultiBandProcessingActive(bool ec_processing_active) const;
peah23ac8b42017-05-23 05:33:56 -0700216 bool CaptureFullBandProcessingActive() const;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200217 bool CaptureAnalyzerActive() const;
peah2ace3f92016-09-10 04:42:27 -0700218 bool RenderMultiBandSubModulesActive() const;
Alex Loiko5825aa62017-12-18 16:02:40 +0100219 bool RenderFullBandProcessingActive() const;
peah2ace3f92016-09-10 04:42:27 -0700220 bool RenderMultiBandProcessingActive() const;
Per Åhgren0aefbf02019-08-23 21:29:17 +0200221 bool HighPassFilteringRequired() const;
peah2ace3f92016-09-10 04:42:27 -0700222
223 private:
Sam Zackrisson0beac582017-09-25 12:04:02 +0200224 const bool capture_post_processor_enabled_ = false;
Alex Loiko5825aa62017-12-18 16:02:40 +0100225 const bool render_pre_processor_enabled_ = false;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200226 const bool capture_analyzer_enabled_ = false;
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200227 bool high_pass_filter_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700228 bool mobile_echo_controller_enabled_ = false;
229 bool noise_suppressor_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700230 bool adaptive_gain_controller_enabled_ = false;
alessiob3ec96df2017-05-22 06:57:06 -0700231 bool gain_controller2_enabled_ = false;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000232 bool gain_adjustment_enabled_ = false;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200233 bool echo_controller_enabled_ = false;
Sam Zackrisson0824c6f2019-10-07 14:03:56 +0200234 bool voice_detector_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700235 bool transient_suppressor_enabled_ = false;
236 bool first_update_ = true;
237 };
238
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100239 // Methods for modifying the formats struct that is used by both
240 // the render and capture threads. The check for whether modifications are
241 // needed is done while holding a single lock only, thereby avoiding that the
242 // capture thread blocks the render thread.
243 // Called by render: Holds the render lock when reading the format struct and
244 // acquires both locks if reinitialization is required.
peahdf3efa82015-11-28 12:35:15 -0800245 int MaybeInitializeRender(const ProcessingConfig& processing_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200246 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100247 // Called by capture: Holds the capture lock when reading the format struct
248 // and acquires both locks if reinitialization is needed.
249 int MaybeInitializeCapture(const StreamConfig& input_config,
250 const StreamConfig& output_config);
peahdf3efa82015-11-28 12:35:15 -0800251
peah2ace3f92016-09-10 04:42:27 -0700252 // Method for updating the state keeping track of the active submodules.
253 // Returns a bool indicating whether the state has changed.
danilchap56359be2017-09-07 07:53:45 -0700254 bool UpdateActiveSubmoduleStates()
Markus Handell0df0fae2020-07-07 15:53:34 +0200255 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800256
Per Åhgrenc0734712020-01-02 15:15:36 +0100257 // Methods requiring APM running in a single-threaded manner, requiring both
258 // the render and capture lock to be acquired.
Michael Graczyk86c6d332015-07-23 11:41:39 -0700259 int InitializeLocked(const ProcessingConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200260 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700261 void InitializeResidualEchoDetector()
Markus Handell0df0fae2020-07-07 15:53:34 +0200262 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenf204faf2019-04-25 15:18:06 +0200263 void InitializeEchoController()
Markus Handell0df0fae2020-07-07 15:53:34 +0200264 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100265
Alessio Bazzica38901042021-10-14 12:14:21 +0200266 // Initializations of capture-only sub-modules, requiring the capture lock
Per Åhgrenc0734712020-01-02 15:15:36 +0100267 // already acquired.
Per Åhgren0f14db22020-01-03 14:27:14 +0100268 void InitializeHighPassFilter(bool forced_reset)
Markus Handell0df0fae2020-07-07 15:53:34 +0200269 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
270 void InitializeVoiceDetector() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
271 void InitializeGainController1() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100272 void InitializeTransientSuppressor()
Markus Handell0df0fae2020-07-07 15:53:34 +0200273 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Alessio Bazzica38901042021-10-14 12:14:21 +0200274 // Initializes the `GainController2` sub-module. If the sub-module is enabled
275 // and `config_has_changed` is true, recreates the sub-module.
276 void InitializeGainController2(bool config_has_changed)
277 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200278 void InitializeNoiseSuppressor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrendb5d7282021-03-15 16:31:04 +0000279 void InitializeCaptureLevelsAdjuster()
280 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200281 void InitializePostProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
282 void InitializeAnalyzer() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100283
284 // Initializations of render-only submodules, requiring the render lock
285 // already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200286 void InitializePreProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peahdf3efa82015-11-28 12:35:15 -0800287
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200288 // Sample rate used for the fullband processing.
289 int proc_fullband_sample_rate_hz() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200290 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200291
Alex Loiko73ec0192018-05-15 10:52:28 +0200292 // Empties and handles the respective RuntimeSetting queues.
293 void HandleCaptureRuntimeSettings()
Markus Handell0df0fae2020-07-07 15:53:34 +0200294 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
295 void HandleRenderRuntimeSettings()
296 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100297
Markus Handell0df0fae2020-07-07 15:53:34 +0200298 void EmptyQueuedRenderAudio() RTC_LOCKS_EXCLUDED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200299 void EmptyQueuedRenderAudioLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200300 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700301 void AllocateRenderQueue()
Markus Handell0df0fae2020-07-07 15:53:34 +0200302 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
peah9e6a2902017-05-15 07:19:21 -0700303 void QueueBandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200304 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah9e6a2902017-05-15 07:19:21 -0700305 void QueueNonbandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200306 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700307
peahdf3efa82015-11-28 12:35:15 -0800308 // Capture-side exclusive methods possibly running APM in a multi-threaded
309 // manner that are called with the render lock already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200310 int ProcessCaptureStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800311
312 // Render-side exclusive methods possibly running APM in a multi-threaded
313 // manner that are called with the render lock already acquired.
ekmeyerson60d9b332015-08-14 10:35:55 -0700314 // TODO(ekm): Remove once all clients updated to new interface.
peahdf3efa82015-11-28 12:35:15 -0800315 int AnalyzeReverseStreamLocked(const float* const* src,
316 const StreamConfig& input_config,
317 const StreamConfig& output_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200318 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
319 int ProcessRenderStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
andrew@webrtc.org17e40642014-03-04 20:58:13 +0000320
aleloi868f32f2017-05-23 07:20:05 -0700321 // Collects configuration settings from public and private
322 // submodules to be saved as an audioproc::Config message on the
Artem Titov0b489302021-07-28 20:50:03 +0200323 // AecDump if it is attached. If not `forced`, only writes the current
324 // config if it is different from the last saved one; if `forced`,
aleloi868f32f2017-05-23 07:20:05 -0700325 // writes the config regardless of the last saved.
326 void WriteAecDumpConfigMessage(bool forced)
Markus Handell0df0fae2020-07-07 15:53:34 +0200327 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700328
329 // Notifies attached AecDump of current configuration and capture data.
330 void RecordUnprocessedCaptureStream(const float* const* capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200331 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700332
Per Åhgren645f24c2020-03-16 12:06:02 +0100333 void RecordUnprocessedCaptureStream(const int16_t* const data,
334 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200335 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700336
337 // Notifies attached AecDump of current configuration and
338 // processed capture data and issues a capture stream recording
339 // request.
340 void RecordProcessedCaptureStream(
341 const float* const* processed_capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200342 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700343
Per Åhgren645f24c2020-03-16 12:06:02 +0100344 void RecordProcessedCaptureStream(const int16_t* const data,
345 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200346 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700347
348 // Notifies attached AecDump about current state (delay, drift, etc).
Markus Handell0df0fae2020-07-07 15:53:34 +0200349 void RecordAudioProcessingState()
350 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700351
Per Åhgren652ada52021-03-03 10:52:44 +0000352 // Ensures that overruns in the capture runtime settings queue is properly
353 // handled by the code, providing safe-fallbacks to mitigate the implications
354 // of any settings being missed.
355 void HandleOverrunInCaptureRuntimeSettingsQueue()
356 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
357
aleloi868f32f2017-05-23 07:20:05 -0700358 // AecDump instance used for optionally logging APM config, input
359 // and output to file in the AEC-dump format defined in debug.proto.
360 std::unique_ptr<AecDump> aec_dump_;
361
362 // Hold the last config written with AecDump for avoiding writing
363 // the same config twice.
Markus Handell0df0fae2020-07-07 15:53:34 +0200364 InternalAPMConfig apm_config_for_aec_dump_ RTC_GUARDED_BY(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700365
peahdf3efa82015-11-28 12:35:15 -0800366 // Critical sections.
Markus Handell0df0fae2020-07-07 15:53:34 +0200367 mutable Mutex mutex_render_ RTC_ACQUIRED_BEFORE(mutex_capture_);
368 mutable Mutex mutex_capture_;
peahdf3efa82015-11-28 12:35:15 -0800369
peahc19f3122016-10-07 14:54:10 -0700370 // Struct containing the Config specifying the behavior of APM.
371 AudioProcessing::Config config_;
372
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200373 // Overrides for testing the exclusion of some submodules from the build.
374 ApmSubmoduleCreationOverrides submodule_creation_overrides_
Markus Handell0df0fae2020-07-07 15:53:34 +0200375 RTC_GUARDED_BY(mutex_capture_);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200376
peah2ace3f92016-09-10 04:42:27 -0700377 // Class containing information about what submodules are active.
saza1d600522019-10-18 13:29:43 +0200378 SubmoduleStates submodule_states_;
peah2ace3f92016-09-10 04:42:27 -0700379
saza1d600522019-10-18 13:29:43 +0200380 // Struct containing the pointers to the submodules.
381 struct Submodules {
382 Submodules(std::unique_ptr<CustomProcessing> capture_post_processor,
383 std::unique_ptr<CustomProcessing> render_pre_processor,
384 rtc::scoped_refptr<EchoDetector> echo_detector,
Per Åhgren3daedb62019-11-22 12:11:40 +0100385 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer)
saza1d600522019-10-18 13:29:43 +0200386 : echo_detector(std::move(echo_detector)),
387 capture_post_processor(std::move(capture_post_processor)),
388 render_pre_processor(std::move(render_pre_processor)),
Per Åhgren3daedb62019-11-22 12:11:40 +0100389 capture_analyzer(std::move(capture_analyzer)) {}
saza1d600522019-10-18 13:29:43 +0200390 // Accessed internally from capture or during initialization.
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100391 const rtc::scoped_refptr<EchoDetector> echo_detector;
392 const std::unique_ptr<CustomProcessing> capture_post_processor;
393 const std::unique_ptr<CustomProcessing> render_pre_processor;
394 const std::unique_ptr<CustomAudioAnalyzer> capture_analyzer;
saza1d600522019-10-18 13:29:43 +0200395 std::unique_ptr<AgcManagerDirect> agc_manager;
396 std::unique_ptr<GainControlImpl> gain_control;
saza1d600522019-10-18 13:29:43 +0200397 std::unique_ptr<GainController2> gain_controller2;
398 std::unique_ptr<HighPassFilter> high_pass_filter;
saza1d600522019-10-18 13:29:43 +0200399 std::unique_ptr<EchoControl> echo_controller;
400 std::unique_ptr<EchoControlMobileImpl> echo_control_mobile;
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100401 std::unique_ptr<NoiseSuppressor> noise_suppressor;
saza1d600522019-10-18 13:29:43 +0200402 std::unique_ptr<TransientSuppressor> transient_suppressor;
saza1d600522019-10-18 13:29:43 +0200403 std::unique_ptr<VoiceDetection> voice_detector;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000404 std::unique_ptr<CaptureLevelsAdjuster> capture_levels_adjuster;
saza1d600522019-10-18 13:29:43 +0200405 } submodules_;
peahdf3efa82015-11-28 12:35:15 -0800406
peah192164e2015-11-17 02:16:45 -0800407 // State that is written to while holding both the render and capture locks
peahdf3efa82015-11-28 12:35:15 -0800408 // but can be read without any lock being held.
409 // As this is only accessed internally of APM, and all internal methods in APM
410 // either are holding the render or capture locks, this construct is safe as
411 // it is not possible to read the variables while writing them.
412 struct ApmFormatState {
413 ApmFormatState()
peah192164e2015-11-17 02:16:45 -0800414 : // Format of processing streams at input/output call sites.
Henrik Lundin64253a92022-02-04 09:02:48 +0000415 api_format({{{kSampleRate16kHz, 1},
416 {kSampleRate16kHz, 1},
417 {kSampleRate16kHz, 1},
418 {kSampleRate16kHz, 1}}}),
peahde65ddc2016-09-16 15:02:15 -0700419 render_processing_format(kSampleRate16kHz, 1) {}
peahdf3efa82015-11-28 12:35:15 -0800420 ProcessingConfig api_format;
peahde65ddc2016-09-16 15:02:15 -0700421 StreamConfig render_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800422 } formats_;
Michael Graczyk86c6d332015-07-23 11:41:39 -0700423
peahdf3efa82015-11-28 12:35:15 -0800424 // APM constants.
425 const struct ApmConstants {
Per Åhgren0695df12020-01-13 14:43:13 +0100426 ApmConstants(bool multi_channel_render_support,
Per Åhgrenc0424252019-12-10 13:04:15 +0100427 bool multi_channel_capture_support,
Per Åhgren19775cb2021-03-12 23:08:09 +0000428 bool enforce_split_band_hpf,
Gustaf Ullberga399c822021-05-18 12:17:56 +0200429 bool minimize_processing_for_unused_output,
430 bool transient_suppressor_forced_off)
Per Åhgren0695df12020-01-13 14:43:13 +0100431 : multi_channel_render_support(multi_channel_render_support),
Per Åhgrenc0424252019-12-10 13:04:15 +0100432 multi_channel_capture_support(multi_channel_capture_support),
Per Åhgren19775cb2021-03-12 23:08:09 +0000433 enforce_split_band_hpf(enforce_split_band_hpf),
434 minimize_processing_for_unused_output(
Gustaf Ullberga399c822021-05-18 12:17:56 +0200435 minimize_processing_for_unused_output),
436 transient_suppressor_forced_off(transient_suppressor_forced_off) {}
Per Åhgrene14cb992019-11-27 09:34:22 +0100437 bool multi_channel_render_support;
438 bool multi_channel_capture_support;
Per Åhgrenc0424252019-12-10 13:04:15 +0100439 bool enforce_split_band_hpf;
Per Åhgren19775cb2021-03-12 23:08:09 +0000440 bool minimize_processing_for_unused_output;
Gustaf Ullberga399c822021-05-18 12:17:56 +0200441 bool transient_suppressor_forced_off;
peahdf3efa82015-11-28 12:35:15 -0800442 } constants_;
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000443
peahdf3efa82015-11-28 12:35:15 -0800444 struct ApmCaptureState {
Per Åhgrenc0734712020-01-02 15:15:36 +0100445 ApmCaptureState();
kwiberg83ffe452016-08-29 14:46:07 -0700446 ~ApmCaptureState();
peahdf3efa82015-11-28 12:35:15 -0800447 bool was_stream_delay_set;
Per Åhgren0a144a72021-02-09 08:47:51 +0100448 bool capture_output_used;
Per Åhgren55bc0772021-03-12 14:18:36 +0000449 bool capture_output_used_last_frame;
peahdf3efa82015-11-28 12:35:15 -0800450 bool key_pressed;
kwiberg88788ad2016-02-19 07:04:49 -0800451 std::unique_ptr<AudioBuffer> capture_audio;
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200452 std::unique_ptr<AudioBuffer> capture_fullband_audio;
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100453 std::unique_ptr<AudioBuffer> linear_aec_output;
peahde65ddc2016-09-16 15:02:15 -0700454 // Only the rate and samples fields of capture_processing_format_ are used
455 // because the capture processing number of channels is mutable and is
456 // tracked by the capture_audio_.
457 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800458 int split_rate;
peah67995532017-04-10 14:12:41 -0700459 bool echo_path_gain_change;
Per Åhgren88cf0502018-07-16 17:08:41 +0200460 int prev_analog_mic_level;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000461 float prev_pre_adjustment_gain;
Fredrik Hernqvistca362852019-05-10 15:50:02 +0200462 int playout_volume;
463 int prev_playout_volume;
Sam Zackrissonb24c00f2018-11-26 16:18:25 +0100464 AudioProcessingStats stats;
Per Åhgren0695df12020-01-13 14:43:13 +0100465 int cached_stream_analog_level_ = 0;
Markus Handell0df0fae2020-07-07 15:53:34 +0200466 } capture_ RTC_GUARDED_BY(mutex_capture_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000467
peahdf3efa82015-11-28 12:35:15 -0800468 struct ApmCaptureNonLockedState {
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200469 ApmCaptureNonLockedState()
peahde65ddc2016-09-16 15:02:15 -0700470 : capture_processing_format(kSampleRate16kHz),
peahdf3efa82015-11-28 12:35:15 -0800471 split_rate(kSampleRate16kHz),
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200472 stream_delay_ms(0) {}
peahde65ddc2016-09-16 15:02:15 -0700473 // Only the rate and samples fields of capture_processing_format_ are used
474 // because the forward processing number of channels is mutable and is
475 // tracked by the capture_audio_.
476 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800477 int split_rate;
478 int stream_delay_ms;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200479 bool echo_controller_enabled = false;
peahdf3efa82015-11-28 12:35:15 -0800480 } capture_nonlocked_;
andrew@webrtc.org75dd2882014-02-11 20:52:30 +0000481
peahdf3efa82015-11-28 12:35:15 -0800482 struct ApmRenderState {
kwiberg83ffe452016-08-29 14:46:07 -0700483 ApmRenderState();
484 ~ApmRenderState();
kwiberg88788ad2016-02-19 07:04:49 -0800485 std::unique_ptr<AudioConverter> render_converter;
486 std::unique_ptr<AudioBuffer> render_audio;
Markus Handell0df0fae2020-07-07 15:53:34 +0200487 } render_ RTC_GUARDED_BY(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700488
Per Åhgrencf4c8722019-12-30 14:32:14 +0100489 // Class for statistics reporting. The class is thread-safe and no lock is
490 // needed when accessing it.
491 class ApmStatsReporter {
492 public:
493 ApmStatsReporter();
494 ~ApmStatsReporter();
495
496 // Returns the most recently reported statistics.
497 AudioProcessingStats GetStatistics();
498
499 // Update the cached statistics.
500 void UpdateStatistics(const AudioProcessingStats& new_stats);
501
502 private:
Markus Handell0df0fae2020-07-07 15:53:34 +0200503 Mutex mutex_stats_;
504 AudioProcessingStats cached_stats_ RTC_GUARDED_BY(mutex_stats_);
Per Åhgrencf4c8722019-12-30 14:32:14 +0100505 SwapQueue<AudioProcessingStats> stats_message_queue_;
506 } stats_reporter_;
507
Markus Handell0df0fae2020-07-07 15:53:34 +0200508 std::vector<int16_t> aecm_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
509 std::vector<int16_t> aecm_capture_queue_buffer_
510 RTC_GUARDED_BY(mutex_capture_);
peah701d6282016-10-25 05:42:20 -0700511
Markus Handell0df0fae2020-07-07 15:53:34 +0200512 size_t agc_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
513 RTC_GUARDED_BY(mutex_capture_) = 0;
514 std::vector<int16_t> agc_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
515 std::vector<int16_t> agc_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700516
Markus Handell0df0fae2020-07-07 15:53:34 +0200517 size_t red_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
518 RTC_GUARDED_BY(mutex_capture_) = 0;
519 std::vector<float> red_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
520 std::vector<float> red_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700521
Markus Handell0df0fae2020-07-07 15:53:34 +0200522 RmsLevel capture_input_rms_ RTC_GUARDED_BY(mutex_capture_);
523 RmsLevel capture_output_rms_ RTC_GUARDED_BY(mutex_capture_);
524 int capture_rms_interval_counter_ RTC_GUARDED_BY(mutex_capture_) = 0;
henrik.lundin290d43a2016-11-29 08:09:09 -0800525
Hanna Silen529131d2021-10-29 14:55:45 +0200526 AnalogGainStatsReporter analog_gain_stats_reporter_
527 RTC_GUARDED_BY(mutex_capture_);
528
peah764e3642016-10-22 05:04:30 -0700529 // Lock protection not needed.
peaha0624602016-10-25 04:45:24 -0700530 std::unique_ptr<
531 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
peah701d6282016-10-25 05:42:20 -0700532 aecm_render_signal_queue_;
533 std::unique_ptr<
534 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
535 agc_render_signal_queue_;
ivoc9f4a4a02016-10-28 05:39:16 -0700536 std::unique_ptr<SwapQueue<std::vector<float>, RenderQueueItemVerifier<float>>>
537 red_render_signal_queue_;
niklase@google.com470e71d2011-07-07 08:21:25 +0000538};
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000539
niklase@google.com470e71d2011-07-07 08:21:25 +0000540} // namespace webrtc
541
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200542#endif // MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_