midi-msg 0.8.2

A (eventually) complete representation of the MIDI 1.0 Detailed Specification and its many extensions and addenda, allowing for the serialization and deserialization of MIDI byte streams to and from a typed representation.
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

use super::{MidiMsg, TimeCode, TimeCodeType};

/// Passed to [`MidiMsg::from_midi_with_context`](crate::MidiMsg::from_midi_with_context) to allow
/// for the capture and use of captured context while reading from a MIDI stream.
///
/// This is used to allow for the formation of fully formed `MidiMsg`s when either a running
/// status is being employed, or when using 14-bit [`ControlChange`](crate::ControlChange) messages.
///
/// It's also used to track the current [`TimeCode`](crate::TimeCode)
/// as sent through [`SystemCommonMsg::TimeCodeQuarterFrame`](crate::SystemCommonMsg::TimeCodeQuarterFrame1)
/// messages, or [`UniversalRealTimeMsg::TimeCodeFull`](crate::UniversalRealTimeMsg::TimeCodeFull)
/// messages.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ReceiverContext {
    pub(crate) previous_channel_message: Option<MidiMsg>,
    pub(crate) time_code: TimeCode,
    pub(crate) is_smf_sysex: bool,
    pub(crate) parsing_smf: bool,
    /// If true, CC messages will be treated as complex CC messages, with their semantics taken from the Midi spec. Otherwise, they will be treated as simple CC messages - i.e. [`ControlChange::CC`](crate::ControlChange::CC).
    pub complex_cc: bool,
}

impl ReceiverContext {
    pub const fn new() -> Self {
        Self {
            previous_channel_message: None,
            time_code: TimeCode {
                frames: 0,
                seconds: 0,
                minutes: 0,
                hours: 0,
                code_type: TimeCodeType::NDF30,
            },
            is_smf_sysex: false,
            parsing_smf: false,
            complex_cc: false,
        }
    }

    /// Interpret CC messages as complex CC messages.
    pub fn complex_cc(mut self) -> Self {
        self.complex_cc = true;
        self
    }

    #[cfg(feature = "file")]
    pub(crate) fn parsing_smf(mut self) -> Self {
        self.parsing_smf = true;
        self
    }
}