Quick start
Choose the native Rust CLI, the Rust library, or the WebAssembly npm package.
Sidespread repairs missing upper-mid and high-frequency detail in stereo music. The DSP pipeline is available as a native Rust CLI, a Rust library, and a WebAssembly npm package for Web and Node.js.
Choose a runtime
| Runtime | Best for | Neural modes |
|---|---|---|
| Native CLI | Complete WAV workflows and optional UniverSR processing | Yes |
| Rust library | In-memory DSP or application integration | Native feature only |
| npm + WASM | Browser and Node.js processing with one JavaScript API | No |
Native CLI
Bashcargo build --release./target/release/sidespread process song.wav
The repaired file is written to song.repaired.wav. Healthy audio is analyzed but not rewritten.
JavaScript
Bashnpm install sidespread
JavaScriptimport { init, process } from 'sidespread';await init();const result = process(interleavedStereo, 48_000);console.log(result.report.processed);
Continue with the npm guide or open the local demo.
Rust library
The DSP-only engine accepts interleaved f32 stereo samples and does not need filesystem access:
Rustuse sidespread::engine::{process_interleaved, ProcessOptions};let result = process_interleaved(&samples, 48_000, &ProcessOptions::default())?;println!("processed: {}", result.report.processed);
See Rust integration for feature flags and complete examples.
Audio contract
- Stereo only, represented as
L, R, L, R, .... - 44.1 or 48 kHz sample rates.
- Finite normalized f32 samples.
- The WASM build includes every non-neural repair stage.