ptcow 0.2.1

Library for editing and playback of PxTone (.ptcop) music
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use crate::{
    result::{ProjectReadError, ReadResult},
    timing::{Meas, Tick, Timing, meas_to_tick, tick_to_meas},
};

/// Timing and loop points
pub struct Master {
    /// The timing data of the song
    pub timing: Timing,
    /// Loop points
    pub loop_points: LoopPoints,
    pub(crate) meas_num: Meas,
}

#[derive(Default)]
pub struct LoopPoints {
    /// The last [`Meas`] the song plays before ending or repeating
    pub last: Meas,
    /// The [`Meas`] the song starts playing from when looped.
    pub repeat: Meas,
}

impl Default for Master {
    fn default() -> Self {
        Self {
            timing: Timing::default(),
            loop_points: LoopPoints::default(),
            meas_num: 1,
        }
    }
}

impl Master {
    pub(crate) fn get_last_tick(&self) -> Tick {
        meas_to_tick(self.loop_points.last, self.timing)
    }

    pub(crate) const fn get_play_meas(&self) -> Meas {
        if self.loop_points.last != 0 {
            self.loop_points.last
        } else {
            self.meas_num
        }
    }

    pub(crate) fn adjust_meas_num(&mut self, tick: Tick) {
        self.meas_num = std::cmp::max(self.meas_num, tick_to_meas(tick, self.timing));
        if self.loop_points.repeat >= self.meas_num {
            self.loop_points.repeat = 0;
        }
        if self.loop_points.last > self.meas_num {
            self.loop_points.last = self.meas_num;
        }
    }

    pub(crate) fn read_v5(rd: &mut crate::io::Reader) -> ReadResult<Self> {
        let size = rd.next::<u32>()?;
        if size != 15 {
            return Err(ProjectReadError::FmtUnknown);
        }
        let beat_clock = rd.next::<u16>()?;
        let beat_num = rd.next::<u8>()?;
        let beat_tempo = rd.next::<f32>()?;
        let clock_repeat = rd.next::<u32>()?;
        let clock_last = rd.next::<u32>()?;

        let timing = Timing {
            ticks_per_beat: beat_clock,
            bpm: beat_tempo,
            beats_per_meas: beat_num,
        };

        let loop_points = LoopPoints {
            repeat: clock_repeat / u32::from(u16::from(beat_num) * beat_clock),
            last: clock_last / u32::from(u16::from(beat_num) * beat_clock),
        };

        Ok(Self {
            timing,
            loop_points,
            meas_num: 1,
        })
    }

    pub(crate) fn write_v5(&self, out: &mut Vec<u8>) {
        let size: u32 = 15;
        out.extend_from_slice(&size.to_le_bytes());
        out.extend_from_slice(&self.timing.ticks_per_beat.to_le_bytes());
        out.extend_from_slice(&self.timing.beats_per_meas.to_le_bytes());
        out.extend_from_slice(&self.timing.bpm.to_le_bytes());
        let clock_repeat: u32 = meas_to_tick(self.loop_points.repeat, self.timing);
        let clock_last: u32 = meas_to_tick(self.loop_points.last, self.timing);
        out.extend_from_slice(&clock_repeat.to_le_bytes());
        out.extend_from_slice(&clock_last.to_le_bytes());
    }
}