admin/webrtc_m130
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deprecate AudioProcessingBuilder in favor of the BuiltinAudioProcessingBuilder

Browse Source 
Update comments and doc mentioning AudioProcessingBuilder accordingly

Bug: webrtc:369904700
Change-Id: If837ddace5fedce94853c80500c6a832de8db9c7
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/367520
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Danil Chapovalov <danilchap@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#43376}
This commit is contained in:
Danil Chapovalov 2024-11-05 10:48:41 +01:00 committed by WebRTC LUCI CQ
parent 279858e9c8
commit c772fc227b
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api/audio/audio_processing.h
View File

@ -86,7 +86,6 @@ class EchoDetector;
// float interfaces use deinterleaved data. // float interfaces use deinterleaved data.
// //
// Usage example, omitting error checking: // Usage example, omitting error checking:
// rtc::scoped_refptr<AudioProcessing> apm = AudioProcessingBuilder().Create();
// //
// AudioProcessing::Config config; // AudioProcessing::Config config;
// config.echo_canceller.enabled = true; // config.echo_canceller.enabled = true;
@ -102,7 +101,8 @@ class EchoDetector;
// //
// config.high_pass_filter.enabled = true; // config.high_pass_filter.enabled = true;
// //
// apm->ApplyConfig(config) // scoped_refptr<AudioProcessing> apm =
// BuiltinAudioProcessingBuilder(config).Build(CreateEnvironment());
// //
// // Start a voice call... // // Start a voice call...
// //
@ -780,9 +780,8 @@ class CustomProcessing {
virtual ~CustomProcessing() {} virtual ~CustomProcessing() {}
}; };
// TODO: bugs.webrtc.org/369904700 - Deprecate and remove in favor of the // Use BuiltinAudioProcessingBuilder instead, see bugs.webrtc.org/369904700
// BuiltinAudioProcessingBuilder. class RTC_EXPORT [[deprecated]] AudioProcessingBuilder {
class RTC_EXPORT AudioProcessingBuilder {
public: public:
AudioProcessingBuilder(); AudioProcessingBuilder();
AudioProcessingBuilder(const AudioProcessingBuilder&) = delete; AudioProcessingBuilder(const AudioProcessingBuilder&) = delete;

4
api/audio/echo_detector_creator.h
View File

@ -17,9 +17,9 @@
namespace webrtc { namespace webrtc {
// Returns an instance of the WebRTC implementation of a residual echo detector. // Returns an instance of the WebRTC implementation of a residual echo detector.
// It can be provided to the webrtc::AudioProcessingBuilder to obtain the // It can be provided to the webrtc::BuiltinAudioProcessingBuilder to obtain the
// usual residual echo metrics. // usual residual echo metrics.
rtc::scoped_refptr<EchoDetector> CreateEchoDetector(); scoped_refptr<EchoDetector> CreateEchoDetector();
} // namespace webrtc } // namespace webrtc

3
api/voip/voip_engine.h
View File

@ -35,7 +35,8 @@ class VoipVolumeControl;
// config.audio_device = // config.audio_device =
// AudioDeviceModule::Create(AudioDeviceModule::kPlatformDefaultAudio, // AudioDeviceModule::Create(AudioDeviceModule::kPlatformDefaultAudio,
// config.task_queue_factory.get()); // config.task_queue_factory.get());
// config.audio_processing = AudioProcessingBuilder().Create(); // config.audio_processing_builder =
// std::make_unique<BuiltinAudioProcessingBuilder>();
// //
// auto voip_engine = CreateVoipEngine(std::move(config)); // auto voip_engine = CreateVoipEngine(std::move(config));
// //

4
modules/audio_processing/g3doc/audio_processing_module.md
View File

@ -10,8 +10,8 @@ microphone signal. These effects are required for VoIP calling and some
examples include echo cancellation (AEC), noise suppression (NS) and examples include echo cancellation (AEC), noise suppression (NS) and
automatic gain control (AGC). automatic gain control (AGC).
The API for APM resides in [`/modules/audio_processing/include`][https://source.chromium.org/chromium/chromium/src/+/main:third_party/webrtc/modules/audio_processing/include]. The API for APM resides in [`/api/audio/audio_processing.h`][https://webrtc.googlesource.com/src/+/refs/heads/main/api/audio/audio_processing.h].
APM is created using the [`AudioProcessingBuilder`][https://source.chromium.org/chromium/chromium/src/+/main:third_party/webrtc/modules/audio_processing/include/audio_processing.h] APM is created using the [`BuiltinAudioProcessingBuilder`][https://webrtc.googlesource.com/src/+/refs/heads/main/api/audio/builtin_audio_processing_builder.h]
builder that allows it to be customized and configured. builder that allows it to be customized and configured.
Some specific aspects of APM include that: Some specific aspects of APM include that: