Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MoAlyousef/soloud-rs
Rust bindings for the soloud audio engine library
https://github.com/MoAlyousef/soloud-rs
audio bindings rust
Last synced: 4 days ago
JSON representation
Rust bindings for the soloud audio engine library
- Host: GitHub
- URL: https://github.com/MoAlyousef/soloud-rs
- Owner: MoAlyousef
- License: mit
- Created: 2020-08-24T16:25:20.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T19:56:35.000Z (7 months ago)
- Last Synced: 2024-10-30T04:50:13.424Z (14 days ago)
- Topics: audio, bindings, rust
- Language: Rust
- Homepage:
- Size: 197 KB
- Stars: 57
- Watchers: 4
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# soloud-rs
[](https://docs.rs/soloud)
[](https://crates.io/crates/soloud)
[](https://github.com/MoAlyousef/soloud-rs/blob/master/LICENSE)
[](https://github.com/MoAlyousef/soloud-rs/actions)
A crossplatform Rust bindings for the soloud audio engine library.
Supported formats: wav, mp3, ogg, flac. The library also comes with a speech synthesizer.
- The official soloud [website](https://sol.gfxile.net/soloud/index.html)
- The official soloud [repo](https://github.com/jarikomppa/soloud)
## Usage
```toml
[dependencies]
soloud = "1"
```
Or to use the git repo:
```toml
[dependencies]
soloud = { git = "https://github.com/moalyousef/soloud-rs" }
```
To play audio:
```rust,no_run
use soloud::*;
fn main() -> Result<(), Box> {
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:
```rust,no_run
use soloud::*;
fn main() -> Result<(), Box> {
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:
```rust,no_run
use soloud::*;
fn main() -> Result<(), Box> {
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:
```bash
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](https://github.com/fltk-rs/demos/tree/master/musicplayer).
## Dependencies
A Rust compiler, C++ compiler, Cargo, CMake and git (all these need to be in your PATH). Ninja is recommended, but not required, and will be used if found. 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:
```toml
[dependencies]
soloud = { version = "1", 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):
```bash
export CXXFLAGS="-I /path/to/include"
```
or for Windows:
```bash
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
### Android support
The ANDROID_SDK_ROOT and ANDROID_NDK_ROOT need to be set.