webrtc-audio-processing 2.0.0

A wrapper for WebRTC's AudioProcessing module.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# webrtc-audio-processing
[![Crates.io](https://img.shields.io/crates/v/webrtc-audio-processing.svg)](https://crates.io/crates/webrtc-audio-processing)
[![Docs.rs](https://docs.rs/webrtc-audio-processing/badge.svg)](https://docs.rs/webrtc-audio-processing)
[![dependency status](https://deps.rs/repo/github/tonarino/webrtc-audio-processing/status.svg)](https://deps.rs/repo/github/tonarino/webrtc-audio-processing)

A wrapper around [PulseAudio's repackaging of WebRTC's AudioProcessing module](https://www.freedesktop.org/software/pulseaudio/webrtc-audio-processing/).

`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](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#tilde-requirements) when pulling this crate:
```toml
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

```sh
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.