Control Surface master
MIDI Control Surface library for Arduino
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 | List of all members
FortySevenEffectsMIDI_Interface< MidiInterface > Class Template Reference

#include <MIDI_Interfaces/Wrappers/FortySevenEffects.hpp>

Detailed Description

template<class MidiInterface>
class FortySevenEffectsMIDI_Interface< MidiInterface >

Class that wraps the FortySevenEffects MIDI library.

This wrapper allows you to use MIDI interfaces that inherit from the FortySevenEffects MIDI library as a native Control Surface MIDI Interface.

It's not recommended to use this wrapper for normal Serial or USB MIDI interfaces, you should use the HardwareSerialMIDI_Interface and USBMIDI_Interface classes for that (see MIDI Interfaces).

It can be useful, however, to use the AppleMIDI library, which uses the FortySevenEffects MidiInterface as its main public API.

Template Parameters
MidiInterfaceThe type of FortySevenEffects MIDI interface to use. You should probably just use decltype as demonstrated in the AppleMIDI.ino example.
Examples
AppleMIDI.ino.

Definition at line 87 of file FortySevenEffects.hpp.

+ Inheritance diagram for FortySevenEffectsMIDI_Interface< MidiInterface >:
+ Collaboration diagram for FortySevenEffectsMIDI_Interface< MidiInterface >:

Default MIDI Interfaces

void setAsDefault ()
 Set this MIDI interface as the default interface. More...
 
static MIDI_InterfacegetDefault ()
 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_PipegetSourcePipe ()
 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_PipegetSinkPipe ()
 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...
 
MIDIStallergetStaller () 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...
 
template<class U , size_t N>
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...
 
template<class U , size_t N>
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...
 

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

 FortySevenEffectsMIDI_Interface (MidiInterface &&midi)
 
void begin () override
 Initialize the MIDI Interface. More...
 
MIDIReadEvent read ()
 
ChannelMessage getChannelMessage () const
 Return the received channel voice message. More...
 
RealTimeMessage getRealTimeMessage () const
 Return the received real-time message. More...
 
SysCommonMessage getSysCommonMessage () const
 Return the received system common message. More...
 
SysExMessage getSysExMessage () const
 Return the received system exclusive message. 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 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...
 
template<class MIDIInterface_t >
static void handleStall (MIDIInterface_t *iface)
 Un-stall the given MIDI interface. More...
 
static void swap (MIDI_Sink &a, MIDI_Sink &b)
 
static void swap (MIDI_Source &a, MIDI_Source &b)
 

Protected Member Functions

void dispatchMIDIEvent (MIDIReadEvent event)
 
void sendChannelMessageImpl (ChannelMessage msg) override
 Low-level function for sending a MIDI channel voice message. More...
 
void sendSysCommonImpl (SysCommonMessage msg) override
 Low-level function for sending a MIDI system common message. More...
 
void sendSysExImpl (SysExMessage msg)
 Low-level function for sending a system exclusive MIDI message. More...
 
void sendRealTimeImpl (RealTimeMessage msg) 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 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_PipesourcePipe = nullptr
 
MIDI_PipesinkPipe = nullptr
 
Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Private Member Functions

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_SinkgetFinalSink ()
 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_SourcegetInitialSource ()
 Base case for recursive function. More...
 
void disconnectSinkPipesShallow ()
 Disconnect only the first pipe connected to this source. More...
 

Private Attributes

FortySevenEffectsMIDI_Parser parser
 
MidiInterface midi
 
MIDI_Callbackscallbacks = nullptr
 

Static Private Attributes

static MIDI_InterfaceDefaultMIDI_Interface = nullptr
 

Constructor & Destructor Documentation

◆ FortySevenEffectsMIDI_Interface()

FortySevenEffectsMIDI_Interface ( MidiInterface &&  midi)
inline

Definition at line 89 of file FortySevenEffects.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtual

Initialize the MIDI Interface.

Reimplemented from MIDI_Interface.

Definition at line 92 of file FortySevenEffects.hpp.

◆ read()

MIDIReadEvent read ( )
inline

Definition at line 94 of file FortySevenEffects.hpp.

◆ getChannelMessage()

ChannelMessage getChannelMessage ( ) const
inline

Return the received channel voice message.

Definition at line 117 of file FortySevenEffects.hpp.

◆ getRealTimeMessage()

RealTimeMessage getRealTimeMessage ( ) const
inline

Return the received real-time message.

Definition at line 121 of file FortySevenEffects.hpp.

◆ getSysCommonMessage()

SysCommonMessage getSysCommonMessage ( ) const
inline

Return the received system common message.

Definition at line 125 of file FortySevenEffects.hpp.

◆ getSysExMessage()

SysExMessage getSysExMessage ( ) const
inline

Return the received system exclusive message.

Definition at line 129 of file FortySevenEffects.hpp.

◆ update()

void update ( )
inlineoverridevirtual

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

Implements MIDI_Interface.

Definition at line 131 of file FortySevenEffects.hpp.

◆ dispatchMIDIEvent()

void dispatchMIDIEvent ( MIDIReadEvent  event)
inlineprotected

Definition at line 142 of file FortySevenEffects.hpp.

◆ sendChannelMessageImpl()

void sendChannelMessageImpl ( ChannelMessage  )
inlineoverrideprotectedvirtual

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

Implements MIDI_Interface.

Definition at line 162 of file FortySevenEffects.hpp.

◆ sendSysCommonImpl()

void sendSysCommonImpl ( SysCommonMessage  )
inlineoverrideprotectedvirtual

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

Implements MIDI_Interface.

Definition at line 168 of file FortySevenEffects.hpp.

◆ sendSysExImpl()

void sendSysExImpl ( SysExMessage  )
inlineprotectedvirtual

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

Implements MIDI_Interface.

Definition at line 173 of file FortySevenEffects.hpp.

◆ sendRealTimeImpl()

void sendRealTimeImpl ( RealTimeMessage  )
inlineoverrideprotectedvirtual

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

Implements MIDI_Interface.

Definition at line 177 of file FortySevenEffects.hpp.

◆ sendNowImpl()

void sendNowImpl ( )
inlineoverrideprotectedvirtual

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

Implements MIDI_Interface.

Definition at line 180 of file FortySevenEffects.hpp.

◆ handleStall() [1/2]

void handleStall ( )
inlineoverrideprivatevirtual

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 184 of file FortySevenEffects.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
cbA 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
cbA 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.

◆ 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.

◆ 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
causePointer 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
causePointer 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
mMIDI message type. [0x80, 0xE0]
cThe MIDI channel. [1, 16]
d1The first data byte. [0, 127]
d2The second data byte. [0, 127]
cableThe 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
mMIDI message type. [0x80, 0xE0]
cThe MIDI channel. [1, 16]
d1The first data byte. [0, 127]
cableThe 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< Derived > *  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< Derived > &  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< Derived > *  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< Derived > &  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

◆ parser

Definition at line 191 of file FortySevenEffects.hpp.

◆ midi

MidiInterface midi
private

Definition at line 192 of file FortySevenEffects.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< Derived > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Derived * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Derived * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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