rosu_map/section/timing_points/

decode.rs

use crate::{
    decode::{DecodeBeatmap, DecodeState},
    section::{
        general::{CountdownType, GameMode, General, GeneralState, ParseGeneralError},
        hit_objects::hit_samples::{ParseSampleBankError, SampleBank},
    },
    util::{ParseNumber, ParseNumberError, StrExt, MAX_PARSE_VALUE},
    Beatmap,
};

use super::{
    DifficultyPoint, EffectFlags, EffectPoint, ParseEffectFlagsError, SamplePoint, TimeSignature,
    TimeSignatureError, TimingPoint,
};

/// Struct containing all data from a `.osu` file's `[TimingPoints]` and
/// `[General]` section.
#[derive(Clone, Debug, PartialEq)]
pub struct TimingPoints {
    // General
    pub audio_file: String,
    pub audio_lead_in: f64,
    pub preview_time: i32,
    pub default_sample_bank: SampleBank,
    pub default_sample_volume: i32,
    pub stack_leniency: f32,
    pub mode: GameMode,
    pub letterbox_in_breaks: bool,
    pub special_style: bool,
    pub widescreen_storyboard: bool,
    pub epilepsy_warning: bool,
    pub samples_match_playback_rate: bool,
    pub countdown: CountdownType,
    pub countdown_offset: i32,

    // TimingPoints
    pub control_points: ControlPoints,
}

impl Default for TimingPoints {
    fn default() -> Self {
        let general = General::default();

        Self {
            audio_file: general.audio_file,
            audio_lead_in: general.audio_lead_in,
            preview_time: general.preview_time,
            default_sample_bank: general.default_sample_bank,
            default_sample_volume: general.default_sample_volume,
            stack_leniency: general.stack_leniency,
            mode: general.mode,
            letterbox_in_breaks: general.letterbox_in_breaks,
            special_style: general.special_style,
            widescreen_storyboard: general.widescreen_storyboard,
            epilepsy_warning: general.epilepsy_warning,
            samples_match_playback_rate: general.samples_match_playback_rate,
            countdown: general.countdown,
            countdown_offset: general.countdown_offset,
            control_points: ControlPoints::default(),
        }
    }
}

impl From<TimingPoints> for Beatmap {
    fn from(timing_points: TimingPoints) -> Self {
        Self {
            audio_file: timing_points.audio_file,
            audio_lead_in: timing_points.audio_lead_in,
            preview_time: timing_points.preview_time,
            default_sample_bank: timing_points.default_sample_bank,
            default_sample_volume: timing_points.default_sample_volume,
            stack_leniency: timing_points.stack_leniency,
            mode: timing_points.mode,
            letterbox_in_breaks: timing_points.letterbox_in_breaks,
            special_style: timing_points.special_style,
            widescreen_storyboard: timing_points.widescreen_storyboard,
            epilepsy_warning: timing_points.epilepsy_warning,
            samples_match_playback_rate: timing_points.samples_match_playback_rate,
            countdown: timing_points.countdown,
            countdown_offset: timing_points.countdown_offset,
            control_points: timing_points.control_points,
            ..Self::default()
        }
    }
}

/// All control points of a [`Beatmap`].
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ControlPoints {
    pub timing_points: Vec<TimingPoint>,
    pub difficulty_points: Vec<DifficultyPoint>,
    pub effect_points: Vec<EffectPoint>,
    pub sample_points: Vec<SamplePoint>,
}

impl ControlPoints {
    /// Finds the [`DifficultyPoint`] that is active at the given time.
    pub fn difficulty_point_at(&self, time: f64) -> Option<&DifficultyPoint> {
        self.difficulty_points
            .binary_search_by(|probe| probe.time.total_cmp(&time))
            .map_or_else(|i| i.checked_sub(1), Some)
            .map(|i| &self.difficulty_points[i])
    }

    /// Finds the [`EffectPoint`] that is active at the given time.
    pub fn effect_point_at(&self, time: f64) -> Option<&EffectPoint> {
        self.effect_points
            .binary_search_by(|probe| probe.time.total_cmp(&time))
            .map_or_else(|i| i.checked_sub(1), Some)
            .map(|i| &self.effect_points[i])
    }

