midi-io 0.2.1

Stream and send strictly-typed MIDI messages
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

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct VirtualPortId(pub(crate) u64);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct PortId(pub(crate) u64);

impl PortId {
    /// The handle's raw value, for storing a reference to a port and matching
    /// it against [`Source::id`] or [`Destination::id`] in a later session.
    ///
    /// How long the value names the same port depends on the backend:
    ///
    /// - CoreMIDI: the endpoint's `kMIDIPropertyUniqueID`, which the system
    ///   persists across launches.
    /// - ALSA: `(client_id << 32) | port_id`; the kernel assigns client numbers
    ///   at registration, so the value can change when a device is reconnected.
    /// - Web MIDI: a hash of the browser's `MIDIPort.id`, as stable as the
    ///   browser keeps that id.
    pub fn to_bits(self) -> u64 {
        self.0
    }
}

/// A source is a sender of MIDI messages.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Source {
    pub(crate) id: PortId,
    pub(crate) name: String,
    pub(crate) is_virtual: bool,
}

impl Source {
    pub fn id(&self) -> PortId {
        self.id
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn is_virtual(&self) -> bool {
        self.is_virtual
    }
}

/// Indicates when available sources have changed
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SourceChange {
    Added(Source),
    Removed(Source),
}

/// A destination is a receiver of MIDI messages.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Destination {
    pub(crate) id: PortId,
    pub(crate) name: String,
    pub(crate) is_virtual: bool,
}

impl Destination {
    pub fn id(&self) -> PortId {
        self.id
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn is_virtual(&self) -> bool {
        self.is_virtual
    }
}

/// Indicates when available destinations have changed
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum DestinationChange {
    Added(Destination),
    Removed(Destination),
}