abstreet/santa/src/music.rs

use std::io::Cursor;

use anyhow::Result;
use rodio::{Decoder, OutputStream, OutputStreamHandle, Sink};

use widgetry::{
    Btn, Checkbox, EventCtx, GfxCtx, HorizontalAlignment, Outcome, Panel, VerticalAlignment,
};

// TODO Speed up when we're almost out of time, slow down when we're low on energy

// Don't play music loudly on the title screen, menus, etc
pub const OUT_OF_GAME: f32 = 0.5;
pub const IN_GAME: f32 = 1.0;

pub struct Music {
    inner: Option<Inner>,
}

impl std::default::Default for Music {
    fn default() -> Music {
        Music::empty()
    }
}

struct Inner {
    // Have to keep this alive for the background thread to continue
    _stream: OutputStream,
    stream_handle: OutputStreamHandle,
    sink: Sink,
    unmuted_volume: f32,
    current_song: String,

    panel: Panel,
}

impl Music {
    pub fn empty() -> Music {
        Music { inner: None }
    }

    pub fn start(ctx: &mut EventCtx, play_music: bool, song: &str) -> Music {
        match Inner::new(ctx, play_music, song) {
            Ok(inner) => Music { inner: Some(inner) },
            Err(err) => {
                error!("No music, sorry: {}", err);
                Music::empty()
            }
        }
    }

    pub fn event(&mut self, ctx: &mut EventCtx, play_music: &mut bool) {
        if let Some(ref mut inner) = self.inner {
            match inner.panel.event(ctx) {
                Outcome::Clicked(_) => unreachable!(),
                Outcome::Changed => {
                    if inner.panel.is_checked("play music") {
                        *play_music = true;
                        inner.unmute();
                    } else {
                        *play_music = false;
                        inner.mute();
                    }
                }
                _ => {}
            }
        }
    }

    pub fn draw(&self, g: &mut GfxCtx) {
        if let Some(ref inner) = self.inner {
            inner.panel.draw(g);
        }
    }

    pub fn specify_volume(&mut self, volume: f32) {
        if let Some(ref mut inner) = self.inner {
            inner.specify_volume(volume);
        }
    }

    pub fn change_song(&mut self, song: &str) {
        if let Some(ref mut inner) = self.inner {
            if let Err(err) = inner.change_song(song) {
                warn!("Couldn't play {}: {}", song, err);
            }
        }
    }
}

impl Inner {
    fn new(ctx: &mut EventCtx, play_music: bool, song: &str) -> Result<Inner> {
        if cfg!(windows) {
            bail!("Audio disabled on Windows: https://github.com/dabreegster/abstreet/issues/430");
        }

        let (stream, stream_handle) = OutputStream::try_default()?;
        let sink = rodio::Sink::try_new(&stream_handle)?;

        let raw_bytes = Cursor::new(abstio::slurp_file(abstio::path(format!(
            "system/assets/music/{}.ogg",
            song
        )))?);
        sink.append(Decoder::new_looped(raw_bytes)?);
        if !play_music {
            sink.set_volume(0.0);
        }

        let panel = Panel::new(
            Checkbox::new(
                play_music,
                Btn::svg_def("system/assets/tools/volume_off.svg").build(ctx, "play music", None),
                Btn::svg_def("system/assets/tools/volume_on.svg").build(ctx, "mute music", None),
            )
            .named("play music")
            .container(),
        )
        .aligned(
            HorizontalAlignment::LeftInset,
            VerticalAlignment::BottomInset,
        )
        .build(ctx);

        Ok(Inner {
            _stream: stream,
            stream_handle,
            sink,
            unmuted_volume: 1.0,
            current_song: song.to_string(),
            panel,
        })
    }

    fn unmute(&mut self) {
        self.sink.set_volume(self.unmuted_volume);
    }

    fn mute(&mut self) {
        self.sink.set_volume(0.0);
    }

    fn specify_volume(&mut self, volume: f32) {
        self.unmuted_volume = volume;
        if self.sink.volume() != 0.0 {
            self.unmute();
        }
    }

    fn change_song(&mut self, song: &str) -> Result<()> {
        if self.current_song == song {
            return Ok(());
        }
        self.current_song = song.to_string();
        let old_volume = self.sink.volume();

        self.sink = rodio::Sink::try_new(&self.stream_handle)?;
        let raw_bytes = Cursor::new(abstio::slurp_file(abstio::path(format!(
            "system/assets/music/{}.ogg",
            song
        )))?);
        self.sink.append(Decoder::new_looped(raw_bytes)?);
        self.sink.set_volume(old_volume);
        Ok(())
    }
}