Enum wmidi::MidiMessage
source · pub enum MidiMessage<'a> {
Show 20 variants
NoteOff(Channel, Note, Velocity),
NoteOn(Channel, Note, Velocity),
PolyphonicKeyPressure(Channel, Note, Velocity),
ControlChange(Channel, ControlFunction, ControlValue),
ProgramChange(Channel, ProgramNumber),
ChannelPressure(Channel, Velocity),
PitchBendChange(Channel, PitchBend),
SysEx(&'a [U7]),
OwnedSysEx(Vec<U7>),
MidiTimeCode(U7),
SongPositionPointer(SongPosition),
SongSelect(Song),
Reserved(u8),
TuneRequest,
TimingClock,
Start,
Continue,
Stop,
ActiveSensing,
Reset,
}
Expand description
Holds information based on the Midi 1.0 spec.
Variants§
NoteOff(Channel, Note, Velocity)
This message is sent when a note is released (ended).
NoteOn(Channel, Note, Velocity)
This message is sent when a note is depressed (start).
PolyphonicKeyPressure(Channel, Note, Velocity)
This message is most often sent by pressing down on the key after it “bottoms out”.
ControlChange(Channel, ControlFunction, ControlValue)
This message is sent when a controller value changes. Controllers include devices such as pedals and levers.
Controller numbers 120-127 are reserved as “Channel Mode Messages”.
ProgramChange(Channel, ProgramNumber)
This message is sent when the patch number changes.
ChannelPressure(Channel, Velocity)
This message is most often sent by pressing down on the key after it “bottoms out”. This message is different from polyphonic after-touch. Use this message to send the single greatest pressure value (of all the current depressed keys).
PitchBendChange(Channel, PitchBend)
This message is sent to indicate a change in the pitch bender (wheel or level, typically). The pitch bender is measured by a fourteen bit value. Center is 8192.
SysEx(&'a [U7])
This message type allows manufacturers to create their own messages (such as bulk dumps, patch parameters, and other non-spec data) and provides a mechanism for creating additional MIDI Specification messages.
In the data held by the SysEx message, the Manufacturer’s ID code (assigned by MMA or AMEI) is either 1 byte or 3 bytes. Two of the 1 Byte IDs are reserved for extensions called Universal Exclusive Messages, which are not manufacturer-specific. If a device recognizes the ID code as its own (or as a supported Universal message) it will listen to the rest of the message. Otherwise the message will be ignored.
OwnedSysEx(Vec<U7>)
This message type allows manufacturers to create their own messages (such as bulk dumps, patch parameters, and other non-spec data) and provides a mechanism for creating additional MIDI Specification messages.
In the data held by the SysEx message, the Manufacturer’s ID code (assigned by MMA or AMEI) is either 1 byte or 3 bytes. Two of the 1 Byte IDs are reserved for extensions called Universal Exclusive Messages, which are not manufacturer-specific. If a device recognizes the ID code as its own (or as a supported Universal message) it will listen to the rest of the message. Otherwise the message will be ignored.
MidiTimeCode(U7)
MIDI Time Code Quarter Frame.
The data is in the format 0nnndddd where nnn is the Message Type and dddd is the Value.
TODO: Interpret data instead of providing the raw format.
SongPositionPointer(SongPosition)
This is an internal 14 bit value that holds the number of MIDI beats (1 beat = six MIDI clocks) since the start of the song.
SongSelect(Song)
The Song Select specifies which sequence or song is to be played.
Reserved(u8)
The u8 data holds the status byte.
TuneRequest
Upon receiving a Tune Request, all analog synthesizers should tune their oscillators.
TimingClock
Timing Clock. Sent 24 times per quarter note when synchronization is required.
Start
Start the current sequence playing. (This message will be followed with Timing Clocks).
Continue
Continue at the point the sequence was Stopped.
Stop
Stop the current sequence.
ActiveSensing
This message is intended to be sent repeatedly to tell the receiver that a connection is alive. Use of this message is optional. When initially received, the receiver will expect to receive another Active Sensing message each 300ms (max), and if it idoes not, then it will assume that the connection has been terminated. At termination, the receiver will turn off all voices and return to normal (non-active sensing) operation.
Reset
Reset all receivers in the system to power-up status. This should be used sparingly, preferably under manual control. In particular, it should not be sent on power-up.
Implementations§
source§impl<'a> MidiMessage<'a>
impl<'a> MidiMessage<'a>
sourcepub fn from_bytes(bytes: &'a [u8]) -> Result<Self, Error>
pub fn from_bytes(bytes: &'a [u8]) -> Result<Self, Error>
Construct a midi message from bytes.
sourcepub fn copy_to_slice(&self, slice: &mut [u8]) -> Result<usize, ToSliceError>
pub fn copy_to_slice(&self, slice: &mut [u8]) -> Result<usize, ToSliceError>
Copies the message as bytes to slice. If slice does not have enough capacity to fit the
message, then an error is returned. On success, the number of bytes written will be
returned. This should be the same number obtained from self.bytes_size()
.
sourcepub fn drop_unowned_sysex(self) -> Option<MidiMessage<'static>>
pub fn drop_unowned_sysex(self) -> Option<MidiMessage<'static>>
Return Some(midi_message)
if self
is not a SysEx message, or None
if it is. This expands the lifetime of
the MidiMessage
from 'a
to 'static
.
sourcepub fn to_owned(&self) -> MidiMessage<'static> ⓘ
pub fn to_owned(&self) -> MidiMessage<'static> ⓘ
Take ownership of the SysEx data. This expands the lifetime of the message to 'static
. If 'static
lifetime
is needed but SysEx messages can be dropped, consider using self.drop_unowned_sysex()
.
sourcepub fn bytes_size(&self) -> usize
pub fn bytes_size(&self) -> usize
The number of bytes the MIDI message takes when converted to bytes.
sourcepub fn wire_size(&self) -> usize
👎Deprecated since 3.1.0: Function has been renamed to MidiMessage::bytes_size().
pub fn wire_size(&self) -> usize
The number of bytes the MIDI message takes when encoded with the std::io::Read
trait.
Trait Implementations§
source§impl<'a> Clone for MidiMessage<'a>
impl<'a> Clone for MidiMessage<'a>
source§impl<'a> Debug for MidiMessage<'a>
impl<'a> Debug for MidiMessage<'a>
source§impl<'a> PartialEq for MidiMessage<'a>
impl<'a> PartialEq for MidiMessage<'a>
source§fn eq(&self, other: &MidiMessage<'a>) -> bool
fn eq(&self, other: &MidiMessage<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> Read for MidiMessage<'a>
impl<'a> Read for MidiMessage<'a>
source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
1.36.0 · source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
buf
. Read more1.0.0 · source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read more