47#if defined _WIN32 || defined __CYGWIN__
48 #if defined(RTMIDI_EXPORT)
49 #define RTMIDI_DLL_PUBLIC __declspec(dllexport)
51 #define RTMIDI_DLL_PUBLIC
55 #define RTMIDI_DLL_PUBLIC __attribute__( (visibility( "default" )) )
57 #define RTMIDI_DLL_PUBLIC
61#define RTMIDI_VERSION "4.0.0"
98 : message_(message), type_(type) {}
104 virtual void printMessage(
void )
const throw() { std::cerr <<
'\n' << message_ <<
"\n\n"; }
107 virtual const Type&
getType(
void )
const throw() {
return type_; }
110 virtual const std::string&
getMessage(
void )
const throw() {
return message_; }
113 virtual const char*
what(
void )
const throw() {
return message_.c_str(); }
116 std::string message_;
181 virtual void openPort(
unsigned int portNumber = 0,
const std::string &portName = std::string(
"RtMidi" ) ) = 0;
184 virtual void openVirtualPort(
const std::string &portName = std::string(
"RtMidi" ) ) = 0;
190 virtual std::string
getPortName(
unsigned int portNumber = 0 ) = 0;
195 void setClientName(
const std::string &clientName );
196 void setPortName(
const std::string &portName );
253 typedef void (*RtMidiCallback)(
double timeStamp, std::vector<unsigned char> *message,
void *userData );
274 const std::string& clientName =
"RtMidi Input Client",
275 unsigned int queueSizeLimit = 100 );
289 void openPort(
unsigned int portNumber = 0,
const std::string &portName = std::string(
"RtMidi Input" ) );
301 void openVirtualPort(
const std::string &portName = std::string(
"RtMidi Input" ) );
314 void setCallback( RtMidiCallback callback,
void *userData = 0 );
321 void cancelCallback();
324 void closePort(
void );
331 virtual bool isPortOpen()
const;
337 unsigned int getPortCount();
345 std::string getPortName(
unsigned int portNumber = 0 );
355 void ignoreTypes(
bool midiSysex =
true,
bool midiTime =
true,
bool midiSense =
true );
365 double getMessage( std::vector<unsigned char> *message );
372 virtual void setErrorCallback(
RtMidiErrorCallback errorCallback = NULL,
void *userData = 0 );
375 void openMidiApi(
RtMidi::Api api,
const std::string &clientName,
unsigned int queueSizeLimit );
404 const std::string& clientName =
"RtMidi Output Client" );
419 void openPort(
unsigned int portNumber = 0,
const std::string &portName = std::string(
"RtMidi Output" ) );
422 void closePort(
void );
429 virtual bool isPortOpen()
const;
440 void openVirtualPort(
const std::string &portName = std::string(
"RtMidi Output" ) );
443 unsigned int getPortCount(
void );
451 std::string getPortName(
unsigned int portNumber = 0 );
458 void sendMessage(
const std::vector<unsigned char> *message );
468 void sendMessage(
const unsigned char *message,
size_t size );
475 virtual void setErrorCallback(
RtMidiErrorCallback errorCallback = NULL,
void *userData = 0 );
478 void openMidiApi(
RtMidi::Api api,
const std::string &clientName );
502 virtual void openPort(
unsigned int portNumber,
const std::string &portName ) = 0;
503 virtual void openVirtualPort(
const std::string &portName ) = 0;
504 virtual void closePort(
void ) = 0;
505 virtual void setClientName(
const std::string &clientName ) = 0;
506 virtual void setPortName(
const std::string &portName ) = 0;
508 virtual unsigned int getPortCount(
void ) = 0;
509 virtual std::string getPortName(
unsigned int portNumber ) = 0;
511 inline bool isPortOpen()
const {
return connected_; }
518 virtual void initialize(
const std::string& clientName ) = 0;
522 std::string errorString_;
524 bool firstErrorOccurred_;
525 void *errorCallbackUserData_;
532 MidiInApi(
unsigned int queueSizeLimit );
535 void cancelCallback(
void );
536 virtual void ignoreTypes(
bool midiSysex,
bool midiTime,
bool midiSense );
537 double getMessage( std::vector<unsigned char> *message );
542 std::vector<unsigned char> bytes;
549 : bytes(0), timeStamp(0.0) {}
555 unsigned int ringSize;
560 : front(0), back(0), ringSize(0), ring(0) {}
562 bool pop( std::vector<unsigned char>*,
double* );
563 unsigned int size(
unsigned int *back=0,
unsigned int *front=0 );
571 unsigned char ignoreFlags;
582 : ignoreFlags(7), doInput(
false), firstMessage(
true), apiData(0), usingCallback(
false),
583 userCallback(0), userData(0), continueSysex(
false) {}
596 virtual void sendMessage(
const unsigned char *message,
size_t size ) = 0;
605inline RtMidi::Api RtMidiIn :: getCurrentApi(
void )
throw() {
return rtapi_->getCurrentApi(); }
606inline void RtMidiIn :: openPort(
unsigned int portNumber,
const std::string &portName ) { rtapi_->openPort( portNumber, portName ); }
607inline void RtMidiIn :: openVirtualPort(
const std::string &portName ) { rtapi_->openVirtualPort( portName ); }
608inline void RtMidiIn :: closePort(
void ) { rtapi_->closePort(); }
609inline bool RtMidiIn :: isPortOpen()
const {
return rtapi_->isPortOpen(); }
610inline void RtMidiIn :: setCallback( RtMidiCallback callback,
void *userData ) {
static_cast<MidiInApi *
>(rtapi_)->setCallback( callback, userData ); }
611inline void RtMidiIn :: cancelCallback(
void ) {
static_cast<MidiInApi *
>(rtapi_)->cancelCallback(); }
612inline unsigned int RtMidiIn :: getPortCount(
void ) {
return rtapi_->getPortCount(); }
613inline std::string RtMidiIn :: getPortName(
unsigned int portNumber ) {
return rtapi_->getPortName( portNumber ); }
614inline void RtMidiIn :: ignoreTypes(
bool midiSysex,
bool midiTime,
bool midiSense ) {
static_cast<MidiInApi *
>(rtapi_)->ignoreTypes( midiSysex, midiTime, midiSense ); }
615inline double RtMidiIn :: getMessage( std::vector<unsigned char> *message ) {
return static_cast<MidiInApi *
>(rtapi_)->getMessage( message ); }
616inline void RtMidiIn :: setErrorCallback(
RtMidiErrorCallback errorCallback,
void *userData ) { rtapi_->setErrorCallback(errorCallback, userData); }
618inline RtMidi::Api RtMidiOut :: getCurrentApi(
void )
throw() {
return rtapi_->getCurrentApi(); }
619inline void RtMidiOut :: openPort(
unsigned int portNumber,
const std::string &portName ) { rtapi_->openPort( portNumber, portName ); }
620inline void RtMidiOut :: openVirtualPort(
const std::string &portName ) { rtapi_->openVirtualPort( portName ); }
621inline void RtMidiOut :: closePort(
void ) { rtapi_->closePort(); }
622inline bool RtMidiOut :: isPortOpen()
const {
return rtapi_->isPortOpen(); }
623inline unsigned int RtMidiOut :: getPortCount(
void ) {
return rtapi_->getPortCount(); }
624inline std::string RtMidiOut :: getPortName(
unsigned int portNumber ) {
return rtapi_->getPortName( portNumber ); }
625inline void RtMidiOut :: sendMessage(
const std::vector<unsigned char> *message ) {
static_cast<MidiOutApi *
>(rtapi_)->sendMessage( &message->at(0), message->size() ); }
626inline void RtMidiOut :: sendMessage(
const unsigned char *message,
size_t size ) {
static_cast<MidiOutApi *
>(rtapi_)->sendMessage( message, size ); }
627inline void RtMidiOut :: setErrorCallback(
RtMidiErrorCallback errorCallback,
void *userData ) { rtapi_->setErrorCallback(errorCallback, userData); }
void(* RtMidiErrorCallback)(RtMidiError::Type type, const std::string &errorText, void *userData)
RtMidi error callback function prototype.
Definition: RtMidi.h:128
void error(RtMidiError::Type type, std::string errorString)
A basic error reporting function for RtMidi classes.
Exception handling class for RtMidi.
Definition: RtMidi.h:79
virtual const std::string & getMessage(void) const
Returns the thrown error message string.
Definition: RtMidi.h:110
virtual const Type & getType(void) const
Returns the thrown error message type.
Definition: RtMidi.h:107
virtual void printMessage(void) const
Prints thrown error message to stderr.
Definition: RtMidi.h:104
Type
Defined RtMidiError types.
Definition: RtMidi.h:82
@ INVALID_USE
Definition: RtMidi.h:90
@ NO_DEVICES_FOUND
Definition: RtMidi.h:86
@ MEMORY_ERROR
Definition: RtMidi.h:88
@ INVALID_PARAMETER
Definition: RtMidi.h:89
@ WARNING
Definition: RtMidi.h:83
@ INVALID_DEVICE
Definition: RtMidi.h:87
@ DRIVER_ERROR
Definition: RtMidi.h:91
@ UNSPECIFIED
Definition: RtMidi.h:85
@ DEBUG_WARNING
Definition: RtMidi.h:84
@ SYSTEM_ERROR
Definition: RtMidi.h:92
virtual ~RtMidiError(void)
The destructor.
Definition: RtMidi.h:101
virtual const char * what(void) const
Returns the thrown error message as a c-style string.
Definition: RtMidi.h:113
RtMidiError(const std::string &message, Type type=RtMidiError::UNSPECIFIED)
The constructor.
Definition: RtMidi.h:97
A realtime MIDI input class.
Definition: RtMidi.h:249
RtMidiIn(RtMidi::Api api=UNSPECIFIED, const std::string &clientName="RtMidi Input Client", unsigned int queueSizeLimit=100)
Default constructor that allows an optional api, client name and queue size.
void(* RtMidiCallback)(double timeStamp, std::vector< unsigned char > *message, void *userData)
User callback function type definition.
Definition: RtMidi.h:253
~RtMidiIn(void)
If a MIDI connection is still open, it will be closed by the destructor.
A realtime MIDI output class.
Definition: RtMidi.h:393
RtMidiOut(RtMidi::Api api=UNSPECIFIED, const std::string &clientName="RtMidi Output Client")
Default constructor that allows an optional client name.
~RtMidiOut(void)
The destructor closes any open MIDI connections.
An abstract base class for realtime MIDI input/output.
Definition: RtMidi.h:133
static void getCompiledApi(std::vector< RtMidi::Api > &apis)
A static function to determine the available compiled MIDI APIs.
virtual void openVirtualPort(const std::string &portName=std::string("RtMidi"))=0
Pure virtual openVirtualPort() function.
virtual void closePort(void)=0
Pure virtual closePort() function.
virtual void openPort(unsigned int portNumber=0, const std::string &portName=std::string("RtMidi"))=0
Pure virtual openPort() function.
static std::string getApiDisplayName(RtMidi::Api api)
Return the display name of a specified compiled MIDI API.
virtual bool isPortOpen(void) const =0
Returns true if a port is open and false if not.
static std::string getApiName(RtMidi::Api api)
Return the name of a specified compiled MIDI API.
virtual std::string getPortName(unsigned int portNumber=0)=0
Pure virtual getPortName() function.
static std::string getVersion(void)
A static function to determine the current RtMidi version.
virtual unsigned int getPortCount()=0
Pure virtual getPortCount() function.
static RtMidi::Api getCompiledApiByName(const std::string &name)
Return the compiled MIDI API having the given name.
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)=0
Set an error callback function to be invoked when an error has occured.
Api
MIDI API specifier arguments.
Definition: RtMidi.h:136
@ UNIX_JACK
Definition: RtMidi.h:140
@ LINUX_ALSA
Definition: RtMidi.h:139
@ MACOSX_CORE
Definition: RtMidi.h:138
@ UNSPECIFIED
Definition: RtMidi.h:137
@ RTMIDI_DUMMY
Definition: RtMidi.h:142
@ WINDOWS_MM
Definition: RtMidi.h:141
double timeStamp
Time in seconds elapsed since the previous message.
Definition: RtMidi.h:545