blob: 344b8c595978e701dcf975047bb47216b6b087a3 [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"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020042#include "rtc_base/gtest_prod_util.h"
43#include "rtc_base/ignore_wundef.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020044#include "rtc_base/swap_queue.h"
Markus Handell0df0fae2020-07-07 15:53:34 +020045#include "rtc_base/synchronization/mutex.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020046#include "rtc_base/thread_annotations.h"
peahdf3efa82015-11-28 12:35:15 -080047
niklase@google.com470e71d2011-07-07 08:21:25 +000048namespace webrtc {
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +000049
Per Åhgren13735822018-02-12 21:42:56 +010050class ApmDataDumper;
ekmeyerson60d9b332015-08-14 10:35:55 -070051class AudioConverter;
Michael Graczykdfa36052015-03-25 16:37:27 -070052
Henrik Lundin8a9aa552022-02-08 09:15:12 +000053constexpr int RuntimeSettingQueueSize() {
54 return 100;
55}
56
niklase@google.com470e71d2011-07-07 08:21:25 +000057class AudioProcessingImpl : public AudioProcessing {
58 public:
peahdf3efa82015-11-28 12:35:15 -080059 // Methods forcing APM to run in a single-threaded manner.
60 // Acquires both the render and capture locks.
Alessio Bazzicabe1b8982021-09-17 08:26:10 +020061 AudioProcessingImpl();
Alessio Bazzica20a9ac62021-10-14 10:55:08 +020062 AudioProcessingImpl(const AudioProcessing::Config& config,
63 std::unique_ptr<CustomProcessing> capture_post_processor,
Alex Loiko5825aa62017-12-18 16:02:40 +010064 std::unique_ptr<CustomProcessing> render_pre_processor,
Gustaf Ullberg002ef282017-10-12 15:13:17 +020065 std::unique_ptr<EchoControlFactory> echo_control_factory,
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +020066 rtc::scoped_refptr<EchoDetector> echo_detector,
67 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer);
kwiberg83ffe452016-08-29 14:46:07 -070068 ~AudioProcessingImpl() override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000069 int Initialize() override;
Michael Graczyk86c6d332015-07-23 11:41:39 -070070 int Initialize(const ProcessingConfig& processing_config) override;
peah88ac8532016-09-12 16:47:25 -070071 void ApplyConfig(const AudioProcessing::Config& config) override;
Per Åhgren09e9a832020-05-11 11:03:47 +020072 bool CreateAndAttachAecDump(const std::string& file_name,
73 int64_t max_log_size_bytes,
74 rtc::TaskQueue* worker_queue) override;
75 bool CreateAndAttachAecDump(FILE* handle,
76 int64_t max_log_size_bytes,
77 rtc::TaskQueue* worker_queue) override;
78 // TODO(webrtc:5298) Deprecated variant.
aleloi868f32f2017-05-23 07:20:05 -070079 void AttachAecDump(std::unique_ptr<AecDump> aec_dump) override;
80 void DetachAecDump() override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020081 void SetRuntimeSetting(RuntimeSetting setting) override;
Per Åhgren0a144a72021-02-09 08:47:51 +010082 bool PostRuntimeSetting(RuntimeSetting setting) override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020083
peahdf3efa82015-11-28 12:35:15 -080084 // Capture-side exclusive methods possibly running APM in a
85 // multi-threaded manner. Acquire the capture lock.
Per Åhgren645f24c2020-03-16 12:06:02 +010086 int ProcessStream(const int16_t* const src,
87 const StreamConfig& input_config,
88 const StreamConfig& output_config,
Per Åhgrendc5522b2020-03-19 14:55:58 +010089 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000090 int ProcessStream(const float* const* src,
Michael Graczyk86c6d332015-07-23 11:41:39 -070091 const StreamConfig& input_config,
92 const StreamConfig& output_config,
93 float* const* dest) override;
Per Åhgrenc20a19c2019-11-13 11:12:29 +010094 bool GetLinearAecOutput(
95 rtc::ArrayView<std::array<float, 160>> linear_output) const override;
peahdf3efa82015-11-28 12:35:15 -080096 void set_output_will_be_muted(bool muted) override;
Per Åhgren0a144a72021-02-09 08:47:51 +010097 void HandleCaptureOutputUsedSetting(bool capture_output_used)
98 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -080099 int set_stream_delay_ms(int delay) override;
peahdf3efa82015-11-28 12:35:15 -0800100 void set_stream_key_pressed(bool key_pressed) override;
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100101 void set_stream_analog_level(int level) override;
Markus Handell02ba1d22020-05-14 14:31:18 +0200102 int recommended_stream_analog_level() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200103 RTC_LOCKS_EXCLUDED(mutex_capture_) override;
peahdf3efa82015-11-28 12:35:15 -0800104
105 // Render-side exclusive methods possibly running APM in a
106 // multi-threaded manner. Acquire the render lock.
Per Åhgren645f24c2020-03-16 12:06:02 +0100107 int ProcessReverseStream(const int16_t* const src,
108 const StreamConfig& input_config,
109 const StreamConfig& output_config,
110 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000111 int AnalyzeReverseStream(const float* const* data,
Gustaf Ullberg8c51f2e2019-10-22 15:21:31 +0200112 const StreamConfig& reverse_config) override;
ekmeyerson60d9b332015-08-14 10:35:55 -0700113 int ProcessReverseStream(const float* const* src,
peahde65ddc2016-09-16 15:02:15 -0700114 const StreamConfig& input_config,
115 const StreamConfig& output_config,
ekmeyerson60d9b332015-08-14 10:35:55 -0700116 float* const* dest) override;
peahdf3efa82015-11-28 12:35:15 -0800117
118 // Methods only accessed from APM submodules or
119 // from AudioProcessing tests in a single-threaded manner.
120 // Hence there is no need for locks in these.
121 int proc_sample_rate_hz() const override;
122 int proc_split_sample_rate_hz() const override;
Peter Kasting69558702016-01-12 16:26:35 -0800123 size_t num_input_channels() const override;
124 size_t num_proc_channels() const override;
125 size_t num_output_channels() const override;
126 size_t num_reverse_channels() const override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000127 int stream_delay_ms() const override;
peahdf3efa82015-11-28 12:35:15 -0800128
Per Åhgrencf4c8722019-12-30 14:32:14 +0100129 AudioProcessingStats GetStatistics(bool has_remote_tracks) override {
130 return GetStatistics();
131 }
132 AudioProcessingStats GetStatistics() override {
133 return stats_reporter_.GetStatistics();
134 }
ivoc3e9a5372016-10-28 07:55:33 -0700135
henrik.lundinadf06352017-04-05 05:48:24 -0700136 AudioProcessing::Config GetConfig() const override;
peah8271d042016-11-22 07:24:52 -0800137
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000138 protected:
andrew@webrtc.orga8b97372014-03-10 22:26:12 +0000139 // Overridden in a mock.
Per Åhgren0ade9832020-09-01 23:57:20 +0200140 virtual void InitializeLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200141 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Niels Möller5b747232021-07-26 17:16:25 +0200142 void AssertLockedForTest()
143 RTC_ASSERT_EXCLUSIVE_LOCK(mutex_render_, mutex_capture_) {
144 mutex_render_.AssertHeld();
145 mutex_capture_.AssertHeld();
146 }
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000147
niklase@google.com470e71d2011-07-07 08:21:25 +0000148 private:
peahc19f3122016-10-07 14:54:10 -0700149 // TODO(peah): These friend classes should be removed as soon as the new
150 // parameter setting scheme allows.
151 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, DefaultBehavior);
152 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, ValidConfigBehavior);
153 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, InValidConfigBehavior);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200154 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
155 ToggleTransientSuppressor);
156 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
157 ReinitializeTransientSuppressor);
158 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
159 BitexactWithDisabledModules);
160
Markus Handell02ba1d22020-05-14 14:31:18 +0200161 int recommended_stream_analog_level_locked() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200162 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200163
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200164 void OverrideSubmoduleCreationForTesting(
165 const ApmSubmoduleCreationOverrides& overrides);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200166
167 // Class providing thread-safe message pipe functionality for
Artem Titov0b489302021-07-28 20:50:03 +0200168 // `runtime_settings_`.
Alessio Bazzicac054e782018-04-16 12:10:09 +0200169 class RuntimeSettingEnqueuer {
170 public:
171 explicit RuntimeSettingEnqueuer(
172 SwapQueue<RuntimeSetting>* runtime_settings);
173 ~RuntimeSettingEnqueuer();
Per Åhgren0a144a72021-02-09 08:47:51 +0100174
175 // Enqueue setting and return whether the setting was successfully enqueued.
176 bool Enqueue(RuntimeSetting setting);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200177
178 private:
Alessio Bazzica33444dc2018-04-20 13:16:55 +0200179 SwapQueue<RuntimeSetting>& runtime_settings_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200180 };
Alex Loiko73ec0192018-05-15 10:52:28 +0200181
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100182 const std::unique_ptr<ApmDataDumper> data_dumper_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200183 static int instance_count_;
Per Åhgrenb2b58d82019-12-02 14:59:40 +0100184 const bool use_setup_specific_default_aec3_config_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200185
Alessio Bazzica0441bb62021-08-10 15:23:23 +0200186 const bool use_denormal_disabler_;
187
Alex Loiko73ec0192018-05-15 10:52:28 +0200188 SwapQueue<RuntimeSetting> capture_runtime_settings_;
189 SwapQueue<RuntimeSetting> render_runtime_settings_;
190
191 RuntimeSettingEnqueuer capture_runtime_settings_enqueuer_;
192 RuntimeSettingEnqueuer render_runtime_settings_enqueuer_;
Alessio Bazzicac054e782018-04-16 12:10:09 +0200193
Gustaf Ullberg002ef282017-10-12 15:13:17 +0200194 // EchoControl factory.
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100195 const std::unique_ptr<EchoControlFactory> echo_control_factory_;
Gustaf Ullbergd8579e02017-10-11 16:29:02 +0200196
saza1d600522019-10-18 13:29:43 +0200197 class SubmoduleStates {
peah2ace3f92016-09-10 04:42:27 -0700198 public:
saza1d600522019-10-18 13:29:43 +0200199 SubmoduleStates(bool capture_post_processor_enabled,
200 bool render_pre_processor_enabled,
201 bool capture_analyzer_enabled);
peah2ace3f92016-09-10 04:42:27 -0700202 // Updates the submodule state and returns true if it has changed.
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200203 bool Update(bool high_pass_filter_enabled,
peah2ace3f92016-09-10 04:42:27 -0700204 bool mobile_echo_controller_enabled,
205 bool noise_suppressor_enabled,
peah2ace3f92016-09-10 04:42:27 -0700206 bool adaptive_gain_controller_enabled,
alessiob3ec96df2017-05-22 06:57:06 -0700207 bool gain_controller2_enabled,
Per Åhgrendb5d7282021-03-15 16:31:04 +0000208 bool gain_adjustment_enabled,
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200209 bool echo_controller_enabled,
peah2ace3f92016-09-10 04:42:27 -0700210 bool transient_suppressor_enabled);
211 bool CaptureMultiBandSubModulesActive() const;
Gustaf Ullberg8675eee2019-10-09 13:34:36 +0200212 bool CaptureMultiBandProcessingPresent() const;
213 bool CaptureMultiBandProcessingActive(bool ec_processing_active) const;
peah23ac8b42017-05-23 05:33:56 -0700214 bool CaptureFullBandProcessingActive() const;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200215 bool CaptureAnalyzerActive() const;
peah2ace3f92016-09-10 04:42:27 -0700216 bool RenderMultiBandSubModulesActive() const;
Alex Loiko5825aa62017-12-18 16:02:40 +0100217 bool RenderFullBandProcessingActive() const;
peah2ace3f92016-09-10 04:42:27 -0700218 bool RenderMultiBandProcessingActive() const;
Per Åhgren0aefbf02019-08-23 21:29:17 +0200219 bool HighPassFilteringRequired() const;
peah2ace3f92016-09-10 04:42:27 -0700220
221 private:
Sam Zackrisson0beac582017-09-25 12:04:02 +0200222 const bool capture_post_processor_enabled_ = false;
Alex Loiko5825aa62017-12-18 16:02:40 +0100223 const bool render_pre_processor_enabled_ = false;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200224 const bool capture_analyzer_enabled_ = false;
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200225 bool high_pass_filter_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700226 bool mobile_echo_controller_enabled_ = false;
227 bool noise_suppressor_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700228 bool adaptive_gain_controller_enabled_ = false;
alessiob3ec96df2017-05-22 06:57:06 -0700229 bool gain_controller2_enabled_ = false;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000230 bool gain_adjustment_enabled_ = false;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200231 bool echo_controller_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700232 bool transient_suppressor_enabled_ = false;
233 bool first_update_ = true;
234 };
235
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100236 // Methods for modifying the formats struct that is used by both
237 // the render and capture threads. The check for whether modifications are
238 // needed is done while holding a single lock only, thereby avoiding that the
239 // capture thread blocks the render thread.
240 // Called by render: Holds the render lock when reading the format struct and
241 // acquires both locks if reinitialization is required.
peahdf3efa82015-11-28 12:35:15 -0800242 int MaybeInitializeRender(const ProcessingConfig& processing_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200243 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100244 // Called by capture: Holds the capture lock when reading the format struct
245 // and acquires both locks if reinitialization is needed.
246 int MaybeInitializeCapture(const StreamConfig& input_config,
247 const StreamConfig& output_config);
peahdf3efa82015-11-28 12:35:15 -0800248
peah2ace3f92016-09-10 04:42:27 -0700249 // Method for updating the state keeping track of the active submodules.
250 // Returns a bool indicating whether the state has changed.
danilchap56359be2017-09-07 07:53:45 -0700251 bool UpdateActiveSubmoduleStates()
Markus Handell0df0fae2020-07-07 15:53:34 +0200252 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800253
Per Åhgrenc0734712020-01-02 15:15:36 +0100254 // Methods requiring APM running in a single-threaded manner, requiring both
255 // the render and capture lock to be acquired.
Michael Graczyk86c6d332015-07-23 11:41:39 -0700256 int InitializeLocked(const ProcessingConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200257 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700258 void InitializeResidualEchoDetector()
Markus Handell0df0fae2020-07-07 15:53:34 +0200259 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenf204faf2019-04-25 15:18:06 +0200260 void InitializeEchoController()
Markus Handell0df0fae2020-07-07 15:53:34 +0200261 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100262
Alessio Bazzica38901042021-10-14 12:14:21 +0200263 // Initializations of capture-only sub-modules, requiring the capture lock
Per Åhgrenc0734712020-01-02 15:15:36 +0100264 // already acquired.
Per Åhgren0f14db22020-01-03 14:27:14 +0100265 void InitializeHighPassFilter(bool forced_reset)
Markus Handell0df0fae2020-07-07 15:53:34 +0200266 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200267 void InitializeGainController1() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100268 void InitializeTransientSuppressor()
Markus Handell0df0fae2020-07-07 15:53:34 +0200269 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Alessio Bazzica38901042021-10-14 12:14:21 +0200270 // Initializes the `GainController2` sub-module. If the sub-module is enabled
271 // and `config_has_changed` is true, recreates the sub-module.
272 void InitializeGainController2(bool config_has_changed)
273 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200274 void InitializeNoiseSuppressor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrendb5d7282021-03-15 16:31:04 +0000275 void InitializeCaptureLevelsAdjuster()
276 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200277 void InitializePostProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
278 void InitializeAnalyzer() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100279
280 // Initializations of render-only submodules, requiring the render lock
281 // already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200282 void InitializePreProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peahdf3efa82015-11-28 12:35:15 -0800283
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200284 // Sample rate used for the fullband processing.
285 int proc_fullband_sample_rate_hz() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200286 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200287
Alex Loiko73ec0192018-05-15 10:52:28 +0200288 // Empties and handles the respective RuntimeSetting queues.
289 void HandleCaptureRuntimeSettings()
Markus Handell0df0fae2020-07-07 15:53:34 +0200290 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
291 void HandleRenderRuntimeSettings()
292 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100293
Markus Handell0df0fae2020-07-07 15:53:34 +0200294 void EmptyQueuedRenderAudio() RTC_LOCKS_EXCLUDED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200295 void EmptyQueuedRenderAudioLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200296 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700297 void AllocateRenderQueue()
Markus Handell0df0fae2020-07-07 15:53:34 +0200298 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
peah9e6a2902017-05-15 07:19:21 -0700299 void QueueBandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200300 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah9e6a2902017-05-15 07:19:21 -0700301 void QueueNonbandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200302 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700303
peahdf3efa82015-11-28 12:35:15 -0800304 // Capture-side exclusive methods possibly running APM in a multi-threaded
305 // manner that are called with the render lock already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200306 int ProcessCaptureStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800307
308 // Render-side exclusive methods possibly running APM in a multi-threaded
309 // manner that are called with the render lock already acquired.
ekmeyerson60d9b332015-08-14 10:35:55 -0700310 // TODO(ekm): Remove once all clients updated to new interface.
peahdf3efa82015-11-28 12:35:15 -0800311 int AnalyzeReverseStreamLocked(const float* const* src,
312 const StreamConfig& input_config,
313 const StreamConfig& output_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200314 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
315 int ProcessRenderStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
andrew@webrtc.org17e40642014-03-04 20:58:13 +0000316
aleloi868f32f2017-05-23 07:20:05 -0700317 // Collects configuration settings from public and private
318 // submodules to be saved as an audioproc::Config message on the
Artem Titov0b489302021-07-28 20:50:03 +0200319 // AecDump if it is attached. If not `forced`, only writes the current
320 // config if it is different from the last saved one; if `forced`,
aleloi868f32f2017-05-23 07:20:05 -0700321 // writes the config regardless of the last saved.
322 void WriteAecDumpConfigMessage(bool forced)
Markus Handell0df0fae2020-07-07 15:53:34 +0200323 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700324
325 // Notifies attached AecDump of current configuration and capture data.
326 void RecordUnprocessedCaptureStream(const float* const* capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200327 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700328
Per Åhgren645f24c2020-03-16 12:06:02 +0100329 void RecordUnprocessedCaptureStream(const int16_t* const data,
330 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200331 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700332
333 // Notifies attached AecDump of current configuration and
334 // processed capture data and issues a capture stream recording
335 // request.
336 void RecordProcessedCaptureStream(
337 const float* const* processed_capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200338 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700339
Per Åhgren645f24c2020-03-16 12:06:02 +0100340 void RecordProcessedCaptureStream(const int16_t* const data,
341 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200342 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700343
344 // Notifies attached AecDump about current state (delay, drift, etc).
Markus Handell0df0fae2020-07-07 15:53:34 +0200345 void RecordAudioProcessingState()
346 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700347
Per Åhgren652ada52021-03-03 10:52:44 +0000348 // Ensures that overruns in the capture runtime settings queue is properly
349 // handled by the code, providing safe-fallbacks to mitigate the implications
350 // of any settings being missed.
351 void HandleOverrunInCaptureRuntimeSettingsQueue()
352 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
353
aleloi868f32f2017-05-23 07:20:05 -0700354 // AecDump instance used for optionally logging APM config, input
355 // and output to file in the AEC-dump format defined in debug.proto.
356 std::unique_ptr<AecDump> aec_dump_;
357
358 // Hold the last config written with AecDump for avoiding writing
359 // the same config twice.
Markus Handell0df0fae2020-07-07 15:53:34 +0200360 InternalAPMConfig apm_config_for_aec_dump_ RTC_GUARDED_BY(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700361
peahdf3efa82015-11-28 12:35:15 -0800362 // Critical sections.
Markus Handell0df0fae2020-07-07 15:53:34 +0200363 mutable Mutex mutex_render_ RTC_ACQUIRED_BEFORE(mutex_capture_);
364 mutable Mutex mutex_capture_;
peahdf3efa82015-11-28 12:35:15 -0800365
peahc19f3122016-10-07 14:54:10 -0700366 // Struct containing the Config specifying the behavior of APM.
367 AudioProcessing::Config config_;
368
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200369 // Overrides for testing the exclusion of some submodules from the build.
370 ApmSubmoduleCreationOverrides submodule_creation_overrides_
Markus Handell0df0fae2020-07-07 15:53:34 +0200371 RTC_GUARDED_BY(mutex_capture_);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200372
peah2ace3f92016-09-10 04:42:27 -0700373 // Class containing information about what submodules are active.
saza1d600522019-10-18 13:29:43 +0200374 SubmoduleStates submodule_states_;
peah2ace3f92016-09-10 04:42:27 -0700375
saza1d600522019-10-18 13:29:43 +0200376 // Struct containing the pointers to the submodules.
377 struct Submodules {
378 Submodules(std::unique_ptr<CustomProcessing> capture_post_processor,
379 std::unique_ptr<CustomProcessing> render_pre_processor,
380 rtc::scoped_refptr<EchoDetector> echo_detector,
Per Åhgren3daedb62019-11-22 12:11:40 +0100381 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer)
saza1d600522019-10-18 13:29:43 +0200382 : echo_detector(std::move(echo_detector)),
383 capture_post_processor(std::move(capture_post_processor)),
384 render_pre_processor(std::move(render_pre_processor)),
Per Åhgren3daedb62019-11-22 12:11:40 +0100385 capture_analyzer(std::move(capture_analyzer)) {}
saza1d600522019-10-18 13:29:43 +0200386 // Accessed internally from capture or during initialization.
Sam Zackrisson03cb7e52021-12-06 15:40:04 +0100387 const rtc::scoped_refptr<EchoDetector> echo_detector;
388 const std::unique_ptr<CustomProcessing> capture_post_processor;
389 const std::unique_ptr<CustomProcessing> render_pre_processor;
390 const std::unique_ptr<CustomAudioAnalyzer> capture_analyzer;
saza1d600522019-10-18 13:29:43 +0200391 std::unique_ptr<AgcManagerDirect> agc_manager;
392 std::unique_ptr<GainControlImpl> gain_control;
saza1d600522019-10-18 13:29:43 +0200393 std::unique_ptr<GainController2> gain_controller2;
394 std::unique_ptr<HighPassFilter> high_pass_filter;
saza1d600522019-10-18 13:29:43 +0200395 std::unique_ptr<EchoControl> echo_controller;
396 std::unique_ptr<EchoControlMobileImpl> echo_control_mobile;
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100397 std::unique_ptr<NoiseSuppressor> noise_suppressor;
saza1d600522019-10-18 13:29:43 +0200398 std::unique_ptr<TransientSuppressor> transient_suppressor;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000399 std::unique_ptr<CaptureLevelsAdjuster> capture_levels_adjuster;
saza1d600522019-10-18 13:29:43 +0200400 } submodules_;
peahdf3efa82015-11-28 12:35:15 -0800401
peah192164e2015-11-17 02:16:45 -0800402 // State that is written to while holding both the render and capture locks
peahdf3efa82015-11-28 12:35:15 -0800403 // but can be read without any lock being held.
404 // As this is only accessed internally of APM, and all internal methods in APM
405 // either are holding the render or capture locks, this construct is safe as
406 // it is not possible to read the variables while writing them.
407 struct ApmFormatState {
408 ApmFormatState()
peah192164e2015-11-17 02:16:45 -0800409 : // Format of processing streams at input/output call sites.
Henrik Lundin64253a92022-02-04 09:02:48 +0000410 api_format({{{kSampleRate16kHz, 1},
411 {kSampleRate16kHz, 1},
412 {kSampleRate16kHz, 1},
413 {kSampleRate16kHz, 1}}}),
peahde65ddc2016-09-16 15:02:15 -0700414 render_processing_format(kSampleRate16kHz, 1) {}
peahdf3efa82015-11-28 12:35:15 -0800415 ProcessingConfig api_format;
peahde65ddc2016-09-16 15:02:15 -0700416 StreamConfig render_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800417 } formats_;
Michael Graczyk86c6d332015-07-23 11:41:39 -0700418
peahdf3efa82015-11-28 12:35:15 -0800419 // APM constants.
420 const struct ApmConstants {
Per Åhgren0695df12020-01-13 14:43:13 +0100421 ApmConstants(bool multi_channel_render_support,
Per Åhgrenc0424252019-12-10 13:04:15 +0100422 bool multi_channel_capture_support,
Per Åhgren19775cb2021-03-12 23:08:09 +0000423 bool enforce_split_band_hpf,
Gustaf Ullberga399c822021-05-18 12:17:56 +0200424 bool minimize_processing_for_unused_output,
425 bool transient_suppressor_forced_off)
Per Åhgren0695df12020-01-13 14:43:13 +0100426 : multi_channel_render_support(multi_channel_render_support),
Per Åhgrenc0424252019-12-10 13:04:15 +0100427 multi_channel_capture_support(multi_channel_capture_support),
Per Åhgren19775cb2021-03-12 23:08:09 +0000428 enforce_split_band_hpf(enforce_split_band_hpf),
429 minimize_processing_for_unused_output(
Gustaf Ullberga399c822021-05-18 12:17:56 +0200430 minimize_processing_for_unused_output),
431 transient_suppressor_forced_off(transient_suppressor_forced_off) {}
Per Åhgrene14cb992019-11-27 09:34:22 +0100432 bool multi_channel_render_support;
433 bool multi_channel_capture_support;
Per Åhgrenc0424252019-12-10 13:04:15 +0100434 bool enforce_split_band_hpf;
Per Åhgren19775cb2021-03-12 23:08:09 +0000435 bool minimize_processing_for_unused_output;
Gustaf Ullberga399c822021-05-18 12:17:56 +0200436 bool transient_suppressor_forced_off;
peahdf3efa82015-11-28 12:35:15 -0800437 } constants_;
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000438
peahdf3efa82015-11-28 12:35:15 -0800439 struct ApmCaptureState {
Per Åhgrenc0734712020-01-02 15:15:36 +0100440 ApmCaptureState();
kwiberg83ffe452016-08-29 14:46:07 -0700441 ~ApmCaptureState();
peahdf3efa82015-11-28 12:35:15 -0800442 bool was_stream_delay_set;
Per Åhgren0a144a72021-02-09 08:47:51 +0100443 bool capture_output_used;
Per Åhgren55bc0772021-03-12 14:18:36 +0000444 bool capture_output_used_last_frame;
peahdf3efa82015-11-28 12:35:15 -0800445 bool key_pressed;
kwiberg88788ad2016-02-19 07:04:49 -0800446 std::unique_ptr<AudioBuffer> capture_audio;
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200447 std::unique_ptr<AudioBuffer> capture_fullband_audio;
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100448 std::unique_ptr<AudioBuffer> linear_aec_output;
peahde65ddc2016-09-16 15:02:15 -0700449 // Only the rate and samples fields of capture_processing_format_ are used
450 // because the capture processing number of channels is mutable and is
451 // tracked by the capture_audio_.
452 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800453 int split_rate;
peah67995532017-04-10 14:12:41 -0700454 bool echo_path_gain_change;
Per Åhgren88cf0502018-07-16 17:08:41 +0200455 int prev_analog_mic_level;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000456 float prev_pre_adjustment_gain;
Fredrik Hernqvistca362852019-05-10 15:50:02 +0200457 int playout_volume;
458 int prev_playout_volume;
Sam Zackrissonb24c00f2018-11-26 16:18:25 +0100459 AudioProcessingStats stats;
Per Åhgren0695df12020-01-13 14:43:13 +0100460 int cached_stream_analog_level_ = 0;
Markus Handell0df0fae2020-07-07 15:53:34 +0200461 } capture_ RTC_GUARDED_BY(mutex_capture_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000462
peahdf3efa82015-11-28 12:35:15 -0800463 struct ApmCaptureNonLockedState {
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200464 ApmCaptureNonLockedState()
peahde65ddc2016-09-16 15:02:15 -0700465 : capture_processing_format(kSampleRate16kHz),
peahdf3efa82015-11-28 12:35:15 -0800466 split_rate(kSampleRate16kHz),
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200467 stream_delay_ms(0) {}
peahde65ddc2016-09-16 15:02:15 -0700468 // Only the rate and samples fields of capture_processing_format_ are used
469 // because the forward processing number of channels is mutable and is
470 // tracked by the capture_audio_.
471 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800472 int split_rate;
473 int stream_delay_ms;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200474 bool echo_controller_enabled = false;
peahdf3efa82015-11-28 12:35:15 -0800475 } capture_nonlocked_;
andrew@webrtc.org75dd2882014-02-11 20:52:30 +0000476
peahdf3efa82015-11-28 12:35:15 -0800477 struct ApmRenderState {
kwiberg83ffe452016-08-29 14:46:07 -0700478 ApmRenderState();
479 ~ApmRenderState();
kwiberg88788ad2016-02-19 07:04:49 -0800480 std::unique_ptr<AudioConverter> render_converter;
481 std::unique_ptr<AudioBuffer> render_audio;
Markus Handell0df0fae2020-07-07 15:53:34 +0200482 } render_ RTC_GUARDED_BY(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700483
Per Åhgrencf4c8722019-12-30 14:32:14 +0100484 // Class for statistics reporting. The class is thread-safe and no lock is
485 // needed when accessing it.
486 class ApmStatsReporter {
487 public:
488 ApmStatsReporter();
489 ~ApmStatsReporter();
490
491 // Returns the most recently reported statistics.
492 AudioProcessingStats GetStatistics();
493
494 // Update the cached statistics.
495 void UpdateStatistics(const AudioProcessingStats& new_stats);
496
497 private:
Markus Handell0df0fae2020-07-07 15:53:34 +0200498 Mutex mutex_stats_;
499 AudioProcessingStats cached_stats_ RTC_GUARDED_BY(mutex_stats_);
Per Åhgrencf4c8722019-12-30 14:32:14 +0100500 SwapQueue<AudioProcessingStats> stats_message_queue_;
501 } stats_reporter_;
502
Markus Handell0df0fae2020-07-07 15:53:34 +0200503 std::vector<int16_t> aecm_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
504 std::vector<int16_t> aecm_capture_queue_buffer_
505 RTC_GUARDED_BY(mutex_capture_);
peah701d6282016-10-25 05:42:20 -0700506
Markus Handell0df0fae2020-07-07 15:53:34 +0200507 size_t agc_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
508 RTC_GUARDED_BY(mutex_capture_) = 0;
509 std::vector<int16_t> agc_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
510 std::vector<int16_t> agc_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700511
Markus Handell0df0fae2020-07-07 15:53:34 +0200512 size_t red_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
513 RTC_GUARDED_BY(mutex_capture_) = 0;
514 std::vector<float> red_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
515 std::vector<float> red_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700516
Markus Handell0df0fae2020-07-07 15:53:34 +0200517 RmsLevel capture_input_rms_ RTC_GUARDED_BY(mutex_capture_);
518 RmsLevel capture_output_rms_ RTC_GUARDED_BY(mutex_capture_);
519 int capture_rms_interval_counter_ RTC_GUARDED_BY(mutex_capture_) = 0;
henrik.lundin290d43a2016-11-29 08:09:09 -0800520
Hanna Silen529131d2021-10-29 14:55:45 +0200521 AnalogGainStatsReporter analog_gain_stats_reporter_
522 RTC_GUARDED_BY(mutex_capture_);
523
peah764e3642016-10-22 05:04:30 -0700524 // Lock protection not needed.
peaha0624602016-10-25 04:45:24 -0700525 std::unique_ptr<
526 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
peah701d6282016-10-25 05:42:20 -0700527 aecm_render_signal_queue_;
528 std::unique_ptr<
529 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
530 agc_render_signal_queue_;
ivoc9f4a4a02016-10-28 05:39:16 -0700531 std::unique_ptr<SwapQueue<std::vector<float>, RenderQueueItemVerifier<float>>>
532 red_render_signal_queue_;
niklase@google.com470e71d2011-07-07 08:21:25 +0000533};
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000534
niklase@google.com470e71d2011-07-07 08:21:25 +0000535} // namespace webrtc
536
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200537#endif // MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_