Sam SungandClaude Opus 5.5
4c18c23c94
An ambience change read and decoded the whole bed on the main thread, about 40 ms a swap. 1.12.1 opens the bed as a looping FMOD stream that reads the archive through its file callbacks (`0x460b54` → `0x7a54d0`, `FSOUND_Stream_Open` at `0x7a5525`). Now: - MPQ files open for in-place reads, one sector at a time. - The bed streams from the archive, opened on the IO pool. A newer swap drops an open still in flight. - kira moves to 0.12.4 on symphonia 0.6. 0.5 sized PCM frames from `nBlockAlign`, which 98 stereo WAVs store as 2, so a streamed bed fell silent halfway. - A fork patch stops a stream at its last packet instead of spinning. - A sector that inflates short is refused. Tests cover a bed's true length, a seamless loop, an off-thread open, the stop at the last packet and the refusal. Fixes #700 Fixes #8 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
144 lines
4.2 KiB
Markdown
144 lines
4.2 KiB
Markdown
# Kira
|
|
|
|
#### [crates.io](https://crates.io/crates/kira) | [docs](https://docs.rs/kira/)
|
|
|
|
Kira is a backend-agnostic library to create expressive audio for games. It
|
|
provides tweens for smoothly adjusting properties of sounds, a flexible mixer
|
|
for applying effects to audio, a clock system for precisely timing audio events,
|
|
and spatial audio support.
|
|
|
|
## Examples
|
|
|
|
Playing a sound multiple times simultaneously:
|
|
|
|
```rust
|
|
use kira::{
|
|
AudioManager, AudioManagerSettings, DefaultBackend,
|
|
sound::static_sound::StaticSoundData,
|
|
};
|
|
|
|
// Create an audio manager. This plays sounds and manages resources.
|
|
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
|
|
let sound_data = StaticSoundData::from_file("sound.ogg")?;
|
|
manager.play(sound_data.clone())?;
|
|
// After a couple seconds...
|
|
manager.play(sound_data.clone())?;
|
|
// Cloning the sound data will not use any extra memory.
|
|
```
|
|
|
|
Gradually speeding up a sound over time:
|
|
|
|
```rust
|
|
use std::time::Duration;
|
|
|
|
use kira::{
|
|
AudioManager, AudioManagerSettings, DefaultBackend,
|
|
sound::static_sound::StaticSoundData,
|
|
Tween,
|
|
};
|
|
|
|
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
|
|
let sound_data = StaticSoundData::from_file("sound.ogg")?;
|
|
let mut sound = manager.play(sound_data)?;
|
|
// Start smoothly adjusting the playback rate parameter.
|
|
sound.set_playback_rate(
|
|
2.0,
|
|
Tween {
|
|
duration: Duration::from_secs(3),
|
|
..Default::default()
|
|
},
|
|
);
|
|
```
|
|
|
|
Playing a sound with a low-pass filter applied (this makes the audio sound
|
|
muffled):
|
|
|
|
```rust
|
|
use kira::{
|
|
AudioManager, AudioManagerSettings, DefaultBackend,
|
|
sound::static_sound::StaticSoundData,
|
|
track::{
|
|
TrackBuilder,
|
|
effect::filter::FilterBuilder,
|
|
},
|
|
};
|
|
|
|
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
|
|
// Create a mixer sub-track with a filter.
|
|
let track = manager.add_sub_track({
|
|
let mut builder = TrackBuilder::new();
|
|
builder.add_effect(FilterBuilder::new().cutoff(1000.0));
|
|
builder
|
|
})?;
|
|
// Play the sound on the track.
|
|
let sound_data = StaticSoundData::from_file("sound.ogg")?.output_destination(&track);
|
|
manager.play(sound_data)?;
|
|
```
|
|
|
|
Playing sounds in time with a musical beat:
|
|
|
|
```rust
|
|
use kira::{
|
|
AudioManager, AudioManagerSettings, DefaultBackend,
|
|
sound::static_sound::StaticSoundData,
|
|
clock::ClockSpeed,
|
|
};
|
|
|
|
const TEMPO: f64 = 120.0;
|
|
|
|
let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
|
|
// Create a clock that ticks 120 times per minute. In this case,
|
|
// each tick is one musical beat. We can use a tick to represent any
|
|
// arbitrary amount of time.
|
|
let mut clock = manager.add_clock(ClockSpeed::TicksPerMinute(TEMPO))?;
|
|
// Play a sound 2 ticks (beats) from now.
|
|
let sound_data_1 = StaticSoundData::from_file("sound1.ogg")?
|
|
.start_time(clock.time() + 2);
|
|
manager.play(sound_data_1)?;
|
|
// Play a different sound 4 ticks (beats) from now.
|
|
let sound_data_2 = StaticSoundData::from_file("sound2.ogg")?
|
|
.start_time(clock.time() + 4);
|
|
manager.play(sound_data_2)?;
|
|
// Start the clock.
|
|
clock.start()?;
|
|
```
|
|
|
|
## Platform support
|
|
|
|
Kira is mainly meant for desktop platforms. Most testing has occurred on
|
|
Windows, but it has been used successfully on Mac and Linux.
|
|
|
|
Kira can also be used in wasm environments with the following limitations:
|
|
|
|
- Static sounds cannot be loaded from files
|
|
- Streaming sounds are not supported because they make heavy use of threads
|
|
|
|
If you'd like to help improve wasm support, please reach out!
|
|
|
|
## Roadmap
|
|
|
|
Features I'd like to have:
|
|
|
|
- C API
|
|
- Spatial audio features:
|
|
- Doppler effect
|
|
|
|
## Contributing
|
|
|
|
I'd love for other people to get involved with development! I'm open to all kinds of
|
|
input - bug reports, feature requests, design critiques, etc. Feel free to open an
|
|
issue or pull request!
|
|
|
|
## License
|
|
|
|
This project is licensed under either of
|
|
|
|
- Apache License, Version 2.0 (LICENSE-APACHE)
|
|
- MIT license (LICENSE-MIT)
|
|
|
|
at your option.
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in `kira` by you, as defined in the Apache-2.0 license, shall be
|
|
dual licensed as above, without any additional terms or conditions.
|