Crate midi_msg[−][src]

This is a library for serializing and deserializing MIDI (byte) streams.

MidiMsg is the starting point for all MIDI messages. All MidiMsgs can be serialized into a valid MIDI sequence. You can create a MidiMsg and turn it into a Vec<u8> like so:

use midi_msg::*;

MidiMsg::ChannelVoice {
    channel: Channel::Ch1,
    msg: ChannelVoiceMsg::NoteOn {
        note: 60,
        velocity: 127
    }
}
.to_midi();

See the readme for a list of the MIDI Manufacturer Association documents that are referenced throughout these docs.

Structs

ChannelBitMap	The set of channels to apply this tuning message to. Used by `ScaleTuning1Byte` and `ScaleTuning2Byte`.
ControlChangeControllerDestination	Allows for the selection of the destination of a control change message. Used by `UniversalRealTimeMsg::GlobalParameterControl`.
ControllerDestination	Allows for the selection of the destination of a channel pressure/poly key pressure message. Used by `UniversalRealTimeMsg`.
GlobalParameter	An `id`:`value` pair that must line up with the `GlobalParameterControl` that it is placed in.
GlobalParameterControl	Global Parameter Control, to control parameters on a device that affect all sound. E.g. a global reverb. Used by `UniversalRealTimeMsg::GlobalParameterControl`.
HighResTimeCode	Like `TimeCode` but includes `fractional_frames`. Used in `TimeCodeCueingSetupMsg`.
IdentityReply	A response to `UniversalNonRealTimeMsg::IdentityRequest`, meant to indicate the type of device that this message is sent from. Used by `UniversalNonRealTimeMsg::IdentityReply`.
KeyBasedInstrumentControl	Intended to act like Control Change messages, but targeted at an individual key. For e.g. Drum sounds that have configurable attack/release/decay per key. Used by `UniversalRealTimeMsg::KeyBasedInstrumentControl`.
KeyBasedTuningDump	Set the tunings of all 128 notes. Used by `UniversalNonRealTimeMsg`.
ManufacturerID	Two 7-bit “bytes”, used to identify the manufacturer for `SystemExclusiveMsg::Commercial` messages. See the published list of IDs.
ScaleTuning1Byte	Set the tuning of all octaves for a set of channels. Used by `UniversalNonRealTimeMsg` and `UniversalRealTimeMsg`.
ScaleTuning2Byte	Set the high-res tuning of all octaves for a set of channels. Used by `UniversalNonRealTimeMsg` and `UniversalRealTimeMsg`.
ScaleTuningDump1Byte	Set the tuning of all octaves for a tuning program/bank. Used by `UniversalNonRealTimeMsg`.
ScaleTuningDump2Byte	Set the high-res tuning of all octaves for a tuning program/bank. Used by `UniversalNonRealTimeMsg`.
Signature	A time signature. Used by `TimeSignature`.
SoundFileMap	How to map a `DLS` or `SF2` file for MIDI reference. Used by `SelectMap`.
StandardTimeCode	Like `TimeCode` but uses `subframes` to optionally include status flags, and fractional frames. Also may be negative. Used in `MachineControlCommandMsg`.
StandardUserBits	Like `UserBits` but allows for the embedding of a “secondary time code”.
TimeCode	Used to synchronize device positions, by `SystemCommonMsg::TimeCodeQuarterFrameX` as well as `UniversalRealTimeMsg::TimeCodeFull`.
TimeCodeStatus	Used by `StandardTimeCode`.
TimeSignature	Used to communicate a new time signature to the receiver. Used by `UniversalRealTimeMsg`.
Tuning	Used to represent a tuning by `TuningNoteChange` and `KeyBasedTuningDump`.
TuningNoteChange	Change the tunings of one or more notes, either real-time or not. Used by `UniversalNonRealTimeMsg` and `UniversalRealTimeMsg`.
UserBits	32 bits defined by SMPTE for “special functions”. Used in `UniversalRealTimeMsg::TimeCodeUserBits`. See the SMTPE time code standard.
WAVMap	How to map a `WAV` file for MIDI reference. Used by `SelectMap`.

Enums

