Rust integration

Sidespread exposes a portable in-memory engine and the native file pipeline from the same crate. Choose features according to whether your application needs the CLI, WAV I/O, or UniverSR.

DSP-only dependency

TOML
1[dependencies]2sidespread = {3  git = "https://github.com/backrunner/sidespread",4  default-features = false5}

Disabling default features leaves the analysis and non-neural repair modules available without ONNX Runtime, model downloads, terminal UI, or filesystem audio I/O.

Process interleaved audio

Rust
1use sidespread::engine::{process_interleaved, ProcessOptions};23fn repair(samples: &[f32], sample_rate: u32) -> anyhow::Result<Vec<f32>> {4    let options = ProcessOptions {5        dsp_strength: 1.6,6        bandwidth_extension: true,7        ..ProcessOptions::default()8    };910    let result = process_interleaved(samples, sample_rate, &options)?;11    eprintln!("processed: {}", result.report.processed);12    Ok(result.audio)13}

The slice must contain interleaved stereo f32 samples. The returned vector has the same channel layout and frame count.

Observe processing progress

Rust
1use sidespread::engine::{process_interleaved_with_progress, ProcessOptions};23let result = process_interleaved_with_progress(4    &samples,5    48_000,6    &ProcessOptions::default(),7    |event| eprintln!("{:?}: {:.0}%", event.stage, event.progress * 100.0),8)?;

The callback runs after each high-level stage begins and finishes with ProcessStage::Complete at 1.0. Use the original process_interleaved function when progress is not needed.

Analyze without processing

Rust
1use sidespread::engine::{analyze_interleaved, ProcessOptions};23let report = analyze_interleaved(&samples, 44_100, &ProcessOptions::default())?;4if report.needs_processing {5    println!("{} routed windows", report.missing_band.routed_segments);6}

Native pipeline

Default features include the CLI, WAV I/O, terminal progress, model management, and optional neural routes:

TOML
1[dependencies]2sidespread = { git = "https://github.com/backrunner/sidespread" }

Rust
1use sidespread::{config::Config, pipeline};23let config = Config::from_process(8_000, 0.3);4pipeline::process("input.wav", "output.wav", &config, None)?;

The native pipeline preserves the CLI behavior: it does not write a WAV when no stage is accepted.

Continue with the Rust API reference.