Rust API reference

Engine functions

Rust
1pub fn analyze_interleaved(2    input: &[f32],3    sample_rate: u32,4    options: &ProcessOptions,5) -> anyhow::Result<EngineReport>;67pub fn process_interleaved(8    input: &[f32],9    sample_rate: u32,10    options: &ProcessOptions,11) -> anyhow::Result<ProcessResult>;1213pub fn process_interleaved_with_progress(14    input: &[f32],15    sample_rate: u32,16    options: &ProcessOptions,17    on_progress: impl FnMut(ProcessProgress),18) -> anyhow::Result<ProcessResult>;

Both functions validate the sample rate, stereo interleaving, option ranges, and sample finiteness. The progress variant emits Prepare, Analyze, MissingBand, Bandwidth, Artifacts, Finalize, and Complete at real pipeline boundaries. ProcessProgress::progress is an overall value from 0 to 1.

Long repair stages use bounded 8-second chunks with 250 ms of surrounding signal context. This keeps STFT memory bounded while preserving enough neighboring audio for stable chunk boundaries.

ProcessResult

Rust
1pub struct ProcessResult {2    pub audio: Vec<f32>,3    pub report: EngineReport,4}

When report.processed is false, audio is bit-for-bit equal to the input.

ProcessOptions

ProcessOptions::default() matches the native process defaults and enables every non-neural stage. Fields use Rust snake_case equivalents of the JavaScript options:

Rust
1pub struct ProcessOptions {2    pub fc: usize,3    pub scan_start_hz: usize,4    pub dsp_strength: f32,5    pub bandwidth_extension: bool,6    pub repair_smearing: bool,7    pub repair_bleeding: bool,8    pub stabilize_phase: bool,9    pub n_fft: usize,10    pub hop: usize,11    // Additional detector, strength, and segmentation controls.12}

See the npm option table for defaults and accepted ranges. Names map directly from camelCase to snake_case.

EngineReport

The report includes input metadata, needs_processing, processed, missing-band routing, shared-bandwidth evidence, artifact safety-gate retention, headroom changes, and per-segment metrics.

Important fields:

Field	Meaning
needs_processing	Detection or configured artifact work requested processing
processed	At least one stage was retained in the output
output_gain_db	Final gain used to maintain headroom
synthesis_mix	Retained share of the synthesized M/S delta
segments	Window metrics and DSP routes

Native pipeline

These APIs are present with the default native feature:

Rust
1pub fn process<P: AsRef<Path>, Q: AsRef<Path>>(2    input: P,3    output: Q,4    config: &Config,5    report_path: Option<&Path>,6) -> anyhow::Result<()>;78pub fn detect<P: AsRef<Path>>(9    input: P,10    config: &Config,11    report_path: Option<&Path>,12) -> anyhow::Result<()>;

Config::from_process() enables calibrated artifact repair. Config::from_detect() keeps those stages disabled and reports analysis only.

Cargo features

Feature	Included behavior
native (default)	CLI, WAV I/O, ONNX Runtime, model downloads, terminal UI, Rayon
wasm	wasm-bindgen exports and JavaScript serialization
No features	Portable Rust analysis and non-neural engine

Build the browser target with:

Bash
1cargo build \2  --target wasm32-unknown-unknown \3  --no-default-features \4  --features wasm