blob: 9a30c8b9f6f8b3e91e29201764dd456c96c8b192 [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
Niels Möller7a669002022-06-27 09:47:02 +020016#include <atomic>
niklase@google.com470e71d2011-07-07 08:21:25 +000017#include <list>
kwiberg88788ad2016-02-19 07:04:49 -080018#include <memory>
Per Åhgren09e9a832020-05-11 11:03:47 +020019#include <string>
Michael Graczyk86c6d332015-07-23 11:41:39 -070020#include <vector>
niklase@google.com470e71d2011-07-07 08:21:25 +000021
Ali Tofigh1fa87c42022-07-25 22:07:08 +020022#include "absl/strings/string_view.h"
Alessio Bazzicafcf1af32022-09-07 17:14:26 +020023#include "absl/types/optional.h"
Alessio Bazzicabab12852022-02-03 16:30:25 +010024#include "api/array_view.h"
Artem Titov741daaf2019-03-21 14:37:36 +010025#include "api/function_view.h"
saza1d600522019-10-18 13:29:43 +020026#include "modules/audio_processing/aec3/echo_canceller3.h"
27#include "modules/audio_processing/agc/agc_manager_direct.h"
Sam Zackrisson41478c72019-10-15 10:10:26 +020028#include "modules/audio_processing/agc/gain_control.h"
Alessio Bazzicad226c572022-10-24 22:05:19 +020029#include "modules/audio_processing/agc2/input_volume_stats_reporter.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020030#include "modules/audio_processing/audio_buffer.h"
Per Åhgrendb5d7282021-03-15 16:31:04 +000031#include "modules/audio_processing/capture_levels_adjuster/capture_levels_adjuster.h"
saza1d600522019-10-18 13:29:43 +020032#include "modules/audio_processing/echo_control_mobile_impl.h"
saza1d600522019-10-18 13:29:43 +020033#include "modules/audio_processing/gain_control_impl.h"
34#include "modules/audio_processing/gain_controller2.h"
35#include "modules/audio_processing/high_pass_filter.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020036#include "modules/audio_processing/include/aec_dump.h"
Per Åhgren71652f42020-03-17 13:23:58 +010037#include "modules/audio_processing/include/audio_frame_proxies.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020038#include "modules/audio_processing/include/audio_processing.h"
Sam Zackrissonb24c00f2018-11-26 16:18:25 +010039#include "modules/audio_processing/include/audio_processing_statistics.h"
Per Åhgren0cbb58e2019-10-29 22:59:44 +010040#include "modules/audio_processing/ns/noise_suppressor.h"
Sam Zackrissonb37e59d2020-04-27 08:39:33 +020041#include "modules/audio_processing/optionally_built_submodule_creators.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020042#include "modules/audio_processing/render_queue_item_verifier.h"
43#include "modules/audio_processing/rms_level.h"
saza1d600522019-10-18 13:29:43 +020044#include "modules/audio_processing/transient/transient_suppressor.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020045#include "rtc_base/gtest_prod_util.h"
46#include "rtc_base/ignore_wundef.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020047#include "rtc_base/swap_queue.h"
Markus Handell0df0fae2020-07-07 15:53:34 +020048#include "rtc_base/synchronization/mutex.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020049#include "rtc_base/thread_annotations.h"
peahdf3efa82015-11-28 12:35:15 -080050
niklase@google.com470e71d2011-07-07 08:21:25 +000051namespace webrtc {
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +000052
Per Åhgren13735822018-02-12 21:42:56 +010053class ApmDataDumper;
ekmeyerson60d9b332015-08-14 10:35:55 -070054class AudioConverter;
Michael Graczykdfa36052015-03-25 16:37:27 -070055
Henrik Lundin8a9aa552022-02-08 09:15:12 +000056constexpr int RuntimeSettingQueueSize() {
57 return 100;
58}
59
niklase@google.com470e71d2011-07-07 08:21:25 +000060class AudioProcessingImpl : public AudioProcessing {
61 public:
peahdf3efa82015-11-28 12:35:15 -080062 // Methods forcing APM to run in a single-threaded manner.
63 // Acquires both the render and capture locks.
Alessio Bazzicabe1b8982021-09-17 08:26:10 +020064 AudioProcessingImpl();
Alessio Bazzica20a9ac62021-10-14 10:55:08 +020065 AudioProcessingImpl(const AudioProcessing::Config& config,
66 std::unique_ptr<CustomProcessing> capture_post_processor,
Alex Loiko5825aa62017-12-18 16:02:40 +010067 std::unique_ptr<CustomProcessing> render_pre_processor,
Gustaf Ullberg002ef282017-10-12 15:13:17 +020068 std::unique_ptr<EchoControlFactory> echo_control_factory,
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +020069 rtc::scoped_refptr<EchoDetector> echo_detector,
70 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer);
kwiberg83ffe452016-08-29 14:46:07 -070071 ~AudioProcessingImpl() override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000072 int Initialize() 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;
Ali Tofigh1fa87c42022-07-25 22:07:08 +020075 bool CreateAndAttachAecDump(absl::string_view file_name,
76 int64_t max_log_size_bytes,
77 rtc::TaskQueue* worker_queue) override;
Per Åhgren09e9a832020-05-11 11:03:47 +020078 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);
Hanna Silena6574902022-11-30 16:59:05 +0100163 FRIEND_TEST_ALL_PREFIXES(
164 AudioProcessingImplInputVolumeControllerExperimentParametrizedTest,
165 ConfigAdjustedWhenExperimentEnabled);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200166
Alessio Bazzica0c0c6022022-09-07 15:15:52 +0200167 void set_stream_analog_level_locked(int level)
168 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Alessio Bazzica533e4612022-09-07 16:58:33 +0200169 void UpdateRecommendedInputVolumeLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200170 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200171
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200172 void OverrideSubmoduleCreationForTesting(
173 const ApmSubmoduleCreationOverrides& overrides);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200174
175 // Class providing thread-safe message pipe functionality for
Artem Titov0b489302021-07-28 20:50:03 +0200176 // `runtime_settings_`.
Alessio Bazzicac054e782018-04-16 12:10:09 +0200177 class RuntimeSettingEnqueuer {
178 public:
179 explicit RuntimeSettingEnqueuer(
180 SwapQueue<RuntimeSetting>* runtime_settings);
181 ~RuntimeSettingEnqueuer();
Per Åhgren0a144a72021-02-09 08:47:51 +0100182
183 // Enqueue setting and return whether the setting was successfully enqueued.
184 bool Enqueue(RuntimeSetting setting);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200185
186 private:
Alessio Bazzica33444dc2018-04-20 13:16:55 +0200187 SwapQueue<RuntimeSetting>& runtime_settings_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200188 };
Alex Loiko73ec0192018-05-15 10:52:28 +0200189
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100190 const std::unique_ptr<ApmDataDumper> data_dumper_;
Niels Möller7a669002022-06-27 09:47:02 +0200191 static std::atomic<int> instance_count_;
Per Åhgrenb2b58d82019-12-02 14:59:40 +0100192 const bool use_setup_specific_default_aec3_config_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200193
Hanna Silena6574902022-11-30 16:59:05 +0100194 // TODO(bugs.webrtc.org/7494): Remove the the config when the field trial is
195 // removed. "WebRTC-Audio-InputVolumeControllerExperiment" field trial
196 // override for the input volume controller config.
197 const absl::optional<InputVolumeController::Config>
198 input_volume_controller_config_override_;
199
Alessio Bazzica0441bb62021-08-10 15:23:23 +0200200 const bool use_denormal_disabler_;
201
Alessio Bazzicaefbe3af2022-03-18 12:39:00 +0100202 const TransientSuppressor::VadMode transient_suppressor_vad_mode_;
203
Alex Loiko73ec0192018-05-15 10:52:28 +0200204 SwapQueue<RuntimeSetting> capture_runtime_settings_;
205 SwapQueue<RuntimeSetting> render_runtime_settings_;
206
207 RuntimeSettingEnqueuer capture_runtime_settings_enqueuer_;
208 RuntimeSettingEnqueuer render_runtime_settings_enqueuer_;
Alessio Bazzicac054e782018-04-16 12:10:09 +0200209
Gustaf Ullberg002ef282017-10-12 15:13:17 +0200210 // EchoControl factory.
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100211 const std::unique_ptr<EchoControlFactory> echo_control_factory_;
Gustaf Ullbergd8579e02017-10-11 16:29:02 +0200212
saza1d600522019-10-18 13:29:43 +0200213 class SubmoduleStates {
peah2ace3f92016-09-10 04:42:27 -0700214 public:
saza1d600522019-10-18 13:29:43 +0200215 SubmoduleStates(bool capture_post_processor_enabled,
216 bool render_pre_processor_enabled,
217 bool capture_analyzer_enabled);
peah2ace3f92016-09-10 04:42:27 -0700218 // Updates the submodule state and returns true if it has changed.
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200219 bool Update(bool high_pass_filter_enabled,
peah2ace3f92016-09-10 04:42:27 -0700220 bool mobile_echo_controller_enabled,
221 bool noise_suppressor_enabled,
peah2ace3f92016-09-10 04:42:27 -0700222 bool adaptive_gain_controller_enabled,
alessiob3ec96df2017-05-22 06:57:06 -0700223 bool gain_controller2_enabled,
Hanna Silen0c1ad292022-06-16 16:35:45 +0200224 bool voice_activity_detector_enabled,
Per Åhgrendb5d7282021-03-15 16:31:04 +0000225 bool gain_adjustment_enabled,
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200226 bool echo_controller_enabled,
peah2ace3f92016-09-10 04:42:27 -0700227 bool transient_suppressor_enabled);
228 bool CaptureMultiBandSubModulesActive() const;
Gustaf Ullberg8675eee2019-10-09 13:34:36 +0200229 bool CaptureMultiBandProcessingPresent() const;
230 bool CaptureMultiBandProcessingActive(bool ec_processing_active) const;
peah23ac8b42017-05-23 05:33:56 -0700231 bool CaptureFullBandProcessingActive() const;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200232 bool CaptureAnalyzerActive() const;
peah2ace3f92016-09-10 04:42:27 -0700233 bool RenderMultiBandSubModulesActive() const;
Alex Loiko5825aa62017-12-18 16:02:40 +0100234 bool RenderFullBandProcessingActive() const;
peah2ace3f92016-09-10 04:42:27 -0700235 bool RenderMultiBandProcessingActive() const;
Per Åhgren0aefbf02019-08-23 21:29:17 +0200236 bool HighPassFilteringRequired() const;
peah2ace3f92016-09-10 04:42:27 -0700237
238 private:
Sam Zackrisson0beac582017-09-25 12:04:02 +0200239 const bool capture_post_processor_enabled_ = false;
Alex Loiko5825aa62017-12-18 16:02:40 +0100240 const bool render_pre_processor_enabled_ = false;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200241 const bool capture_analyzer_enabled_ = false;
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200242 bool high_pass_filter_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700243 bool mobile_echo_controller_enabled_ = false;
244 bool noise_suppressor_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700245 bool adaptive_gain_controller_enabled_ = false;
Hanna Silen0c1ad292022-06-16 16:35:45 +0200246 bool voice_activity_detector_enabled_ = false;
alessiob3ec96df2017-05-22 06:57:06 -0700247 bool gain_controller2_enabled_ = false;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000248 bool gain_adjustment_enabled_ = false;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200249 bool echo_controller_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700250 bool transient_suppressor_enabled_ = false;
251 bool first_update_ = true;
252 };
253
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100254 // Methods for modifying the formats struct that is used by both
255 // the render and capture threads. The check for whether modifications are
256 // needed is done while holding a single lock only, thereby avoiding that the
257 // capture thread blocks the render thread.
258 // Called by render: Holds the render lock when reading the format struct and
259 // acquires both locks if reinitialization is required.
Sam Zackrisson5dd54822022-11-17 11:26:58 +0100260 void MaybeInitializeRender(const StreamConfig& input_config,
261 const StreamConfig& output_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200262 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrisson5dd54822022-11-17 11:26:58 +0100263 // Called by capture: Acquires and releases the capture lock to read the
264 // format struct and acquires both locks if reinitialization is needed.
265 void MaybeInitializeCapture(const StreamConfig& input_config,
266 const StreamConfig& output_config);
peahdf3efa82015-11-28 12:35:15 -0800267
peah2ace3f92016-09-10 04:42:27 -0700268 // Method for updating the state keeping track of the active submodules.
269 // Returns a bool indicating whether the state has changed.
danilchap56359be2017-09-07 07:53:45 -0700270 bool UpdateActiveSubmoduleStates()
Markus Handell0df0fae2020-07-07 15:53:34 +0200271 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800272
Per Åhgrenc0734712020-01-02 15:15:36 +0100273 // Methods requiring APM running in a single-threaded manner, requiring both
274 // the render and capture lock to be acquired.
Sam Zackrisson5dd54822022-11-17 11:26:58 +0100275 void InitializeLocked(const ProcessingConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200276 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700277 void InitializeResidualEchoDetector()
Markus Handell0df0fae2020-07-07 15:53:34 +0200278 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenf204faf2019-04-25 15:18:06 +0200279 void InitializeEchoController()
Markus Handell0df0fae2020-07-07 15:53:34 +0200280 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100281
Alessio Bazzica38901042021-10-14 12:14:21 +0200282 // Initializations of capture-only sub-modules, requiring the capture lock
Per Åhgrenc0734712020-01-02 15:15:36 +0100283 // already acquired.
Per Åhgren0f14db22020-01-03 14:27:14 +0100284 void InitializeHighPassFilter(bool forced_reset)
Markus Handell0df0fae2020-07-07 15:53:34 +0200285 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200286 void InitializeGainController1() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100287 void InitializeTransientSuppressor()
Markus Handell0df0fae2020-07-07 15:53:34 +0200288 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Alessio Bazzica38901042021-10-14 12:14:21 +0200289 // Initializes the `GainController2` sub-module. If the sub-module is enabled
290 // and `config_has_changed` is true, recreates the sub-module.
291 void InitializeGainController2(bool config_has_changed)
292 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Hanna Silen0c1ad292022-06-16 16:35:45 +0200293 // Initializes the `VoiceActivityDetectorWrapper` sub-module. If the
294 // sub-module is enabled and `config_has_changed` is true, recreates the
295 // sub-module.
296 void InitializeVoiceActivityDetector(bool config_has_changed)
297 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200298 void InitializeNoiseSuppressor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrendb5d7282021-03-15 16:31:04 +0000299 void InitializeCaptureLevelsAdjuster()
300 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200301 void InitializePostProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
302 void InitializeAnalyzer() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100303
304 // Initializations of render-only submodules, requiring the render lock
305 // already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200306 void InitializePreProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peahdf3efa82015-11-28 12:35:15 -0800307
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200308 // Sample rate used for the fullband processing.
309 int proc_fullband_sample_rate_hz() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200310 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200311
Alex Loiko73ec0192018-05-15 10:52:28 +0200312 // Empties and handles the respective RuntimeSetting queues.
313 void HandleCaptureRuntimeSettings()
Markus Handell0df0fae2020-07-07 15:53:34 +0200314 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
315 void HandleRenderRuntimeSettings()
316 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100317
Markus Handell0df0fae2020-07-07 15:53:34 +0200318 void EmptyQueuedRenderAudio() RTC_LOCKS_EXCLUDED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200319 void EmptyQueuedRenderAudioLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200320 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700321 void AllocateRenderQueue()
Markus Handell0df0fae2020-07-07 15:53:34 +0200322 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
peah9e6a2902017-05-15 07:19:21 -0700323 void QueueBandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200324 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah9e6a2902017-05-15 07:19:21 -0700325 void QueueNonbandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200326 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700327
peahdf3efa82015-11-28 12:35:15 -0800328 // Capture-side exclusive methods possibly running APM in a multi-threaded
329 // manner that are called with the render lock already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200330 int ProcessCaptureStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800331
332 // Render-side exclusive methods possibly running APM in a multi-threaded
333 // manner that are called with the render lock already acquired.
peahdf3efa82015-11-28 12:35:15 -0800334 int AnalyzeReverseStreamLocked(const float* const* src,
335 const StreamConfig& input_config,
336 const StreamConfig& output_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200337 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
338 int ProcessRenderStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
andrew@webrtc.org17e40642014-03-04 20:58:13 +0000339
aleloi868f32f2017-05-23 07:20:05 -0700340 // Collects configuration settings from public and private
341 // submodules to be saved as an audioproc::Config message on the
Artem Titov0b489302021-07-28 20:50:03 +0200342 // AecDump if it is attached. If not `forced`, only writes the current
343 // config if it is different from the last saved one; if `forced`,
aleloi868f32f2017-05-23 07:20:05 -0700344 // writes the config regardless of the last saved.
345 void WriteAecDumpConfigMessage(bool forced)
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 of current configuration and capture data.
349 void RecordUnprocessedCaptureStream(const float* const* capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200350 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700351
Per Åhgren645f24c2020-03-16 12:06:02 +0100352 void RecordUnprocessedCaptureStream(const int16_t* const data,
353 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200354 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700355
356 // Notifies attached AecDump of current configuration and
357 // processed capture data and issues a capture stream recording
358 // request.
359 void RecordProcessedCaptureStream(
360 const float* const* processed_capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200361 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700362
Per Åhgren645f24c2020-03-16 12:06:02 +0100363 void RecordProcessedCaptureStream(const int16_t* const data,
364 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200365 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700366
367 // Notifies attached AecDump about current state (delay, drift, etc).
Markus Handell0df0fae2020-07-07 15:53:34 +0200368 void RecordAudioProcessingState()
369 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700370
Per Åhgren652ada52021-03-03 10:52:44 +0000371 // Ensures that overruns in the capture runtime settings queue is properly
372 // handled by the code, providing safe-fallbacks to mitigate the implications
373 // of any settings being missed.
374 void HandleOverrunInCaptureRuntimeSettingsQueue()
375 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
376
aleloi868f32f2017-05-23 07:20:05 -0700377 // AecDump instance used for optionally logging APM config, input
378 // and output to file in the AEC-dump format defined in debug.proto.
379 std::unique_ptr<AecDump> aec_dump_;
380
381 // Hold the last config written with AecDump for avoiding writing
382 // the same config twice.
Markus Handell0df0fae2020-07-07 15:53:34 +0200383 InternalAPMConfig apm_config_for_aec_dump_ RTC_GUARDED_BY(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700384
peahdf3efa82015-11-28 12:35:15 -0800385 // Critical sections.
Markus Handell0df0fae2020-07-07 15:53:34 +0200386 mutable Mutex mutex_render_ RTC_ACQUIRED_BEFORE(mutex_capture_);
387 mutable Mutex mutex_capture_;
peahdf3efa82015-11-28 12:35:15 -0800388
peahc19f3122016-10-07 14:54:10 -0700389 // Struct containing the Config specifying the behavior of APM.
390 AudioProcessing::Config config_;
391
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200392 // Overrides for testing the exclusion of some submodules from the build.
393 ApmSubmoduleCreationOverrides submodule_creation_overrides_
Markus Handell0df0fae2020-07-07 15:53:34 +0200394 RTC_GUARDED_BY(mutex_capture_);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200395
peah2ace3f92016-09-10 04:42:27 -0700396 // Class containing information about what submodules are active.
saza1d600522019-10-18 13:29:43 +0200397 SubmoduleStates submodule_states_;
peah2ace3f92016-09-10 04:42:27 -0700398
saza1d600522019-10-18 13:29:43 +0200399 // Struct containing the pointers to the submodules.
400 struct Submodules {
401 Submodules(std::unique_ptr<CustomProcessing> capture_post_processor,
402 std::unique_ptr<CustomProcessing> render_pre_processor,
403 rtc::scoped_refptr<EchoDetector> echo_detector,
Per Åhgren3daedb62019-11-22 12:11:40 +0100404 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer)
saza1d600522019-10-18 13:29:43 +0200405 : echo_detector(std::move(echo_detector)),
406 capture_post_processor(std::move(capture_post_processor)),
407 render_pre_processor(std::move(render_pre_processor)),
Per Åhgren3daedb62019-11-22 12:11:40 +0100408 capture_analyzer(std::move(capture_analyzer)) {}
saza1d600522019-10-18 13:29:43 +0200409 // Accessed internally from capture or during initialization.
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100410 const rtc::scoped_refptr<EchoDetector> echo_detector;
411 const std::unique_ptr<CustomProcessing> capture_post_processor;
412 const std::unique_ptr<CustomProcessing> render_pre_processor;
413 const std::unique_ptr<CustomAudioAnalyzer> capture_analyzer;
saza1d600522019-10-18 13:29:43 +0200414 std::unique_ptr<AgcManagerDirect> agc_manager;
415 std::unique_ptr<GainControlImpl> gain_control;
saza1d600522019-10-18 13:29:43 +0200416 std::unique_ptr<GainController2> gain_controller2;
Hanna Silen0c1ad292022-06-16 16:35:45 +0200417 std::unique_ptr<VoiceActivityDetectorWrapper> voice_activity_detector;
saza1d600522019-10-18 13:29:43 +0200418 std::unique_ptr<HighPassFilter> high_pass_filter;
saza1d600522019-10-18 13:29:43 +0200419 std::unique_ptr<EchoControl> echo_controller;
420 std::unique_ptr<EchoControlMobileImpl> echo_control_mobile;
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100421 std::unique_ptr<NoiseSuppressor> noise_suppressor;
saza1d600522019-10-18 13:29:43 +0200422 std::unique_ptr<TransientSuppressor> transient_suppressor;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000423 std::unique_ptr<CaptureLevelsAdjuster> capture_levels_adjuster;
saza1d600522019-10-18 13:29:43 +0200424 } submodules_;
peahdf3efa82015-11-28 12:35:15 -0800425
peah192164e2015-11-17 02:16:45 -0800426 // State that is written to while holding both the render and capture locks
peahdf3efa82015-11-28 12:35:15 -0800427 // but can be read without any lock being held.
428 // As this is only accessed internally of APM, and all internal methods in APM
429 // either are holding the render or capture locks, this construct is safe as
430 // it is not possible to read the variables while writing them.
431 struct ApmFormatState {
432 ApmFormatState()
peah192164e2015-11-17 02:16:45 -0800433 : // Format of processing streams at input/output call sites.
Henrik Lundin64253a92022-02-04 09:02:48 +0000434 api_format({{{kSampleRate16kHz, 1},
435 {kSampleRate16kHz, 1},
436 {kSampleRate16kHz, 1},
437 {kSampleRate16kHz, 1}}}),
peahde65ddc2016-09-16 15:02:15 -0700438 render_processing_format(kSampleRate16kHz, 1) {}
peahdf3efa82015-11-28 12:35:15 -0800439 ProcessingConfig api_format;
peahde65ddc2016-09-16 15:02:15 -0700440 StreamConfig render_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800441 } formats_;
Michael Graczyk86c6d332015-07-23 11:41:39 -0700442
peahdf3efa82015-11-28 12:35:15 -0800443 // APM constants.
444 const struct ApmConstants {
Per Åhgren0695df12020-01-13 14:43:13 +0100445 ApmConstants(bool multi_channel_render_support,
Per Åhgrenc0424252019-12-10 13:04:15 +0100446 bool multi_channel_capture_support,
Per Åhgren19775cb2021-03-12 23:08:09 +0000447 bool enforce_split_band_hpf,
Gustaf Ullberga399c822021-05-18 12:17:56 +0200448 bool minimize_processing_for_unused_output,
449 bool transient_suppressor_forced_off)
Per Åhgren0695df12020-01-13 14:43:13 +0100450 : multi_channel_render_support(multi_channel_render_support),
Per Åhgrenc0424252019-12-10 13:04:15 +0100451 multi_channel_capture_support(multi_channel_capture_support),
Per Åhgren19775cb2021-03-12 23:08:09 +0000452 enforce_split_band_hpf(enforce_split_band_hpf),
453 minimize_processing_for_unused_output(
Gustaf Ullberga399c822021-05-18 12:17:56 +0200454 minimize_processing_for_unused_output),
455 transient_suppressor_forced_off(transient_suppressor_forced_off) {}
Per Åhgrene14cb992019-11-27 09:34:22 +0100456 bool multi_channel_render_support;
457 bool multi_channel_capture_support;
Per Åhgrenc0424252019-12-10 13:04:15 +0100458 bool enforce_split_band_hpf;
Per Åhgren19775cb2021-03-12 23:08:09 +0000459 bool minimize_processing_for_unused_output;
Gustaf Ullberga399c822021-05-18 12:17:56 +0200460 bool transient_suppressor_forced_off;
peahdf3efa82015-11-28 12:35:15 -0800461 } constants_;
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000462
peahdf3efa82015-11-28 12:35:15 -0800463 struct ApmCaptureState {
Per Åhgrenc0734712020-01-02 15:15:36 +0100464 ApmCaptureState();
kwiberg83ffe452016-08-29 14:46:07 -0700465 ~ApmCaptureState();
peahdf3efa82015-11-28 12:35:15 -0800466 bool was_stream_delay_set;
Per Åhgren0a144a72021-02-09 08:47:51 +0100467 bool capture_output_used;
Per Åhgren55bc0772021-03-12 14:18:36 +0000468 bool capture_output_used_last_frame;
peahdf3efa82015-11-28 12:35:15 -0800469 bool key_pressed;
kwiberg88788ad2016-02-19 07:04:49 -0800470 std::unique_ptr<AudioBuffer> capture_audio;
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200471 std::unique_ptr<AudioBuffer> capture_fullband_audio;
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100472 std::unique_ptr<AudioBuffer> linear_aec_output;
peahde65ddc2016-09-16 15:02:15 -0700473 // Only the rate and samples fields of capture_processing_format_ are used
474 // because the capture 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;
peah67995532017-04-10 14:12:41 -0700478 bool echo_path_gain_change;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000479 float prev_pre_adjustment_gain;
Fredrik Hernqvistca362852019-05-10 15:50:02 +0200480 int playout_volume;
481 int prev_playout_volume;
Sam Zackrissonb24c00f2018-11-26 16:18:25 +0100482 AudioProcessingStats stats;
Alessio Bazzicafcf1af32022-09-07 17:14:26 +0200483 // Input volume applied on the audio input device when the audio is
484 // acquired. Unspecified when unknown.
485 absl::optional<int> applied_input_volume;
486 bool applied_input_volume_changed;
Alessio Bazzica533e4612022-09-07 16:58:33 +0200487 // Recommended input volume to apply on the audio input device the next time
488 // that audio is acquired. Unspecified when no input volume can be
489 // recommended.
490 absl::optional<int> recommended_input_volume;
Markus Handell0df0fae2020-07-07 15:53:34 +0200491 } capture_ RTC_GUARDED_BY(mutex_capture_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000492
peahdf3efa82015-11-28 12:35:15 -0800493 struct ApmCaptureNonLockedState {
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200494 ApmCaptureNonLockedState()
peahde65ddc2016-09-16 15:02:15 -0700495 : capture_processing_format(kSampleRate16kHz),
peahdf3efa82015-11-28 12:35:15 -0800496 split_rate(kSampleRate16kHz),
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200497 stream_delay_ms(0) {}
peahde65ddc2016-09-16 15:02:15 -0700498 // Only the rate and samples fields of capture_processing_format_ are used
499 // because the forward processing number of channels is mutable and is
500 // tracked by the capture_audio_.
501 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800502 int split_rate;
503 int stream_delay_ms;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200504 bool echo_controller_enabled = false;
peahdf3efa82015-11-28 12:35:15 -0800505 } capture_nonlocked_;
andrew@webrtc.org75dd2882014-02-11 20:52:30 +0000506
peahdf3efa82015-11-28 12:35:15 -0800507 struct ApmRenderState {
kwiberg83ffe452016-08-29 14:46:07 -0700508 ApmRenderState();
509 ~ApmRenderState();
kwiberg88788ad2016-02-19 07:04:49 -0800510 std::unique_ptr<AudioConverter> render_converter;
511 std::unique_ptr<AudioBuffer> render_audio;
Markus Handell0df0fae2020-07-07 15:53:34 +0200512 } render_ RTC_GUARDED_BY(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700513
Per Åhgrencf4c8722019-12-30 14:32:14 +0100514 // Class for statistics reporting. The class is thread-safe and no lock is
515 // needed when accessing it.
516 class ApmStatsReporter {
517 public:
518 ApmStatsReporter();
519 ~ApmStatsReporter();
520
521 // Returns the most recently reported statistics.
522 AudioProcessingStats GetStatistics();
523
524 // Update the cached statistics.
525 void UpdateStatistics(const AudioProcessingStats& new_stats);
526
527 private:
Markus Handell0df0fae2020-07-07 15:53:34 +0200528 Mutex mutex_stats_;
529 AudioProcessingStats cached_stats_ RTC_GUARDED_BY(mutex_stats_);
Per Åhgrencf4c8722019-12-30 14:32:14 +0100530 SwapQueue<AudioProcessingStats> stats_message_queue_;
531 } stats_reporter_;
532
Markus Handell0df0fae2020-07-07 15:53:34 +0200533 std::vector<int16_t> aecm_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
534 std::vector<int16_t> aecm_capture_queue_buffer_
535 RTC_GUARDED_BY(mutex_capture_);
peah701d6282016-10-25 05:42:20 -0700536
Markus Handell0df0fae2020-07-07 15:53:34 +0200537 size_t agc_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
538 RTC_GUARDED_BY(mutex_capture_) = 0;
539 std::vector<int16_t> agc_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
540 std::vector<int16_t> agc_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700541
Markus Handell0df0fae2020-07-07 15:53:34 +0200542 size_t red_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
543 RTC_GUARDED_BY(mutex_capture_) = 0;
544 std::vector<float> red_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
545 std::vector<float> red_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700546
Markus Handell0df0fae2020-07-07 15:53:34 +0200547 RmsLevel capture_input_rms_ RTC_GUARDED_BY(mutex_capture_);
548 RmsLevel capture_output_rms_ RTC_GUARDED_BY(mutex_capture_);
549 int capture_rms_interval_counter_ RTC_GUARDED_BY(mutex_capture_) = 0;
henrik.lundin290d43a2016-11-29 08:09:09 -0800550
Alessio Bazzicac34a8c12022-10-26 13:30:25 +0000551 InputVolumeStatsReporter applied_input_volume_stats_reporter_
Hanna Silen529131d2021-10-29 14:55:45 +0200552 RTC_GUARDED_BY(mutex_capture_);
Alessio Bazzicafbe5d7c2022-10-27 00:05:32 +0200553 InputVolumeStatsReporter recommended_input_volume_stats_reporter_
554 RTC_GUARDED_BY(mutex_capture_);
Hanna Silen529131d2021-10-29 14:55:45 +0200555
peah764e3642016-10-22 05:04:30 -0700556 // Lock protection not needed.
peaha0624602016-10-25 04:45:24 -0700557 std::unique_ptr<
558 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
peah701d6282016-10-25 05:42:20 -0700559 aecm_render_signal_queue_;
560 std::unique_ptr<
561 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
562 agc_render_signal_queue_;
ivoc9f4a4a02016-10-28 05:39:16 -0700563 std::unique_ptr<SwapQueue<std::vector<float>, RenderQueueItemVerifier<float>>>
564 red_render_signal_queue_;
niklase@google.com470e71d2011-07-07 08:21:25 +0000565};
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000566
niklase@google.com470e71d2011-07-07 08:21:25 +0000567} // namespace webrtc
568
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200569#endif // MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_