audio-io

A simple library to read and write audio files on your disk.

The library can read many formats and can write only to wav files.

Quick Start

Read Audio

You can read most common audio formats, if you specify them in the feature flags.

use audio_io::*;

let data: AudioData<f32> = audio_read("test.wav", AudioReadConfig::default()).unwrap();
let sample_rate = data.sample_rate;
let block = data.audio_block(); // convert into AudioBlock, which makes it easier to access channels or frames (does not allocate).

Write Audio

You can only write wav files.

use audio_io::*;

let sample_rate = 48000
let block = AudioBlockPlanarView::from_slice(&[[0.0, 0.0, 0.0], [1.0, 1.0, 1.0]]);
audio_write("tmp.wav", block, sample_rate, AudioWriteConfig::default()).unwrap();

By leveraging audio-blocks you can write any audio layout, e.g.:

let block = AudioBlockInterleavedView::from_slice(&[0.0, 1.0, 0.0, 1.0, 0.0, 1.0], 2, 3);
audio_write("tmp.wav", block, sample_rate, AudioWriteConfig::default()).unwrap();

let block = AudioBlockSequentialView::from_slice(&[0.0, 0.0, 0.0, 1.0, 1.0, 1.0], 2, 3);
audio_write("tmp.wav", block, sample_rate, AudioWriteConfig::default()).unwrap();

Supported Input Codecs

Only royalty free codecs are enabled by default.

To enable all formats, use the all feature flag.

Read and Write Options

Reading

When reading a file you can specify the following things:

• Start and stop in frames or time
• First channel and number of channels

The crate will try to decode and store only the parts that you selected.

Writing

For writing audio you can only select to store the audio in Int16 or Float32. By default Int16 is selected, for broader compatibility.

Some example configs:

• read from frame 300 to 400

let audio = audio_read::<_, f32>(
    "test.wav",
    AudioReadConfig {
        start: Position::Frame(300),
        stop: Position::Frame(400),
        ..Default::default()
    },
).unwrap();

• read the first 0.5 seconds

use std::time::Duration;

let audio = audio_read::<_, f32>(
    "test.wav",
    AudioReadConfig {
        stop: Position::Time(Duration::from_secs_f32(0.5)),
        ..Default::default()
    },
).unwrap();

• read only the first two channels

let audio = audio_read::<_, f32>(
    "test.wav",
    AudioReadConfig {
        num_channels: Some(2),
        ..Default::default()
    },
).unwrap();

• skip the first channel, reading channel 2 and 3

let audio = audio_read::<_, f32>(
    "test.wav",
    AudioReadConfig {
        first_channel: Some(1),
        num_channels: Some(2),
        ..Default::default()
    },
).unwrap();

• write audio samples in Float32

audio_write(
    "tmp.wav",
    data1.audio_block(),
    data1.sample_rate,
    AudioWriteConfig {
        sample_format: WriteSampleFormat::Float32,
    },
)
.unwrap();