A pure Rust implementation of the Web Audio API, for use in non-browser contexts
The Web Audio API (MDN docs) provides a powerful and versatile system for controlling audio on the Web, allowing developers to choose audio sources, add effects to audio, create audio visualizations, apply spatial effects (such as panning) and much more.
Our Rust implementation decouples the Web Audio API from the Web. You can now use it in desktop apps, command line utilities, headless execution, etc.
```rust use webaudioapi::context::{AudioContext, BaseAudioContext}; use webaudioapi::node::{AudioNode, AudioScheduledSourceNode};
// set up the audio context with optimized settings for your hardware let context = AudioContext::default();
// for background music, read from local file let file = std::fs::File::open("samples/major-scale.ogg").unwrap(); let buffer = context.decodeaudiodata_sync(file).unwrap();
// setup an AudioBufferSourceNode let src = context.createbuffersource(); src.setbuffer(buffer); src.setloop(true);
// create a biquad filter let biquad = context.createbiquadfilter(); biquad.frequency().set_value(125.);
// connect the audio nodes src.connect(&biquad); biquad.connect(&context.destination());
// play the buffer src.start();
// enjoy listening loop { } ```
Check out the docs for more info.
We have tried to stick to the official W3C spec as close as possible, but some deviations could not be avoided:
We provide NodeJS bindings to this library over at https://github.com/ircam-ismm/node-web-audio-api so you can use this library by simply writing native NodeJS code.
It is a work in progress, but eventually we should be able to run the official WebAudioAPI test harness and track our spec compliance improvements over time.
By default, the cpal library is used for
cross platform audio I/O.
We offer experimental support for the
cubeb backend via the cubeb feature
flag. Please note that cmake must be installed locally in order to run
cubeb.
| Feature flag | Backend | Notes | | -------------- | -------------- | ------------------------------------------------------- | | cpal (default) | ALSA | | | cpal (default) | WASAPI | | | cpal (default) | CoreAudio | | | cpal (default) | Oboe (Android) | | | cpal-jack | JACK | | | cpal-asio | ASIO | see https://github.com/rustaudio/cpal#asio-on-windows |
| cubeb | PulseAudio | | | cubeb | AudioUnit | | | cubeb | WASAPI | | | cubeb | OpenSL | | | cubeb | AAudio | | | cubeb | sndio | | | cubeb | Sun | | | cubeb | OSS | |
Using the library on Linux with the ALSA backend might lead to unexpected cranky sound with the default render size (i.e. 128 frames). In such cases, a simple workaround is to pass the AudioContextLatencyCategory::Playback latency hint when creating the audio context, which will increase the render size to 1024 frames:
rs
let audio_context = AudioContext::new(AudioContextOptions {
latency_hint: AudioContextLatencyCategory::Playback,
..AudioContextOptions::default()
});
For real-time and interactive applications where low latency is crucial, you should instead rely on the JACK backend provided by cpal. To that end you will need a running JACK server and build your application with the cpal-jack feature, e.g. cargo run --release --features "cpal-jack" --example microphone.
web-audio-api-rs welcomes contribution from everyone in the form of suggestions, bug reports, pull requests, and feedback. 💛
If you need ideas for contribution, there are several ways to get started:
examples/ directory) and start
building your own audio graphsUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in web-audio-api-rs by you, shall be licensed as MIT, without any additional terms or conditions.
This project is licensed under the [MIT license].
The IR files used for HRTF spatialization are part of the LISTEN database created by the EAC team from Ircam.