soloud-rs
A crossplatform Rust bindings for the soloud audio engine library.
Supported formats: wav, mp3, ogg, flac. The library also comes with a speech synthesizer.
Usage
[dependencies]
soloud = "0.3"
Or to use the git repo:
[dependencies]
soloud = { git = "https://github.com/moalyousef/soloud-rs" }
To play audio:
use soloud::*;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut sl = Soloud::default()?;
let mut wav = audio::Wav::default();
wav.load(&std::path::Path::new("sample.wav"))?;
sl.play(&wav); // calls to play are non-blocking, so we put the thread to sleep
while sl.voice_count() > 0 {
std::thread::sleep(std::time::Duration::from_millis(100));
}
wav.load(&std::path::Path::new("Recording.mp3"))?;
sl.play(&wav);
while sl.voice_count() > 0 {
std::thread::sleep(std::time::Duration::from_millis(100));
}
Ok(())
}
To play speech:
use soloud::*;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut sl = Soloud::default()?;
let mut speech = audio::Speech::default();
speech.set_text("Hello World")?;
sl.play(&speech);
while sl.active_voice_count() > 0 {
std::thread::sleep(std::time::Duration::from_millis(100));
}
speech.set_text("1 2 3")?;
sl.play(&speech);
while sl.active_voice_count() > 0 {
std::thread::sleep(std::time::Duration::from_millis(100));
}
speech.set_text("Can you hear me?")?;
sl.play(&speech);
while sl.active_voice_count() > 0 {
std::thread::sleep(std::time::Duration::from_millis(100));
}
Ok(())
}
To add a filter:
use soloud::*;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut sl = Soloud::default()?;
let mut wav = audio::Wav::default();
let mut filt = filter::EchoFilter::default();
filt.set_params(0.2)?; // sets the delay
wav.load(&std::path::Path::new("sample.wav"))?;
wav.set_filter(0, Some(&filt));
sl.play(&wav);
while sl.voice_count() > 0 {
std::thread::sleep(std::time::Duration::from_millis(100));
}
Ok(())
}
The examples can be found in the soloud/examples directory. They can be run using:
$ cargo run --example simple
$ cargo run --example speech
$ cargo run --example filter
$ cargo run --example load_mem
You will need to have valid "sample.wav" and "Recording.mp3" audio files in the project root. Or you can change the paths to point to any supported audio file.
There is also a demo gui application (using fltk) here.
Dependencies
A Rust compiler, C++ compiler, Cargo, CMake and git (all these need to be in your PATH). This crate uses the miniaudio backend by default which assumes default sound drivers are functional.
Backends
The default backend is miniaudio, however Soloud supports several backends to varying degrees. To enable support of a certain backend, alsa for example:
[dependencies]
soloud = { version = "0.3", default-features = false, features = ["alsa"] }
This also assumes that those libraries headers are in your include path where CMake can find them, otherwise you can set it via the command line (posix):
$ export CXXFLAGS="-I /path/to/include"
or for Windows:
$ set CXXFLAGS="-I C:\\path\\to\\include"
The same can be done for CFLAGS if needed.
Supported backends:
- miniaudio
- oss
- alsa
- sdl2
- sdl2-static
- portaudio
- openal
- xaudio2
- winmm
- wasapi
- opensles
- coreaudio
- jack
1.2k Jan 1, 2023
1k Jan 2, 2023
20 May 25, 2023
3 Aug 31, 2022
27 Jan 3, 2023
39 Apr 4, 2023
9 Nov 28, 2022
116 Dec 18, 2022
20 Oct 16, 2022
10 Sep 12, 2022
93 Dec 23, 2022
11 Sep 17, 2022
5 Sep 16, 2022
3 Nov 1, 2022
415 Dec 27, 2022
86 Nov 7, 2022
8 Nov 23, 2022
10 Apr 16, 2023
3 Feb 7, 2024