    /// Finds the [`SamplePoint`] that is active at the given time.
    pub fn sample_point_at(&self, time: f64) -> Option<&SamplePoint> {
        let i = self
            .sample_points
            .binary_search_by(|probe| probe.time.total_cmp(&time))
            .unwrap_or_else(|i| i.saturating_sub(1));

        self.sample_points.get(i)
    }

    /// Finds the [`TimingPoint`] that is active at the given time.
    pub fn timing_point_at(&self, time: f64) -> Option<&TimingPoint> {
        let i = self
            .timing_points
            .binary_search_by(|probe| probe.time.total_cmp(&time))
            .unwrap_or_else(|i| i.saturating_sub(1));

        self.timing_points.get(i)
    }

    /// Add a [`ControlPoint`] into its corresponding list.
    pub fn add<P: ControlPoint<ControlPoints>>(&mut self, point: P) {
        if !point.check_already_existing(self) {
            point.add(self);
        }
    }
}

/// A control point to be added into a collection of type `C`.
pub trait ControlPoint<C> {
    /// Whether `self` is redundant w.r.t. an already existing control point.
    fn check_already_existing(&self, control_points: &C) -> bool;

    /// Adding the control point into the collection.
    ///
    /// Note that control points should be inserted in order by time.
    fn add(self, control_points: &mut C);
}

impl ControlPoint<ControlPoints> for TimingPoint {
    fn check_already_existing(&self, _: &ControlPoints) -> bool {
        false
    }

    fn add(self, control_points: &mut ControlPoints) {
        match control_points
            .timing_points
            .binary_search_by(|probe| probe.time.total_cmp(&self.time))
        {
            Err(i) => control_points.timing_points.insert(i, self),
            Ok(i) => control_points.timing_points[i] = self,
        }
    }
}

impl ControlPoint<ControlPoints> for DifficultyPoint {
    fn check_already_existing(&self, control_points: &ControlPoints) -> bool {
        match control_points.difficulty_point_at(self.time) {
            Some(existing) => self.is_redundant(existing),
            None => self.is_redundant(&DifficultyPoint::default()),
        }
    }

    fn add(self, control_points: &mut ControlPoints) {
        match control_points
            .difficulty_points
            .binary_search_by(|probe| probe.time.total_cmp(&self.time))
        {
            Err(i) => control_points.difficulty_points.insert(i, self),
            Ok(i) => control_points.difficulty_points[i] = self,
        }
    }
}

impl ControlPoint<ControlPoints> for EffectPoint {
    fn check_already_existing(&self, control_points: &ControlPoints) -> bool {
        match control_points.effect_point_at(self.time) {
            Some(existing) => self.is_redundant(existing),
            None => self.is_redundant(&EffectPoint::default()),
        }
    }

    fn add(self, control_points: &mut ControlPoints) {
        match control_points
            .effect_points
            .binary_search_by(|probe| probe.time.total_cmp(&self.time))
        {
            Err(i) => control_points.effect_points.insert(i, self),
            Ok(i) => control_points.effect_points[i] = self,
        }
    }
}

impl ControlPoint<ControlPoints> for SamplePoint {
    fn check_already_existing(&self, control_points: &ControlPoints) -> bool {
        control_points
            .sample_points
            .binary_search_by(|probe| probe.time.total_cmp(&self.time))
            .map_or_else(|i| i.checked_sub(1), Some)
            .map_or(false, |i| {
                self.is_redundant(&control_points.sample_points[i])
            })
    }

    fn add(self, control_points: &mut ControlPoints) {
        match control_points
            .sample_points
            .binary_search_by(|probe| probe.time.total_cmp(&self.time))
        {
            Err(i) => control_points.sample_points.insert(i, self),
            Ok(i) => control_points.sample_points[i] = self,
        }
    }
}

