AIRE

AIRE is an audio engine for Rust built for games and interactive applications. It lets you load sounds, stream music, and control everything at runtime.

Features

Play WAV, OGG, FLAC, and MP3 files
Stream large files from disk without loading them into memory
Synthesize audio with a band-limited oscillator (sine, saw, saw down, triangle, square, pulse)
Loop sounds
Control volume and pan at runtime
Pause, resume, and stop sounds
Apply ADSR amplitude envelopes with linear or exponential curves
Organize sounds into named groups with independent volume and pan
Write custom audio sources and effects

Usage

Add AIRE to your Cargo.toml:

[dependencies]

aire = "0.3"

Play a sound

use aire::{Engine, FileSource, Sound};
use std::{thread, time::Duration};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let engine = Engine::new()?;
    let source = FileSource::load("sound.wav", engine.sample_rate())?;
    let _handle = engine.add_sound(Sound::new(source, engine.sample_rate()))?;

    thread::sleep(Duration::from_secs(5));
    Ok(())
}

Stream a music track

use aire::{DecodePool, Engine, FileSource, Sound};
use std::{thread, time::Duration};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let engine = Engine::new()?;
    let pool = DecodePool::new(1);

    let source = FileSource::stream("music.ogg", engine.sample_rate(), &pool)?.looping();
    let _handle = engine.add_sound(Sound::new(source, engine.sample_rate()))?;

    thread::sleep(Duration::from_secs(30));
    Ok(())
}

Synthesize a tone

use aire::{Engine, Oscillator, Sound, Waveform};
use std::{thread, time::Duration};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let engine = Engine::new()?;
    let rate = engine.sample_rate();

    let osc = Oscillator::new(Waveform::Saw, 220.0, rate)
        .amplitude(-6.0)
        .duration(2000);
    let _handle = engine.add_sound(Sound::new(osc, rate))?;

    thread::sleep(Duration::from_secs(3));
    Ok(())
}

Control a sound at runtime

use aire::{Engine, FileSource, Sound};
use std::{thread, time::Duration};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let engine = Engine::new()?;

    let source = FileSource::load("music.ogg", engine.sample_rate())?.looping();
    let handle = engine.add_sound(Sound::new(source, engine.sample_rate()))?;

    thread::sleep(Duration::from_secs(3));
    handle.set_volume(-6.0)?;
    handle.set_pan(0.25)?;

    thread::sleep(Duration::from_secs(3));
    handle.pause()?;

    thread::sleep(Duration::from_secs(2));
    handle.resume()?;

    thread::sleep(Duration::from_secs(3));
    handle.stop()?;

    Ok(())
}

Roadmap

Planned features and future direction are tracked on the project board.

Contributing

Issues and pull requests are welcome. If you're planning something big, open an issue first so we can discuss it before you put in the work.

For bug reports, include a minimal reproducible example if you can. It makes things a lot faster to track down.

Before opening a PR, make sure cargo test passes and there are no new warnings.

License

Licensed under either of MIT or Apache 2.0 at your option.

aire 0.3.3