Struct MpeState 

pub struct MpeState { /* private fields */ }

MPE state for one MIDI input stream (typically one track).

Implementations

impl MpeState

pub fn new() -> Self

Create a fresh, inactive MPE state.

pub fn lower(&self) -> Option<&MpeZone>

Returns the Lower Zone if configured.

pub fn upper(&self) -> Option<&MpeZone>

Returns the Upper Zone if configured.

pub fn zone_for_channel(&self, channel: u8) -> Option<&MpeZone>

Returns the zone (lower or upper) that channel belongs to, if any.

pub fn is_manager_channel(&self, channel: u8) -> bool

Returns true if channel is a Manager Channel in any configured zone.

pub fn is_member_channel(&self, channel: u8) -> bool

Returns true if channel is a Member Channel in any configured zone.

pub fn is_active(&self) -> bool

Returns true if any MPE zone is active.

pub fn active_zone(&self) -> Option<&MpeZone>

Returns the active zone to use for voice allocation. When both zones are configured the Lower Zone is preferred because it is the most common setup; callers that need both zones can inspect [lower] and [upper] directly.

pub fn configure_zone(&mut self, manager_channel: u8, member_count: u8)

Configure a zone from an MPE Configuration Message.

manager_channel is the 0-based channel on which the MCM was received (must be 0 for Lower Zone or 15 for Upper Zone). member_count is the value sent with CC#6 (0..=15). A count of zero deactivates the zone.

If the new zone overlaps an existing zone, the new zone steals the channels and the old zone is deactivated if it is left with no members, per MPE v1.1 Appendix B.

pub fn set_pitch_bend_sensitivity(&mut self, channel: u8, semitones: u8)

Set Pitch Bend Sensitivity from an RPN #0 message.

channel is the 0-based channel on which the RPN was received. semitones is the MSB value (CC#6). The cent value (CC#38) is ignored for now; MPE recommends integer semitones.

pub fn feed(&mut self, data: &[u8]) -> Option<u8>

Feed one raw MIDI event into the MPE state machine.

Returns the channel that was affected if the event was an MCM or RPN message that changed state. This is mostly useful for tests and logging.

Trait Implementations

impl Clone for MpeState

fn clone(&self) -> MpeState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MpeState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MpeState

fn default() -> MpeState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MpeState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MpeState

impl PartialEq for MpeState

fn eq(&self, other: &MpeState) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for MpeState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MpeState