thiserror! {
    /// All the ways that parsing a `.osu` file into [`TimingPoints`] can fail.
    #[derive(Debug)]
    pub enum ParseTimingPointsError {
        #[error("failed to parse effect flags")]
        EffectFlags(#[from] ParseEffectFlagsError),
        #[error("failed to parse general section")]
        General(#[from] ParseGeneralError),
        #[error("invalid line")]
        InvalidLine,
        #[error("failed to parse number")]
        Number(#[from] ParseNumberError),
        #[error("failed to parse sample bank")]
        SampleBank(#[from] ParseSampleBankError),
        #[error("time signature error")]
        TimeSignature(#[from] TimeSignatureError),
        #[error("beat length cannot be NaN in a timing control point")]
        TimingControlPointNaN,
    }
}

/// The parsing state for [`TimingPoints`] in [`DecodeBeatmap`].
pub struct TimingPointsState {
    general: GeneralState,
    pending_control_points_time: f64,
    pending_timing_point: Option<TimingPoint>,
    pending_difficulty_point: Option<DifficultyPoint>,
    pending_effect_point: Option<EffectPoint>,
    pending_sample_point: Option<SamplePoint>,
    control_points: ControlPoints,
}

impl TimingPointsState {
    pub(crate) const fn mode(&self) -> GameMode {
        self.general.mode
    }
}

trait Pending: Sized {
    fn pending(state: &mut TimingPointsState) -> &mut Option<Self>;

    fn push_front(self, state: &mut TimingPointsState) {
        let pending = Self::pending(state);

        if pending.is_none() {
            *pending = Some(self);
        }
    }

    fn push_back(self, state: &mut TimingPointsState) {
        *Self::pending(state) = Some(self);
    }
}

impl Pending for TimingPoint {
    fn pending(state: &mut TimingPointsState) -> &mut Option<Self> {
        &mut state.pending_timing_point
    }
}

impl Pending for DifficultyPoint {
    fn pending(state: &mut TimingPointsState) -> &mut Option<Self> {
        &mut state.pending_difficulty_point
    }
}

impl Pending for EffectPoint {
    fn pending(state: &mut TimingPointsState) -> &mut Option<Self> {
        &mut state.pending_effect_point
    }
}

impl Pending for SamplePoint {
    fn pending(state: &mut TimingPointsState) -> &mut Option<Self> {
        &mut state.pending_sample_point
    }
}

impl TimingPointsState {
    fn add_control_point<P: Pending>(&mut self, time: f64, point: P, timing_change: bool) {
        if (time - self.pending_control_points_time).abs() >= f64::EPSILON {
            self.flush_pending_points();
        }

        if timing_change {
            point.push_front(self);
        } else {
            point.push_back(self);
        }

        self.pending_control_points_time = time;
    }

    fn flush_pending_points(&mut self) {
        if let Some(point) = self.pending_timing_point.take() {
            self.control_points.add(point);
        }

        if let Some(point) = self.pending_difficulty_point.take() {
            self.control_points.add(point);
        }

        if let Some(point) = self.pending_effect_point.take() {
            self.control_points.add(point);
        }

        if let Some(point) = self.pending_sample_point.take() {
            self.control_points.add(point);
        }
    }
}

impl DecodeState for TimingPointsState {
    fn create(version: i32) -> Self {
        Self {
            general: GeneralState::create(version),
            pending_control_points_time: 0.0,
            pending_timing_point: None,
            pending_difficulty_point: None,
            pending_effect_point: None,
            pending_sample_point: None,
            control_points: ControlPoints::default(),
        }
    }
}

impl From<TimingPointsState> for TimingPoints {
    fn from(mut state: TimingPointsState) -> Self {
        state.flush_pending_points();

        Self {
            audio_file: state.general.audio_file,
            audio_lead_in: state.general.audio_lead_in,
            preview_time: state.general.preview_time,
            default_sample_bank: state.general.default_sample_bank,
            default_sample_volume: state.general.default_sample_volume,
            stack_leniency: state.general.stack_leniency,
            mode: state.general.mode,
            letterbox_in_breaks: state.general.letterbox_in_breaks,
            special_style: state.general.special_style,
            widescreen_storyboard: state.general.widescreen_storyboard,
            epilepsy_warning: state.general.epilepsy_warning,
            samples_match_playback_rate: state.general.samples_match_playback_rate,
            countdown: state.general.countdown,
            countdown_offset: state.general.countdown_offset,
            control_points: state.control_points,
        }
    }
}

impl DecodeBeatmap for TimingPoints {
    type Error = ParseTimingPointsError;
    type State = TimingPointsState;

    fn parse_general(state: &mut Self::State, line: &str) -> Result<(), Self::Error> {
        General::parse_general(&mut state.general, line).map_err(ParseTimingPointsError::General)
    }

    fn parse_editor(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_metadata(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_difficulty(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_events(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_timing_points(state: &mut Self::State, line: &str) -> Result<(), Self::Error> {
        let mut split = line.trim_comment().split(',');

        let (time, beat_len) = split
            .next()
            .zip(split.next())
            .ok_or(ParseTimingPointsError::InvalidLine)?;

        let time = time.parse_num::<f64>()?;

        // Manual `str::parse_num::<f64>` so that NaN does not cause an error
        let beat_len = beat_len
            .trim()
            .parse::<f64>()
            .map_err(ParseNumberError::InvalidFloat)?;

        if beat_len < f64::from(-MAX_PARSE_VALUE) {
            return Err(ParseNumberError::NumberUnderflow.into());
        } else if beat_len > f64::from(MAX_PARSE_VALUE) {
            return Err(ParseNumberError::NumberOverflow.into());
        }

        let speed_multiplier = if beat_len < 0.0 {
            100.0 / -beat_len
        } else {
            1.0
        };

        let mut time_signature = TimeSignature::new_simple_quadruple();

        if let Some(next) = split.next() {
            if !matches!(next.chars().next(), Some('0')) {
                time_signature = TimeSignature::new(next.parse_num()?)?;
            }
        }

        let mut sample_set = split
            .next()
            .map(i32::parse)
            .transpose()?
            .map(SampleBank::try_from)
            .and_then(Result::ok)
            .unwrap_or(state.general.default_sample_bank);

        let custom_sample_bank = split.next().map(i32::parse).transpose()?.unwrap_or(0);

        let sample_volume = split
            .next()
            .map(i32::parse)
            .transpose()?
            .unwrap_or(state.general.default_sample_volume);

        let timing_change = split
            .next()
            .map_or(true, |next| matches!(next.chars().next(), Some('1')));

        let mut kiai_mode = false;
        let mut omit_first_bar_signature = false;

        if let Some(next) = split.next() {
            let effect_flags: EffectFlags = next.parse()?;
            kiai_mode = effect_flags.has_flag(EffectFlags::KIAI);
            omit_first_bar_signature = effect_flags.has_flag(EffectFlags::OMIT_FIRST_BAR_LINE);
        }

        if sample_set == SampleBank::None {
            sample_set = SampleBank::Normal;
        }

        if timing_change {
            if beat_len.is_nan() {
                return Err(ParseTimingPointsError::TimingControlPointNaN);
            }

            let timing = TimingPoint::new(time, beat_len, omit_first_bar_signature, time_signature);
            state.add_control_point(time, timing, timing_change);
        }

        let difficulty = DifficultyPoint::new(time, beat_len, speed_multiplier);
        state.add_control_point(time, difficulty, timing_change);

        let sample = SamplePoint::new(time, sample_set, sample_volume, custom_sample_bank);
        state.add_control_point(time, sample, timing_change);

        let mut effect = EffectPoint::new(time, kiai_mode);

        if matches!(state.general.mode, GameMode::Taiko | GameMode::Mania) {
            effect.scroll_speed = speed_multiplier.clamp(0.01, 10.0);
        }

        state.add_control_point(time, effect, timing_change);

        state.pending_control_points_time = time;

        Ok(())
    }

    fn parse_colors(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_hit_objects(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_variables(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_catch_the_beat(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }

    fn parse_mania(_: &mut Self::State, _: &str) -> Result<(), Self::Error> {
        Ok(())
    }
}