blob: 026152b576a947e2b984962c4fac5ff748727b58 [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
Artem Titov741daaf2019-03-21 14:37:36 +010021#include "api/function_view.h"
saza1d600522019-10-18 13:29:43 +020022#include "modules/audio_processing/aec3/echo_canceller3.h"
23#include "modules/audio_processing/agc/agc_manager_direct.h"
Sam Zackrisson41478c72019-10-15 10:10:26 +020024#include "modules/audio_processing/agc/gain_control.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020025#include "modules/audio_processing/audio_buffer.h"
Per Åhgrendb5d7282021-03-15 16:31:04 +000026#include "modules/audio_processing/capture_levels_adjuster/capture_levels_adjuster.h"
saza1d600522019-10-18 13:29:43 +020027#include "modules/audio_processing/echo_control_mobile_impl.h"
saza1d600522019-10-18 13:29:43 +020028#include "modules/audio_processing/gain_control_impl.h"
29#include "modules/audio_processing/gain_controller2.h"
30#include "modules/audio_processing/high_pass_filter.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020031#include "modules/audio_processing/include/aec_dump.h"
Per Åhgren71652f42020-03-17 13:23:58 +010032#include "modules/audio_processing/include/audio_frame_proxies.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020033#include "modules/audio_processing/include/audio_processing.h"
Sam Zackrissonb24c00f2018-11-26 16:18:25 +010034#include "modules/audio_processing/include/audio_processing_statistics.h"
saza1d600522019-10-18 13:29:43 +020035#include "modules/audio_processing/level_estimator.h"
Per Åhgren0cbb58e2019-10-29 22:59:44 +010036#include "modules/audio_processing/ns/noise_suppressor.h"
Sam Zackrissonb37e59d2020-04-27 08:39:33 +020037#include "modules/audio_processing/optionally_built_submodule_creators.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020038#include "modules/audio_processing/render_queue_item_verifier.h"
saza1d600522019-10-18 13:29:43 +020039#include "modules/audio_processing/residual_echo_detector.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020040#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
niklase@google.com470e71d2011-07-07 08:21:25 +000054class AudioProcessingImpl : public AudioProcessing {
55 public:
peahdf3efa82015-11-28 12:35:15 -080056 // Methods forcing APM to run in a single-threaded manner.
57 // Acquires both the render and capture locks.
Alessio Bazzicabe1b8982021-09-17 08:26:10 +020058 AudioProcessingImpl();
Alessio Bazzica20a9ac62021-10-14 10:55:08 +020059 AudioProcessingImpl(const AudioProcessing::Config& config,
60 std::unique_ptr<CustomProcessing> capture_post_processor,
Alex Loiko5825aa62017-12-18 16:02:40 +010061 std::unique_ptr<CustomProcessing> render_pre_processor,
Gustaf Ullberg002ef282017-10-12 15:13:17 +020062 std::unique_ptr<EchoControlFactory> echo_control_factory,
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +020063 rtc::scoped_refptr<EchoDetector> echo_detector,
64 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer);
kwiberg83ffe452016-08-29 14:46:07 -070065 ~AudioProcessingImpl() override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000066 int Initialize() override;
peahde65ddc2016-09-16 15:02:15 -070067 int Initialize(int capture_input_sample_rate_hz,
68 int capture_output_sample_rate_hz,
69 int render_sample_rate_hz,
70 ChannelLayout capture_input_layout,
71 ChannelLayout capture_output_layout,
72 ChannelLayout render_input_layout) override;
Michael Graczyk86c6d332015-07-23 11:41:39 -070073 int Initialize(const ProcessingConfig& processing_config) override;
peah88ac8532016-09-12 16:47:25 -070074 void ApplyConfig(const AudioProcessing::Config& config) override;
Per Åhgren09e9a832020-05-11 11:03:47 +020075 bool CreateAndAttachAecDump(const std::string& file_name,
76 int64_t max_log_size_bytes,
77 rtc::TaskQueue* worker_queue) override;
78 bool CreateAndAttachAecDump(FILE* handle,
79 int64_t max_log_size_bytes,
80 rtc::TaskQueue* worker_queue) override;
81 // TODO(webrtc:5298) Deprecated variant.
aleloi868f32f2017-05-23 07:20:05 -070082 void AttachAecDump(std::unique_ptr<AecDump> aec_dump) override;
83 void DetachAecDump() override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020084 void SetRuntimeSetting(RuntimeSetting setting) override;
Per Åhgren0a144a72021-02-09 08:47:51 +010085 bool PostRuntimeSetting(RuntimeSetting setting) override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020086
peahdf3efa82015-11-28 12:35:15 -080087 // Capture-side exclusive methods possibly running APM in a
88 // multi-threaded manner. Acquire the capture lock.
Per Åhgren645f24c2020-03-16 12:06:02 +010089 int ProcessStream(const int16_t* const src,
90 const StreamConfig& input_config,
91 const StreamConfig& output_config,
Per Åhgrendc5522b2020-03-19 14:55:58 +010092 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000093 int ProcessStream(const float* const* src,
Michael Graczyk86c6d332015-07-23 11:41:39 -070094 const StreamConfig& input_config,
95 const StreamConfig& output_config,
96 float* const* dest) override;
Per Åhgrenc20a19c2019-11-13 11:12:29 +010097 bool GetLinearAecOutput(
98 rtc::ArrayView<std::array<float, 160>> linear_output) const override;
peahdf3efa82015-11-28 12:35:15 -080099 void set_output_will_be_muted(bool muted) override;
Per Åhgren0a144a72021-02-09 08:47:51 +0100100 void HandleCaptureOutputUsedSetting(bool capture_output_used)
101 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800102 int set_stream_delay_ms(int delay) override;
peahdf3efa82015-11-28 12:35:15 -0800103 void set_stream_key_pressed(bool key_pressed) override;
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100104 void set_stream_analog_level(int level) override;
Markus Handell02ba1d22020-05-14 14:31:18 +0200105 int recommended_stream_analog_level() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200106 RTC_LOCKS_EXCLUDED(mutex_capture_) override;
peahdf3efa82015-11-28 12:35:15 -0800107
108 // Render-side exclusive methods possibly running APM in a
109 // multi-threaded manner. Acquire the render lock.
Per Åhgren645f24c2020-03-16 12:06:02 +0100110 int ProcessReverseStream(const int16_t* const src,
111 const StreamConfig& input_config,
112 const StreamConfig& output_config,
113 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000114 int AnalyzeReverseStream(const float* const* data,
Gustaf Ullberg8c51f2e2019-10-22 15:21:31 +0200115 const StreamConfig& reverse_config) override;
ekmeyerson60d9b332015-08-14 10:35:55 -0700116 int ProcessReverseStream(const float* const* src,
peahde65ddc2016-09-16 15:02:15 -0700117 const StreamConfig& input_config,
118 const StreamConfig& output_config,
ekmeyerson60d9b332015-08-14 10:35:55 -0700119 float* const* dest) override;
peahdf3efa82015-11-28 12:35:15 -0800120
121 // Methods only accessed from APM submodules or
122 // from AudioProcessing tests in a single-threaded manner.
123 // Hence there is no need for locks in these.
124 int proc_sample_rate_hz() const override;
125 int proc_split_sample_rate_hz() const override;
Peter Kasting69558702016-01-12 16:26:35 -0800126 size_t num_input_channels() const override;
127 size_t num_proc_channels() const override;
128 size_t num_output_channels() const override;
129 size_t num_reverse_channels() const override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000130 int stream_delay_ms() const override;
peahdf3efa82015-11-28 12:35:15 -0800131
Per Åhgrencf4c8722019-12-30 14:32:14 +0100132 AudioProcessingStats GetStatistics(bool has_remote_tracks) override {
133 return GetStatistics();
134 }
135 AudioProcessingStats GetStatistics() override {
136 return stats_reporter_.GetStatistics();
137 }
ivoc3e9a5372016-10-28 07:55:33 -0700138
henrik.lundinadf06352017-04-05 05:48:24 -0700139 AudioProcessing::Config GetConfig() const override;
peah8271d042016-11-22 07:24:52 -0800140
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000141 protected:
andrew@webrtc.orga8b97372014-03-10 22:26:12 +0000142 // Overridden in a mock.
Per Åhgren0ade9832020-09-01 23:57:20 +0200143 virtual void InitializeLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200144 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Niels Möller5b747232021-07-26 17:16:25 +0200145 void AssertLockedForTest()
146 RTC_ASSERT_EXCLUSIVE_LOCK(mutex_render_, mutex_capture_) {
147 mutex_render_.AssertHeld();
148 mutex_capture_.AssertHeld();
149 }
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000150
niklase@google.com470e71d2011-07-07 08:21:25 +0000151 private:
peahc19f3122016-10-07 14:54:10 -0700152 // TODO(peah): These friend classes should be removed as soon as the new
153 // parameter setting scheme allows.
154 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, DefaultBehavior);
155 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, ValidConfigBehavior);
156 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, InValidConfigBehavior);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200157 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
158 ToggleTransientSuppressor);
159 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
160 ReinitializeTransientSuppressor);
161 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
162 BitexactWithDisabledModules);
163
Markus Handell02ba1d22020-05-14 14:31:18 +0200164 int recommended_stream_analog_level_locked() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200165 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200166
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200167 void OverrideSubmoduleCreationForTesting(
168 const ApmSubmoduleCreationOverrides& overrides);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200169
170 // Class providing thread-safe message pipe functionality for
Artem Titov0b489302021-07-28 20:50:03 +0200171 // `runtime_settings_`.
Alessio Bazzicac054e782018-04-16 12:10:09 +0200172 class RuntimeSettingEnqueuer {
173 public:
174 explicit RuntimeSettingEnqueuer(
175 SwapQueue<RuntimeSetting>* runtime_settings);
176 ~RuntimeSettingEnqueuer();
Per Åhgren0a144a72021-02-09 08:47:51 +0100177
178 // Enqueue setting and return whether the setting was successfully enqueued.
179 bool Enqueue(RuntimeSetting setting);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200180
181 private:
Alessio Bazzica33444dc2018-04-20 13:16:55 +0200182 SwapQueue<RuntimeSetting>& runtime_settings_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200183 };
Alex Loiko73ec0192018-05-15 10:52:28 +0200184
185 std::unique_ptr<ApmDataDumper> data_dumper_;
186 static int instance_count_;
Per Åhgrenb2b58d82019-12-02 14:59:40 +0100187 const bool use_setup_specific_default_aec3_config_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200188
Alessio Bazzica0441bb62021-08-10 15:23:23 +0200189 const bool use_denormal_disabler_;
190
Alex Loiko73ec0192018-05-15 10:52:28 +0200191 SwapQueue<RuntimeSetting> capture_runtime_settings_;
192 SwapQueue<RuntimeSetting> render_runtime_settings_;
193
194 RuntimeSettingEnqueuer capture_runtime_settings_enqueuer_;
195 RuntimeSettingEnqueuer render_runtime_settings_enqueuer_;
Alessio Bazzicac054e782018-04-16 12:10:09 +0200196
Gustaf Ullberg002ef282017-10-12 15:13:17 +0200197 // EchoControl factory.
198 std::unique_ptr<EchoControlFactory> echo_control_factory_;
Gustaf Ullbergd8579e02017-10-11 16:29:02 +0200199
saza1d600522019-10-18 13:29:43 +0200200 class SubmoduleStates {
peah2ace3f92016-09-10 04:42:27 -0700201 public:
saza1d600522019-10-18 13:29:43 +0200202 SubmoduleStates(bool capture_post_processor_enabled,
203 bool render_pre_processor_enabled,
204 bool capture_analyzer_enabled);
peah2ace3f92016-09-10 04:42:27 -0700205 // Updates the submodule state and returns true if it has changed.
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200206 bool Update(bool high_pass_filter_enabled,
peah2ace3f92016-09-10 04:42:27 -0700207 bool mobile_echo_controller_enabled,
ivoc9f4a4a02016-10-28 05:39:16 -0700208 bool residual_echo_detector_enabled,
peah2ace3f92016-09-10 04:42:27 -0700209 bool noise_suppressor_enabled,
peah2ace3f92016-09-10 04:42:27 -0700210 bool adaptive_gain_controller_enabled,
alessiob3ec96df2017-05-22 06:57:06 -0700211 bool gain_controller2_enabled,
Per Åhgrendb5d7282021-03-15 16:31:04 +0000212 bool gain_adjustment_enabled,
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200213 bool echo_controller_enabled,
Sam Zackrisson0824c6f2019-10-07 14:03:56 +0200214 bool voice_detector_enabled,
peah2ace3f92016-09-10 04:42:27 -0700215 bool transient_suppressor_enabled);
216 bool CaptureMultiBandSubModulesActive() const;
Gustaf Ullberg8675eee2019-10-09 13:34:36 +0200217 bool CaptureMultiBandProcessingPresent() const;
218 bool CaptureMultiBandProcessingActive(bool ec_processing_active) const;
peah23ac8b42017-05-23 05:33:56 -0700219 bool CaptureFullBandProcessingActive() const;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200220 bool CaptureAnalyzerActive() const;
peah2ace3f92016-09-10 04:42:27 -0700221 bool RenderMultiBandSubModulesActive() const;
Alex Loiko5825aa62017-12-18 16:02:40 +0100222 bool RenderFullBandProcessingActive() const;
peah2ace3f92016-09-10 04:42:27 -0700223 bool RenderMultiBandProcessingActive() const;
Per Åhgren0aefbf02019-08-23 21:29:17 +0200224 bool HighPassFilteringRequired() const;
peah2ace3f92016-09-10 04:42:27 -0700225
226 private:
Sam Zackrisson0beac582017-09-25 12:04:02 +0200227 const bool capture_post_processor_enabled_ = false;
Alex Loiko5825aa62017-12-18 16:02:40 +0100228 const bool render_pre_processor_enabled_ = false;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200229 const bool capture_analyzer_enabled_ = false;
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200230 bool high_pass_filter_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700231 bool mobile_echo_controller_enabled_ = false;
ivoc9f4a4a02016-10-28 05:39:16 -0700232 bool residual_echo_detector_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700233 bool noise_suppressor_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700234 bool adaptive_gain_controller_enabled_ = false;
alessiob3ec96df2017-05-22 06:57:06 -0700235 bool gain_controller2_enabled_ = false;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000236 bool gain_adjustment_enabled_ = false;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200237 bool echo_controller_enabled_ = false;
Sam Zackrisson0824c6f2019-10-07 14:03:56 +0200238 bool voice_detector_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700239 bool transient_suppressor_enabled_ = false;
240 bool first_update_ = true;
241 };
242
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100243 // Methods for modifying the formats struct that is used by both
244 // the render and capture threads. The check for whether modifications are
245 // needed is done while holding a single lock only, thereby avoiding that the
246 // capture thread blocks the render thread.
247 // Called by render: Holds the render lock when reading the format struct and
248 // acquires both locks if reinitialization is required.
peahdf3efa82015-11-28 12:35:15 -0800249 int MaybeInitializeRender(const ProcessingConfig& processing_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200250 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100251 // Called by capture: Holds the capture lock when reading the format struct
252 // and acquires both locks if reinitialization is needed.
253 int MaybeInitializeCapture(const StreamConfig& input_config,
254 const StreamConfig& output_config);
peahdf3efa82015-11-28 12:35:15 -0800255
peah2ace3f92016-09-10 04:42:27 -0700256 // Method for updating the state keeping track of the active submodules.
257 // Returns a bool indicating whether the state has changed.
danilchap56359be2017-09-07 07:53:45 -0700258 bool UpdateActiveSubmoduleStates()
Markus Handell0df0fae2020-07-07 15:53:34 +0200259 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800260
Per Åhgrenc0734712020-01-02 15:15:36 +0100261 // Methods requiring APM running in a single-threaded manner, requiring both
262 // the render and capture lock to be acquired.
Michael Graczyk86c6d332015-07-23 11:41:39 -0700263 int InitializeLocked(const ProcessingConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200264 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700265 void InitializeResidualEchoDetector()
Markus Handell0df0fae2020-07-07 15:53:34 +0200266 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenf204faf2019-04-25 15:18:06 +0200267 void InitializeEchoController()
Markus Handell0df0fae2020-07-07 15:53:34 +0200268 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100269
270 // Initializations of capture-only submodules, requiring the capture lock
271 // already acquired.
Per Åhgren0f14db22020-01-03 14:27:14 +0100272 void InitializeHighPassFilter(bool forced_reset)
Markus Handell0df0fae2020-07-07 15:53:34 +0200273 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
274 void InitializeVoiceDetector() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
275 void InitializeGainController1() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100276 void InitializeTransientSuppressor()
Markus Handell0df0fae2020-07-07 15:53:34 +0200277 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
278 void InitializeGainController2() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
279 void InitializeNoiseSuppressor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrendb5d7282021-03-15 16:31:04 +0000280 void InitializeCaptureLevelsAdjuster()
281 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200282 void InitializePostProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
283 void InitializeAnalyzer() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100284
285 // Initializations of render-only submodules, requiring the render lock
286 // already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200287 void InitializePreProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peahdf3efa82015-11-28 12:35:15 -0800288
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200289 // Sample rate used for the fullband processing.
290 int proc_fullband_sample_rate_hz() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200291 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200292
Alex Loiko73ec0192018-05-15 10:52:28 +0200293 // Empties and handles the respective RuntimeSetting queues.
294 void HandleCaptureRuntimeSettings()
Markus Handell0df0fae2020-07-07 15:53:34 +0200295 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
296 void HandleRenderRuntimeSettings()
297 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100298
Markus Handell0df0fae2020-07-07 15:53:34 +0200299 void EmptyQueuedRenderAudio() RTC_LOCKS_EXCLUDED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200300 void EmptyQueuedRenderAudioLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200301 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700302 void AllocateRenderQueue()
Markus Handell0df0fae2020-07-07 15:53:34 +0200303 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
peah9e6a2902017-05-15 07:19:21 -0700304 void QueueBandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200305 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah9e6a2902017-05-15 07:19:21 -0700306 void QueueNonbandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200307 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700308
peahdf3efa82015-11-28 12:35:15 -0800309 // Capture-side exclusive methods possibly running APM in a multi-threaded
310 // manner that are called with the render lock already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200311 int ProcessCaptureStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800312
313 // Render-side exclusive methods possibly running APM in a multi-threaded
314 // manner that are called with the render lock already acquired.
ekmeyerson60d9b332015-08-14 10:35:55 -0700315 // TODO(ekm): Remove once all clients updated to new interface.
peahdf3efa82015-11-28 12:35:15 -0800316 int AnalyzeReverseStreamLocked(const float* const* src,
317 const StreamConfig& input_config,
318 const StreamConfig& output_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200319 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
320 int ProcessRenderStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
andrew@webrtc.org17e40642014-03-04 20:58:13 +0000321
aleloi868f32f2017-05-23 07:20:05 -0700322 // Collects configuration settings from public and private
323 // submodules to be saved as an audioproc::Config message on the
Artem Titov0b489302021-07-28 20:50:03 +0200324 // AecDump if it is attached. If not `forced`, only writes the current
325 // config if it is different from the last saved one; if `forced`,
aleloi868f32f2017-05-23 07:20:05 -0700326 // writes the config regardless of the last saved.
327 void WriteAecDumpConfigMessage(bool forced)
Markus Handell0df0fae2020-07-07 15:53:34 +0200328 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700329
330 // Notifies attached AecDump of current configuration and capture data.
331 void RecordUnprocessedCaptureStream(const float* const* capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200332 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700333
Per Åhgren645f24c2020-03-16 12:06:02 +0100334 void RecordUnprocessedCaptureStream(const int16_t* const data,
335 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200336 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700337
338 // Notifies attached AecDump of current configuration and
339 // processed capture data and issues a capture stream recording
340 // request.
341 void RecordProcessedCaptureStream(
342 const float* const* processed_capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200343 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700344
Per Åhgren645f24c2020-03-16 12:06:02 +0100345 void RecordProcessedCaptureStream(const int16_t* const data,
346 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200347 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700348
349 // Notifies attached AecDump about current state (delay, drift, etc).
Markus Handell0df0fae2020-07-07 15:53:34 +0200350 void RecordAudioProcessingState()
351 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700352
Per Åhgren652ada52021-03-03 10:52:44 +0000353 // Ensures that overruns in the capture runtime settings queue is properly
354 // handled by the code, providing safe-fallbacks to mitigate the implications
355 // of any settings being missed.
356 void HandleOverrunInCaptureRuntimeSettingsQueue()
357 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
358
aleloi868f32f2017-05-23 07:20:05 -0700359 // AecDump instance used for optionally logging APM config, input
360 // and output to file in the AEC-dump format defined in debug.proto.
361 std::unique_ptr<AecDump> aec_dump_;
362
363 // Hold the last config written with AecDump for avoiding writing
364 // the same config twice.
Markus Handell0df0fae2020-07-07 15:53:34 +0200365 InternalAPMConfig apm_config_for_aec_dump_ RTC_GUARDED_BY(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700366
peahdf3efa82015-11-28 12:35:15 -0800367 // Critical sections.
Markus Handell0df0fae2020-07-07 15:53:34 +0200368 mutable Mutex mutex_render_ RTC_ACQUIRED_BEFORE(mutex_capture_);
369 mutable Mutex mutex_capture_;
peahdf3efa82015-11-28 12:35:15 -0800370
peahc19f3122016-10-07 14:54:10 -0700371 // Struct containing the Config specifying the behavior of APM.
372 AudioProcessing::Config config_;
373
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200374 // Overrides for testing the exclusion of some submodules from the build.
375 ApmSubmoduleCreationOverrides submodule_creation_overrides_
Markus Handell0df0fae2020-07-07 15:53:34 +0200376 RTC_GUARDED_BY(mutex_capture_);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200377
peah2ace3f92016-09-10 04:42:27 -0700378 // Class containing information about what submodules are active.
saza1d600522019-10-18 13:29:43 +0200379 SubmoduleStates submodule_states_;
peah2ace3f92016-09-10 04:42:27 -0700380
saza1d600522019-10-18 13:29:43 +0200381 // Struct containing the pointers to the submodules.
382 struct Submodules {
383 Submodules(std::unique_ptr<CustomProcessing> capture_post_processor,
384 std::unique_ptr<CustomProcessing> render_pre_processor,
385 rtc::scoped_refptr<EchoDetector> echo_detector,
Per Åhgren3daedb62019-11-22 12:11:40 +0100386 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer)
saza1d600522019-10-18 13:29:43 +0200387 : echo_detector(std::move(echo_detector)),
388 capture_post_processor(std::move(capture_post_processor)),
389 render_pre_processor(std::move(render_pre_processor)),
Per Åhgren3daedb62019-11-22 12:11:40 +0100390 capture_analyzer(std::move(capture_analyzer)) {}
saza1d600522019-10-18 13:29:43 +0200391 // Accessed internally from capture or during initialization.
392 std::unique_ptr<AgcManagerDirect> agc_manager;
393 std::unique_ptr<GainControlImpl> gain_control;
saza1d600522019-10-18 13:29:43 +0200394 std::unique_ptr<GainController2> gain_controller2;
395 std::unique_ptr<HighPassFilter> high_pass_filter;
396 rtc::scoped_refptr<EchoDetector> echo_detector;
saza1d600522019-10-18 13:29:43 +0200397 std::unique_ptr<EchoControl> echo_controller;
398 std::unique_ptr<EchoControlMobileImpl> echo_control_mobile;
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100399 std::unique_ptr<NoiseSuppressor> noise_suppressor;
saza1d600522019-10-18 13:29:43 +0200400 std::unique_ptr<TransientSuppressor> transient_suppressor;
401 std::unique_ptr<CustomProcessing> capture_post_processor;
402 std::unique_ptr<CustomProcessing> render_pre_processor;
saza1d600522019-10-18 13:29:43 +0200403 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer;
404 std::unique_ptr<LevelEstimator> output_level_estimator;
405 std::unique_ptr<VoiceDetection> voice_detector;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000406 std::unique_ptr<CaptureLevelsAdjuster> capture_levels_adjuster;
saza1d600522019-10-18 13:29:43 +0200407 } submodules_;
peahdf3efa82015-11-28 12:35:15 -0800408
peah192164e2015-11-17 02:16:45 -0800409 // State that is written to while holding both the render and capture locks
peahdf3efa82015-11-28 12:35:15 -0800410 // but can be read without any lock being held.
411 // As this is only accessed internally of APM, and all internal methods in APM
412 // either are holding the render or capture locks, this construct is safe as
413 // it is not possible to read the variables while writing them.
414 struct ApmFormatState {
415 ApmFormatState()
peah192164e2015-11-17 02:16:45 -0800416 : // Format of processing streams at input/output call sites.
peahdf3efa82015-11-28 12:35:15 -0800417 api_format({{{kSampleRate16kHz, 1, false},
418 {kSampleRate16kHz, 1, false},
419 {kSampleRate16kHz, 1, false},
420 {kSampleRate16kHz, 1, false}}}),
peahde65ddc2016-09-16 15:02:15 -0700421 render_processing_format(kSampleRate16kHz, 1) {}
peahdf3efa82015-11-28 12:35:15 -0800422 ProcessingConfig api_format;
peahde65ddc2016-09-16 15:02:15 -0700423 StreamConfig render_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800424 } formats_;
Michael Graczyk86c6d332015-07-23 11:41:39 -0700425
peahdf3efa82015-11-28 12:35:15 -0800426 // APM constants.
427 const struct ApmConstants {
Per Åhgren0695df12020-01-13 14:43:13 +0100428 ApmConstants(bool multi_channel_render_support,
Per Åhgrenc0424252019-12-10 13:04:15 +0100429 bool multi_channel_capture_support,
Per Åhgren19775cb2021-03-12 23:08:09 +0000430 bool enforce_split_band_hpf,
Gustaf Ullberga399c822021-05-18 12:17:56 +0200431 bool minimize_processing_for_unused_output,
432 bool transient_suppressor_forced_off)
Per Åhgren0695df12020-01-13 14:43:13 +0100433 : multi_channel_render_support(multi_channel_render_support),
Per Åhgrenc0424252019-12-10 13:04:15 +0100434 multi_channel_capture_support(multi_channel_capture_support),
Per Åhgren19775cb2021-03-12 23:08:09 +0000435 enforce_split_band_hpf(enforce_split_band_hpf),
436 minimize_processing_for_unused_output(
Gustaf Ullberga399c822021-05-18 12:17:56 +0200437 minimize_processing_for_unused_output),
438 transient_suppressor_forced_off(transient_suppressor_forced_off) {}
Per Åhgrene14cb992019-11-27 09:34:22 +0100439 bool multi_channel_render_support;
440 bool multi_channel_capture_support;
Per Åhgrenc0424252019-12-10 13:04:15 +0100441 bool enforce_split_band_hpf;
Per Åhgren19775cb2021-03-12 23:08:09 +0000442 bool minimize_processing_for_unused_output;
Gustaf Ullberga399c822021-05-18 12:17:56 +0200443 bool transient_suppressor_forced_off;
peahdf3efa82015-11-28 12:35:15 -0800444 } constants_;
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000445
peahdf3efa82015-11-28 12:35:15 -0800446 struct ApmCaptureState {
Per Åhgrenc0734712020-01-02 15:15:36 +0100447 ApmCaptureState();
kwiberg83ffe452016-08-29 14:46:07 -0700448 ~ApmCaptureState();
peahdf3efa82015-11-28 12:35:15 -0800449 bool was_stream_delay_set;
Per Åhgren0a144a72021-02-09 08:47:51 +0100450 bool capture_output_used;
Per Åhgren55bc0772021-03-12 14:18:36 +0000451 bool capture_output_used_last_frame;
peahdf3efa82015-11-28 12:35:15 -0800452 bool key_pressed;
kwiberg88788ad2016-02-19 07:04:49 -0800453 std::unique_ptr<AudioBuffer> capture_audio;
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200454 std::unique_ptr<AudioBuffer> capture_fullband_audio;
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100455 std::unique_ptr<AudioBuffer> linear_aec_output;
peahde65ddc2016-09-16 15:02:15 -0700456 // Only the rate and samples fields of capture_processing_format_ are used
457 // because the capture processing number of channels is mutable and is
458 // tracked by the capture_audio_.
459 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800460 int split_rate;
peah67995532017-04-10 14:12:41 -0700461 bool echo_path_gain_change;
Per Åhgren88cf0502018-07-16 17:08:41 +0200462 int prev_analog_mic_level;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000463 float prev_pre_adjustment_gain;
Fredrik Hernqvistca362852019-05-10 15:50:02 +0200464 int playout_volume;
465 int prev_playout_volume;
Sam Zackrissonb24c00f2018-11-26 16:18:25 +0100466 AudioProcessingStats stats;
Per Åhgrena1351272019-08-15 12:15:46 +0200467 struct KeyboardInfo {
468 void Extract(const float* const* data, const StreamConfig& stream_config);
469 size_t num_keyboard_frames = 0;
470 const float* keyboard_data = nullptr;
471 } keyboard_info;
Per Åhgren0695df12020-01-13 14:43:13 +0100472 int cached_stream_analog_level_ = 0;
Markus Handell0df0fae2020-07-07 15:53:34 +0200473 } capture_ RTC_GUARDED_BY(mutex_capture_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000474
peahdf3efa82015-11-28 12:35:15 -0800475 struct ApmCaptureNonLockedState {
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200476 ApmCaptureNonLockedState()
peahde65ddc2016-09-16 15:02:15 -0700477 : capture_processing_format(kSampleRate16kHz),
peahdf3efa82015-11-28 12:35:15 -0800478 split_rate(kSampleRate16kHz),
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200479 stream_delay_ms(0) {}
peahde65ddc2016-09-16 15:02:15 -0700480 // Only the rate and samples fields of capture_processing_format_ are used
481 // because the forward processing number of channels is mutable and is
482 // tracked by the capture_audio_.
483 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800484 int split_rate;
485 int stream_delay_ms;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200486 bool echo_controller_enabled = false;
peahdf3efa82015-11-28 12:35:15 -0800487 } capture_nonlocked_;
andrew@webrtc.org75dd2882014-02-11 20:52:30 +0000488
peahdf3efa82015-11-28 12:35:15 -0800489 struct ApmRenderState {
kwiberg83ffe452016-08-29 14:46:07 -0700490 ApmRenderState();
491 ~ApmRenderState();
kwiberg88788ad2016-02-19 07:04:49 -0800492 std::unique_ptr<AudioConverter> render_converter;
493 std::unique_ptr<AudioBuffer> render_audio;
Markus Handell0df0fae2020-07-07 15:53:34 +0200494 } render_ RTC_GUARDED_BY(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700495
Per Åhgrencf4c8722019-12-30 14:32:14 +0100496 // Class for statistics reporting. The class is thread-safe and no lock is
497 // needed when accessing it.
498 class ApmStatsReporter {
499 public:
500 ApmStatsReporter();
501 ~ApmStatsReporter();
502
503 // Returns the most recently reported statistics.
504 AudioProcessingStats GetStatistics();
505
506 // Update the cached statistics.
507 void UpdateStatistics(const AudioProcessingStats& new_stats);
508
509 private:
Markus Handell0df0fae2020-07-07 15:53:34 +0200510 Mutex mutex_stats_;
511 AudioProcessingStats cached_stats_ RTC_GUARDED_BY(mutex_stats_);
Per Åhgrencf4c8722019-12-30 14:32:14 +0100512 SwapQueue<AudioProcessingStats> stats_message_queue_;
513 } stats_reporter_;
514
Markus Handell0df0fae2020-07-07 15:53:34 +0200515 std::vector<int16_t> aecm_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
516 std::vector<int16_t> aecm_capture_queue_buffer_
517 RTC_GUARDED_BY(mutex_capture_);
peah701d6282016-10-25 05:42:20 -0700518
Markus Handell0df0fae2020-07-07 15:53:34 +0200519 size_t agc_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
520 RTC_GUARDED_BY(mutex_capture_) = 0;
521 std::vector<int16_t> agc_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
522 std::vector<int16_t> agc_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700523
Markus Handell0df0fae2020-07-07 15:53:34 +0200524 size_t red_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
525 RTC_GUARDED_BY(mutex_capture_) = 0;
526 std::vector<float> red_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
527 std::vector<float> red_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700528
Markus Handell0df0fae2020-07-07 15:53:34 +0200529 RmsLevel capture_input_rms_ RTC_GUARDED_BY(mutex_capture_);
530 RmsLevel capture_output_rms_ RTC_GUARDED_BY(mutex_capture_);
531 int capture_rms_interval_counter_ RTC_GUARDED_BY(mutex_capture_) = 0;
henrik.lundin290d43a2016-11-29 08:09:09 -0800532
peah764e3642016-10-22 05:04:30 -0700533 // Lock protection not needed.
peaha0624602016-10-25 04:45:24 -0700534 std::unique_ptr<
535 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
peah701d6282016-10-25 05:42:20 -0700536 aecm_render_signal_queue_;
537 std::unique_ptr<
538 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
539 agc_render_signal_queue_;
ivoc9f4a4a02016-10-28 05:39:16 -0700540 std::unique_ptr<SwapQueue<std::vector<float>, RenderQueueItemVerifier<float>>>
541 red_render_signal_queue_;
niklase@google.com470e71d2011-07-07 08:21:25 +0000542};
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000543
niklase@google.com470e71d2011-07-07 08:21:25 +0000544} // namespace webrtc
545
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200546#endif // MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_