46 #define RTMIDI_VERSION "2.1.1"
88 virtual void printMessage(
void )
const throw() { std::cerr <<
'\n' << message_ <<
"\n\n"; }
91 virtual const Type&
getType(
void)
const throw() {
return type_; }
94 virtual const std::string&
getMessage(
void)
const throw() {
return message_; }
97 virtual const char*
what(
void )
const throw() {
return message_.c_str(); }
100 std::string message_;
131 static std::string
getVersion(
void ) throw();
142 virtual
void openPort(
unsigned int portNumber = 0, const std::
string portName = std::
string( "
RtMidi" ) ) = 0;
145 virtual
void openVirtualPort( const std::
string portName = std::
string( "RtMidi" ) ) = 0;
151 virtual std::
string getPortName(
unsigned int portNumber = 0 ) = 0;
211 typedef void (*RtMidiCallback)(
double timeStamp, std::vector<unsigned char> *message,
void *userData);
232 const std::string clientName = std::string(
"RtMidi Input Client"),
233 unsigned int queueSizeLimit = 100 );
239 RtMidi::
Api getCurrentApi(
void ) throw();
247 void openPort(
unsigned int portNumber = 0, const std::
string portName = std::
string( "RtMidi Input" ) );
259 void openVirtualPort( const std::
string portName = std::
string( "RtMidi Input" ) );
272 void setCallback( RtMidiCallback callback,
void *userData = 0 );
279 void cancelCallback();
291 unsigned int getPortCount();
298 std::
string getPortName(
unsigned int portNumber = 0 );
308 void ignoreTypes(
bool midiSysex = true,
bool midiTime = true,
bool midiSense = true );
318 double getMessage( std::vector<
unsigned char> *message );
328 void openMidiApi( RtMidi::
Api api, const std::
string clientName,
unsigned int queueSizeLimit );
361 const std::string clientName = std::string(
"RtMidi Output Client") );
376 void openPort(
unsigned int portNumber = 0,
const std::string portName = std::string(
"RtMidi Output" ) );
393 void openVirtualPort(
const std::string portName = std::string(
"RtMidi Output" ) );
402 std::string
getPortName(
unsigned int portNumber = 0 );
409 void sendMessage( std::vector<unsigned char> *message );
419 void openMidiApi(
RtMidi::Api api,
const std::string clientName );
443 virtual void openPort(
unsigned int portNumber,
const std::string portName ) = 0;
448 virtual std::string
getPortName(
unsigned int portNumber ) = 0;
450 inline bool isPortOpen()
const {
return connected_; }
457 virtual void initialize(
const std::string& clientName ) = 0;
461 std::string errorString_;
463 bool firstErrorOccurred_;
464 void *errorCallbackUserData_;
471 MidiInApi(
unsigned int queueSizeLimit );
474 void cancelCallback(
void );
475 virtual void ignoreTypes(
bool midiSysex,
bool midiTime,
bool midiSense );
476 double getMessage( std::vector<unsigned char> *message );
481 std::vector<unsigned char> bytes;
486 :bytes(0), timeStamp(0.0) {}
493 unsigned int ringSize;
498 :front(0), back(0), size(0), ringSize(0) {}
506 unsigned char ignoreFlags;
517 : ignoreFlags(7), doInput(
false), firstMessage(
true),
518 apiData(0), usingCallback(
false), userCallback(0), userData(0),
519 continueSysex(
false) {}
532 virtual void sendMessage( std::vector<unsigned char> *message ) = 0;
542 inline void RtMidiIn :: openPort(
unsigned int portNumber,
const std::string portName ) { rtapi_->openPort( portNumber, portName ); }
555 inline void RtMidiOut :: openPort(
unsigned int portNumber,
const std::string portName ) { rtapi_->openPort( portNumber, portName ); }
570 #if !defined(__LINUX_ALSA__) && !defined(__UNIX_JACK__) && !defined(__MACOSX_CORE__) && !defined(__WINDOWS_MM__)
571 #define __RTMIDI_DUMMY__
574 #if defined(__MACOSX_CORE__)
579 MidiInCore(
const std::string clientName,
unsigned int queueSizeLimit );
582 void openPort(
unsigned int portNumber,
const std::string portName );
586 std::string
getPortName(
unsigned int portNumber );
589 void initialize(
const std::string& clientName );
598 void openPort(
unsigned int portNumber,
const std::string portName );
602 std::string
getPortName(
unsigned int portNumber );
603 void sendMessage( std::vector<unsigned char> *message );
606 void initialize(
const std::string& clientName );
611 #if defined(__UNIX_JACK__)
616 MidiInJack(
const std::string clientName,
unsigned int queueSizeLimit );
619 void openPort(
unsigned int portNumber,
const std::string portName );
623 std::string
getPortName(
unsigned int portNumber );
626 std::string clientName;
628 void connect(
void );
629 void initialize(
const std::string& clientName );
638 void openPort(
unsigned int portNumber,
const std::string portName );
642 std::string
getPortName(
unsigned int portNumber );
643 void sendMessage( std::vector<unsigned char> *message );
646 std::string clientName;
648 void connect(
void );
649 void initialize(
const std::string& clientName );
654 #if defined(__LINUX_ALSA__)
659 MidiInAlsa(
const std::string clientName,
unsigned int queueSizeLimit );
662 void openPort(
unsigned int portNumber,
const std::string portName );
666 std::string
getPortName(
unsigned int portNumber );
669 void initialize(
const std::string& clientName );
678 void openPort(
unsigned int portNumber,
const std::string portName );
682 std::string
getPortName(
unsigned int portNumber );
683 void sendMessage( std::vector<unsigned char> *message );
686 void initialize(
const std::string& clientName );
691 #if defined(__WINDOWS_MM__)
696 MidiInWinMM(
const std::string clientName,
unsigned int queueSizeLimit );
699 void openPort(
unsigned int portNumber,
const std::string portName );
703 std::string
getPortName(
unsigned int portNumber );
706 void initialize(
const std::string& clientName );
715 void openPort(
unsigned int portNumber,
const std::string portName );
719 std::string
getPortName(
unsigned int portNumber );
720 void sendMessage( std::vector<unsigned char> *message );
723 void initialize(
const std::string& clientName );
728 #if defined(__RTMIDI_DUMMY__)
733 MidiInDummy(
const std::string ,
unsigned int queueSizeLimit ) :
MidiInApi( queueSizeLimit ) { errorString_ =
"MidiInDummy: This class provides no functionality."; error(
RtMidiError::WARNING, errorString_ ); }
735 void openPort(
unsigned int ,
const std::string ) {}
739 std::string
getPortName(
unsigned int portNumber ) {
return ""; }
742 void initialize(
const std::string& ) {}
748 MidiOutDummy(
const std::string ) { errorString_ =
"MidiOutDummy: This class provides no functionality."; error(
RtMidiError::WARNING, errorString_ ); }
750 void openPort(
unsigned int ,
const std::string ) {}
754 std::string
getPortName(
unsigned int ) {
return ""; }
755 void sendMessage( std::vector<unsigned char> * ) {}
758 void initialize(
const std::string& ) {}
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)
Set an error callback function to be invoked when an error has occured.
Definition: RtMidi.h:562
RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiIn.
Definition: RtMidi.h:541
std::string getPortName(unsigned int portNumber=0)
Return a string identifier for the specified MIDI port type and number.
Definition: RtMidi.h:560
void(* RtMidiErrorCallback)(RtMidiError::Type type, const std::string &errorText, void *userData)
RtMidi error callback function prototype.
Definition: RtMidi.h:112
A realtime MIDI input class.
Definition: RtMidi.h:206
virtual unsigned int getPortCount()=0
Pure virtual getPortCount() function.
virtual void openVirtualPort(const std::string portName=std::string("RtMidi"))=0
Pure virtual openVirtualPort() function.
RtMidiError(const std::string &message, Type type=RtMidiError::UNSPECIFIED)
The constructor.
Definition: RtMidi.h:82
virtual void openPort(unsigned int portNumber=0, const std::string portName=std::string("RtMidi"))=0
Pure virtual openPort() function.
virtual const char * what(void) const
Returns the thrown error message as a c-style string.
Definition: RtMidi.h:97
An abstract base class for realtime MIDI input/output.
Definition: RtMidi.h:116
void ignoreTypes(bool midiSysex=true, bool midiTime=true, bool midiSense=true)
Specify whether certain MIDI message types should be queued or ignored during input.
Definition: RtMidi.h:550
virtual void closePort(void)=0
Pure virtual closePort() function.
void closePort(void)
Close an open MIDI connection (if one exists).
Definition: RtMidi.h:544
virtual std::string getPortName(unsigned int portNumber=0)=0
Pure virtual getPortName() function.
Api
MIDI API specifier arguments.
Definition: RtMidi.h:121
void(* RtMidiCallback)(double timeStamp, std::vector< unsigned char > *message, void *userData)
User callback function type definition.
Definition: RtMidi.h:211
void openVirtualPort(const std::string portName=std::string("RtMidi Input"))
Create a virtual input port, with optional name, to allow software connections (OS X...
Definition: RtMidi.h:543
void sendMessage(std::vector< unsigned char > *message)
Immediately send a single message out an open MIDI output port.
Definition: RtMidi.h:561
void setCallback(RtMidiCallback callback, void *userData=0)
Set a callback function to be invoked for incoming MIDI messages.
Definition: RtMidi.h:546
Type
Defined RtMidiError types.
Definition: RtMidi.h:67
void openVirtualPort(const std::string portName=std::string("RtMidi Output"))
Create a virtual output port, with optional name, to allow software connections (OS X...
Definition: RtMidi.h:556
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)=0
Set an error callback function to be invoked when an error has occured.
unsigned int getPortCount(void)
Return the number of available MIDI output ports.
Definition: RtMidi.h:559
unsigned int getPortCount()
Return the number of available MIDI input ports.
Definition: RtMidi.h:548
void cancelCallback()
Cancel use of the current callback function (if one exists).
Definition: RtMidi.h:547
void closePort(void)
Close an open MIDI connection (if one exists).
Definition: RtMidi.h:557
std::string getPortName(unsigned int portNumber=0)
Return a string identifier for the specified MIDI input port number.
Definition: RtMidi.h:549
RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiOut.
Definition: RtMidi.h:554
virtual bool isPortOpen() const
Returns true if a port is open and false if not.
Definition: RtMidi.h:558
virtual bool isPortOpen(void) const =0
Returns true if a port is open and false if not.
void openPort(unsigned int portNumber=0, const std::string portName=std::string("RtMidi Output"))
Open a MIDI output connection.
Definition: RtMidi.h:555
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)
Set an error callback function to be invoked when an error has occured.
Definition: RtMidi.h:552
virtual ~RtMidiError(void)
The destructor.
Definition: RtMidi.h:85
virtual const std::string & getMessage(void) const
Returns the thrown error message string.
Definition: RtMidi.h:94
Exception handling class for RtMidi.
Definition: RtMidi.h:63
double getMessage(std::vector< unsigned char > *message)
Fill the user-provided vector with the data bytes for the next available MIDI message in the input qu...
Definition: RtMidi.h:551
virtual bool isPortOpen() const
Returns true if a port is open and false if not.
Definition: RtMidi.h:545
static void getCompiledApi(std::vector< RtMidi::Api > &apis)
A static function to determine the available compiled MIDI APIs.
A realtime MIDI output class.
Definition: RtMidi.h:348
virtual const Type & getType(void) const
Returns the thrown error message type.
Definition: RtMidi.h:91
virtual void printMessage(void) const
Prints thrown error message to stderr.
Definition: RtMidi.h:88
void openPort(unsigned int portNumber=0, const std::string portName=std::string("RtMidi Input"))
Open a MIDI input connection given by enumeration number.
Definition: RtMidi.h:542
static std::string getVersion(void)
A static function to determine the current RtMidi version.