Skip to main content

chaos_rpg_audio/
lib.rs

1//! Sound for [CHAOS RPG](https://gitlab.com/mattbusel/chaos-rpg): every
2//! sound effect and music loop is synthesized at runtime by
3//! `chaos_rpg_core::audio_synth` and played through [rodio]. There are no
4//! audio files.
5//!
6//! If there is no audio device, [`AudioSystem::try_new`] returns `None` and
7//! the game runs silently.
8//!
9//! ```no_run
10//! use chaos_rpg_audio::AudioSystem;
11//! use chaos_rpg_core::audio_events::AudioEvent;
12//!
13//! if let Some(audio) = AudioSystem::try_new() {
14//!     audio.emit(AudioEvent::PlayerAttack); // queued; never blocks
15//! }
16//! ```
17//!
18//! To get the sounds without playing them, build a [`SoundBank`]: every field
19//! is a ready-to-save WAV file (see the `export_sounds` example).
20
21mod sound_bank;
22mod music_system;
23
24pub use sound_bank::SoundBank;
25pub use music_system::MusicSystem;
26
27use chaos_rpg_core::audio_events::{AudioEvent, MusicState, MusicVibe};
28use std::sync::mpsc::{self, Sender};
29use std::thread;
30
31/// The main audio system. Create once at startup, then call `emit()` from the game loop.
32pub struct AudioSystem {
33    tx: Sender<AudioMsg>,
34}
35
36enum AudioMsg {
37    Sfx(AudioEvent),
38    SetMusicState(MusicState),
39    SetVibe(MusicVibe),
40    Stop,
41}
42
43impl AudioSystem {
44    /// Initialise the audio system. Returns `None` silently if no audio device exists.
45    pub fn try_new() -> Option<Self> {
46        let (tx, rx) = mpsc::channel::<AudioMsg>();
47
48        // Probe for audio device availability before spawning
49        if rodio::OutputStream::try_default().is_err() {
50            return None;
51        }
52
53        thread::spawn(move || {
54            // Create the stream on the audio thread (OutputStream is !Send)
55            let Ok((_stream, stream_handle)) = rodio::OutputStream::try_default() else { return; };
56            let bank = SoundBank::new();
57            let mut music = MusicSystem::new(&stream_handle, &bank);
58            for msg in rx {
59                match msg {
60                    AudioMsg::Sfx(ev) => bank.play(&stream_handle, &ev),
61                    AudioMsg::SetMusicState(state) => music.transition_to(state, &stream_handle, &bank),
62                    AudioMsg::SetVibe(vibe) => music.set_vibe(vibe, &stream_handle, &bank),
63                    AudioMsg::Stop => break,
64                }
65            }
66        });
67
68        Some(Self { tx })
69    }
70
71    /// Emit an audio event from the game. Non-blocking — queued to the audio thread.
72    pub fn emit(&self, event: AudioEvent) {
73        // Derive music state changes from key events
74        let music_state = match &event {
75            AudioEvent::FloorEntered { .. } => Some(MusicState::Exploration),
76            AudioEvent::BossEncounterStart { .. } | AudioEvent::GauntletStart => Some(MusicState::Boss),
77            AudioEvent::PlayerAttack | AudioEvent::EnemyAttack | AudioEvent::DamageDealt { .. } => {
78                Some(MusicState::Combat)
79            }
80            AudioEvent::ShopEntered => Some(MusicState::Shop),
81            AudioEvent::GameOver => Some(MusicState::GameOver),
82            AudioEvent::Victory => Some(MusicState::Victory),
83            AudioEvent::CursedFloorActivated => Some(MusicState::CursedFloor),
84            _ => None,
85        };
86
87        let _ = self.tx.send(AudioMsg::Sfx(event));
88        if let Some(state) = music_state {
89            let _ = self.tx.send(AudioMsg::SetMusicState(state));
90        }
91    }
92
93    /// Explicitly set music state without triggering a SFX.
94    pub fn set_music_state(&self, state: MusicState) {
95        let _ = self.tx.send(AudioMsg::SetMusicState(state));
96    }
97
98    /// Change the music vibe preset (takes effect immediately, restarts current track).
99    pub fn set_vibe(&self, vibe: MusicVibe) {
100        let _ = self.tx.send(AudioMsg::SetVibe(vibe));
101    }
102}
103
104impl Drop for AudioSystem {
105    fn drop(&mut self) {
106        let _ = self.tx.send(AudioMsg::Stop);
107    }
108}