mirror of
https://github.com/Xevion/Pac-Man.git
synced 2025-12-11 08:08:00 -06:00
refactor: improve audio system states, add try_new(), organize constants, volume memory
This commit is contained in:
190
src/audio.rs
190
src/audio.rs
@@ -2,12 +2,18 @@
|
|||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
||||||
use crate::asset::Asset;
|
use crate::asset::Asset;
|
||||||
|
use anyhow::{anyhow, Result};
|
||||||
use sdl2::{
|
use sdl2::{
|
||||||
mixer::{self, Chunk, InitFlag, LoaderRWops, AUDIO_S16LSB, DEFAULT_CHANNELS},
|
mixer::{self, Chunk, InitFlag, LoaderRWops, AUDIO_S16LSB},
|
||||||
rwops::RWops,
|
rwops::RWops,
|
||||||
};
|
};
|
||||||
use strum::IntoEnumIterator;
|
use strum::IntoEnumIterator;
|
||||||
|
|
||||||
|
const AUDIO_FREQUENCY: i32 = 16_000;
|
||||||
|
const AUDIO_CHANNELS: i32 = 4;
|
||||||
|
const DEFAULT_VOLUME: u8 = 32;
|
||||||
|
const WAKA_SOUND_COUNT: u8 = 4;
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
||||||
pub enum Sound {
|
pub enum Sound {
|
||||||
Waka(u8),
|
Waka(u8),
|
||||||
@@ -23,19 +29,16 @@ impl IntoEnumIterator for Sound {
|
|||||||
type Iterator = std::vec::IntoIter<Sound>;
|
type Iterator = std::vec::IntoIter<Sound>;
|
||||||
|
|
||||||
fn iter() -> Self::Iterator {
|
fn iter() -> Self::Iterator {
|
||||||
vec![
|
let mut sounds = vec![
|
||||||
Sound::Waka(0),
|
|
||||||
Sound::Waka(1),
|
|
||||||
Sound::Waka(2),
|
|
||||||
Sound::Waka(3),
|
|
||||||
Sound::PacmanDeath,
|
Sound::PacmanDeath,
|
||||||
Sound::ExtraLife,
|
Sound::ExtraLife,
|
||||||
Sound::Fruit,
|
Sound::Fruit,
|
||||||
Sound::Ghost,
|
Sound::Ghost,
|
||||||
Sound::Beginning,
|
Sound::Beginning,
|
||||||
Sound::Intermission,
|
Sound::Intermission,
|
||||||
]
|
];
|
||||||
.into_iter()
|
sounds.extend((0..WAKA_SOUND_COUNT).map(Sound::Waka));
|
||||||
|
sounds.into_iter()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -48,8 +51,14 @@ pub struct Audio {
|
|||||||
_mixer_context: Option<mixer::Sdl2MixerContext>,
|
_mixer_context: Option<mixer::Sdl2MixerContext>,
|
||||||
sounds: HashMap<Sound, Chunk>,
|
sounds: HashMap<Sound, Chunk>,
|
||||||
next_waka_index: u8,
|
next_waka_index: u8,
|
||||||
muted: bool,
|
state: AudioState,
|
||||||
disabled: bool,
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
enum AudioState {
|
||||||
|
Enabled { volume: u8 },
|
||||||
|
Muted { previous_volume: u8 },
|
||||||
|
Disabled,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for Audio {
|
impl Default for Audio {
|
||||||
@@ -64,7 +73,21 @@ impl Audio {
|
|||||||
/// If audio fails to initialize, the audio system will be disabled and
|
/// If audio fails to initialize, the audio system will be disabled and
|
||||||
/// all functions will silently do nothing.
|
/// all functions will silently do nothing.
|
||||||
pub fn new() -> Self {
|
pub fn new() -> Self {
|
||||||
let frequency = 16_000;
|
match Self::try_new() {
|
||||||
|
Ok(audio) => audio,
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!("Failed to initialize audio: {}. Audio will be disabled.", e);
|
||||||
|
Self {
|
||||||
|
_mixer_context: None,
|
||||||
|
sounds: HashMap::new(),
|
||||||
|
next_waka_index: 0,
|
||||||
|
state: AudioState::Disabled,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn try_new() -> Result<Self> {
|
||||||
let format = AUDIO_S16LSB;
|
let format = AUDIO_S16LSB;
|
||||||
let chunk_size = {
|
let chunk_size = {
|
||||||
// 256 is the minimum for Emscripten, but in practice 1024 is much more reliable
|
// 256 is the minimum for Emscripten, but in practice 1024 is much more reliable
|
||||||
@@ -81,103 +104,52 @@ impl Audio {
|
|||||||
};
|
};
|
||||||
|
|
||||||
// Try to open audio, but don't panic if it fails
|
// Try to open audio, but don't panic if it fails
|
||||||
if let Err(e) = mixer::open_audio(frequency, format, DEFAULT_CHANNELS, chunk_size) {
|
mixer::open_audio(AUDIO_FREQUENCY, format, AUDIO_CHANNELS, chunk_size)
|
||||||
tracing::warn!("Failed to open audio: {}. Audio will be disabled.", e);
|
.map_err(|e| anyhow!("Failed to open audio: {}", e))?;
|
||||||
return Self {
|
|
||||||
_mixer_context: None,
|
|
||||||
sounds: HashMap::new(),
|
|
||||||
next_waka_index: 0u8,
|
|
||||||
muted: false,
|
|
||||||
disabled: true,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
let channels = 4;
|
mixer::allocate_channels(AUDIO_CHANNELS);
|
||||||
mixer::allocate_channels(4);
|
|
||||||
|
|
||||||
// set channel volume
|
// set channel volume
|
||||||
for i in 0..channels {
|
for i in 0..AUDIO_CHANNELS {
|
||||||
mixer::Channel(i).set_volume(32);
|
mixer::Channel(i).set_volume(DEFAULT_VOLUME as i32);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Try to initialize mixer, but don't panic if it fails
|
// Try to initialize mixer, but don't panic if it fails
|
||||||
let mixer_context = match mixer::init(InitFlag::OGG) {
|
let mixer_context = mixer::init(InitFlag::OGG).map_err(|e| anyhow!("Failed to initialize SDL2_mixer: {}", e))?;
|
||||||
Ok(ctx) => ctx,
|
|
||||||
Err(e) => {
|
|
||||||
tracing::warn!("Failed to initialize SDL2_mixer: {}. Audio will be disabled.", e);
|
|
||||||
return Self {
|
|
||||||
_mixer_context: None,
|
|
||||||
sounds: HashMap::new(),
|
|
||||||
next_waka_index: 0u8,
|
|
||||||
muted: false,
|
|
||||||
disabled: true,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Try to load sounds, but don't panic if any fail
|
// Try to load sounds, but don't panic if any fail
|
||||||
let mut sounds = HashMap::new();
|
let sounds: HashMap<Sound, Chunk> = Sound::iter()
|
||||||
for (i, sound_type) in Sound::iter().enumerate() {
|
.filter_map(|sound_type| match Self::load_sound(sound_type) {
|
||||||
let asset = Asset::SoundFile(sound_type);
|
Ok(chunk) => Some((sound_type, chunk)),
|
||||||
match asset.get_bytes() {
|
|
||||||
Ok(data) => match RWops::from_bytes(&data) {
|
|
||||||
Ok(rwops) => match rwops.load_wav() {
|
|
||||||
Ok(chunk) => {
|
|
||||||
sounds.insert(sound_type, chunk);
|
|
||||||
}
|
|
||||||
Err(e) => {
|
|
||||||
tracing::warn!("Failed to load sound {} from asset API: {}", i + 1, e);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
Err(e) => {
|
|
||||||
tracing::warn!("Failed to create RWops for sound {}: {}", i + 1, e);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
Err(e) => {
|
Err(e) => {
|
||||||
tracing::warn!("Failed to load sound asset {}: {}", i + 1, e);
|
tracing::warn!("Failed to load sound {:?}: {}", sound_type, e);
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let death_sound = match Asset::SoundFile(Sound::PacmanDeath).get_bytes() {
|
|
||||||
Ok(data) => match RWops::from_bytes(&data) {
|
|
||||||
Ok(rwops) => match rwops.load_wav() {
|
|
||||||
Ok(chunk) => Some(chunk),
|
|
||||||
Err(e) => {
|
|
||||||
tracing::warn!("Failed to load death sound from asset API: {}", e);
|
|
||||||
None
|
|
||||||
}
|
|
||||||
},
|
|
||||||
Err(e) => {
|
|
||||||
tracing::warn!("Failed to create RWops for death sound: {}", e);
|
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
},
|
})
|
||||||
Err(e) => {
|
.collect();
|
||||||
tracing::warn!("Failed to load death sound asset: {}", e);
|
|
||||||
None
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// If no sounds loaded successfully, disable audio
|
// If no sounds loaded successfully, disable audio
|
||||||
if sounds.is_empty() && death_sound.is_none() {
|
if sounds.is_empty() {
|
||||||
tracing::warn!("No sounds loaded successfully. Audio will be disabled.");
|
return Err(anyhow!("No sounds loaded successfully"));
|
||||||
return Self {
|
|
||||||
_mixer_context: Some(mixer_context),
|
|
||||||
sounds: HashMap::new(),
|
|
||||||
next_waka_index: 0u8,
|
|
||||||
muted: false,
|
|
||||||
disabled: true,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Audio {
|
Ok(Audio {
|
||||||
_mixer_context: Some(mixer_context),
|
_mixer_context: Some(mixer_context),
|
||||||
sounds,
|
sounds,
|
||||||
next_waka_index: 0u8,
|
next_waka_index: 0u8,
|
||||||
muted: false,
|
state: AudioState::Enabled { volume: DEFAULT_VOLUME },
|
||||||
disabled: false,
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn load_sound(sound_type: Sound) -> Result<Chunk> {
|
||||||
|
let asset = Asset::SoundFile(sound_type);
|
||||||
|
let data = asset
|
||||||
|
.get_bytes()
|
||||||
|
.map_err(|e| anyhow!("Failed to get bytes for {:?}: {}", sound_type, e))?;
|
||||||
|
let rwops = RWops::from_bytes(&data).map_err(|e| anyhow!("Failed to create RWops for {:?}: {}", sound_type, e))?;
|
||||||
|
rwops
|
||||||
|
.load_wav()
|
||||||
|
.map_err(|e| anyhow!("Failed to load wav for {:?}: {}", sound_type, e))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Plays the next waka eating sound in the cycle of four variants.
|
/// Plays the next waka eating sound in the cycle of four variants.
|
||||||
@@ -186,7 +158,7 @@ impl Audio {
|
|||||||
/// advances to the next variant. Silently returns if audio is disabled, muted,
|
/// advances to the next variant. Silently returns if audio is disabled, muted,
|
||||||
/// or no sounds were loaded successfully.
|
/// or no sounds were loaded successfully.
|
||||||
pub fn waka(&mut self) {
|
pub fn waka(&mut self) {
|
||||||
if self.disabled || self.muted || self.sounds.is_empty() {
|
if !matches!(self.state, AudioState::Enabled { .. }) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -200,12 +172,12 @@ impl Audio {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
self.next_waka_index = (self.next_waka_index + 1) & 3;
|
self.next_waka_index = (self.next_waka_index + 1) % WAKA_SOUND_COUNT;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Plays the provided sound effect once.
|
/// Plays the provided sound effect once.
|
||||||
pub fn play(&mut self, sound: Sound) {
|
pub fn play(&mut self, sound: Sound) {
|
||||||
if self.disabled || self.muted {
|
if !matches!(self.state, AudioState::Enabled { .. }) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -216,21 +188,21 @@ impl Audio {
|
|||||||
|
|
||||||
/// Halts all currently playing audio channels.
|
/// Halts all currently playing audio channels.
|
||||||
pub fn stop_all(&mut self) {
|
pub fn stop_all(&mut self) {
|
||||||
if !self.disabled {
|
if self.state != AudioState::Disabled {
|
||||||
mixer::Channel::all().halt();
|
mixer::Channel::all().halt();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Pauses all currently playing audio channels.
|
/// Pauses all currently playing audio channels.
|
||||||
pub fn pause_all(&mut self) {
|
pub fn pause_all(&mut self) {
|
||||||
if !self.disabled {
|
if self.state != AudioState::Disabled {
|
||||||
mixer::Channel::all().pause();
|
mixer::Channel::all().pause();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Resumes all currently playing audio channels.
|
/// Resumes all currently playing audio channels.
|
||||||
pub fn resume_all(&mut self) {
|
pub fn resume_all(&mut self) {
|
||||||
if !self.disabled {
|
if self.state != AudioState::Disabled {
|
||||||
mixer::Channel::all().resume();
|
mixer::Channel::all().resume();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -241,15 +213,23 @@ impl Audio {
|
|||||||
/// their default volume (32) when unmuting. The mute state is tracked internally
|
/// their default volume (32) when unmuting. The mute state is tracked internally
|
||||||
/// regardless of whether audio is disabled, allowing the state to be preserved.
|
/// regardless of whether audio is disabled, allowing the state to be preserved.
|
||||||
pub fn set_mute(&mut self, mute: bool) {
|
pub fn set_mute(&mut self, mute: bool) {
|
||||||
if !self.disabled {
|
match (mute, self.state) {
|
||||||
let channels = 4;
|
// Mute
|
||||||
let volume = if mute { 0 } else { 32 };
|
(true, AudioState::Enabled { volume }) => {
|
||||||
for i in 0..channels {
|
self.state = AudioState::Muted { previous_volume: volume };
|
||||||
mixer::Channel(i).set_volume(volume);
|
for i in 0..AUDIO_CHANNELS {
|
||||||
|
mixer::Channel(i).set_volume(0);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
// Unmute
|
||||||
|
(false, AudioState::Muted { previous_volume }) => {
|
||||||
|
self.state = AudioState::Enabled { volume: previous_volume };
|
||||||
|
for i in 0..AUDIO_CHANNELS {
|
||||||
|
mixer::Channel(i).set_volume(previous_volume as i32);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
}
|
}
|
||||||
|
|
||||||
self.muted = mute;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the current mute state regardless of whether audio is functional.
|
/// Returns the current mute state regardless of whether audio is functional.
|
||||||
@@ -257,7 +237,7 @@ impl Audio {
|
|||||||
/// This tracks the user's mute preference and will return `true` if muted
|
/// This tracks the user's mute preference and will return `true` if muted
|
||||||
/// even when the audio system is disabled due to initialization failures.
|
/// even when the audio system is disabled due to initialization failures.
|
||||||
pub fn is_muted(&self) -> bool {
|
pub fn is_muted(&self) -> bool {
|
||||||
self.muted
|
matches!(self.state, AudioState::Muted { .. })
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns whether the audio system failed to initialize and is non-functional.
|
/// Returns whether the audio system failed to initialize and is non-functional.
|
||||||
@@ -266,6 +246,6 @@ impl Audio {
|
|||||||
/// audio device, or failure to load any sound assets. When disabled, all
|
/// audio device, or failure to load any sound assets. When disabled, all
|
||||||
/// audio operations become no-ops.
|
/// audio operations become no-ops.
|
||||||
pub fn is_disabled(&self) -> bool {
|
pub fn is_disabled(&self) -> bool {
|
||||||
self.disabled
|
matches!(self.state, AudioState::Disabled)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ pub fn sleep(duration: Duration, focused: bool) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(unused_variables)]
|
||||||
pub fn init_console(force_console: bool) -> Result<(), PlatformError> {
|
pub fn init_console(force_console: bool) -> Result<(), PlatformError> {
|
||||||
use crate::formatter::CustomFormatter;
|
use crate::formatter::CustomFormatter;
|
||||||
use tracing::Level;
|
use tracing::Level;
|
||||||
|
|||||||
Reference in New Issue
Block a user