Enum midi_msg::ControlChange

pub enum ControlChange {
    CC {
        control: u8,
        value: u8,
    },
    CCHighRes {
        control1: u8,
        control2: u8,
        value: u16,
    },
    BankSelect(u16),
    ModWheel(u16),
    Breath(u16),
    Foot(u16),
    Portamento(u16),
    Volume(u16),
    Balance(u16),
    Pan(u16),
    Expression(u16),
    Effect1(u16),
    Effect2(u16),
    GeneralPurpose1(u16),
    GeneralPurpose2(u16),
    GeneralPurpose3(u16),
    GeneralPurpose4(u16),
    GeneralPurpose5(u8),
    GeneralPurpose6(u8),
    GeneralPurpose7(u8),
    GeneralPurpose8(u8),
    Hold(u8),
    Hold2(u8),
    TogglePortamento(bool),
    Sostenuto(u8),
    SoftPedal(u8),
    ToggleLegato(bool),
    SoundVariation(u8),
    Timbre(u8),
    ReleaseTime(u8),
    AttackTime(u8),
    Brightness(u8),
    DecayTime(u8),
    VibratoRate(u8),
    VibratoDepth(u8),
    VibratoDelay(u8),
    SoundControl1(u8),
    SoundControl2(u8),
    SoundControl3(u8),
    SoundControl4(u8),
    SoundControl5(u8),
    SoundControl6(u8),
    SoundControl7(u8),
    SoundControl8(u8),
    SoundControl9(u8),
    SoundControl10(u8),
    HighResVelocity(u8),
    PortamentoControl(u8),
    Effects1Depth(u8),
    Effects2Depth(u8),
    Effects3Depth(u8),
    Effects4Depth(u8),
    Effects5Depth(u8),
    ReverbSendLevel(u8),
    TremoloDepth(u8),
    ChorusSendLevel(u8),
    CelesteDepth(u8),
    PhaserDepth(u8),
    Parameter(Parameter),
    DataEntry(u16),
    DataEntry2(u8, u8),
    DataIncrement(u8),
    DataDecrement(u8),
}

Used by ChannelVoiceMsg::ControlChange to modify sounds. Each control targets a particular ControlNumber, the meaning of which is given by convention.

When deserializing and complex_cc is false (the default), only ControlChange::CC values are returned. “Simple” CC values represent the control parameter with a number, while “complex” variants capture the semantics of the spec. Simple can be turned into their complex counterparts using the to_complex method, or vis-versa using the to_simple and to_simple_high_res methods.

Variants

CC

“Simple” Control Change message.

Control number may be any valid Midi CC Control number. May not be > 119.

Fields

control: u8

value: u8

0-127

CCHighRes

“Simple” high-resolution Control Change message.

control1 is associated with the MSB of the value, control2 with the LSB. Neither controls may be > 119.

Fields

control1: u8

control2: u8

value: u16

0-16383

BankSelect(u16)

0-16383

ModWheel(u16)

0-16383

Breath(u16)

0-16383

Foot(u16)

0-16383

Portamento(u16)

0-16383

Volume(u16)

0-16383

Balance(u16)

0-16383

Pan(u16)

0-16383

Expression(u16)

0-16383

Effect1(u16)

0-16383

Effect2(u16)

0-16383

GeneralPurpose1(u16)

0-16383

GeneralPurpose2(u16)

0-16383

GeneralPurpose3(u16)

0-16383

GeneralPurpose4(u16)

0-16383

GeneralPurpose5(u8)

0-127

GeneralPurpose6(u8)

0-127

GeneralPurpose7(u8)

0-127

GeneralPurpose8(u8)

0-127

Hold(u8)

0-127

Hold2(u8)

0-127

TogglePortamento(bool)

Turn portamento on or off

Sostenuto(u8)

0-127

SoftPedal(u8)

0-127

ToggleLegato(bool)

Turn legato on or off

SoundVariation(u8)

Same as SoundControl1

Timbre(u8)

Same as SoundControl2

ReleaseTime(u8)

Same as SoundControl3

AttackTime(u8)

Same as SoundControl4

Brightness(u8)

Same as SoundControl5, and used as the MPE “third dimension” (usually Timbre) control (RP-021, RP-053)

DecayTime(u8)

Same as SoundControl6 (RP-021)

VibratoRate(u8)

Same as SoundControl7 (RP-021)

VibratoDepth(u8)

Same as SoundControl8 (RP-021)

VibratoDelay(u8)

Same as SoundControl9 (RP-021)

SoundControl1(u8)

0-127

SoundControl2(u8)

0-127

SoundControl3(u8)

0-127

SoundControl4(u8)

0-127

SoundControl5(u8)

0-127

SoundControl6(u8)

0-127

SoundControl7(u8)

0-127

SoundControl8(u8)

0-127

SoundControl9(u8)

0-127

SoundControl10(u8)

0-127

HighResVelocity(u8)

Used as the LSB of the velocity for the next note on/off message, 0-127. Defined in CA-031

PortamentoControl(u8)

0-127

Effects1Depth(u8)

0-127

Effects2Depth(u8)

0-127

Effects3Depth(u8)

0-127

Effects4Depth(u8)

0-127

Effects5Depth(u8)

0-127

ReverbSendLevel(u8)

Same as Effects1Depth (RP-023)

TremoloDepth(u8)

Same as Effects2Depth

ChorusSendLevel(u8)

Same as Effects3Depth (RP-023)

CelesteDepth(u8)

Same as Effects4Depth

PhaserDepth(u8)

Same as Effects5Depth

Parameter(Parameter)

Registered and Unregistered Parameters

DataEntry(u16)

Set the value of the last-set Parameter. 0-16383

DataEntry2(u8, u8)

Set the MSB and LSB of the last-set parameter separately.

DataIncrement(u8)

Increment the value of the last-set Parameter. 0-127

DataDecrement(u8)

Decrement the value of the last-set Parameter. 0-127

Implementations

impl ControlChange

pub fn to_complex(&self) -> Self

pub fn to_simple(&self) -> Self

pub fn to_simple_high_res(&self) -> Self

pub fn control(&self) -> u8

pub fn value(&self) -> u8

The value of the control change, 0-127. Will be 0 for ControlChange::Parameter.

pub fn value_high_res(&self) -> u16

The 14-bit value of the control change. Non-high-res parameters are scaled to 14 bits. Will be 0 for ControlChange::Parameter.

pub fn to_midi_running(&self) -> Vec<u8>

pub fn extend_midi_running(&self, v: &mut Vec<u8>)

Trait Implementations

impl Clone for ControlChange

fn clone(&self) -> ControlChange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlChange

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

Formats the value using the given formatter.

impl PartialEq for ControlChange

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ControlChange

impl Eq for ControlChange

impl StructuralPartialEq for ControlChange