webrtc/modules/audio_processing/g3doc/audio_processing_module.md
Tony Herre b0ed12099f Update links to point at main branch
As part of go/coil update code search links to not point to the
"master" branch.

Bug: chromium:1226942
Change-Id: I0ae9e84ecc660f789a69fe0b226f93bbc39a8a66
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/226081
Commit-Queue: Tony Herre <toprice@chromium.org>
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34531}
2021-07-22 16:41:26 +00:00

26 lines
1.3 KiB
Markdown

# Audio Processing Module (APM)
<?% config.freshness.owner = 'peah' %?>
<?% config.freshness.reviewed = '2021-04-13' %?>
## Overview
The APM is responsible for applying speech enhancements effects to the
microphone signal. These effects are required for VoIP calling and some
examples include echo cancellation (AEC), noise suppression (NS) and
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].
APM is created using the [`AudioProcessingBuilder`][https://source.chromium.org/chromium/chromium/src/+/main:third_party/webrtc/modules/audio_processing/include/audio_processing.h]
builder that allows it to be customized and configured.
Some specific aspects of APM include that:
* APM is fully thread-safe in that it can be accessed concurrently from
different threads.
* APM handles for any input sample rates < 384 kHz and achieves this by
automatic reconfiguration whenever a new sample format is observed.
* APM handles any number of microphone channels and loudspeaker channels, with
the same automatic reconfiguration as for the sample rates.
APM can either be used as part of the WebRTC native pipeline, or standalone.