#include <MIDI_Interfaces/USBHostMIDI_Interface.hpp>

Detailed Description

A class for MIDI interfaces sending MIDI messages to a MIDI USB device connected to a Teensy's USB host port.

Requires a Teensy 3.6 or 4.1 and the USBHost_t36 library.

This one uses the default small buffer (similar to USBHost_t36's MIDIDevice).

See also: USBHostMIDI_Interface_BigBuffer for a bigger buffer.

Examples: USBHostMIDI_Interface-Passthrough.ino.

Definition at line 42 of file USBHostMIDI_Interface.hpp.

Inheritance diagram for USBHostMIDI_Interface:

Collaboration diagram for USBHostMIDI_Interface:

Reading incoming MIDI messages
MIDIReadEvent	read ()
	Try reading and parsing a single incoming MIDI message. More...

ChannelMessage	getChannelMessage () const
	Return the received channel voice message. More...

SysCommonMessage	getSysCommonMessage () const
	Return the received system common message. More...

RealTimeMessage	getRealTimeMessage () const
	Return the received real-time message. More...

SysExMessage	getSysExMessage () const
	Return the received system exclusive message. More...

Buffering USB packets
bool	alwaysSendsImmediately () const
	Check if this USB interface always sends its USB packets immediately after sending a MIDI message. More...

void	neverSendImmediately ()
	Don't send the USB packets immediately after sending a MIDI message. More...

void	alwaysSendImmediately ()
	Send the USB packets immediately after sending a MIDI message. More...

Default MIDI Interfaces
void	setAsDefault ()
	Set this MIDI interface as the default interface. More...

static MIDI_Interface *	getDefault ()
	Return the default MIDI interface. More...

MIDI Input Callbacks
void	setCallbacks (MIDI_Callbacks *cb)
	Set the callbacks that will be called when a MIDI message is received. More...

void	setCallbacks (MIDI_Callbacks &cb)
	Set the callbacks that will be called when a MIDI message is received. More...

Connecting and disconnecting MIDI Pipes
void	connectSourcePipe (MIDI_Pipe *source)
	Fully connect a source pipe to this sink. More...

void	disconnectSourcePipes ()
	Disconnect all source pipes that sink to this sink (recursively). More...

bool	disconnect (TrueMIDI_Source &source)
	Disconnect the given source from this sink. More...

bool	disconnect (MIDI_Pipe &)=delete

bool	hasSourcePipe () const
	Check if this sink is connected to a source pipe. More...

MIDI_Pipe *	getSourcePipe ()
	Get a pointer to the pipe this sink is connected to, or `nullptr` if not connected. More...

Connecting and disconnecting MIDI Pipes
bool	disconnect (TrueMIDI_Sink &sink)
	Disconnect the given sink from this source. More...

bool	disconnect (MIDI_Pipe &)=delete

void	connectSinkPipe (MIDI_Pipe *sink)
	Fully connect a sink pipe to this source. More...

void	disconnectSinkPipes ()
	Disconnect all sink pipes that this source sinks to (recursively). More...

bool	hasSinkPipe () const
	Check if this source is connected to a sink pipe. More...

MIDI_Pipe *	getSinkPipe ()
	Get a pointer to the pipe this source is connected to, or `nullptr` if not connected. More...

Sending data over a MIDI Pipe
void	sourceMIDItoPipe (ChannelMessage)
	Send a MIDI Channel Message down the pipe. More...

void	sourceMIDItoPipe (SysExMessage)
	Send a MIDI System Exclusive message down the pipe. More...

void	sourceMIDItoPipe (SysCommonMessage)
	Send a MIDI System Common message down the pipe. More...

void	sourceMIDItoPipe (RealTimeMessage)
	Send a MIDI Real-Time message down the pipe. More...

Stalling the sink pipes and exclusive access
void	stall (MIDIStaller *cause=eternal_stall)
	Stall this MIDI source. More...

void	unstall (MIDIStaller *cause=eternal_stall)
	Un-stall the pipes connected to this source, so other sources are allowed to send again. More...

bool	isStalled () const
	Check if this source can write to the sinks it connects to. More...

MIDIStaller *	getStaller () const
	Get a pointer to whatever is causing this MIDI source to be stalled. More...

const char *	getStallerName () const
	Get the name of whatever is causing this MIDI source to be stalled. More...

void	handleStallers () const
	Give the code that is stalling the MIDI sink pipes the opportunity to do its job and un-stall the pipes. More...

Sending MIDI Channel Voice messages
void	send (ChannelMessage message)
	Send a MIDI Channel Voice message. More...

void	sendChannelMessage (MIDIMessageType m, Channel c, uint8_t d1, uint8_t d2, Cable cable=CABLE_1)
	Send a 3-byte MIDI Channel Voice message. More...

void	sendChannelMessage (MIDIMessageType m, Channel c, uint8_t d1, Cable cable=CABLE_1)
	Send a 2-byte MIDI Channel Voice message. More...

void	sendNoteOn (MIDIAddress address, uint8_t velocity)
	Send a MIDI Note On event. More...

void	sendNoteOff (MIDIAddress address, uint8_t velocity)
	Send a MIDI Note Off event. More...

void	sendKeyPressure (MIDIAddress address, uint8_t pressure)
	Send a MIDI Key Pressure event. More...

void	sendControlChange (MIDIAddress address, uint8_t value)
	Send a MIDI Control Change event. More...

void	sendProgramChange (MIDIAddress address)
	Send a MIDI Program Change event. More...

void	sendProgramChange (MIDIChannelCable address, uint8_t value)
	Send a MIDI Program Change event. More...

void	sendChannelPressure (MIDIChannelCable address, uint8_t pressure)
	Send a MIDI Channel Pressure event. More...

void	sendPitchBend (MIDIChannelCable address, uint16_t value)
	Send a MIDI Pitch Bend event. More...

Sending MIDI System Common messages
void	send (SysCommonMessage message)
	Send a MIDI System Common message. More...

void	sendSysCommon (MIDIMessageType m, Cable cable=CABLE_1)
	Send a MIDI System Common message. More...

void	sendSysCommon (MIDIMessageType m, uint8_t data1, Cable cable=CABLE_1)
	Send a MIDI System Common message. More...

void	sendSysCommon (MIDIMessageType m, uint8_t data1, uint8_t data2, Cable cable=CABLE_1)
	Send a MIDI System Common message. More...

void	sendMTCQuarterFrame (uint8_t data, Cable cable=CABLE_1)
	Send a MIDI Time Code Quarter Frame. More...

void	sendMTCQuarterFrame (uint8_t messageType, uint8_t values, Cable cable=CABLE_1)
	Send a MIDI Time Code Quarter Frame. More...

void	sendSongPositionPointer (uint16_t spp, Cable cable=CABLE_1)
	Send a MIDI Song Position Pointer message. More...

void	sendSongSelect (uint8_t song, Cable cable=CABLE_1)
	Send a MIDI Song Select message. More...

void	sendTuneRequest (Cable cable=CABLE_1)
	Send a MIDI Tune Request. More...

Sending MIDI System Exclusive messages
void	send (SysExMessage message)
	Send a MIDI System Exclusive message. More...

void	sendSysEx (const uint8_t(&sysexdata)[N], Cable cable=CABLE_1)
	Send a MIDI System Exclusive message. More...

void	sendSysEx (const uint8_t *data, uint16_t length, Cable cable=CABLE_1)
	Send a MIDI System Exclusive message. More...

Sending MIDI Real-Time messages
void	send (RealTimeMessage message)
	Send a MIDI Real-Time message. More...

void	sendRealTime (MIDIMessageType rt, Cable cable=CABLE_1)
	Send a MIDI Real-Time message. More...

void	sendRealTime (uint8_t rt, Cable cable=CABLE_1)
	Send a MIDI Real-Time message. More...

void	sendTimingClock (Cable cable=CABLE_1)
	Send a MIDI Timing Clock message. More...

void	sendStart (Cable cable=CABLE_1)
	Send a MIDI Start message. More...

void	sendContinue (Cable cable=CABLE_1)
	Send a MIDI Continue message. More...

void	sendStop (Cable cable=CABLE_1)
	Send a MIDI Stop message. More...

void	sendActiveSensing (Cable cable=CABLE_1)
	Send a MIDI Active Sensing message. More...

void	sendSystemReset (Cable cable=CABLE_1)
	Send a MIDI System Reset message. More...

Flusing the MIDI send buffer
void	sendNow ()
	Causes all buffered messages to be sent immediately. More...

Deprecated
void	sendKP (MIDIAddress address, uint8_t pressure)
	Send a MIDI Key Pressure event. More...

void	sendCC (MIDIAddress address, uint8_t value)
	Send a MIDI Control Change event. More...

void	sendPC (MIDIAddress address)
	Send a MIDI Program Change event. More...

void	sendPC (MIDIChannelCable address, uint8_t value)
	Send a MIDI Program Change event. More...

void	sendCP (MIDIChannelCable address, uint8_t pressure)
	Send a MIDI Channel Pressure event. More...

void	sendPB (MIDIChannelCable address, uint16_t value)
	Send a MIDI Pitch Bend event. More...

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

bool	isEnabled () const
	Check if this updatable is enabled. More...

void	moveDown ()
	Move down this element in the list. More...

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

Underlying USB communication
USBHostMIDIBackend< 64 >	backend
	The (platform-specific) backend used for MIDI over USB communication. More...

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class. More...

static void	updateAll ()
	Update all enabled instances of this class. More...

Public Member Functions
	USBHostMIDI_Interface (USBHost &host)

void	begin () override
	Initialize the MIDI Interface. More...

void	update () override
	Read the MIDI interface and call the callback if a message was received. More...

Static Public Member Functions
template<class MIDIInterface_t >
static void	handleStall (MIDIInterface_t *iface)
	Un-stall the given MIDI interface. More...

template<class MIDIInterface_t >
static void	updateIncoming (MIDIInterface_t *iface)
	Read, parse and dispatch incoming MIDI messages on the given interface. More...

template<class MIDIInterface_t >
static void	dispatchIncoming (MIDIInterface_t *iface, MIDIReadEvent event)
	Dispatch the given type of MIDI message from the given interface. More...

static void	swap (MIDI_Sink &a, MIDI_Sink &b)

static void	swap (MIDI_Source &a, MIDI_Source &b)

Protected Member Functions
void	sinkMIDIfromPipe (ChannelMessage msg) override
	Accept an incoming MIDI Channel message from the source pipe. More...

void	sinkMIDIfromPipe (SysExMessage msg) override
	Accept an incoming MIDI System Exclusive message from the source pipe. More...

void	sinkMIDIfromPipe (SysCommonMessage msg) override
	Accept an incoming MIDI System Common message from the source pipe. More...

void	sinkMIDIfromPipe (RealTimeMessage msg) override
	Accept an incoming MIDI Real-Time message from the source pipe. More...

void	onChannelMessage (ChannelMessage message)
	Call the channel message callback and send the message to the sink pipe. More...

void	onSysExMessage (SysExMessage message)
	Call the SysEx message callback and send the message to the sink pipe. More...

void	onSysCommonMessage (SysCommonMessage message)
	Call the System Common message callback and send the message to the sink pipe. More...

void	onRealTimeMessage (RealTimeMessage message)
	Call the real-time message callback and send the message to the sink pipe. More...

virtual const char *	getName () const
	Get the staller's name for debugging purposes. More...

Static Protected Member Functions
static const char *	getNameNull (MIDIStaller *s)
	Get the staller's name for debugging purposes. More...

Protected Attributes
MIDI_Pipe *	sourcePipe = nullptr

MIDI_Pipe *	sinkPipe = nullptr

Updatable< MIDI_Interface > *	next

Updatable< MIDI_Interface > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< MIDI_Interface > >	updatables

Private Member Functions
void	sendChannelMessageImpl (ChannelMessage) override
	Low-level function for sending a MIDI channel voice message. More...

void	sendSysCommonImpl (SysCommonMessage) override
	Low-level function for sending a MIDI system common message. More...

void	sendSysExImpl (SysExMessage) override
	Low-level function for sending a system exclusive MIDI message. More...

void	sendRealTimeImpl (RealTimeMessage) override
	Low-level function for sending a MIDI real-time message. More...

void	sendNowImpl () override
	Low-level function for sending any buffered outgoing MIDI messages. More...

void	handleStall () override
	Call back that should finish any MIDI messages that are in progress, and un-stall the pipe or MIDI source as quickly as possible. More...

virtual void	stallDownstream (MIDIStaller , MIDI_Source )
	Base case for recursive stall function. More...

virtual void	unstallDownstream (MIDIStaller , MIDI_Source )
	Base case for recursive un-stall function. More...

virtual MIDI_Sink *	getFinalSink ()
	Base case for recursive function. More...

void	disconnectSourcePipesShallow ()
	Disconnect only the first pipe connected to this sink. More...

virtual void	stallUpstream (MIDIStaller , MIDI_Sink )
	Base case for recursive stall function. More...

virtual void	unstallUpstream (MIDIStaller , MIDI_Sink )
	Base case for recursive un-stall function. More...

virtual MIDI_Source *	getInitialSource ()
	Base case for recursive function. More...

void	disconnectSinkPipesShallow ()
	Disconnect only the first pipe connected to this source. More...

Private Attributes
USBMIDI_Parser	parser
	Parses USB packets into MIDI messages. More...

USBMIDI_Sender	sender
	Sends USB MIDI messages. More...

bool	alwaysSendImmediately_

MIDI_Callbacks *	callbacks = nullptr

Static Private Attributes
static MIDI_Interface *	DefaultMIDI_Interface = nullptr

Constructor & Destructor Documentation

◆ USBHostMIDI_Interface()

USBHostMIDI_Interface ( USBHost & host )

inline

Definition at line 45 of file USBHostMIDI_Interface.hpp.

Member Function Documentation

◆ sendChannelMessageImpl()

void sendChannelMessageImpl ( ChannelMessage msg )

overrideprivatevirtualinherited

Low-level function for sending a MIDI channel voice message.

Implements MIDI_Interface.

Definition at line 31 of file USBMIDI_Interface.ipp.

◆ sendSysCommonImpl()

void sendSysCommonImpl ( SysCommonMessage msg )

overrideprivatevirtualinherited

Low-level function for sending a MIDI system common message.

Implements MIDI_Interface.

Definition at line 32 of file USBMIDI_Interface.ipp.

◆ sendSysExImpl()

void sendSysExImpl ( SysExMessage msg )

overrideprivatevirtualinherited

Low-level function for sending a system exclusive MIDI message.

Implements MIDI_Interface.

Definition at line 33 of file USBMIDI_Interface.ipp.

◆ sendRealTimeImpl()

void sendRealTimeImpl ( RealTimeMessage msg )

overrideprivatevirtualinherited

Low-level function for sending a MIDI real-time message.

Implements MIDI_Interface.

Definition at line 34 of file USBMIDI_Interface.ipp.

◆ sendNowImpl()

void sendNowImpl ( )

inlineoverrideprivatevirtualinherited

Low-level function for sending any buffered outgoing MIDI messages.

Implements MIDI_Interface.

Definition at line 35 of file USBMIDI_Interface.hpp.

◆ handleStall() [1/2]

void handleStall

overrideprivatevirtualinherited

Call back that should finish any MIDI messages that are in progress, and un-stall the pipe or MIDI source as quickly as possible.

Implements MIDIStaller.

Definition at line 38 of file USBMIDI_Interface.ipp.

◆ handleStall() [2/2]

void handleStall ( MIDIInterface_t * iface )

staticinherited

Un-stall the given MIDI interface.

Assumes the interface has been stalled because of a chunked SysEx messages. Waits untill that message is finished.

Definition at line 165 of file MIDI_Interface.hpp.

◆ begin()

void begin

overridevirtualinherited

Initialize the MIDI Interface.

Reimplemented from MIDI_Interface.

Definition at line 41 of file USBMIDI_Interface.ipp.

◆ update()

void update

overridevirtualinherited

Read the MIDI interface and call the callback if a message was received.

Implements MIDI_Interface.

Definition at line 42 of file USBMIDI_Interface.ipp.

◆ read()

MIDIReadEvent read

inherited

Try reading and parsing a single incoming MIDI message.

Returns: Returns the type of the read message, or MIDIReadEvent::NO_MESSAGE if no MIDI message was available.

Definition at line 51 of file USBMIDI_Interface.ipp.

◆ getChannelMessage()

ChannelMessage getChannelMessage

inherited

Return the received channel voice message.

Definition at line 54 of file USBMIDI_Interface.ipp.

◆ getSysCommonMessage()

SysCommonMessage getSysCommonMessage

inherited

Return the received system common message.

Definition at line 56 of file USBMIDI_Interface.ipp.

◆ getRealTimeMessage()

RealTimeMessage getRealTimeMessage

inherited

Return the received real-time message.

Definition at line 58 of file USBMIDI_Interface.ipp.

◆ getSysExMessage()

SysExMessage getSysExMessage

inherited

Return the received system exclusive message.

Definition at line 60 of file USBMIDI_Interface.ipp.

◆ alwaysSendsImmediately()

bool alwaysSendsImmediately ( ) const

inlineinherited

Check if this USB interface always sends its USB packets immediately after sending a MIDI message.

The default value depends on the MIDI USB backend being used: true for the MIDIUSB library, and false for the Teensy Core USB MIDI functions (because they have a short timeout).

Definition at line 99 of file USBMIDI_Interface.hpp.

◆ neverSendImmediately()

void neverSendImmediately ( )

inlineinherited

Don't send the USB packets immediately after sending a MIDI message.

By disabling immediate transmission, packets are buffered until you call sendNow() or until a timeout is reached, so multiple MIDI messages can be transmitted in a single USB packet. This is more efficient and results in a higher maximum bandwidth, but it could increase latency when used incorrectly.

Definition at line 106 of file USBMIDI_Interface.hpp.

◆ alwaysSendImmediately()

void alwaysSendImmediately ( )

inlineinherited

Send the USB packets immediately after sending a MIDI message.

See also: neverSendImmediately()

Definition at line 109 of file USBMIDI_Interface.hpp.

◆ setAsDefault()

void setAsDefault ( )

inherited

Set this MIDI interface as the default interface.

Definition at line 15 of file MIDI_Interface.cpp.

◆ getDefault()

MIDI_Interface * getDefault ( )

staticinherited

Return the default MIDI interface.

If the default MIDI interface was configured explicitly using setAsDefault(), that interface is returned. If it wasn't set, or if that MIDI interface no longer exists, this function returns the newest MIDI interface, the one that was constructed most recently. If no MIDI interfaces exist, nullptr is returned.

Definition at line 23 of file MIDI_Interface.cpp.

◆ setCallbacks() [1/2]

void setCallbacks ( MIDI_Callbacks * cb )

inlineinherited

Set the callbacks that will be called when a MIDI message is received.

Parameters

cb	A pointer to the callback object.

Examples: MIDI-Input-Fine-Grained-All-Callbacks.ino, MIDI-Input-Fine-Grained.ino, MIDI-Input.ino, and SysEx-Send-Receive.ino.

Definition at line 58 of file MIDI_Interface.hpp.

◆ setCallbacks() [2/2]

void setCallbacks ( MIDI_Callbacks & cb )

inlineinherited

Set the callbacks that will be called when a MIDI message is received.

Parameters

cb	A reference to the callback object.

Definition at line 62 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [1/4]

void sinkMIDIfromPipe ( ChannelMessage msg )

inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI Channel message from the source pipe.

Implements MIDI_Sink.

Definition at line 81 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [2/4]

void sinkMIDIfromPipe ( SysExMessage msg )

inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI System Exclusive message from the source pipe.

Implements MIDI_Sink.

Definition at line 83 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [3/4]

void sinkMIDIfromPipe ( SysCommonMessage msg )

inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI System Common message from the source pipe.

Implements MIDI_Sink.

Definition at line 85 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [4/4]

void sinkMIDIfromPipe ( RealTimeMessage msg )

inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI Real-Time message from the source pipe.

Implements MIDI_Sink.

Definition at line 87 of file MIDI_Interface.hpp.

◆ onChannelMessage()

void onChannelMessage ( ChannelMessage message )

protectedinherited

Call the channel message callback and send the message to the sink pipe.

Definition at line 35 of file MIDI_Interface.cpp.

◆ onSysExMessage()

void onSysExMessage ( SysExMessage message )

protectedinherited

Call the SysEx message callback and send the message to the sink pipe.

Definition at line 41 of file MIDI_Interface.cpp.

◆ onSysCommonMessage()

void onSysCommonMessage ( SysCommonMessage message )

protectedinherited

Call the System Common message callback and send the message to the sink pipe.

Definition at line 47 of file MIDI_Interface.cpp.

◆ onRealTimeMessage()

void onRealTimeMessage ( RealTimeMessage message )

protectedinherited

Call the real-time message callback and send the message to the sink pipe.

Definition at line 53 of file MIDI_Interface.cpp.

◆ updateIncoming()

void updateIncoming ( MIDIInterface_t * iface )

staticinherited

Read, parse and dispatch incoming MIDI messages on the given interface.

Definition at line 122 of file MIDI_Interface.hpp.

◆ dispatchIncoming()

void dispatchIncoming	(	MIDIInterface_t *	iface,
		MIDIReadEvent	event
	)

staticinherited

Dispatch the given type of MIDI message from the given interface.

Definition at line 143 of file MIDI_Interface.hpp.

◆ connectSourcePipe()

void connectSourcePipe ( MIDI_Pipe * source )

inherited

Fully connect a source pipe to this sink.

Definition at line 16 of file MIDI_Pipes.cpp.

◆ disconnectSourcePipes()

void disconnectSourcePipes ( )

inherited

Disconnect all source pipes that sink to this sink (recursively).

Definition at line 25 of file MIDI_Pipes.cpp.

◆ disconnect() [1/4]

bool disconnect ( TrueMIDI_Source & source )

inherited

Disconnect the given source from this sink.

Leaves other sources connected. Returns true if the source was found and disconnected, false if the given source was not a direct or indirect source to this sink.

Definition at line 40 of file MIDI_Pipes.cpp.

◆ disconnect() [2/4]

bool disconnect ( MIDI_Pipe & )

deleteinherited

◆ disconnect() [3/4]

bool disconnect ( TrueMIDI_Sink & sink )

inherited

Disconnect the given sink from this source.

Leaves other sinks connected. Returns true if the sink was found and disconnected, false if the given sink was not a direct or indirect sink of this source.

Definition at line 99 of file MIDI_Pipes.cpp.

◆ disconnect() [4/4]

bool disconnect ( MIDI_Pipe & )

deleteinherited

◆ hasSourcePipe()

bool hasSourcePipe ( ) const

inlineinherited

Check if this sink is connected to a source pipe.

Definition at line 117 of file MIDI_Pipes.hpp.

◆ getSourcePipe()

MIDI_Pipe * getSourcePipe ( )

inlineinherited

Get a pointer to the pipe this sink is connected to, or nullptr if not connected.

Definition at line 120 of file MIDI_Pipes.hpp.

◆ stallDownstream()

virtual void stallDownstream	(	MIDIStaller *	,
		MIDI_Source *
	)

inlineprivatevirtualinherited

Base case for recursive stall function.

See also: MIDI_Pipe::stallDownstream

Reimplemented in MIDI_Pipe.

Definition at line 127 of file MIDI_Pipes.hpp.

◆ unstallDownstream()

virtual void unstallDownstream	(	MIDIStaller *	,
		MIDI_Source *
	)

inlineprivatevirtualinherited

Base case for recursive un-stall function.

See also: MIDI_Pipe::unstallDownstream

Reimplemented in MIDI_Pipe.

Definition at line 130 of file MIDI_Pipes.hpp.

◆ getFinalSink()

virtual MIDI_Sink * getFinalSink ( )

inlineprivatevirtualinherited

Base case for recursive function.

See also: MIDI_Pipe::getFinalSink

Reimplemented in MIDI_Pipe.

Definition at line 133 of file MIDI_Pipes.hpp.

◆ disconnectSourcePipesShallow()

void disconnectSourcePipesShallow ( )

privateinherited

Disconnect only the first pipe connected to this sink.

Leaves the other pipes connected to the original pipe, which doesn't have a sink anymore when this function finishes. Used to disconnect a MIDI_Pipe while preserving the connections of its “through” inputs.

Definition at line 33 of file MIDI_Pipes.cpp.

◆ swap() [1/2]

void swap	(	MIDI_Sink &	a,
		MIDI_Sink &	b
	)

staticinherited

Definition at line 56 of file MIDI_Pipes.cpp.

◆ swap() [2/2]

void swap	(	MIDI_Source &	a,
		MIDI_Source &	b
	)

staticinherited

Definition at line 113 of file MIDI_Pipes.cpp.

◆ sourceMIDItoPipe() [1/4]

void sourceMIDItoPipe ( ChannelMessage msg )

inherited

Send a MIDI Channel Message down the pipe.

Definition at line 132 of file MIDI_Pipes.cpp.

◆ sourceMIDItoPipe() [2/4]

void sourceMIDItoPipe ( SysExMessage msg )

inherited

Send a MIDI System Exclusive message down the pipe.

Definition at line 138 of file MIDI_Pipes.cpp.

◆ sourceMIDItoPipe() [3/4]

void sourceMIDItoPipe ( SysCommonMessage msg )

inherited

Send a MIDI System Common message down the pipe.

Definition at line 144 of file MIDI_Pipes.cpp.

◆ sourceMIDItoPipe() [4/4]

void sourceMIDItoPipe ( RealTimeMessage msg )

inherited

Send a MIDI Real-Time message down the pipe.

Definition at line 150 of file MIDI_Pipes.cpp.

◆ stall()

void stall ( MIDIStaller * cause = eternal_stall )

inherited

Stall this MIDI source.

This means that this becomes the only source that can sink to the sinks connected to this source. Other sources have to wait until this source un-stalls the pipe before they can send again.

Parameters

cause Pointer to the reason for this stall, can be called back to un-stall the pipes.

Definition at line 157 of file MIDI_Pipes.cpp.

◆ unstall()

void unstall ( MIDIStaller * cause = eternal_stall )

inherited

Un-stall the pipes connected to this source, so other sources are allowed to send again.

Parameters

cause Pointer to the reason for the stall (this has to be the same one that was used to stall).

Definition at line 162 of file MIDI_Pipes.cpp.

◆ isStalled()

bool isStalled ( ) const

inherited

Check if this source can write to the sinks it connects to.

Definition at line 167 of file MIDI_Pipes.cpp.

◆ getStaller()

MIDIStaller * getStaller ( ) const

inherited

Get a pointer to whatever is causing this MIDI source to be stalled.

There could be multiple stallers, this function just returns one.

Definition at line 173 of file MIDI_Pipes.cpp.

◆ getStallerName()

const char * getStallerName ( ) const

inherited

Get the name of whatever is causing this MIDI source to be stalled.

There could be multiple stallers, this function just returns one.

Definition at line 179 of file MIDI_Pipes.cpp.

◆ handleStallers()

void handleStallers ( ) const

inherited

Give the code that is stalling the MIDI sink pipes the opportunity to do its job and un-stall the pipes.

Definition at line 183 of file MIDI_Pipes.cpp.

◆ connectSinkPipe()

void connectSinkPipe ( MIDI_Pipe * sink )

inherited

Fully connect a sink pipe to this source.

Definition at line 75 of file MIDI_Pipes.cpp.

◆ disconnectSinkPipes()

void disconnectSinkPipes ( )

inherited

Disconnect all sink pipes that this source sinks to (recursively).

Definition at line 84 of file MIDI_Pipes.cpp.

◆ hasSinkPipe()

bool hasSinkPipe ( ) const

inlineinherited

Check if this source is connected to a sink pipe.

Definition at line 231 of file MIDI_Pipes.hpp.

◆ getSinkPipe()

MIDI_Pipe * getSinkPipe ( )

inlineinherited

Get a pointer to the pipe this source is connected to, or nullptr if not connected.

Definition at line 234 of file MIDI_Pipes.hpp.

◆ stallUpstream()

virtual void stallUpstream	(	MIDIStaller *	,
		MIDI_Sink *
	)

inlineprivatevirtualinherited

Base case for recursive stall function.

See also: MIDI_Pipe::stallUpstream

Reimplemented in MIDI_Pipe.

Definition at line 241 of file MIDI_Pipes.hpp.

◆ unstallUpstream()

virtual void unstallUpstream	(	MIDIStaller *	,
		MIDI_Sink *
	)

inlineprivatevirtualinherited

Base case for recursive un-stall function.

See also: MIDI_Pipe::unstallUpstream

Reimplemented in MIDI_Pipe.

Definition at line 244 of file MIDI_Pipes.hpp.

◆ getInitialSource()

virtual MIDI_Source * getInitialSource ( )

inlineprivatevirtualinherited

Base case for recursive function.

See also: MIDI_Pipe::getInitialSource

Reimplemented in MIDI_Pipe.

Definition at line 247 of file MIDI_Pipes.hpp.

◆ disconnectSinkPipesShallow()

void disconnectSinkPipesShallow ( )

privateinherited

Disconnect only the first pipe connected to this source.

Leaves the other pipes connected to the original pipe, which doesn't have a source anymore when this function finishes. Used to disconnect a MIDI_Pipe while preserving the connections of its “through” outputs.

Definition at line 92 of file MIDI_Pipes.cpp.

◆ send() [1/4]

void send ( ChannelMessage message )

inherited

Send a MIDI Channel Voice message.

Definition at line 17 of file MIDI_Sender.ipp.

◆ send() [2/4]

void send ( SysCommonMessage message )

inherited

Send a MIDI System Common message.

Definition at line 74 of file MIDI_Sender.ipp.

◆ send() [3/4]

void send ( SysExMessage message )

inherited

Send a MIDI System Exclusive message.

Definition at line 101 of file MIDI_Sender.ipp.

◆ send() [4/4]

void send ( RealTimeMessage message )

inherited

Send a MIDI Real-Time message.

Definition at line 114 of file MIDI_Sender.ipp.

◆ sendChannelMessage() [1/2]

void sendChannelMessage	(	MIDIMessageType	m,
		Channel	c,
		uint8_t	d1,
		uint8_t	d2,
		Cable	cable = `CABLE_1`
	)

inherited

Send a 3-byte MIDI Channel Voice message.

Parameters

m	MIDI message type. [0x80, 0xE0]
c	The MIDI channel. [1, 16]
d1	The first data byte. [0, 127]
d2	The second data byte. [0, 127]
cable	The MIDI Cable Number. [CABLE_1, CABLE_16]

Definition at line 33 of file MIDI_Sender.ipp.

◆ sendChannelMessage() [2/2]

void sendChannelMessage	(	MIDIMessageType	m,
		Channel	c,
		uint8_t	d1,
		Cable	cable = `CABLE_1`
	)

inherited

Send a 2-byte MIDI Channel Voice message.

Parameters

m	MIDI message type. [0x80, 0xE0]
c	The MIDI channel. [1, 16]
d1	The first data byte. [0, 127]
cable	The MIDI Cable Number. [1, 16]

Definition at line 48 of file MIDI_Sender.ipp.

◆ sendNoteOn()

void sendNoteOn	(	MIDIAddress	address,
		uint8_t	velocity
	)

inherited

Send a MIDI Note On event.

Examples: MIDI-Output.ino, Send-All-MIDI-Messages.ino, and Send-MIDI-Notes.ino.

Definition at line 52 of file MIDI_Sender.ipp.

◆ sendNoteOff()

void sendNoteOff	(	MIDIAddress	address,
		uint8_t	velocity
	)

inherited

Send a MIDI Note Off event.

Examples: MIDI-Output.ino, Send-All-MIDI-Messages.ino, and Send-MIDI-Notes.ino.

Definition at line 54 of file MIDI_Sender.ipp.

◆ sendKeyPressure()

void sendKeyPressure	(	MIDIAddress	address,
		uint8_t	pressure
	)

inherited

Send a MIDI Key Pressure event.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 56 of file MIDI_Sender.ipp.

◆ sendControlChange()

void sendControlChange	(	MIDIAddress	address,
		uint8_t	value
	)

inherited

Send a MIDI Control Change event.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 58 of file MIDI_Sender.ipp.

◆ sendProgramChange() [1/2]

void sendProgramChange ( MIDIAddress address )

inherited

Send a MIDI Program Change event.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 60 of file MIDI_Sender.ipp.

◆ sendProgramChange() [2/2]

void sendProgramChange	(	MIDIChannelCable	address,
		uint8_t	value
	)

inherited

Send a MIDI Program Change event.

Definition at line 62 of file MIDI_Sender.ipp.

◆ sendChannelPressure()

void sendChannelPressure	(	MIDIChannelCable	address,
		uint8_t	pressure
	)

inherited

Send a MIDI Channel Pressure event.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 64 of file MIDI_Sender.ipp.

◆ sendPitchBend()

void sendPitchBend	(	MIDIChannelCable	address,
		uint16_t	value
	)

inherited

Send a MIDI Pitch Bend event.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 66 of file MIDI_Sender.ipp.

◆ sendSysCommon() [1/3]

void sendSysCommon	(	MIDIMessageType	m,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI System Common message.

Definition at line 76 of file MIDI_Sender.ipp.

◆ sendSysCommon() [2/3]

void sendSysCommon	(	MIDIMessageType	m,
		uint8_t	data1,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI System Common message.

Definition at line 78 of file MIDI_Sender.ipp.

◆ sendSysCommon() [3/3]

void sendSysCommon	(	MIDIMessageType	m,
		uint8_t	data1,
		uint8_t	data2,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI System Common message.

Definition at line 80 of file MIDI_Sender.ipp.

◆ sendMTCQuarterFrame() [1/2]

void sendMTCQuarterFrame	(	uint8_t	data,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI Time Code Quarter Frame.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 84 of file MIDI_Sender.ipp.

◆ sendMTCQuarterFrame() [2/2]

void sendMTCQuarterFrame	(	uint8_t	messageType,
		uint8_t	values,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI Time Code Quarter Frame.

Definition at line 86 of file MIDI_Sender.ipp.

◆ sendSongPositionPointer()

void sendSongPositionPointer	(	uint16_t	spp,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI Song Position Pointer message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 89 of file MIDI_Sender.ipp.

◆ sendSongSelect()

void sendSongSelect	(	uint8_t	song,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI Song Select message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 91 of file MIDI_Sender.ipp.

◆ sendTuneRequest()

void sendTuneRequest ( Cable cable = CABLE_1 )

inherited

Send a MIDI Tune Request.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 93 of file MIDI_Sender.ipp.

◆ sendSysEx() [1/2]

void sendSysEx	(	const uint8_t(&)	sysexdata[N],
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI System Exclusive message.

Examples: Send-All-MIDI-Messages.ino, and SysEx-Send-Receive.ino.

Definition at line 104 of file MIDI_Sender.ipp.

◆ sendSysEx() [2/2]

void sendSysEx	(	const uint8_t *	data,
		uint16_t	length,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI System Exclusive message.

Definition at line 106 of file MIDI_Sender.ipp.

◆ sendRealTime() [1/2]

void sendRealTime	(	MIDIMessageType	rt,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI Real-Time message.

Definition at line 116 of file MIDI_Sender.ipp.

◆ sendRealTime() [2/2]

void sendRealTime	(	uint8_t	rt,
		Cable	cable = `CABLE_1`
	)

inherited

Send a MIDI Real-Time message.

Definition at line 118 of file MIDI_Sender.ipp.

◆ sendTimingClock()

void sendTimingClock ( Cable cable = CABLE_1 )

inherited

Send a MIDI Timing Clock message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 121 of file MIDI_Sender.ipp.

◆ sendStart()

void sendStart ( Cable cable = CABLE_1 )

inherited

Send a MIDI Start message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 123 of file MIDI_Sender.ipp.

◆ sendContinue()

void sendContinue ( Cable cable = CABLE_1 )

inherited

Send a MIDI Continue message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 125 of file MIDI_Sender.ipp.

◆ sendStop()

void sendStop ( Cable cable = CABLE_1 )

inherited

Send a MIDI Stop message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 127 of file MIDI_Sender.ipp.

◆ sendActiveSensing()

void sendActiveSensing ( Cable cable = CABLE_1 )

inherited

Send a MIDI Active Sensing message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 129 of file MIDI_Sender.ipp.

◆ sendSystemReset()

void sendSystemReset ( Cable cable = CABLE_1 )

inherited

Send a MIDI System Reset message.

Examples: Send-All-MIDI-Messages.ino.

Definition at line 131 of file MIDI_Sender.ipp.

◆ sendNow()

void sendNow

inherited

Causes all buffered messages to be sent immediately.

Note: Doesn't necessarily wait until all data has been sent, it just triggers the transmission, so everything will be transmitted as soon as possible.

Definition at line 142 of file MIDI_Sender.ipp.

◆ sendKP()

void sendKP	(	MIDIAddress	address,
		uint8_t	pressure
	)

inherited

Send a MIDI Key Pressure event.

Definition at line 152 of file MIDI_Sender.ipp.

◆ sendCC()

void sendCC	(	MIDIAddress	address,
		uint8_t	value
	)

inherited

Send a MIDI Control Change event.

Definition at line 156 of file MIDI_Sender.ipp.

◆ sendPC() [1/2]

void sendPC ( MIDIAddress address )

inherited

Send a MIDI Program Change event.

Definition at line 160 of file MIDI_Sender.ipp.

◆ sendPC() [2/2]

void sendPC	(	MIDIChannelCable	address,
		uint8_t	value
	)

inherited

Send a MIDI Program Change event.

Definition at line 164 of file MIDI_Sender.ipp.

◆ sendCP()

void sendCP	(	MIDIChannelCable	address,
		uint8_t	pressure
	)

inherited

Send a MIDI Channel Pressure event.

Definition at line 168 of file MIDI_Sender.ipp.

◆ sendPB()

void sendPB	(	MIDIChannelCable	address,
		uint16_t	value
	)

inherited

Send a MIDI Pitch Bend event.

Definition at line 172 of file MIDI_Sender.ipp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Examples: MIDI-Monitor.ino.

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Examples: MIDI-Monitor.ino.

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< MIDI_Interface > > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< MIDI_Interface > > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 134 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< Updatable< MIDI_Interface > > * element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< Updatable< MIDI_Interface > > & element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 145 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 124 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

◆ getName()

virtual const char * getName ( ) const

inlinevirtualinherited

Get the staller's name for debugging purposes.

Definition at line 15 of file MIDI_Staller.hpp.

◆ getNameNull()

const char * getNameNull ( MIDIStaller * s )

staticinherited

Get the staller's name for debugging purposes.

Correctly deals with null pointers or eternal stallers.

Definition at line 354 of file MIDI_Pipes.cpp.

Member Data Documentation

◆ backend

USBHostMIDIBackend< 64 > backend

inherited

The (platform-specific) backend used for MIDI over USB communication.

Definition at line 69 of file USBMIDI_Interface.hpp.

◆ parser

USBMIDI_Parser parser

privateinherited

Parses USB packets into MIDI messages.

Definition at line 85 of file USBMIDI_Interface.hpp.

◆ sender

USBMIDI_Sender sender

privateinherited

Sends USB MIDI messages.

Definition at line 87 of file USBMIDI_Interface.hpp.

◆ alwaysSendImmediately_

bool alwaysSendImmediately_

privateinherited

See also: neverSendImmediately()

Definition at line 89 of file USBMIDI_Interface.hpp.

◆ callbacks

MIDI_Callbacks* callbacks = nullptr

privateinherited

Definition at line 115 of file MIDI_Interface.hpp.

◆ DefaultMIDI_Interface

MIDI_Interface * DefaultMIDI_Interface = nullptr

staticprivateinherited

Definition at line 118 of file MIDI_Interface.hpp.

◆ sourcePipe

MIDI_Pipe* sourcePipe = nullptr

protectedinherited

Definition at line 142 of file MIDI_Pipes.hpp.

◆ sinkPipe

MIDI_Pipe* sinkPipe = nullptr

protectedinherited

Definition at line 256 of file MIDI_Pipes.hpp.

◆ updatables

DoublyLinkedList< Updatable< MIDI_Interface > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< MIDI_Interface > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< MIDI_Interface > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

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

USBHostMIDI_Interface.hpp

Detailed Description

Reading incoming MIDI messages

Buffering USB packets

Default MIDI Interfaces

MIDI Input Callbacks

Connecting and disconnecting MIDI Pipes

Connecting and disconnecting MIDI Pipes

Sending data over a MIDI Pipe

Stalling the sink pipes and exclusive access

Sending MIDI Channel Voice messages

Sending MIDI System Common messages

Sending MIDI System Exclusive messages

Sending MIDI Real-Time messages

Flusing the MIDI send buffer

Deprecated

Enabling and disabling updatables

Underlying USB communication

Main initialization and updating methods

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ USBHostMIDI_Interface()

Member Function Documentation

◆ sendChannelMessageImpl()

◆ sendSysCommonImpl()

◆ sendSysExImpl()

◆ sendRealTimeImpl()

◆ sendNowImpl()

◆ handleStall() [1/2]

◆ handleStall() [2/2]

◆ begin()

◆ update()

◆ read()

◆ getChannelMessage()

◆ getSysCommonMessage()

◆ getRealTimeMessage()

◆ getSysExMessage()

◆ alwaysSendsImmediately()

◆ neverSendImmediately()

◆ alwaysSendImmediately()

◆ setAsDefault()

◆ getDefault()

◆ setCallbacks() [1/2]

◆ setCallbacks() [2/2]

◆ sinkMIDIfromPipe() [1/4]

◆ sinkMIDIfromPipe() [2/4]

◆ sinkMIDIfromPipe() [3/4]

◆ sinkMIDIfromPipe() [4/4]

◆ onChannelMessage()

◆ onSysExMessage()

◆ onSysCommonMessage()

◆ onRealTimeMessage()

◆ updateIncoming()

◆ dispatchIncoming()

◆ connectSourcePipe()

◆ disconnectSourcePipes()

◆ disconnect() [1/4]

◆ disconnect() [2/4]

◆ disconnect() [3/4]

◆ disconnect() [4/4]

◆ hasSourcePipe()

◆ getSourcePipe()

◆ stallDownstream()

◆ unstallDownstream()

◆ getFinalSink()

◆ disconnectSourcePipesShallow()

◆ swap() [1/2]

◆ swap() [2/2]

◆ sourceMIDItoPipe() [1/4]

◆ sourceMIDItoPipe() [2/4]

◆ sourceMIDItoPipe() [3/4]

◆ sourceMIDItoPipe() [4/4]

◆ stall()