qualia_audio/midi/sync/
mtc.rs1use crate::types::AudioError;
13
14#[derive(Debug, Clone, Copy, PartialEq, Eq)]
16pub enum FrameRate {
17 Fps24,
19 Fps25,
21 Fps2997Drop,
23 Fps30,
25}
26
27impl FrameRate {
28 #[inline]
30 pub const fn code(self) -> u8 {
31 match self {
32 FrameRate::Fps24 => 0,
33 FrameRate::Fps25 => 1,
34 FrameRate::Fps2997Drop => 2,
35 FrameRate::Fps30 => 3,
36 }
37 }
38
39 #[inline]
41 pub const fn from_code(code: u8) -> FrameRate {
42 match code & 0b11 {
43 0 => FrameRate::Fps24,
44 1 => FrameRate::Fps25,
45 2 => FrameRate::Fps2997Drop,
46 _ => FrameRate::Fps30,
47 }
48 }
49
50 #[inline]
52 pub const fn frames_per_second(self) -> u8 {
53 match self {
54 FrameRate::Fps24 => 24,
55 FrameRate::Fps25 => 25,
56 FrameRate::Fps2997Drop | FrameRate::Fps30 => 30,
57 }
58 }
59}
60
61#[derive(Debug, Clone, Copy, PartialEq, Eq)]
63pub struct Timecode {
64 pub hours: u8,
66 pub minutes: u8,
68 pub seconds: u8,
70 pub frames: u8,
72 pub rate: FrameRate,
74}
75
76impl Timecode {
77 pub fn new(
79 hours: u8,
80 minutes: u8,
81 seconds: u8,
82 frames: u8,
83 rate: FrameRate,
84 ) -> Result<Self, AudioError> {
85 if hours > 23 || minutes > 59 || seconds > 59 || frames >= rate.frames_per_second() {
86 return Err(AudioError::InvalidParameter);
87 }
88 Ok(Self {
89 hours,
90 minutes,
91 seconds,
92 frames,
93 rate,
94 })
95 }
96}
97
98pub fn encode_quarter_frames(tc: Timecode) -> [u8; 8] {
101 let nibbles = [
102 tc.frames & 0x0F, (tc.frames >> 4) & 0x0F, tc.seconds & 0x0F, (tc.seconds >> 4) & 0x0F, tc.minutes & 0x0F, (tc.minutes >> 4) & 0x0F, tc.hours & 0x0F, ((tc.hours >> 4) & 0x01) | (tc.rate.code() << 1), ];
111 let mut out = [0u8; 8];
112 let mut i = 0;
113 while i < 8 {
114 out[i] = ((i as u8) << 4) | (nibbles[i] & 0x0F);
115 i += 1;
116 }
117 out
118}
119
120pub fn decode_quarter_frames(data: &[u8; 8]) -> Result<Timecode, AudioError> {
126 let mut nibbles = [0u8; 8];
127 let mut seen = [false; 8];
128 for &b in data.iter() {
129 let idx = (b >> 4) as usize;
130 if idx >= 8 || seen[idx] {
131 return Err(AudioError::InvalidParameter);
132 }
133 seen[idx] = true;
134 nibbles[idx] = b & 0x0F;
135 }
136 if seen.iter().any(|&s| !s) {
137 return Err(AudioError::InvalidParameter);
138 }
139 let frames = nibbles[0] | (nibbles[1] << 4);
140 let seconds = nibbles[2] | (nibbles[3] << 4);
141 let minutes = nibbles[4] | (nibbles[5] << 4);
142 let rate = FrameRate::from_code(nibbles[7] >> 1);
143 let hours = nibbles[6] | ((nibbles[7] & 0x01) << 4);
144 Timecode::new(hours, minutes, seconds, frames, rate)
145}
146
147#[cfg(test)]
148mod tests {
149 use super::*;
150
151 #[test]
152 fn golden_round_trip() {
153 let tc = Timecode::new(17, 42, 53, 12, FrameRate::Fps25).unwrap();
154 let bytes = encode_quarter_frames(tc);
155 let back = decode_quarter_frames(&bytes).unwrap();
156 assert_eq!(tc, back);
157 }
158
159 #[test]
160 fn round_trip_hour_high_bit() {
161 let tc = Timecode::new(23, 59, 59, 29, FrameRate::Fps30).unwrap();
163 let bytes = encode_quarter_frames(tc);
164 assert_eq!(decode_quarter_frames(&bytes).unwrap(), tc);
165 }
166
167 #[test]
168 fn rate_preserved() {
169 for rate in [
170 FrameRate::Fps24,
171 FrameRate::Fps25,
172 FrameRate::Fps2997Drop,
173 FrameRate::Fps30,
174 ] {
175 let tc = Timecode::new(1, 2, 3, 4, rate).unwrap();
176 assert_eq!(
177 decode_quarter_frames(&encode_quarter_frames(tc))
178 .unwrap()
179 .rate,
180 rate
181 );
182 }
183 }
184
185 #[test]
186 fn rejects_duplicate_piece() {
187 let mut bytes = encode_quarter_frames(Timecode::new(1, 2, 3, 4, FrameRate::Fps24).unwrap());
188 bytes[1] = bytes[0]; assert_eq!(
190 decode_quarter_frames(&bytes),
191 Err(AudioError::InvalidParameter)
192 );
193 }
194
195 #[test]
196 fn rejects_out_of_range_field() {
197 assert!(Timecode::new(24, 0, 0, 0, FrameRate::Fps24).is_err());
198 assert!(Timecode::new(0, 0, 0, 24, FrameRate::Fps24).is_err());
199 }
200}