webrtc-audio-processing 2.0.0

A wrapper for WebRTC's AudioProcessing module.
docs.rs failed to build webrtc-audio-processing-2.0.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: webrtc-audio-processing-0.5.0

webrtc-audio-processing

Crates.io Docs.rs dependency status

A wrapper around PulseAudio's repackaging of WebRTC's AudioProcessing module.

webrtc-audio-processing can remove echo from an audio input stream in the situation where a speaker is feeding back into a microphone, as well as noise-removal, auto-gain-control, voice-activity-detection, and more!

Example Usage

See examples/simple.rs for an example of how to use this crate.

Versioning

Major version of this Rust wrapper tracks the major version of the PulseAudio WebRTC AudioProcessing upstream; minor and patch versions are independent.

As a result, Rust webrtc-audio-processing doesn't fully conform to semantic versioning: for example version 2.3 can introduce an API-breaking change over 2.2. Patch versions are backwards compatible.

It is therefore suggested that you use tilde requirements when pulling this crate:

webrtc-audio-processing = "~2.0"

Building

Feature Flags

  • bundled - Build webrtc-audio-processing from the included C++ code; also enables symbol mangling in the built WebRTC library so that multiple major versions of webrtc-audio-processing can be linked together
  • serde - Derive serialize and deserialize traits for Serde use
  • experimental-aec3-config - allow access to detailed EchoCanceller3 config from the C++ code; experimental, not subject to semver guarantees; activates the bundled flag (needs private WebRTC headers)

Development Feature Flags

  • portaudio - To build recording and karaoke examples. Does not affect the library build.

Dynamic linking

By default the build will attempt to dynamically link with the library installed via your OS's package manager.

You can specify an include path yourself by setting the environment variable WEBRTC_AUDIO_PROCESSING_INCLUDE.

Packages

sudo apt install libwebrtc-audio-processing-dev # Ubuntu/Debian
sudo pacman -S webrtc-audio-processing # Arch

Build from source

The webrtc source code is included as a git submodule. Be sure to clone this repo with the --recursive flag, or pull the submodule with git submodule update --init.

Building from source and static linking can be enabled with the bundled feature flag. You need the following tools to build from source:

  • clang or gcc
  • pkg-config (macOS: brew install pkg-config)
  • meson (masOS: brew install meson)
  • ninja-build (macOS: brew install ninja)

Publishing

  1. cargo release --verbose <new-version>, double-check and follow instructions
  2. Create a GitHub release from the pushed tag and highlight any important or breaking changes.