BarMarker	Indicates that the next MIDI clock message is the first clock of a new measure. Which bar is optionally indicated by this message. Used by `UniversalRealTimeMsg::BarMarker`.
BeatValue	The note value of a beat, used by `Signature`.
Channel	The MIDI channel, 1-16. Used by `MidiMsg` and elsewhere.
ChannelModeMsg	Channel-level messages that should alter the mode of the receiver. Used in `MidiMsg`.
ChannelVoiceMsg	Channel-level messages that act on a voice. For instance, turning notes on off, or modifying sounding notes. Used in `MidiMsg`.
ChorusType	The type of chorus, used by `GlobalParameterControl::chorus`.
ControlChange	Used by `ChannelVoiceMsg::ControlChange` to modify sounds. Each control targets a particular `ControlNumber`, the meaning of which is given by convention.
ControlNumber	An enum that defines the MIDI numbers associated with Control Changes.
ControlledParameter	The parameters that can be controlled by `ControllerDestination` or `ControlChangeControllerDestination`.
DeviceID	The device ID being addressed, either a number between 0-126 or `AllCall` (all devices). Used by `SystemExclusiveMsg::UniversalNonRealTime` and `SystemExclusiveMsg::UniversalRealTime`.
ExtendedLoopType	The type of loop being described by a `SampleDumpMsg`.
ExtendedSampleDumpMsg	The extended sample dump messages described in CA-019, used to allow for longer, named samples. Used by `UniversalNonRealTimeMsg::SampleDump`.
FileDumpMsg	Used to transmit general file data. Used by `UniversalNonRealTimeMsg`.
FileReferenceMsg	The set of messages used for accessing files on a shared file system or network so they can be used to play sounds without transferring the file contents. Used by `UniversalNonRealTimeMsg::FileReference`.
FileReferenceType	The file type of a given file, as used by `FileReferenceMsg`.
FileType	A four-character file type used by `FileDumpMsg`.
GMPercussionMap	The General MIDI percussion sound to play for a given note number when targeting Channel 10.
GMSoundSet	The instrument that should be played when applying a `ChannelVoiceMsg::ProgramChange`.
GeneralMidi	Used to turn General MIDI level 1 or 2 on, or turn them off.
InformationField	A MIDI Machine Control Information Field, which functions something like an address
LoopNumber	What loop a `SampleDumpMsg` or `ExtendedSampleDumpMsg` is referring to.
LoopType	The type of loop being described by a `SampleDumpMsg`.
MachineControlCommandMsg	A MIDI Machine Control Command. Used by `UniversalRealTimeMsg::MachineControlCommand`.
MachineControlResponseMsg	A MIDI Machine Control Response> Used by `UniversalRealTimeMsg::MachineControlResponse`.
MidiMsg	The primary interface of this library. Used to encode MIDI messages.
Parameter	Used by `ControlChange::Parameter`. “Entry” Parameters can be used to set the given parameters: they will first select that parameter, then send a `ControlChange::DataEntry` with the given value.
PolyMode	Used by `ChannelModeMsg::PolyMode`.
ReverbType	The type of reverb, used by `GlobalParameterControl::reverb`.
SampleDumpMsg	Used to request and transmit sampler data. Used by `UniversalNonRealTimeMsg::SampleDump`.
SelectMap	How to map a file for MIDI reference. Used by `FileReferenceMsg::SelectContents`.
ShowControlMsg	A MIDI Show Control command. Used by `UniversalRealTimeMsg::ShowControl`.
SlotPath	The “slot” of the device being referred to by `GlobalParameterControl`. Values other than `Unregistered` come from the General MIDI 2 spec.
SubFrames	Used by `StandardTimeCode`.
SystemCommonMsg	A fairly limited set of messages, generally for device synchronization. Used in `MidiMsg`.
SystemExclusiveMsg	The bulk of the MIDI spec lives here, in “Universal System Exclusive” messages. Also used for manufacturer-specific messages. Used in `MidiMsg`.
SystemRealTimeMsg	A fairly limited set of messages used for device synchronization. Used in `MidiMsg`.
TimeCodeCueingMsg	Realtime Time Code Cueing. Used by `UniversalRealTimeMsg::TimeCodeCueing`.
TimeCodeCueingSetupMsg	Non-realtime Time Code Cueing. Used by `UniversalNonRealTimeMsg::TimeCodeCueingSetup`.
TimeCodeType	Indicates the frame rate of the given `TimeCode`.
UniversalNonRealTimeMsg	A diverse range of messages for non-real-time applications. Used by `SystemExclusiveMsg::UniversalNonRealTime`.
UniversalRealTimeMsg	A diverse range of messages for real-time applications. Used by `SystemExclusiveMsg::UniversalRealTime`.

Functions

freq_to_midi_note_cents	Given a frequency in Hertz, returns (midi_note_number, additional cents from semitone)
freq_to_midi_note_float	Given a frequency in Hertz, returns a floating point midi note number with 1.0 = 100 cents
midi_note_cents_to_freq	Given a midi note number and additional cents, return the frequency
midi_note_float_to_freq	Given a floating point midi note number, return the frequency in Hertz