#include <MidiMessage.h>
Classes | |
| union | PackedData |
Public Types | |
| enum | SmpteTimecodeType { fps24 = 0 , fps25 = 1 , fps30drop = 2 , fps30 = 3 } |
| enum | MidiMachineControlCommand { mmc_stop = 1 , mmc_play = 2 , mmc_deferredplay = 3 , mmc_fastforward = 4 , mmc_rewind = 5 , mmc_recordStart = 6 , mmc_recordStop = 7 , mmc_pause = 9 } |
Private Member Functions | |
| bool | isHeapAllocated () const noexcept |
| uint8 * | getData () noexcept |
| const uint8 * | getData () const noexcept |
| uint8 * | allocateSpace (int) |
Private Attributes | |
| PackedData | packedData |
| double | timeStamp |
| int | size |
Detailed Description
Encapsulates a MIDI message.
- See also
- MidiMessageSequence, MidiOutput, MidiInput
Member Enumeration Documentation
◆ MidiMachineControlCommand
◆ SmpteTimecodeType
SMPTE timecode types. Used by the getFullFrameParameters() and fullFrame() methods.
| Enumerator | |
|---|---|
| fps24 | |
| fps25 | |
| fps30drop | |
| fps30 | |
Constructor & Destructor Documentation
◆ MidiMessage() [1/8]
Creates a 3-byte short midi message.
- Parameters
-
byte1 message byte 1 byte2 message byte 2 byte3 message byte 3 timeStamp the time to give the midi message - this value doesn't use any particular units, so will be application-specific
◆ MidiMessage() [2/8]
Creates a 2-byte short midi message.
- Parameters
-
byte1 message byte 1 byte2 message byte 2 timeStamp the time to give the midi message - this value doesn't use any particular units, so will be application-specific
◆ MidiMessage() [3/8]
|
noexcept |
Creates a 1-byte short midi message.
- Parameters
-
byte1 message byte 1 timeStamp the time to give the midi message - this value doesn't use any particular units, so will be application-specific
◆ MidiMessage() [4/8]
Creates a midi message from a block of data.
◆ MidiMessage() [5/8]
| water::MidiMessage::MidiMessage | ( | const void * | data, |
| int | maxBytesToUse, | ||
| int & | numBytesUsed, | ||
| uint8 | lastStatusByte, | ||
| double | timeStamp = 0, | ||
| bool | sysexHasEmbeddedLength = true ) |
Reads the next midi message from some data.
This will read as many bytes from a data stream as it needs to make a complete message, and will return the number of bytes it used. This lets you read a sequence of midi messages from a file or stream.
- Parameters
-
data the data to read from maxBytesToUse the maximum number of bytes it's allowed to read numBytesUsed returns the number of bytes that were actually needed lastStatusByte in a sequence of midi messages, the initial byte can be dropped from a message if it's the same as the first byte of the previous message, so this lets you supply the byte to use if the first byte of the message has in fact been dropped. timeStamp the time to give the midi message - this value doesn't use any particular units, so will be application-specific sysexHasEmbeddedLength when reading sysexes, this flag indicates whether to expect the data to begin with a variable-length field indicating its size
◆ MidiMessage() [6/8]
|
noexcept |
Creates an active-sense message. Since the MidiMessage has to contain a valid message, this default constructor just initialises it with an empty sysex message.
◆ MidiMessage() [7/8]
| water::MidiMessage::MidiMessage | ( | const MidiMessage & | other | ) |
Creates a copy of another midi message.
◆ MidiMessage() [8/8]
| water::MidiMessage::MidiMessage | ( | const MidiMessage & | other, |
| double | newTimeStamp ) |
Creates a copy of another midi message, with a different timestamp.
◆ ~MidiMessage()
|
noexcept |
Destructor.
Member Function Documentation
◆ addToTimeStamp()
|
inlinenoexcept |
Adds a value to the message's timestamp. The units for the timestamp will be application-specific.
◆ aftertouchChange()
|
staticnoexcept |
Creates an aftertouch message.
- Parameters
-
channel the midi channel, in the range 1 to 16 noteNumber the key number, 0 to 127 aftertouchAmount the amount of aftertouch, 0 to 127
- See also
- isAftertouch
◆ allControllersOff()
|
staticnoexcept |
Creates an all-controllers-off message.
- Parameters
-
channel the midi channel, in the range 1 to 16
◆ allNotesOff()
|
staticnoexcept |
Creates an all-notes-off message.
- Parameters
-
channel the midi channel, in the range 1 to 16
- See also
- isAllNotesOff
◆ allocateSpace()
◆ allSoundOff()
|
staticnoexcept |
Creates an all-sound-off message.
- Parameters
-
channel the midi channel, in the range 1 to 16
- See also
- isAllSoundOff
◆ channelPressureChange()
|
staticnoexcept |
Creates a channel-pressure change event.
- Parameters
-
channel the midi channel: 1 to 16 pressure the pressure, 0 to 127
- See also
- isChannelPressure
◆ controllerEvent()
|
staticnoexcept |
Creates a controller message.
- Parameters
-
channel the midi channel, in the range 1 to 16 controllerType the type of controller value the controller value
- See also
- isController
◆ createSysExMessage()
|
static |
Creates a system-exclusive message. The data passed in is wrapped with header and tail bytes of 0xf0 and 0xf7.
◆ floatValueToMidiByte()
|
staticnoexcept |
Converts a floating-point value between 0 and 1 to a MIDI 7-bit value between 0 and 127.
◆ fullFrame()
|
static |
Creates a full-frame MTC message.
◆ getAfterTouchValue()
|
noexcept |
Returns the amount of aftertouch from an aftertouch messages.
The value returned is in the range 0 to 127, and will be nonsense for messages other than aftertouch messages.
- See also
- isAftertouch
◆ getChannel()
|
noexcept |
Returns the midi channel associated with the message.
- Returns
- a value 1 to 16 if the message has a channel, or 0 if it hasn't (e.g. if it's a sysex)
- See also
- isForChannel, setChannel
◆ getChannelPressureValue()
|
noexcept |
Returns the pressure from a channel pressure change message.
- Returns
- the pressure, in the range 0 to 127
- See also
- isChannelPressure, channelPressureChange
◆ getControllerNumber()
|
noexcept |
Returns the controller number of a controller message.
The name of the controller can be looked up using the getControllerName() method. Note that the value returned is invalid for messages that aren't controller changes.
- See also
- isController, getControllerName, getControllerValue
◆ getControllerValue()
|
noexcept |
Returns the controller value from a controller message.
A value 0 to 127 is returned to indicate the new controller position. Note that the value returned is invalid for messages that aren't controller changes.
- See also
- isController, getControllerNumber
◆ getData() [1/2]
◆ getData() [2/2]
|
inlineprivatenoexcept |
◆ getFloatVelocity()
|
noexcept |
Returns the velocity of a note-on or note-off message.
The value returned will be in the range 0 to 1.0 If the message isn't a note-on or off event, it will return 0.
- See also
- getVelocity, setVelocity
◆ getFullFrameParameters()
|
noexcept |
Extracts the timecode information from a full-frame midi timecode message.
You should only call this on messages where you've used isFullFrame() to check that they're the right kind.
◆ getKeySignatureNumberOfSharpsOrFlats()
|
noexcept |
Returns the key from a key-signature meta-event. This method must only be called if isKeySignatureMetaEvent() is true. A positive number here indicates the number of sharps in the key signature, and a negative number indicates a number of flats. So e.g. 3 = F# + C# + G#, -2 = Bb + Eb
◆ getMessageLengthFromFirstByte()
Based on the first byte of a short midi message, this uses a lookup table to return the message length (either 1, 2, or 3 bytes).
The value passed in must be 0x80 or higher.
◆ getMetaEventData()
Returns a pointer to the data in a meta-event.
- See also
- isMetaEvent, getMetaEventLength
◆ getMetaEventLength()
|
noexcept |
Returns the length of the data for a meta-event.
- See also
- isMetaEvent, getMetaEventData
◆ getMetaEventType()
|
noexcept |
Returns a meta-event's type number.
If the message isn't a meta-event, this will return -1.
◆ getMidiChannelMetaEventChannel()
|
noexcept |
Returns the channel number from a channel meta-event.
- Returns
- the channel, in the range 1 to 16.
- See also
- isMidiChannelMetaEvent
◆ getMidiMachineControlCommand()
|
noexcept |
For an MMC message, this returns its type.
Make sure it's actually an MMC message with isMidiMachineControlMessage() before calling this method.
◆ getMidiNoteInHertz()
|
staticnoexcept |
Returns the frequency of a midi note number.
The frequencyOfA parameter is an optional frequency for 'A', normally 440-444Hz for concert pitch.
- See also
- getMidiNoteName
◆ getNoteNumber()
|
noexcept |
Returns the midi note number for note-on and note-off messages. If the message isn't a note-on or off, the value returned is undefined.
- See also
- isNoteOff, getMidiNoteName, getMidiNoteInHertz, setNoteNumber
◆ getPitchWheelValue()
|
noexcept |
Returns the pitch wheel position from a pitch-wheel move message.
The value returned is a 14-bit number from 0 to 0x3fff, indicating the wheel position. If called for messages which aren't pitch wheel events, the number returned will be nonsense.
- See also
- isPitchWheel
◆ getProgramChangeNumber()
|
noexcept |
Returns the new program number of a program change message. If the message isn't a program change, the value returned is undefined.
- See also
- isProgramChange
◆ getQuarterFrameSequenceNumber()
|
noexcept |
Returns the sequence number of a quarter-frame midi timecode message. This will be a value between 0 and 7.
- See also
- isQuarterFrame, getQuarterFrameValue, quarterFrame
◆ getQuarterFrameValue()
|
noexcept |
Returns the value from a quarter-frame message. This will be the lower nybble of the message's data-byte, a value between 0 and 15
◆ getRawData()
Returns a pointer to the raw midi data.
- See also
- getRawDataSize
◆ getRawDataSize()
|
inlinenoexcept |
Returns the number of bytes of data in the message.
- See also
- getRawData
◆ getSongPositionPointerMidiBeat()
|
noexcept |
Returns the midi beat-number of a song-position-pointer message.
- See also
- isSongPositionPointer, songPositionPointer
◆ getSysExData()
Returns a pointer to the sysex data inside the message. If this event isn't a sysex event, it'll return 0.
- See also
- getSysExDataSize
◆ getSysExDataSize()
|
noexcept |
Returns the size of the sysex data. This value excludes the 0xf0 header byte and the 0xf7 at the end.
- See also
- getSysExData
◆ getTempoMetaEventTickLength()
|
noexcept |
Returns the tick length from a tempo meta-event.
- Parameters
-
timeFormat the 16-bit time format value from the midi file's header.
- Returns
- the tick length (in seconds).
- See also
- isTempoMetaEvent
◆ getTempoSecondsPerQuarterNote()
|
noexcept |
Calculates the seconds-per-quarter-note from a tempo meta-event.
◆ getTimeSignatureInfo()
Returns the time-signature values from a time-signature meta-event.
- See also
- isTimeSignatureMetaEvent
◆ getTimeStamp()
|
inlinenoexcept |
Returns the timestamp associated with this message.
The exact meaning of this time and its units will vary, as messages are used in a variety of different contexts.
If you're getting the message from a midi file, this could be a time in seconds, or a number of ticks - see MidiFile::convertTimestampTicksToSeconds().
If the message is being used in a MidiBuffer, it might indicate the number of audio samples from the start of the buffer.
If the message was created by a MidiInput, see MidiInputCallback::handleIncomingMidiMessage() for details of the way that it initialises this value.
- See also
- setTimeStamp, addToTimeStamp
◆ getVelocity()
|
noexcept |
Returns the velocity of a note-on or note-off message.
The value returned will be in the range 0 to 127. If the message isn't a note-on or off event, it will return 0.
- See also
- getFloatVelocity
◆ isActiveSense()
|
noexcept |
Returns true if this is an active-sense message.
◆ isAftertouch()
|
noexcept |
Returns true if the message is an aftertouch event.
For aftertouch events, use the getNoteNumber() method to find out the key that it applies to, and getAftertouchValue() to find out the amount. Use getChannel() to find out the channel.
- See also
- getAftertouchValue, getNoteNumber
◆ isAllNotesOff()
|
noexcept |
Checks whether this message is an all-notes-off message.
- See also
- allNotesOff
◆ isAllSoundOff()
|
noexcept |
Checks whether this message is an all-sound-off message.
- See also
- allSoundOff
◆ isChannelPressure()
|
noexcept |
Returns true if the message is a channel-pressure change event.
This is like aftertouch, but common to the whole channel rather than a specific note. Use getChannelPressureValue() to find out the pressure, and getChannel() to find out the channel.
- See also
- channelPressureChange
◆ isController()
|
noexcept |
Returns true if this is a midi controller message.
◆ isControllerOfType()
|
noexcept |
Returns true if this message is a controller message and if it has the specified controller type.
◆ isForChannel()
|
noexcept |
Returns true if the message applies to the given midi channel.
- Parameters
-
channelNumber the channel number to look for, in the range 1 to 16
- See also
- getChannel, setChannel
◆ isFullFrame()
|
noexcept |
Returns true if this is a full-frame midi timecode message.
◆ isHeapAllocated()
|
inlineprivatenoexcept |
◆ isKeySignatureMajorKey()
|
noexcept |
Returns true if this key-signature event is major, or false if it's minor. This method must only be called if isKeySignatureMetaEvent() is true.
◆ isKeySignatureMetaEvent()
|
noexcept |
Returns true if this is a 'key-signature' meta-event.
◆ isMetaEvent()
|
noexcept |
Returns true if this event is a meta-event.
Meta-events are things like tempo changes, track names, etc.
◆ isMidiChannelMetaEvent()
|
noexcept |
Returns true if this is a 'channel' meta-event.
A channel meta-event specifies the midi channel that should be used for subsequent meta-events.
- See also
- getMidiChannelMetaEventChannel
◆ isMidiClock()
|
noexcept |
Returns true if this is a midi clock event.
- See also
- midiClock, songPositionPointer
◆ isMidiContinue()
|
noexcept |
Returns true if this is a midi continue event.
- See also
- midiContinue
◆ isMidiMachineControlGoto()
|
noexcept |
Checks whether this is an MMC "goto" message. If it is, the parameters passed-in are set to the time that the message contains.
- See also
- midiMachineControlGoto
◆ isMidiMachineControlMessage()
|
noexcept |
Checks whether this is an MMC message. If it is, you can use the getMidiMachineControlCommand() to find out its type.
◆ isMidiNoteBlack()
|
staticnoexcept |
Returns true if the given midi note number is a black key.
◆ isMidiStart()
|
noexcept |
Returns true if this is a midi start event.
- See also
- midiStart
◆ isMidiStop()
|
noexcept |
Returns true if this is a midi stop event.
- See also
- midiStop
◆ isNoteOff()
|
noexcept |
Returns true if this message is a 'key-up' event.
If returnTrueForNoteOnVelocity0 is true, then his will also return true for a note-on event with a velocity of 0.
- See also
- isNoteOn, getNoteNumber, getVelocity, noteOff
◆ isNoteOn()
|
noexcept |
Returns true if this message is a 'key-down' event.
- Parameters
-
returnTrueForVelocity0 if true, then if this event is a note-on with velocity 0, it will still be considered to be a note-on and the method will return true. If returnTrueForVelocity0 is false, then if this is a note-on event with velocity 0, it'll be regarded as a note-off, and the method will return false
- See also
- isNoteOff, getNoteNumber, getVelocity, noteOn
◆ isNoteOnOrOff()
|
noexcept |
◆ isPitchWheel()
|
noexcept |
Returns true if the message is a pitch-wheel move.
- See also
- getPitchWheelValue, pitchWheel
◆ isProgramChange()
|
noexcept |
Returns true if the message is a program (patch) change message.
- See also
- getProgramChangeNumber
◆ isQuarterFrame()
|
noexcept |
Returns true if this is a quarter-frame midi timecode message.
◆ isSoftPedalOff()
|
noexcept |
Returns true if this message is a 'soft pedal up' controller message.
◆ isSoftPedalOn()
|
noexcept |
Returns true if this message is a 'soft pedal down' controller message.
◆ isSongPositionPointer()
|
noexcept |
Returns true if this is a song-position-pointer message.
◆ isSostenutoPedalOff()
|
noexcept |
Returns true if this message is a 'sostenuto pedal up' controller message.
◆ isSostenutoPedalOn()
|
noexcept |
Returns true if this message is a 'sostenuto pedal down' controller message.
◆ isSustainPedalOff()
|
noexcept |
Returns true if this message is a 'sustain pedal up' controller message.
◆ isSustainPedalOn()
|
noexcept |
Returns true if this message is a 'sustain pedal down' controller message.
◆ isSysEx()
|
noexcept |
Returns true if this is a system-exclusive message.
◆ isTempoMetaEvent()
|
noexcept |
Returns true if this is a 'tempo' meta-event.
◆ isTimeSignatureMetaEvent()
|
noexcept |
Returns true if this is a 'time-signature' meta-event.
- See also
- getTimeSignatureInfo
◆ keySignatureMetaEvent()
|
static |
Creates a key-signature meta-event.
- Parameters
-
numberOfSharpsOrFlats if positive, this indicates the number of sharps in the key; if negative, the number of flats isMinorKey if true, the key is minor; if false, it is major
- See also
- isKeySignatureMetaEvent
◆ masterVolume()
|
static |
Creates a master-volume change message.
- Parameters
-
volume the volume, 0 to 1.0
◆ midiChannelMetaEvent()
|
staticnoexcept |
Creates a midi channel meta-event.
- Parameters
-
channel the midi channel, in the range 1 to 16
- See also
- isMidiChannelMetaEvent
◆ midiClock()
|
staticnoexcept |
Creates a midi clock event.
◆ midiContinue()
|
staticnoexcept |
Creates a midi continue event.
◆ midiMachineControlCommand()
|
static |
Creates an MMC message.
◆ midiMachineControlGoto()
|
static |
Creates an MMC "goto" message. This messages tells the device to go to a specific frame.
- See also
- isMidiMachineControlGoto
◆ midiStart()
|
staticnoexcept |
Creates a midi start event.
◆ midiStop()
|
staticnoexcept |
Creates a midi stop event.
◆ multiplyVelocity()
|
noexcept |
Multiplies the velocity of a note-on or note-off message by a given amount.
If the message isn't a note on or off, this will do nothing.
- Parameters
-
scaleFactor the value by which to multiply the velocity
- See also
- setVelocity
◆ noteOff() [1/3]
|
staticnoexcept |
Creates a key-up message.
- Parameters
-
channel the midi channel, in the range 1 to 16 noteNumber the key number, 0 to 127
- See also
- isNoteOff
◆ noteOff() [2/3]
|
staticnoexcept |
Creates a key-up message.
- Parameters
-
channel the midi channel, in the range 1 to 16 noteNumber the key number, 0 to 127 velocity in the range 0 to 1.0
- See also
- isNoteOff
◆ noteOff() [3/3]
|
staticnoexcept |
Creates a key-up message.
- Parameters
-
channel the midi channel, in the range 1 to 16 noteNumber the key number, 0 to 127 velocity in the range 0 to 127
- See also
- isNoteOff
◆ noteOn() [1/2]
|
staticnoexcept |
Creates a key-down message (using a floating-point velocity).
- Parameters
-
channel the midi channel, in the range 1 to 16 noteNumber the key number, 0 to 127 velocity in the range 0 to 1.0
- See also
- isNoteOn
◆ noteOn() [2/2]
|
staticnoexcept |
Creates a key-down message (using an integer velocity).
- Parameters
-
channel the midi channel, in the range 1 to 16 noteNumber the key number, 0 to 127 velocity in the range 0 to 127
- See also
- isNoteOn
◆ operator=()
| MidiMessage & water::MidiMessage::operator= | ( | const MidiMessage & | other | ) |
Copies this message from another one.
◆ pitchbendToPitchwheelPos()
|
staticnoexcept |
Converts a pitchbend value in semitones to a MIDI 14-bit pitchwheel position value.
◆ pitchWheel()
|
staticnoexcept |
Creates a pitch-wheel move message.
- Parameters
-
channel the midi channel, in the range 1 to 16 position the wheel position, in the range 0 to 16383
- See also
- isPitchWheel
◆ programChange()
|
staticnoexcept |
Creates a program-change message.
- Parameters
-
channel the midi channel, in the range 1 to 16 programNumber the midi program number, 0 to 127
- See also
- isProgramChange
◆ quarterFrame()
|
staticnoexcept |
Creates a quarter-frame MTC message.
- Parameters
-
sequenceNumber a value 0 to 7 for the upper nybble of the message's data byte value a value 0 to 15 for the lower nybble of the message's data byte
◆ readVariableLengthVal()
|
staticnoexcept |
Reads a midi variable-length integer.
- Parameters
-
data the data to read the number from numBytesUsed on return, this will be set to the number of bytes that were read
◆ setChannel()
Changes the message's midi channel. This won't do anything for non-channel messages like sysexes.
- Parameters
-
newChannelNumber the channel number to change it to, in the range 1 to 16
◆ setNoteNumber()
Changes the midi note number of a note-on or note-off message. If the message isn't a note on or off, this will do nothing.
◆ setTimeStamp()
|
inlinenoexcept |
Changes the message's associated timestamp. The units for the timestamp will be application-specific - see the notes for getTimeStamp().
- See also
- addToTimeStamp, getTimeStamp
◆ setVelocity()
|
noexcept |
Changes the velocity of a note-on or note-off message.
If the message isn't a note on or off, this will do nothing.
- Parameters
-
newVelocity the new velocity, in the range 0 to 1.0
- See also
- getFloatVelocity, multiplyVelocity
◆ songPositionPointer()
|
staticnoexcept |
Creates a song-position-pointer message.
The position is a number of midi beats from the start of the song, where 1 midi beat is 6 midi clocks, and there are 24 midi clocks in a quarter-note. So there are 4 midi beats in a quarter-note.
◆ tempoMetaEvent()
|
staticnoexcept |
Creates a tempo meta-event.
- See also
- isTempoMetaEvent
◆ timeSignatureMetaEvent()
|
static |
Creates a time-signature meta-event.
- See also
- isTimeSignatureMetaEvent
Member Data Documentation
◆ packedData
|
private |
◆ size
|
private |
◆ timeStamp
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/midi/MidiMessage.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/midi/MidiMessage.cpp
Generated on for LMMS by
1.16.1