JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Member Functions | List of all members
MidiMessageSequence Class Reference

A sequence of timestamped midi messages. More...

Classes

class  MidiEventHolder
 Structure used to hold midi events in the sequence. More...
 

Public Member Functions

 MidiMessageSequence ()
 Creates an empty midi sequence object.
 
 MidiMessageSequence (const MidiMessageSequence &)
 Creates a copy of another sequence.
 
MidiMessageSequenceoperator= (const MidiMessageSequence &)
 Replaces this sequence with another one.
 
 ~MidiMessageSequence ()
 Destructor.
 
void clear ()
 Clears the sequence.
 
int getNumEvents () const noexcept
 Returns the number of events in the sequence.
 
MidiEventHoldergetEventPointer (int index) const noexcept
 Returns a pointer to one of the events.
 
double getTimeOfMatchingKeyUp (int index) const noexcept
 Returns the time of the note-up that matches the note-on at this index.
 
int getIndexOfMatchingKeyUp (int index) const noexcept
 Returns the index of the note-up that matches the note-on at this index.
 
int getIndexOf (MidiEventHolder *event) const noexcept
 Returns the index of an event.
 
int getNextIndexAtTime (double timeStamp) const noexcept
 Returns the index of the first event on or after the given timestamp.
 
double getStartTime () const noexcept
 Returns the timestamp of the first event in the sequence.
 
double getEndTime () const noexcept
 Returns the timestamp of the last event in the sequence.
 
double getEventTime (int index) const noexcept
 Returns the timestamp of the event at a given index.
 
MidiEventHolderaddEvent (const MidiMessage &newMessage, double timeAdjustment=0)
 Inserts a midi message into the sequence.
 
void deleteEvent (int index, bool deleteMatchingNoteUp)
 Deletes one of the events in the sequence.
 
void addSequence (const MidiMessageSequence &other, double timeAdjustmentDelta, double firstAllowableDestTime, double endOfAllowableDestTimes)
 Merges another sequence into this one.
 
void updateMatchedPairs () noexcept
 Makes sure all the note-on and note-off pairs are up-to-date.
 
void sort () noexcept
 Forces a sort of the sequence.
 
void extractMidiChannelMessages (int channelNumberToExtract, MidiMessageSequence &destSequence, bool alsoIncludeMetaEvents) const
 Copies all the messages for a particular midi channel to another sequence.
 
void extractSysExMessages (MidiMessageSequence &destSequence) const
 Copies all midi sys-ex messages to another sequence.
 
void deleteMidiChannelMessages (int channelNumberToRemove)
 Removes any messages in this sequence that have a specific midi channel.
 
void deleteSysExMessages ()
 Removes any sys-ex messages from this sequence.
 
void addTimeToMessages (double deltaTime) noexcept
 Adds an offset to the timestamps of all events in the sequence.
 
void createControllerUpdatesForTime (int channelNumber, double time, OwnedArray< MidiMessage > &resultMessages)
 Scans through the sequence to determine the state of any midi controllers at a given time.
 
void swapWith (MidiMessageSequence &) noexcept
 Swaps this sequence with another one.
 

Detailed Description

A sequence of timestamped midi messages.

This allows the sequence to be manipulated, and also to be read from and written to a standard midi file.

See Also
MidiMessage, MidiFile

Constructor & Destructor Documentation

MidiMessageSequence::MidiMessageSequence ( )

Creates an empty midi sequence object.

MidiMessageSequence::MidiMessageSequence ( const MidiMessageSequence )

Creates a copy of another sequence.

MidiMessageSequence::~MidiMessageSequence ( )

Destructor.

Member Function Documentation

MidiMessageSequence& MidiMessageSequence::operator= ( const MidiMessageSequence )

Replaces this sequence with another one.

void MidiMessageSequence::clear ( )

Clears the sequence.

int MidiMessageSequence::getNumEvents ( ) const
noexcept

Returns the number of events in the sequence.

MidiEventHolder* MidiMessageSequence::getEventPointer ( int  index) const
noexcept

Returns a pointer to one of the events.

double MidiMessageSequence::getTimeOfMatchingKeyUp ( int  index) const
noexcept

Returns the time of the note-up that matches the note-on at this index.

If the event at this index isn't a note-on, it'll just return 0.

See Also
MidiMessageSequence::MidiEventHolder::noteOffObject
int MidiMessageSequence::getIndexOfMatchingKeyUp ( int  index) const
noexcept

Returns the index of the note-up that matches the note-on at this index.

If the event at this index isn't a note-on, it'll just return -1.

See Also
MidiMessageSequence::MidiEventHolder::noteOffObject
int MidiMessageSequence::getIndexOf ( MidiEventHolder event) const
noexcept

Returns the index of an event.

int MidiMessageSequence::getNextIndexAtTime ( double  timeStamp) const
noexcept

