https://github.com/zeozeozeo/kittyaudio
A Rust audio playback library focusing on simplicity.
https://github.com/zeozeozeo/kittyaudio
audio audio-playback cpal gamedev low-latency multimedia playback rustlang symphonia
Last synced: 2 months ago
JSON representation
A Rust audio playback library focusing on simplicity.
- Host: GitHub
- URL: https://github.com/zeozeozeo/kittyaudio
- Owner: zeozeozeo
- License: unlicense
- Created: 2023-11-27T12:26:34.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-29T09:03:11.000Z (5 months ago)
- Last Synced: 2025-03-23T22:37:12.918Z (3 months ago)
- Topics: audio, audio-playback, cpal, gamedev, low-latency, multimedia, playback, rustlang, symphonia
- Language: Rust
- Homepage: https://docs.rs/kittyaudio
- Size: 1.97 MB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐱 kittyaudio
 
#### [crates.io](https://crates.io/crates/kittyaudio) | [docs.rs](https://docs.rs/kittyaudio) | [examples](https://github.com/zeozeozeo/kittyaudio/tree/master/examples) | [changelogs](https://github.com/zeozeozeo/kittyaudio/blob/master/CHANGELOG.md)
kittyaudio is a Rust audio playback library focusing on simplicity, speed and low-latency audio playback.
Installation with `cargo`:
```
cargo add kittyaudio
```
# Example
```rust
use kittyaudio::{include_sound, Mixer};
fn main() {
// include a sound into the executable.
// this type can be cheaply cloned.
let sound = include_sound!("jump.ogg").unwrap();
// create sound mixer
let mut mixer = Mixer::new();
mixer.init(); // use init_ex to specify settings
let playing_sound = mixer.play(sound);
playing_sound.set_volume(0.5); // decrease volume
mixer.wait(); // wait for all sounds to finish
}
```
# Features
* Low-latency audio playback
* Cross-platform audio playback (including wasm)
* Handle device changes or disconnects in real time
* Low CPU usage
* Minimal dependencies
* Minimal memory allocations
* No `panic!()` or `.unwrap()`, always propogate errors
* No unsafe code
* Simple API, while being customizable
* Optionally use [Symphonia](https://github.com/pdeljanov/Symphonia) to support most audio formats
* Feature to disable audio playback support, if you want to use kittyaudio purely as an audio library
* Commands to change volume, playback rate, position and panning in the sound with easings
* Loops, and commands to change them with easings
# Roadmap
Those features are not implemented yet.
* Effects (reverb, delay, eq, etc.)
* C API
* Audio streaming from disk