blob: c88cfcde92182c3135d98beba41cd176959000a8 [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.
peah88ac8532016-09-12 16:47:25 -070058 explicit AudioProcessingImpl(const webrtc::Config& config);
Sam Zackrissondb389722018-06-21 10:12:24 +020059 // AudioProcessingImpl takes ownership of capture post processor.
peah88ac8532016-09-12 16:47:25 -070060 AudioProcessingImpl(const webrtc::Config& config,
Alex Loiko5825aa62017-12-18 16:02:40 +010061 std::unique_ptr<CustomProcessing> capture_post_processor,
62 std::unique_ptr<CustomProcessing> render_pre_processor,
Gustaf Ullberg002ef282017-10-12 15:13:17 +020063 std::unique_ptr<EchoControlFactory> echo_control_factory,
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +020064 rtc::scoped_refptr<EchoDetector> echo_detector,
65 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer);
kwiberg83ffe452016-08-29 14:46:07 -070066 ~AudioProcessingImpl() override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000067 int Initialize() override;
peahde65ddc2016-09-16 15:02:15 -070068 int Initialize(int capture_input_sample_rate_hz,
69 int capture_output_sample_rate_hz,
70 int render_sample_rate_hz,
71 ChannelLayout capture_input_layout,
72 ChannelLayout capture_output_layout,
73 ChannelLayout render_input_layout) override;
Michael Graczyk86c6d332015-07-23 11:41:39 -070074 int Initialize(const ProcessingConfig& processing_config) override;
peah88ac8532016-09-12 16:47:25 -070075 void ApplyConfig(const AudioProcessing::Config& config) override;
Per Åhgren09e9a832020-05-11 11:03:47 +020076 bool CreateAndAttachAecDump(const std::string& file_name,
77 int64_t max_log_size_bytes,
78 rtc::TaskQueue* worker_queue) override;
79 bool CreateAndAttachAecDump(FILE* handle,
80 int64_t max_log_size_bytes,
81 rtc::TaskQueue* worker_queue) override;
82 // TODO(webrtc:5298) Deprecated variant.
aleloi868f32f2017-05-23 07:20:05 -070083 void AttachAecDump(std::unique_ptr<AecDump> aec_dump) override;
84 void DetachAecDump() override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020085 void SetRuntimeSetting(RuntimeSetting setting) override;
Per Åhgren0a144a72021-02-09 08:47:51 +010086 bool PostRuntimeSetting(RuntimeSetting setting) override;
Alessio Bazzicac054e782018-04-16 12:10:09 +020087
peahdf3efa82015-11-28 12:35:15 -080088 // Capture-side exclusive methods possibly running APM in a
89 // multi-threaded manner. Acquire the capture lock.
Per Åhgren645f24c2020-03-16 12:06:02 +010090 int ProcessStream(const int16_t* const src,
91 const StreamConfig& input_config,
92 const StreamConfig& output_config,
Per Åhgrendc5522b2020-03-19 14:55:58 +010093 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +000094 int ProcessStream(const float* const* src,
Michael Graczyk86c6d332015-07-23 11:41:39 -070095 const StreamConfig& input_config,
96 const StreamConfig& output_config,
97 float* const* dest) override;
Per Åhgrenc20a19c2019-11-13 11:12:29 +010098 bool GetLinearAecOutput(
99 rtc::ArrayView<std::array<float, 160>> linear_output) const override;
peahdf3efa82015-11-28 12:35:15 -0800100 void set_output_will_be_muted(bool muted) override;
Per Åhgren0a144a72021-02-09 08:47:51 +0100101 void HandleCaptureOutputUsedSetting(bool capture_output_used)
102 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800103 int set_stream_delay_ms(int delay) override;
peahdf3efa82015-11-28 12:35:15 -0800104 void set_stream_key_pressed(bool key_pressed) override;
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100105 void set_stream_analog_level(int level) override;
Markus Handell02ba1d22020-05-14 14:31:18 +0200106 int recommended_stream_analog_level() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200107 RTC_LOCKS_EXCLUDED(mutex_capture_) override;
peahdf3efa82015-11-28 12:35:15 -0800108
109 // Render-side exclusive methods possibly running APM in a
110 // multi-threaded manner. Acquire the render lock.
Per Åhgren645f24c2020-03-16 12:06:02 +0100111 int ProcessReverseStream(const int16_t* const src,
112 const StreamConfig& input_config,
113 const StreamConfig& output_config,
114 int16_t* const dest) override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000115 int AnalyzeReverseStream(const float* const* data,
Gustaf Ullberg8c51f2e2019-10-22 15:21:31 +0200116 const StreamConfig& reverse_config) override;
ekmeyerson60d9b332015-08-14 10:35:55 -0700117 int ProcessReverseStream(const float* const* src,
peahde65ddc2016-09-16 15:02:15 -0700118 const StreamConfig& input_config,
119 const StreamConfig& output_config,
ekmeyerson60d9b332015-08-14 10:35:55 -0700120 float* const* dest) override;
peahdf3efa82015-11-28 12:35:15 -0800121
122 // Methods only accessed from APM submodules or
123 // from AudioProcessing tests in a single-threaded manner.
124 // Hence there is no need for locks in these.
125 int proc_sample_rate_hz() const override;
126 int proc_split_sample_rate_hz() const override;
Peter Kasting69558702016-01-12 16:26:35 -0800127 size_t num_input_channels() const override;
128 size_t num_proc_channels() const override;
129 size_t num_output_channels() const override;
130 size_t num_reverse_channels() const override;
kjellander@webrtc.org14665ff2015-03-04 12:58:35 +0000131 int stream_delay_ms() const override;
peahdf3efa82015-11-28 12:35:15 -0800132
Per Åhgrencf4c8722019-12-30 14:32:14 +0100133 AudioProcessingStats GetStatistics(bool has_remote_tracks) override {
134 return GetStatistics();
135 }
136 AudioProcessingStats GetStatistics() override {
137 return stats_reporter_.GetStatistics();
138 }
ivoc3e9a5372016-10-28 07:55:33 -0700139
henrik.lundinadf06352017-04-05 05:48:24 -0700140 AudioProcessing::Config GetConfig() const override;
peah8271d042016-11-22 07:24:52 -0800141
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000142 protected:
andrew@webrtc.orga8b97372014-03-10 22:26:12 +0000143 // Overridden in a mock.
Per Åhgren0ade9832020-09-01 23:57:20 +0200144 virtual void InitializeLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200145 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000146
niklase@google.com470e71d2011-07-07 08:21:25 +0000147 private:
peahc19f3122016-10-07 14:54:10 -0700148 // TODO(peah): These friend classes should be removed as soon as the new
149 // parameter setting scheme allows.
150 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, DefaultBehavior);
151 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, ValidConfigBehavior);
152 FRIEND_TEST_ALL_PREFIXES(ApmConfiguration, InValidConfigBehavior);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200153 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
154 ToggleTransientSuppressor);
155 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
156 ReinitializeTransientSuppressor);
157 FRIEND_TEST_ALL_PREFIXES(ApmWithSubmodulesExcludedTest,
158 BitexactWithDisabledModules);
159
Markus Handell02ba1d22020-05-14 14:31:18 +0200160 int recommended_stream_analog_level_locked() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200161 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200162
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200163 void OverrideSubmoduleCreationForTesting(
164 const ApmSubmoduleCreationOverrides& overrides);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200165
166 // Class providing thread-safe message pipe functionality for
167 // |runtime_settings_|.
168 class RuntimeSettingEnqueuer {
169 public:
170 explicit RuntimeSettingEnqueuer(
171 SwapQueue<RuntimeSetting>* runtime_settings);
172 ~RuntimeSettingEnqueuer();
Per Åhgren0a144a72021-02-09 08:47:51 +0100173
174 // Enqueue setting and return whether the setting was successfully enqueued.
175 bool Enqueue(RuntimeSetting setting);
Alessio Bazzicac054e782018-04-16 12:10:09 +0200176
177 private:
Alessio Bazzica33444dc2018-04-20 13:16:55 +0200178 SwapQueue<RuntimeSetting>& runtime_settings_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200179 };
Alex Loiko73ec0192018-05-15 10:52:28 +0200180
181 std::unique_ptr<ApmDataDumper> data_dumper_;
182 static int instance_count_;
Per Åhgrenb2b58d82019-12-02 14:59:40 +0100183 const bool use_setup_specific_default_aec3_config_;
Alex Loiko73ec0192018-05-15 10:52:28 +0200184
185 SwapQueue<RuntimeSetting> capture_runtime_settings_;
186 SwapQueue<RuntimeSetting> render_runtime_settings_;
187
188 RuntimeSettingEnqueuer capture_runtime_settings_enqueuer_;
189 RuntimeSettingEnqueuer render_runtime_settings_enqueuer_;
Alessio Bazzicac054e782018-04-16 12:10:09 +0200190
Gustaf Ullberg002ef282017-10-12 15:13:17 +0200191 // EchoControl factory.
192 std::unique_ptr<EchoControlFactory> echo_control_factory_;
Gustaf Ullbergd8579e02017-10-11 16:29:02 +0200193
saza1d600522019-10-18 13:29:43 +0200194 class SubmoduleStates {
peah2ace3f92016-09-10 04:42:27 -0700195 public:
saza1d600522019-10-18 13:29:43 +0200196 SubmoduleStates(bool capture_post_processor_enabled,
197 bool render_pre_processor_enabled,
198 bool capture_analyzer_enabled);
peah2ace3f92016-09-10 04:42:27 -0700199 // Updates the submodule state and returns true if it has changed.
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200200 bool Update(bool high_pass_filter_enabled,
peah2ace3f92016-09-10 04:42:27 -0700201 bool mobile_echo_controller_enabled,
ivoc9f4a4a02016-10-28 05:39:16 -0700202 bool residual_echo_detector_enabled,
peah2ace3f92016-09-10 04:42:27 -0700203 bool noise_suppressor_enabled,
peah2ace3f92016-09-10 04:42:27 -0700204 bool adaptive_gain_controller_enabled,
alessiob3ec96df2017-05-22 06:57:06 -0700205 bool gain_controller2_enabled,
Per Åhgrendb5d7282021-03-15 16:31:04 +0000206 bool gain_adjustment_enabled,
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200207 bool echo_controller_enabled,
Sam Zackrisson0824c6f2019-10-07 14:03:56 +0200208 bool voice_detector_enabled,
peah2ace3f92016-09-10 04:42:27 -0700209 bool transient_suppressor_enabled);
210 bool CaptureMultiBandSubModulesActive() const;
Gustaf Ullberg8675eee2019-10-09 13:34:36 +0200211 bool CaptureMultiBandProcessingPresent() const;
212 bool CaptureMultiBandProcessingActive(bool ec_processing_active) const;
peah23ac8b42017-05-23 05:33:56 -0700213 bool CaptureFullBandProcessingActive() const;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200214 bool CaptureAnalyzerActive() const;
peah2ace3f92016-09-10 04:42:27 -0700215 bool RenderMultiBandSubModulesActive() const;
Alex Loiko5825aa62017-12-18 16:02:40 +0100216 bool RenderFullBandProcessingActive() const;
peah2ace3f92016-09-10 04:42:27 -0700217 bool RenderMultiBandProcessingActive() const;
Per Åhgren0aefbf02019-08-23 21:29:17 +0200218 bool HighPassFilteringRequired() const;
peah2ace3f92016-09-10 04:42:27 -0700219
220 private:
Sam Zackrisson0beac582017-09-25 12:04:02 +0200221 const bool capture_post_processor_enabled_ = false;
Alex Loiko5825aa62017-12-18 16:02:40 +0100222 const bool render_pre_processor_enabled_ = false;
Valeriia Nemychnikovaf06eb572018-08-29 10:37:09 +0200223 const bool capture_analyzer_enabled_ = false;
Sam Zackrissoncb1b5562018-09-28 14:15:09 +0200224 bool high_pass_filter_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700225 bool mobile_echo_controller_enabled_ = false;
ivoc9f4a4a02016-10-28 05:39:16 -0700226 bool residual_echo_detector_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700227 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;
Sam Zackrisson0824c6f2019-10-07 14:03:56 +0200232 bool voice_detector_enabled_ = false;
peah2ace3f92016-09-10 04:42:27 -0700233 bool transient_suppressor_enabled_ = false;
234 bool first_update_ = true;
235 };
236
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100237 // Methods for modifying the formats struct that is used by both
238 // the render and capture threads. The check for whether modifications are
239 // needed is done while holding a single lock only, thereby avoiding that the
240 // capture thread blocks the render thread.
241 // Called by render: Holds the render lock when reading the format struct and
242 // acquires both locks if reinitialization is required.
peahdf3efa82015-11-28 12:35:15 -0800243 int MaybeInitializeRender(const ProcessingConfig& processing_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200244 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrisson12e319a2020-01-03 14:54:20 +0100245 // Called by capture: Holds the capture lock when reading the format struct
246 // and acquires both locks if reinitialization is needed.
247 int MaybeInitializeCapture(const StreamConfig& input_config,
248 const StreamConfig& output_config);
peahdf3efa82015-11-28 12:35:15 -0800249
peah2ace3f92016-09-10 04:42:27 -0700250 // Method for updating the state keeping track of the active submodules.
251 // Returns a bool indicating whether the state has changed.
danilchap56359be2017-09-07 07:53:45 -0700252 bool UpdateActiveSubmoduleStates()
Markus Handell0df0fae2020-07-07 15:53:34 +0200253 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800254
Per Åhgrenc0734712020-01-02 15:15:36 +0100255 // Methods requiring APM running in a single-threaded manner, requiring both
256 // the render and capture lock to be acquired.
Michael Graczyk86c6d332015-07-23 11:41:39 -0700257 int InitializeLocked(const ProcessingConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200258 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700259 void InitializeResidualEchoDetector()
Markus Handell0df0fae2020-07-07 15:53:34 +0200260 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenf204faf2019-04-25 15:18:06 +0200261 void InitializeEchoController()
Markus Handell0df0fae2020-07-07 15:53:34 +0200262 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100263
264 // Initializations of capture-only submodules, requiring the capture lock
265 // already acquired.
Per Åhgren0f14db22020-01-03 14:27:14 +0100266 void InitializeHighPassFilter(bool forced_reset)
Markus Handell0df0fae2020-07-07 15:53:34 +0200267 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
268 void InitializeVoiceDetector() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
269 void InitializeGainController1() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100270 void InitializeTransientSuppressor()
Markus Handell0df0fae2020-07-07 15:53:34 +0200271 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
272 void InitializeGainController2() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
273 void InitializeNoiseSuppressor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrendb5d7282021-03-15 16:31:04 +0000274 void InitializeCaptureLevelsAdjuster()
275 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Markus Handell0df0fae2020-07-07 15:53:34 +0200276 void InitializePostProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
277 void InitializeAnalyzer() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Per Åhgrenc0734712020-01-02 15:15:36 +0100278
279 // Initializations of render-only submodules, requiring the render lock
280 // already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200281 void InitializePreProcessor() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peahdf3efa82015-11-28 12:35:15 -0800282
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200283 // Sample rate used for the fullband processing.
284 int proc_fullband_sample_rate_hz() const
Markus Handell0df0fae2020-07-07 15:53:34 +0200285 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200286
Alex Loiko73ec0192018-05-15 10:52:28 +0200287 // Empties and handles the respective RuntimeSetting queues.
288 void HandleCaptureRuntimeSettings()
Markus Handell0df0fae2020-07-07 15:53:34 +0200289 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
290 void HandleRenderRuntimeSettings()
291 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
Sam Zackrissonf0d1c032019-03-27 13:28:08 +0100292
Markus Handell0df0fae2020-07-07 15:53:34 +0200293 void EmptyQueuedRenderAudio() RTC_LOCKS_EXCLUDED(mutex_capture_);
Markus Handell02ba1d22020-05-14 14:31:18 +0200294 void EmptyQueuedRenderAudioLocked()
Markus Handell0df0fae2020-07-07 15:53:34 +0200295 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700296 void AllocateRenderQueue()
Markus Handell0df0fae2020-07-07 15:53:34 +0200297 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_, mutex_capture_);
peah9e6a2902017-05-15 07:19:21 -0700298 void QueueBandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200299 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah9e6a2902017-05-15 07:19:21 -0700300 void QueueNonbandedRenderAudio(AudioBuffer* audio)
Markus Handell0df0fae2020-07-07 15:53:34 +0200301 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700302
peahdf3efa82015-11-28 12:35:15 -0800303 // Capture-side exclusive methods possibly running APM in a multi-threaded
304 // manner that are called with the render lock already acquired.
Markus Handell0df0fae2020-07-07 15:53:34 +0200305 int ProcessCaptureStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
peahdf3efa82015-11-28 12:35:15 -0800306
307 // Render-side exclusive methods possibly running APM in a multi-threaded
308 // manner that are called with the render lock already acquired.
ekmeyerson60d9b332015-08-14 10:35:55 -0700309 // TODO(ekm): Remove once all clients updated to new interface.
peahdf3efa82015-11-28 12:35:15 -0800310 int AnalyzeReverseStreamLocked(const float* const* src,
311 const StreamConfig& input_config,
312 const StreamConfig& output_config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200313 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
314 int ProcessRenderStreamLocked() RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_render_);
andrew@webrtc.org17e40642014-03-04 20:58:13 +0000315
aleloi868f32f2017-05-23 07:20:05 -0700316 // Collects configuration settings from public and private
317 // submodules to be saved as an audioproc::Config message on the
318 // AecDump if it is attached. If not |forced|, only writes the current
319 // config if it is different from the last saved one; if |forced|,
320 // writes the config regardless of the last saved.
321 void WriteAecDumpConfigMessage(bool forced)
Markus Handell0df0fae2020-07-07 15:53:34 +0200322 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700323
324 // Notifies attached AecDump of current configuration and capture data.
325 void RecordUnprocessedCaptureStream(const float* const* capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200326 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700327
Per Åhgren645f24c2020-03-16 12:06:02 +0100328 void RecordUnprocessedCaptureStream(const int16_t* const data,
329 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200330 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700331
332 // Notifies attached AecDump of current configuration and
333 // processed capture data and issues a capture stream recording
334 // request.
335 void RecordProcessedCaptureStream(
336 const float* const* processed_capture_stream)
Markus Handell0df0fae2020-07-07 15:53:34 +0200337 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700338
Per Åhgren645f24c2020-03-16 12:06:02 +0100339 void RecordProcessedCaptureStream(const int16_t* const data,
340 const StreamConfig& config)
Markus Handell0df0fae2020-07-07 15:53:34 +0200341 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700342
343 // Notifies attached AecDump about current state (delay, drift, etc).
Markus Handell0df0fae2020-07-07 15:53:34 +0200344 void RecordAudioProcessingState()
345 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700346
Per Åhgren652ada52021-03-03 10:52:44 +0000347 // Ensures that overruns in the capture runtime settings queue is properly
348 // handled by the code, providing safe-fallbacks to mitigate the implications
349 // of any settings being missed.
350 void HandleOverrunInCaptureRuntimeSettingsQueue()
351 RTC_EXCLUSIVE_LOCKS_REQUIRED(mutex_capture_);
352
aleloi868f32f2017-05-23 07:20:05 -0700353 // AecDump instance used for optionally logging APM config, input
354 // and output to file in the AEC-dump format defined in debug.proto.
355 std::unique_ptr<AecDump> aec_dump_;
356
357 // Hold the last config written with AecDump for avoiding writing
358 // the same config twice.
Markus Handell0df0fae2020-07-07 15:53:34 +0200359 InternalAPMConfig apm_config_for_aec_dump_ RTC_GUARDED_BY(mutex_capture_);
aleloi868f32f2017-05-23 07:20:05 -0700360
peahdf3efa82015-11-28 12:35:15 -0800361 // Critical sections.
Markus Handell0df0fae2020-07-07 15:53:34 +0200362 mutable Mutex mutex_render_ RTC_ACQUIRED_BEFORE(mutex_capture_);
363 mutable Mutex mutex_capture_;
peahdf3efa82015-11-28 12:35:15 -0800364
peahc19f3122016-10-07 14:54:10 -0700365 // Struct containing the Config specifying the behavior of APM.
366 AudioProcessing::Config config_;
367
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200368 // Overrides for testing the exclusion of some submodules from the build.
369 ApmSubmoduleCreationOverrides submodule_creation_overrides_
Markus Handell0df0fae2020-07-07 15:53:34 +0200370 RTC_GUARDED_BY(mutex_capture_);
Sam Zackrissonb37e59d2020-04-27 08:39:33 +0200371
peah2ace3f92016-09-10 04:42:27 -0700372 // Class containing information about what submodules are active.
saza1d600522019-10-18 13:29:43 +0200373 SubmoduleStates submodule_states_;
peah2ace3f92016-09-10 04:42:27 -0700374
saza1d600522019-10-18 13:29:43 +0200375 // Struct containing the pointers to the submodules.
376 struct Submodules {
377 Submodules(std::unique_ptr<CustomProcessing> capture_post_processor,
378 std::unique_ptr<CustomProcessing> render_pre_processor,
379 rtc::scoped_refptr<EchoDetector> echo_detector,
Per Åhgren3daedb62019-11-22 12:11:40 +0100380 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer)
saza1d600522019-10-18 13:29:43 +0200381 : echo_detector(std::move(echo_detector)),
382 capture_post_processor(std::move(capture_post_processor)),
383 render_pre_processor(std::move(render_pre_processor)),
Per Åhgren3daedb62019-11-22 12:11:40 +0100384 capture_analyzer(std::move(capture_analyzer)) {}
saza1d600522019-10-18 13:29:43 +0200385 // Accessed internally from capture or during initialization.
386 std::unique_ptr<AgcManagerDirect> agc_manager;
387 std::unique_ptr<GainControlImpl> gain_control;
saza1d600522019-10-18 13:29:43 +0200388 std::unique_ptr<GainController2> gain_controller2;
389 std::unique_ptr<HighPassFilter> high_pass_filter;
390 rtc::scoped_refptr<EchoDetector> echo_detector;
saza1d600522019-10-18 13:29:43 +0200391 std::unique_ptr<EchoControl> echo_controller;
392 std::unique_ptr<EchoControlMobileImpl> echo_control_mobile;
Per Åhgren0cbb58e2019-10-29 22:59:44 +0100393 std::unique_ptr<NoiseSuppressor> noise_suppressor;
saza1d600522019-10-18 13:29:43 +0200394 std::unique_ptr<TransientSuppressor> transient_suppressor;
395 std::unique_ptr<CustomProcessing> capture_post_processor;
396 std::unique_ptr<CustomProcessing> render_pre_processor;
saza1d600522019-10-18 13:29:43 +0200397 std::unique_ptr<CustomAudioAnalyzer> capture_analyzer;
398 std::unique_ptr<LevelEstimator> output_level_estimator;
399 std::unique_ptr<VoiceDetection> voice_detector;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000400 std::unique_ptr<CaptureLevelsAdjuster> capture_levels_adjuster;
saza1d600522019-10-18 13:29:43 +0200401 } submodules_;
peahdf3efa82015-11-28 12:35:15 -0800402
peah192164e2015-11-17 02:16:45 -0800403 // State that is written to while holding both the render and capture locks
peahdf3efa82015-11-28 12:35:15 -0800404 // but can be read without any lock being held.
405 // As this is only accessed internally of APM, and all internal methods in APM
406 // either are holding the render or capture locks, this construct is safe as
407 // it is not possible to read the variables while writing them.
408 struct ApmFormatState {
409 ApmFormatState()
peah192164e2015-11-17 02:16:45 -0800410 : // Format of processing streams at input/output call sites.
peahdf3efa82015-11-28 12:35:15 -0800411 api_format({{{kSampleRate16kHz, 1, false},
412 {kSampleRate16kHz, 1, false},
413 {kSampleRate16kHz, 1, false},
414 {kSampleRate16kHz, 1, false}}}),
peahde65ddc2016-09-16 15:02:15 -0700415 render_processing_format(kSampleRate16kHz, 1) {}
peahdf3efa82015-11-28 12:35:15 -0800416 ProcessingConfig api_format;
peahde65ddc2016-09-16 15:02:15 -0700417 StreamConfig render_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800418 } formats_;
Michael Graczyk86c6d332015-07-23 11:41:39 -0700419
peahdf3efa82015-11-28 12:35:15 -0800420 // APM constants.
421 const struct ApmConstants {
Per Åhgren0695df12020-01-13 14:43:13 +0100422 ApmConstants(bool multi_channel_render_support,
Per Åhgrenc0424252019-12-10 13:04:15 +0100423 bool multi_channel_capture_support,
Per Åhgren19775cb2021-03-12 23:08:09 +0000424 bool enforce_split_band_hpf,
Gustaf Ullberga399c822021-05-18 12:17:56 +0200425 bool minimize_processing_for_unused_output,
426 bool transient_suppressor_forced_off)
Per Åhgren0695df12020-01-13 14:43:13 +0100427 : multi_channel_render_support(multi_channel_render_support),
Per Åhgrenc0424252019-12-10 13:04:15 +0100428 multi_channel_capture_support(multi_channel_capture_support),
Per Åhgren19775cb2021-03-12 23:08:09 +0000429 enforce_split_band_hpf(enforce_split_band_hpf),
430 minimize_processing_for_unused_output(
Gustaf Ullberga399c822021-05-18 12:17:56 +0200431 minimize_processing_for_unused_output),
432 transient_suppressor_forced_off(transient_suppressor_forced_off) {}
Per Åhgrene14cb992019-11-27 09:34:22 +0100433 bool multi_channel_render_support;
434 bool multi_channel_capture_support;
Per Åhgrenc0424252019-12-10 13:04:15 +0100435 bool enforce_split_band_hpf;
Per Åhgren19775cb2021-03-12 23:08:09 +0000436 bool minimize_processing_for_unused_output;
Gustaf Ullberga399c822021-05-18 12:17:56 +0200437 bool transient_suppressor_forced_off;
peahdf3efa82015-11-28 12:35:15 -0800438 } constants_;
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000439
peahdf3efa82015-11-28 12:35:15 -0800440 struct ApmCaptureState {
Per Åhgrenc0734712020-01-02 15:15:36 +0100441 ApmCaptureState();
kwiberg83ffe452016-08-29 14:46:07 -0700442 ~ApmCaptureState();
peahdf3efa82015-11-28 12:35:15 -0800443 bool was_stream_delay_set;
Per Åhgren0a144a72021-02-09 08:47:51 +0100444 bool capture_output_used;
Per Åhgren55bc0772021-03-12 14:18:36 +0000445 bool capture_output_used_last_frame;
peahdf3efa82015-11-28 12:35:15 -0800446 bool key_pressed;
kwiberg88788ad2016-02-19 07:04:49 -0800447 std::unique_ptr<AudioBuffer> capture_audio;
Gustaf Ullberg422b9e02019-10-09 13:02:14 +0200448 std::unique_ptr<AudioBuffer> capture_fullband_audio;
Per Åhgrenc20a19c2019-11-13 11:12:29 +0100449 std::unique_ptr<AudioBuffer> linear_aec_output;
peahde65ddc2016-09-16 15:02:15 -0700450 // Only the rate and samples fields of capture_processing_format_ are used
451 // because the capture processing number of channels is mutable and is
452 // tracked by the capture_audio_.
453 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800454 int split_rate;
peah67995532017-04-10 14:12:41 -0700455 bool echo_path_gain_change;
Per Åhgren88cf0502018-07-16 17:08:41 +0200456 int prev_analog_mic_level;
Per Åhgrendb5d7282021-03-15 16:31:04 +0000457 float prev_pre_adjustment_gain;
Fredrik Hernqvistca362852019-05-10 15:50:02 +0200458 int playout_volume;
459 int prev_playout_volume;
Sam Zackrissonb24c00f2018-11-26 16:18:25 +0100460 AudioProcessingStats stats;
Per Åhgrena1351272019-08-15 12:15:46 +0200461 struct KeyboardInfo {
462 void Extract(const float* const* data, const StreamConfig& stream_config);
463 size_t num_keyboard_frames = 0;
464 const float* keyboard_data = nullptr;
465 } keyboard_info;
Per Åhgren0695df12020-01-13 14:43:13 +0100466 int cached_stream_analog_level_ = 0;
Markus Handell0df0fae2020-07-07 15:53:34 +0200467 } capture_ RTC_GUARDED_BY(mutex_capture_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000468
peahdf3efa82015-11-28 12:35:15 -0800469 struct ApmCaptureNonLockedState {
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200470 ApmCaptureNonLockedState()
peahde65ddc2016-09-16 15:02:15 -0700471 : capture_processing_format(kSampleRate16kHz),
peahdf3efa82015-11-28 12:35:15 -0800472 split_rate(kSampleRate16kHz),
Alessio Bazzicacc22f512018-08-30 13:01:34 +0200473 stream_delay_ms(0) {}
peahde65ddc2016-09-16 15:02:15 -0700474 // Only the rate and samples fields of capture_processing_format_ are used
475 // because the forward processing number of channels is mutable and is
476 // tracked by the capture_audio_.
477 StreamConfig capture_processing_format;
peahdf3efa82015-11-28 12:35:15 -0800478 int split_rate;
479 int stream_delay_ms;
Gustaf Ullbergce045ac2017-10-16 13:49:04 +0200480 bool echo_controller_enabled = false;
peahdf3efa82015-11-28 12:35:15 -0800481 } capture_nonlocked_;
andrew@webrtc.org75dd2882014-02-11 20:52:30 +0000482
peahdf3efa82015-11-28 12:35:15 -0800483 struct ApmRenderState {
kwiberg83ffe452016-08-29 14:46:07 -0700484 ApmRenderState();
485 ~ApmRenderState();
kwiberg88788ad2016-02-19 07:04:49 -0800486 std::unique_ptr<AudioConverter> render_converter;
487 std::unique_ptr<AudioBuffer> render_audio;
Markus Handell0df0fae2020-07-07 15:53:34 +0200488 } render_ RTC_GUARDED_BY(mutex_render_);
peah764e3642016-10-22 05:04:30 -0700489
Per Åhgrencf4c8722019-12-30 14:32:14 +0100490 // Class for statistics reporting. The class is thread-safe and no lock is
491 // needed when accessing it.
492 class ApmStatsReporter {
493 public:
494 ApmStatsReporter();
495 ~ApmStatsReporter();
496
497 // Returns the most recently reported statistics.
498 AudioProcessingStats GetStatistics();
499
500 // Update the cached statistics.
501 void UpdateStatistics(const AudioProcessingStats& new_stats);
502
503 private:
Markus Handell0df0fae2020-07-07 15:53:34 +0200504 Mutex mutex_stats_;
505 AudioProcessingStats cached_stats_ RTC_GUARDED_BY(mutex_stats_);
Per Åhgrencf4c8722019-12-30 14:32:14 +0100506 SwapQueue<AudioProcessingStats> stats_message_queue_;
507 } stats_reporter_;
508
Markus Handell0df0fae2020-07-07 15:53:34 +0200509 std::vector<int16_t> aecm_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
510 std::vector<int16_t> aecm_capture_queue_buffer_
511 RTC_GUARDED_BY(mutex_capture_);
peah701d6282016-10-25 05:42:20 -0700512
Markus Handell0df0fae2020-07-07 15:53:34 +0200513 size_t agc_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
514 RTC_GUARDED_BY(mutex_capture_) = 0;
515 std::vector<int16_t> agc_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
516 std::vector<int16_t> agc_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
peah764e3642016-10-22 05:04:30 -0700517
Markus Handell0df0fae2020-07-07 15:53:34 +0200518 size_t red_render_queue_element_max_size_ RTC_GUARDED_BY(mutex_render_)
519 RTC_GUARDED_BY(mutex_capture_) = 0;
520 std::vector<float> red_render_queue_buffer_ RTC_GUARDED_BY(mutex_render_);
521 std::vector<float> red_capture_queue_buffer_ RTC_GUARDED_BY(mutex_capture_);
ivoc9f4a4a02016-10-28 05:39:16 -0700522
Markus Handell0df0fae2020-07-07 15:53:34 +0200523 RmsLevel capture_input_rms_ RTC_GUARDED_BY(mutex_capture_);
524 RmsLevel capture_output_rms_ RTC_GUARDED_BY(mutex_capture_);
525 int capture_rms_interval_counter_ RTC_GUARDED_BY(mutex_capture_) = 0;
henrik.lundin290d43a2016-11-29 08:09:09 -0800526
peah764e3642016-10-22 05:04:30 -0700527 // Lock protection not needed.
peaha0624602016-10-25 04:45:24 -0700528 std::unique_ptr<
529 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
peah701d6282016-10-25 05:42:20 -0700530 aecm_render_signal_queue_;
531 std::unique_ptr<
532 SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
533 agc_render_signal_queue_;
ivoc9f4a4a02016-10-28 05:39:16 -0700534 std::unique_ptr<SwapQueue<std::vector<float>, RenderQueueItemVerifier<float>>>
535 red_render_signal_queue_;
niklase@google.com470e71d2011-07-07 08:21:25 +0000536};
andrew@webrtc.orgddbb8a22014-04-22 21:00:04 +0000537
niklase@google.com470e71d2011-07-07 08:21:25 +0000538} // namespace webrtc
539
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200540#endif // MODULES_AUDIO_PROCESSING_AUDIO_PROCESSING_IMPL_H_