lighthouse-protocol 6.2.1

Protocol types for Project Lighthouse
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

use serde::{Deserialize, Serialize};

use super::EventSource;

/// A MIDI message event.
#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
pub struct MidiEvent {
    /// The client identifier. Also unique per MIDI input device.
    pub source: EventSource,
    /// The binary MIDI message.
    /// 
    /// The first byte is a status byte (first/most significant bit = 1), the
    /// remaining bytes are data bytes (first/most significant bit = 0).
    /// 
    /// To give a simple example, pressing C5 on a MIDI keyboard would generate the
    /// following message:
    /// 
    /// ```plaintext
    ///     [0x90,     0x48,     0x64]
    ///      Ch.1    Note 72   Velocity 100
    ///     NoteOn   i.e. C5
    /// ```
    /// 
    /// The note values can be looked up online:
    /// 
    /// - https://www.phys.unsw.edu.au/jw/notes.html
    /// 
    /// Same goes for a full description of the packet structure:
    /// 
    /// - https://www.w3.org/TR/webmidi/#terminology
    /// - http://www.opensound.com/pguide/midi/midi5.html
    /// - https://www.songstuff.com/recording/article/midi-message-format/
    #[serde(with = "serde_bytes")]
    pub data: Vec<u8>,
}