audiotoolbox 0.4.0

Safe Rust bindings for Apple's AudioToolbox framework via a Swift bridge on macOS
Documentation

audiotoolbox-rs

Safe Rust bindings for Apple’s AudioToolbox.framework on macOS via a Swift bridge.

Covered areas

audiotoolbox-rs 0.4.0 now ships bridge-backed wrappers for:

  • AudioFormat
  • AudioFile
  • AudioFileComponent
  • ExtAudioFile
  • AudioConverter
  • AudioComponent
  • AudioUnit
  • AUAudioUnit
  • AUGraph
  • AVFAudio (AVAudioEngine / AVAudioNode / AVAudioFormat / AVAudioPCMBuffer / AVAudioSequencer)
  • AudioQueue
  • MusicSequence / MusicPlayer / MusicEventIterator
  • AudioServices
  • AudioFileStream
  • CAFFile

The original raw C surface is still available behind the raw-ffi Cargo feature, and the audit-filling long-tail C declarations are available under audiotoolbox::generated_c_types.

Installation

[dependencies]
audiotoolbox = "0.4.0"

To reach the legacy raw C bindings as well:

[dependencies]
audiotoolbox = { version = "0.4.0", features = ["raw-ffi"] }

Quick start

use audiotoolbox::AudioFile;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let file = AudioFile::open("/System/Library/Sounds/Glass.aiff")?;
    let format = file.data_format()?;
    let duration = file.estimated_duration()?;

    println!(
        "sample_rate={:.1} channels={} duration={:.3}s",
        format.mSampleRate,
        format.mChannelsPerFrame,
        duration,
    );

    Ok(())
}

Async callback streams

Enable the async feature for executor-agnostic wrappers over property listeners and render-notify callbacks. Render-notify streams use a real-time-safe SPSC handoff; synchronous pull-render callbacks remain manual.

[dependencies]
audiotoolbox = { version = "0.4.0", features = ["async"] }

use audiotoolbox::{
    AudioUnit, AUDIO_COMPONENT_TYPE_FORMAT_CONVERTER, AUDIO_UNIT_PROPERTY_STREAM_FORMAT,
    AUDIO_UNIT_SUBTYPE_AU_CONVERTER,
};

# async fn run() -> Result<(), audiotoolbox::AudioToolboxError> {
let unit = AudioUnit::new_apple(
    AUDIO_COMPONENT_TYPE_FORMAT_CONVERTER,
    AUDIO_UNIT_SUBTYPE_AU_CONVERTER,
)?;
let property_stream = unit.property_events(AUDIO_UNIT_PROPERTY_STREAM_FORMAT, 16)?;
let render_stream = unit.render_notify_stream(128)?;
let _ = property_stream.buffered_count() + render_stream.buffered_count();
# Ok(())
# }

Highlights

  • ScreenCaptureKit-style Swift bridge with one bridge file per logical area
  • Owned Rust handles with Drop
  • AudioFile, AudioFileComponent, ExtAudioFile, and AudioFileStream smoke-tested against Glass.aiff
  • In-memory AudioConverter one-shot conversion helper
  • AudioUnit, AUAudioUnit, AUGraph, and MusicSequence / MusicPlayer / MusicEventIterator creation helpers
  • AVAudioEngine / AVAudioNode / AVAudioFormat / AVAudioPCMBuffer / AVAudioSequencer wrappers for the common AVFAudio path plus exact-name audit aliases for the remaining sampled surface
  • Pure-Rust CAFFile header parsing helpers
  • 15 numbered examples and 16 integration smoke tests, including an exhaustive symbol-surface smoke test for every former audit gap

Examples

for ex in examples/*.rs; do cargo run --example "$(basename "$ex" .rs)"; done

Highlights:

  • 01_read_glass
  • 04_ext_audio_file_decode
  • 07_audio_unit_converter
  • 08_audio_queue_output
  • 10_audio_file_stream
  • 11_caf_header
  • 12_avfaudio
  • 13_au_audio_unit
  • 14_au_graph
  • 15_audio_file_component

Validation

Verified with:

cargo clippy --all-targets -- -D warnings
cargo test
for ex in examples/*.rs; do cargo run --example "$(basename "$ex" .rs)"; done
cargo check --features raw-ffi

Coverage audit

See COVERAGE_AUDIT.md for the sampled public-symbol coverage scoreboard and COVERAGE.md for the header-by-header audit of implemented, partial, and skipped APIs.

License

Licensed under either of: