MIDI Input

Modules
	Callbacks

Functions
bool	MidiInterface< SerialPort, _Settings >::read ()
	Read messages from the serial port using the main input channel. More...
bool	MidiInterface< SerialPort, _Settings >::read (Channel inChannel)
	Read messages on a specified channel. More...
MidiType	MidiInterface< SerialPort, _Settings >::getType () const
	Get the last received message's type. More...
Channel	MidiInterface< SerialPort, _Settings >::getChannel () const
	Get the channel of the message stored in the structure. More...
DataByte	MidiInterface< SerialPort, _Settings >::getData1 () const
	Get the first data byte of the last received message. More...
DataByte	MidiInterface< SerialPort, _Settings >::getData2 () const
	Get the second data byte of the last received message. More...
const byte *	MidiInterface< SerialPort, _Settings >::getSysExArray () const
	Get the System Exclusive byte array. More...
unsigned	MidiInterface< SerialPort, _Settings >::getSysExArrayLength () const
	Get the lenght of the System Exclusive array. More...
bool	MidiInterface< SerialPort, _Settings >::check () const
	Check if a valid message is stored in the structure. More...
Channel	MidiInterface< SerialPort, _Settings >::getInputChannel () const
void	MidiInterface< SerialPort, _Settings >::setInputChannel (Channel inChannel)
	Set the value for the input MIDI channel. More...
static MidiType	MidiInterface< SerialPort, _Settings >::getTypeFromStatusByte (byte inStatus)
	Extract an enumerated MIDI type from a status byte. More...
static Channel	MidiInterface< SerialPort, _Settings >::getChannelFromStatusByte (byte inStatus)
	Returns channel in the range 1-16. More...
static bool	MidiInterface< SerialPort, _Settings >::isChannelMessage (MidiType inType)

Detailed Description

Function Documentation

check()

template<class SerialPort , class Settings >

bool MidiInterface< SerialPort, Settings >::check ( ) const

inline

Check if a valid message is stored in the structure.

Definition at line 1064 of file MIDI.hpp.

{
    return mMessage.valid;
}

getChannel()

template<class SerialPort , class Settings >

Channel MidiInterface< SerialPort, Settings >::getChannel ( ) const

inline

Get the channel of the message stored in the structure.

Returns

Channel range is 1 to 16. For non-channel messages, this will return 0.

Definition at line 1022 of file MIDI.hpp.

{
    return mMessage.channel;
}

getChannelFromStatusByte()

template<class SerialPort , class Settings >

Channel MidiInterface< SerialPort, Settings >::getChannelFromStatusByte ( byte  inStatus )

inlinestatic

Returns channel in the range 1-16.

Definition at line 1118 of file MIDI.hpp.

{
    return (inStatus & 0x0f) + 1;
}

getData1()

template<class SerialPort , class Settings >

DataByte MidiInterface< SerialPort, Settings >::getData1 ( ) const

inline

Get the first data byte of the last received message.

Definition at line 1029 of file MIDI.hpp.

{
    return mMessage.data1;
}

getData2()

template<class SerialPort , class Settings >

DataByte MidiInterface< SerialPort, Settings >::getData2 ( ) const

inline

Get the second data byte of the last received message.

Definition at line 1036 of file MIDI.hpp.

{
    return mMessage.data2;
}

getInputChannel()

template<class SerialPort , class Settings >

Channel MidiInterface< SerialPort, Settings >::getInputChannel ( ) const

inline

Definition at line 1072 of file MIDI.hpp.

{
    return mInputChannel;
}

getSysExArray()

template<class SerialPort , class Settings >

const byte * MidiInterface< SerialPort, Settings >::getSysExArray ( ) const

inline

Get the System Exclusive byte array.

See also

getSysExArrayLength to get the array's length in bytes.

Definition at line 1046 of file MIDI.hpp.

{
    return mMessage.sysexArray;
}

getSysExArrayLength()

template<class SerialPort , class Settings >

unsigned MidiInterface< SerialPort, Settings >::getSysExArrayLength ( ) const

inline

Get the lenght of the System Exclusive array.

It is coded using data1 as LSB and data2 as MSB.

Returns

The array's length, in bytes.

Definition at line 1057 of file MIDI.hpp.

{
    return mMessage.getSysExSize();
}

getType()

template<class SerialPort , class Settings >

MidiType MidiInterface< SerialPort, Settings >::getType ( ) const

inline

Get the last received message's type.

Returns an enumerated type.

See also

MidiType

Definition at line 1011 of file MIDI.hpp.

{
    return mMessage.type;
}

getTypeFromStatusByte()

template<class SerialPort , class Settings >

MidiType MidiInterface< SerialPort, Settings >::getTypeFromStatusByte ( byte  inStatus )

inlinestatic

Extract an enumerated MIDI type from a status byte.

This is a utility static method, used internally, made public so you can handle MidiTypes more easily.

Definition at line 1095 of file MIDI.hpp.

{
    if ((inStatus  < 0x80) ||
        (inStatus == 0xf4) ||
        (inStatus == 0xf5) ||
        (inStatus == 0xf9) ||
        (inStatus == 0xfD))
    {
        // Data bytes and undefined.
        return InvalidType;
    }
    if (inStatus < 0xf0)
    {
        // Channel message, remove channel nibble.
        return MidiType(inStatus & 0xf0);
    }

    return MidiType(inStatus);
}

isChannelMessage()

template<class SerialPort , class Settings >

bool MidiInterface< SerialPort, Settings >::isChannelMessage ( MidiType  inType )

inlinestatic

Definition at line 1124 of file MIDI.hpp.

{
    return (inType == NoteOff           ||
            inType == NoteOn            ||
            inType == ControlChange     ||
            inType == AfterTouchPoly    ||
            inType == AfterTouchChannel ||
            inType == PitchBend         ||
            inType == ProgramChange);
}

read() [1/2]

template<class SerialPort , class Settings >

bool MidiInterface< SerialPort, Settings >::read ( )

inline

Read messages from the serial port using the main input channel.

Returns

True if a valid message has been stored in the structure, false if not. A valid message is a message that matches the input channel.

If the Thru is enabled and the message matches the filter, it is sent back on the MIDI output.

See also

see setInputChannel()

Definition at line 644 of file MIDI.hpp.

{
    return read(mInputChannel);
}

read() [2/2]

template<class SerialPort , class Settings >

bool MidiInterface< SerialPort, Settings >::read ( Channel  inChannel )

inline

Read messages on a specified channel.

Definition at line 652 of file MIDI.hpp.

{
    if (inChannel >= MIDI_CHANNEL_OFF)
        return false; // MIDI Input disabled.

    if (!parse())
        return false;

    handleNullVelocityNoteOnAsNoteOff();
    const bool channelMatch = inputFilter(inChannel);

    if (channelMatch)
    {
        launchCallback();
    }

    thruFilter(inChannel);

    return channelMatch;
}

setInputChannel()

template<class SerialPort , class Settings >

void MidiInterface< SerialPort, Settings >::setInputChannel ( Channel  inChannel )

inline

Set the value for the input MIDI channel.

Parameters

inChannel

the channel value. Valid values are 1 to 16, MIDI_CHANNEL_OMNI if you want to listen to all channels, and MIDI_CHANNEL_OFF to disable input.

Definition at line 1082 of file MIDI.hpp.

{
    mInputChannel = inChannel;
}