CPAL - Cross-Platform Audio Library

Low-level library for audio input and output, written in Rust.

For higher-level audio playback and capture, consider Rodio or similar libraries.

Supported Functionality

• Enumerate audio hosts, devices, and their supported stream configurations.
• Look up devices by stable ID or by default input/output role.
• Inspect device metadata: name, manufacturer, type, and bus type.
• Build input and output streams with compile-time or runtime sample formats.
• Play, pause, and query the buffer size and clock of a stream.

Supported Platforms

Linux Build Dependencies

On Linux, building cpal requires the ALSA development files: libasound2-dev on Debian and Ubuntu, alsa-lib-devel on Fedora.

ALSA is needed even when using JACK, PipeWire, or PulseAudio.

The optional realtime-dbus feature additionally requires libdbus-1-dev (Debian/Ubuntu) or dbus-devel (Fedora). See ALSA Real-Time Priority Promotion.

Minimum Supported Rust Version (MSRV)

The minimum Rust version required depends on which audio backend and features you're using, as each platform has different dependencies:

The audioworklet backend additionally requires -Zbuild-std with atomics support enabled.

Optional Features

See the beep example for selecting the backend at runtime.

Compiling for ASIO

Locating the ASIO SDK

The location of ASIO SDK is exposed to CPAL by setting the CPAL_ASIO_DIR environment variable.

The build script will try to find the ASIO SDK by following these steps in order:

1. Check if CPAL_ASIO_DIR is set and if so use the path to point to the SDK.
2. Check if the ASIO SDK is already installed in the temporary directory, if so use that and set the path of CPAL_ASIO_DIR to the output of std::env::temp_dir().join("asio_sdk").
3. If the ASIO SDK is not already installed, download it from https://www.steinberg.net/asiosdk and install it in the temporary directory. The path of CPAL_ASIO_DIR will be set to the output of std::env::temp_dir().join("asio_sdk").

In an ideal situation you don't need to worry about this step.

Preparing the Build Environment

1. Install LLVM/Clang: bindgen, the library used to generate bindings to the C++ SDK, requires clang. Download and install LLVM from http://releases.llvm.org/download.html under the "Pre-Built Binaries" section.

2. Set LIBCLANG_PATH: Add the LLVM bin directory to a LIBCLANG_PATH environment variable. If you installed LLVM to the default directory, this should work in the command prompt:

bat setx LIBCLANG_PATH "C:\Program Files\LLVM\bin"

1. Install ASIO Drivers (optional for testing): If you don't have any ASIO devices or drivers available, you can download and install ASIO4ALL from http://www.asio4all.org/. Be sure to enable the "offline" feature during installation.

2. Visual Studio: The build script assumes Microsoft Visual Studio is installed. It will try to find vcvarsall.bat and execute it with the right host and target architecture. If needed, you can manually execute it:

bat "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" amd64

For more information see the vcvarsall.bat documentation.

Using ASIO in Your Application

1. Enable the feature in your Cargo.toml:

toml cpal = { version = "*", features = ["asio"] }

1. Select the ASIO backend in your code:

rust let host = cpal::host_from_id(cpal::HostId::Asio) .expect("failed to initialise ASIO host");

Cross-Compilation

When Windows is the host and target OS, the build script supports all cross-compilation targets supported by the MSVC compiler.

It is also possible to compile Windows applications with ASIO support on Linux and macOS using the MinGW-w64 toolchain.

Requirements:

• Include the MinGW-w64 include directory in your CPLUS_INCLUDE_PATH environment variable
• Include the LLVM include directory in your CPLUS_INCLUDE_PATH environment variable

Example for macOS (targeting x86_64-pc-windows-gnu with mingw-w64 installed via brew):

export CPLUS_INCLUDE_PATH="$CPLUS_INCLUDE_PATH:/opt/homebrew/Cellar/mingw-w64/11.0.1/toolchain-x86_64/x86_64-w64-mingw32/include"

Compiling for WebAssembly

If you are interested in using CPAL with WebAssembly, please see this guide in our Wiki which walks through setting up a new project from scratch. Some of the examples in this repository also provide working configurations that you can use as reference.

Troubleshooting

No Default Device Available

If you receive errors about no default input or output device:

• Linux/PipeWire: Check that PipeWire is running: pw-cli info
• Linux/PulseAudio: Check that PulseAudio is running: pulseaudio --check
• macOS: Check System Preferences > Sound for available devices
• Mobile (iOS/Android): Ensure your app has microphone/audio permissions
• Windows: Verify your audio device is enabled in Sound Settings

ALSA, PipeWire, and PulseAudio

When PipeWire or PulseAudio is running, it holds the ALSA default device exclusively. A second stream attempting to open it via the ALSA host will fail with a DeviceBusy error. To route audio through the sound server via ALSA, use the bridge devices pipewire or pulse instead of default. Better yet, use the pipewire or pulseaudio cpal features for native integration.

On targets without a sound server, address devices directly as hw: or plughw:.

Buffer Size Issues

BufferSize::Default uses the system-configured device default, which on ALSA can range from a PipeWire quantum (typically 1024 frames) to u32::MAX on misconfigured or exotic hardware. A very deep buffer causes samples to be consumed far faster than audible playback, making audio appear to fast-forward ahead of actual output.

Configure the system and/or request a fixed size in your application:

config.buffer_size = cpal::BufferSize::Fixed(1024);

Query device.default_output_config()?.buffer_size() for valid ranges. Smaller buffers reduce latency but increase CPU load and the risk of glitches.

ALSA Real-Time Priority Promotion

RT promotion is only attempted for a whitelist of PCM types: direct hardware PCMs (hw:) and pure format-conversion plugins (linear, A-law, mu-law, ADPCM, float, IEC 958).

RealtimeDenied is emitted on the error callback only when promotion is attempted but fails, which happens when the process lacks the resource limits to acquire SCHED_FIFO. While RT priority is desirable for low latency, the stream will continue to play at the default scheduling priority.

With the realtime-dbus feature, rtkit arranges the necessary limits over D-Bus on typical desktop systems. With the plain realtime feature, you must ensure that rtprio is granted yourself. Add to /etc/security/limits.d/audio.conf and ensure the user is member of the audio group:

@audio - rtprio 95

then add the user to the audio group (usermod -aG audio "$USER") and re-login. The same group may anyway be needed to grant access to ALSA device files via udev on systems that do not arrange this automatically via logind.

Build Errors

If you are unable to build the library:

• Verify you have installed the required development libraries, as documented above
• ASIO on Windows: Verify CPAL_ASIO_DIR and LIBCLANG_PATH are set and LLVM is installed

Examples

CPAL comes with several examples in examples/.

Run an example with:

cargo run --example beep

For platform-specific features, enable the relevant features:

cargo run --example beep --features asio        # Windows ASIO backend
cargo run --example beep --features jack        # JACK backend
cargo run --example beep --features pipewire    # PipeWire backend
cargo run --example beep --features pulseaudio  # PulseAudio backend

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Resources

• Documentation: docs.rs/cpal
• Examples: examples/ directory in this repository
• Higher-level playback and capture: Rodio or similar libraries
• Discord: Join the #cpal channel for questions and discussion
• GitHub: Report issues and view source code
• RustAudio: Part of the RustAudio organization

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.