#include <MIDI_Interfaces/MIDI_Pipes.hpp>
Class that can send MIDI messages to a MIDI pipe.
Definition at line 160 of file MIDI_Pipes.hpp.
Sending data over a MIDI Pipe | |
void | sourceMIDItoPipe (ChannelMessage) |
Send a MIDI Channel Message down the pipe. | |
void | sourceMIDItoPipe (SysExMessage) |
Send a MIDI System Exclusive message down the pipe. | |
void | sourceMIDItoPipe (SysCommonMessage) |
Send a MIDI System Common message down the pipe. | |
void | sourceMIDItoPipe (RealTimeMessage) |
Send a MIDI Real-Time message down the pipe. | |
Stalling the sink pipes and exclusive access | |
void | stall (MIDIStaller *cause=eternal_stall) |
Stall this MIDI source. | |
void | unstall (MIDIStaller *cause=eternal_stall) |
Un-stall the pipes connected to this source, so other sources are allowed to send again. | |
bool | isStalled () const |
Check if this source can write to the sinks it connects to. | |
MIDIStaller * | getStaller () const |
Get a pointer to whatever is causing this MIDI source to be stalled. | |
const char * | getStallerName () const |
Get the name of whatever is causing this MIDI source to be stalled. | |
void | handleStallers () const |
Give the code that is stalling the MIDI sink pipes the opportunity to do its job and un-stall the pipes. | |
Connecting and disconnecting MIDI Pipes | |
void | connectSinkPipe (MIDI_Pipe *sink) |
Fully connect a sink pipe to this source. | |
void | disconnectSinkPipes () |
Disconnect all sink pipes that this source sinks to (recursively). | |
bool | disconnect (TrueMIDI_Sink &sink) |
Disconnect the given sink from this source. | |
bool | disconnect (MIDI_Pipe &)=delete |
bool | hasSinkPipe () const |
Check if this source is connected to a sink pipe. | |
MIDI_Pipe * | getSinkPipe () |
Get a pointer to the pipe this source is connected to, or nullptr if not connected. | |
Public Member Functions | |
MIDI_Source ()=default | |
Default constructor. | |
MIDI_Source (const MIDI_Source &)=delete | |
Copy constructor (copying not allowed). | |
MIDI_Source & | operator= (const MIDI_Source &)=delete |
Copy assignment (copying not allowed). | |
MIDI_Source (MIDI_Source &&other) | |
Move constructor. | |
MIDI_Source & | operator= (MIDI_Source &&other) |
Move assignment. | |
virtual | ~MIDI_Source () |
Destructor. | |
Static Public Member Functions | |
static void | swap (MIDI_Source &a, MIDI_Source &b) |
Protected Attributes | |
MIDI_Pipe * | sinkPipe = nullptr |
Private Member Functions | |
virtual void | stallUpstream (MIDIStaller *, MIDI_Sink *) |
Base case for recursive stall function. | |
virtual void | unstallUpstream (MIDIStaller *, MIDI_Sink *) |
Base case for recursive un-stall function. | |
virtual MIDI_Source * | getInitialSource () |
Base case for recursive function. | |
void | disconnectSinkPipesShallow () |
Disconnect only the first pipe connected to this source. | |
|
default |
Default constructor.
|
delete |
Copy constructor (copying not allowed).
MIDI_Source | ( | MIDI_Source && | other | ) |
Move constructor.
Definition at line 106 of file MIDI_Pipes.cpp.
|
virtual |
Destructor.
Definition at line 131 of file MIDI_Pipes.cpp.
|
delete |
Copy assignment (copying not allowed).
MIDI_Source & operator= | ( | MIDI_Source && | other | ) |
Move assignment.
Definition at line 126 of file MIDI_Pipes.cpp.
void sourceMIDItoPipe | ( | ChannelMessage | msg | ) |
Send a MIDI Channel Message down the pipe.
Definition at line 133 of file MIDI_Pipes.cpp.
void sourceMIDItoPipe | ( | SysExMessage | msg | ) |
Send a MIDI System Exclusive message down the pipe.
Definition at line 139 of file MIDI_Pipes.cpp.
void sourceMIDItoPipe | ( | SysCommonMessage | msg | ) |
Send a MIDI System Common message down the pipe.
Definition at line 145 of file MIDI_Pipes.cpp.
void sourceMIDItoPipe | ( | RealTimeMessage | msg | ) |
Send a MIDI Real-Time message down the pipe.
Definition at line 151 of file MIDI_Pipes.cpp.
void stall | ( | MIDIStaller * | cause = eternal_stall | ) |
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.
cause | Pointer to the reason for this stall, can be called back to un-stall the pipes. |
Definition at line 158 of file MIDI_Pipes.cpp.
void unstall | ( | MIDIStaller * | cause = eternal_stall | ) |
Un-stall the pipes connected to this source, so other sources are allowed to send again.
cause | Pointer to the reason for the stall (this has to be the same one that was used to stall). |
Definition at line 164 of file MIDI_Pipes.cpp.
bool isStalled | ( | ) | const |
Check if this source can write to the sinks it connects to.
Definition at line 170 of file MIDI_Pipes.cpp.
MIDIStaller * getStaller | ( | ) | const |
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 176 of file MIDI_Pipes.cpp.
const char * getStallerName | ( | ) | const |
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 182 of file MIDI_Pipes.cpp.
void handleStallers | ( | ) | const |
Give the code that is stalling the MIDI sink pipes the opportunity to do its job and un-stall the pipes.
Definition at line 186 of file MIDI_Pipes.cpp.
void connectSinkPipe | ( | MIDI_Pipe * | sink | ) |
Fully connect a sink pipe to this source.
Definition at line 76 of file MIDI_Pipes.cpp.
void disconnectSinkPipes | ( | ) |
Disconnect all sink pipes that this source sinks to (recursively).
Definition at line 85 of file MIDI_Pipes.cpp.
bool disconnect | ( | TrueMIDI_Sink & | sink | ) |
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 100 of file MIDI_Pipes.cpp.
|
delete |
|
inline |
Check if this source is connected to a sink pipe.
Definition at line 237 of file MIDI_Pipes.hpp.
|
inline |
Get a pointer to the pipe this source is connected to, or nullptr
if not connected.
Definition at line 240 of file MIDI_Pipes.hpp.
|
inlineprivatevirtual |
Base case for recursive stall function.
Reimplemented in MIDI_Pipe.
Definition at line 247 of file MIDI_Pipes.hpp.
|
inlineprivatevirtual |
Base case for recursive un-stall function.
Reimplemented in MIDI_Pipe.
Definition at line 250 of file MIDI_Pipes.hpp.
|
inlineprivatevirtual |
Base case for recursive function.
Reimplemented in MIDI_Pipe.
Definition at line 253 of file MIDI_Pipes.hpp.
|
private |
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 93 of file MIDI_Pipes.cpp.
|
static |
Definition at line 114 of file MIDI_Pipes.cpp.
|
protected |
Definition at line 262 of file MIDI_Pipes.hpp.