Skip to main content

oscyl_driver/
sysex.rs

1//! Reassembles complete SysEx messages from a raw MIDI byte stream.
2
3/// Universal device inquiry, all channels. Synths answer with an identity
4/// reply that [`crate::Driver::recognize`] classifies.
5pub const DEVICE_INQUIRY: [u8; 6] = [0xF0, 0x7E, 0x7F, 0x06, 0x01, 0xF7];
6
7/// Collects bytes until a full `F0 … F7` message is available.
8///
9/// Realtime bytes (`F8`–`FF`, such as clock and active sensing) may legally
10/// appear inside a SysEx message and are dropped. Bytes outside a message are
11/// ignored.
12#[derive(Debug, Default)]
13pub struct Framer {
14    buf: Vec<u8>,
15    in_sysex: bool,
16}
17
18impl Framer {
19    /// A framer outside any message.
20    pub fn new() -> Self {
21        Self::default()
22    }
23
24    /// Feed raw bytes; returns every message completed by them.
25    pub fn push(&mut self, bytes: &[u8]) -> Vec<Vec<u8>> {
26        let mut done = Vec::new();
27        for &b in bytes {
28            match b {
29                0xF8.. => {}
30                0xF0 => {
31                    self.buf.clear();
32                    self.buf.push(b);
33                    self.in_sysex = true;
34                }
35                0xF7 if self.in_sysex => {
36                    self.buf.push(b);
37                    done.push(std::mem::take(&mut self.buf));
38                    self.in_sysex = false;
39                }
40                // Any other status byte aborts an unterminated message.
41                0x80.. => {
42                    self.buf.clear();
43                    self.in_sysex = false;
44                }
45                _ if self.in_sysex => self.buf.push(b),
46                _ => {}
47            }
48        }
49        done
50    }
51}
52
53#[cfg(test)]
54mod tests {
55    use super::*;
56
57    #[test]
58    fn drops_realtime_bytes_inside_sysex() {
59        let mut f = Framer::new();
60        let out = f.push(&[0xF0, 0x42, 0xF8, 0x30, 0xFE, 0x01, 0xF7]);
61        assert_eq!(out, vec![vec![0xF0, 0x42, 0x30, 0x01, 0xF7]]);
62    }
63
64    #[test]
65    fn reassembles_split_message() {
66        let mut f = Framer::new();
67        assert!(f.push(&[0x90, 0x40, 0xF0, 0x42]).is_empty());
68        assert!(f.push(&[0x30, 0x00]).is_empty());
69        assert_eq!(
70            f.push(&[0x01, 0xF7, 0xF0]),
71            vec![vec![0xF0, 0x42, 0x30, 0x00, 0x01, 0xF7]]
72        );
73    }
74
75    #[test]
76    fn status_byte_aborts_unterminated_message() {
77        let mut f = Framer::new();
78        assert!(f.push(&[0xF0, 0x42, 0x90, 0x40, 0x7F, 0xF7]).is_empty());
79    }
80}