Returns the index of the first event on or after the given timestamp.

If the time is beyond the end of the sequence, this will return the number of events.

double MidiMessageSequence::getStartTime ( ) const
noexcept

Returns the timestamp of the first event in the sequence.

See Also
getEndTime
double MidiMessageSequence::getEndTime ( ) const
noexcept

Returns the timestamp of the last event in the sequence.

See Also
getStartTime
double MidiMessageSequence::getEventTime ( int  index) const
noexcept

Returns the timestamp of the event at a given index.

If the index is out-of-range, this will return 0.0

MidiEventHolder* MidiMessageSequence::addEvent ( const MidiMessage newMessage,
double  timeAdjustment = 0 
)

Inserts a midi message into the sequence.

The index at which the new message gets inserted will depend on its timestamp, because the sequence is kept sorted.

Remember to call updateMatchedPairs() after adding note-on events.

Parameters
newMessagethe new message to add (an internal copy will be made)
timeAdjustmentan optional value to add to the timestamp of the message that will be inserted
See Also
updateMatchedPairs
void MidiMessageSequence::deleteEvent ( int  index,
bool  deleteMatchingNoteUp 
)

Deletes one of the events in the sequence.

Remember to call updateMatchedPairs() after removing events.

Parameters
indexthe index of the event to delete
deleteMatchingNoteUpwhether to also remove the matching note-off if the event you're removing is a note-on
void MidiMessageSequence::addSequence ( const MidiMessageSequence other,
double  timeAdjustmentDelta,
double  firstAllowableDestTime,
double  endOfAllowableDestTimes 
)

Merges another sequence into this one.

Remember to call updateMatchedPairs() after using this method.

Parameters
otherthe sequence to add from
timeAdjustmentDeltaan amount to add to the timestamps of the midi events as they are read from the other sequence
firstAllowableDestTimeevents will not be added if their time is earlier than this time. (This is after their time has been adjusted by the timeAdjustmentDelta)
endOfAllowableDestTimesevents will not be added if their time is equal to or greater than this time. (This is after their time has been adjusted by the timeAdjustmentDelta)
void MidiMessageSequence::updateMatchedPairs ( )
noexcept

Makes sure all the note-on and note-off pairs are up-to-date.

Call this after re-ordering messages or deleting/adding messages, and it will scan the list and make sure all the note-offs in the MidiEventHolder structures are pointing at the correct ones.

void MidiMessageSequence::sort ( )
noexcept

Forces a sort of the sequence.

You may need to call this if you've manually modified the timestamps of some events such that the overall order now needs updating.

void MidiMessageSequence::extractMidiChannelMessages ( int  channelNumberToExtract,
MidiMessageSequence destSequence,
bool  alsoIncludeMetaEvents 
) const

Copies all the messages for a particular midi channel to another sequence.

Parameters
channelNumberToExtractthe midi channel to look for, in the range 1 to 16
destSequencethe sequence that the chosen events should be copied to
alsoIncludeMetaEventsif true, any meta-events (which don't apply to a specific channel) will also be copied across.
See Also
extractSysExMessages
void MidiMessageSequence::extractSysExMessages ( MidiMessageSequence destSequence) const

Copies all midi sys-ex messages to another sequence.

Parameters
destSequencethis is the sequence to which any sys-exes in this sequence will be added
See Also
extractMidiChannelMessages
void MidiMessageSequence::deleteMidiChannelMessages ( int  channelNumberToRemove)

Removes any messages in this sequence that have a specific midi channel.

Parameters
channelNumberToRemovethe midi channel to look for, in the range 1 to 16
void MidiMessageSequence::deleteSysExMessages ( )

Removes any sys-ex messages from this sequence.

void MidiMessageSequence::addTimeToMessages ( double  deltaTime)
noexcept

Adds an offset to the timestamps of all events in the sequence.

Parameters
deltaTimethe amount to add to each timestamp.
void MidiMessageSequence::createControllerUpdatesForTime ( int  channelNumber,
double  time,
OwnedArray< MidiMessage > &  resultMessages 
)

Scans through the sequence to determine the state of any midi controllers at a given time.

This will create a sequence of midi controller changes that can be used to set all midi controllers to the state they would be in at the specified time within this sequence.

As well as controllers, it will also recreate the midi program number and pitch bend position.

Parameters
channelNumberthe midi channel to look for, in the range 1 to 16. Controllers for other channels will be ignored.
timethe time at which you want to find out the state - there are no explicit units for this time measurement, it's the same units as used for the timestamps of the messages
resultMessagesan array to which midi controller-change messages will be added. This will be the minimum number of controller changes to recreate the state at the required time.
void MidiMessageSequence::swapWith ( MidiMessageSequence )
noexcept

Swaps this sequence with another one.


The documentation for this class was generated from the following file: