Skip to main content

RpnTracker

Struct RpnTracker 

Source
pub struct RpnTracker { /* private fields */ }
Expand description

Tracks RPN/NRPN state across all 16 MIDI channels.

This struct is designed for real-time safety:

  • Fixed-size array (no heap allocation)
  • All operations are O(1)
  • Implements Copy for simple value semantics

§Usage

Plugins that need to receive RPN/NRPN messages should store an instance of this tracker in their state and call process_cc for each incoming Control Change event.

struct MyPlugin {
    rpn_tracker: RpnTracker,
}

impl Processor for MyPlugin {
    fn process_midi(&mut self, input: &[MidiEvent], output: &mut MidiBuffer) {
        for event in input {
            if let MidiEventKind::ControlChange(cc) = &event.event {
                if let Some(msg) = self.rpn_tracker.process_cc(cc) {
                    // Handle complete RPN/NRPN message
                    if msg.is_pitch_bend_sensitivity() {
                        let (semitones, cents) = msg.pitch_bend_sensitivity();
                        self.pitch_bend_range = semitones as f32 + cents as f32 / 100.0;
                    }
                }
            }
        }
    }
}

Implementations§

Source§

impl RpnTracker

Source

pub const fn new() -> Self

Create a new RPN tracker with all channels in their default state.

Source

pub fn reset(&mut self)

Reset all channel states.

Source

pub fn reset_channel(&mut self, channel: MidiChannel)

Reset a specific channel’s state.

Source

pub fn process_cc( &mut self, cc: &ControlChange, ) -> Option<ParameterNumberMessage>

Process a Control Change event.

Returns Some(ParameterNumberMessage) when a complete RPN/NRPN message has been assembled from the CC sequence.

§Arguments
  • cc - The Control Change event to process
§Returns
  • None for non-RPN/NRPN CCs or incomplete sequences
  • Some(message) when a complete RPN/NRPN is ready
Source

pub fn current_parameter( &self, channel: MidiChannel, ) -> Option<(ParameterNumberKind, u16)>

Get the currently selected parameter for a channel, if any.

Trait Implementations§

Source§

impl Clone for RpnTracker

Source§

fn clone(&self) -> RpnTracker

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RpnTracker

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RpnTracker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for RpnTracker

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.