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_MAJOR 6
62#define RTMIDI_VERSION_MINOR 1
63#define RTMIDI_VERSION_PATCH 0
64#define RTMIDI_VERSION_BETA 0
66#define RTMIDI_TOSTRING2(n) #n
67#define RTMIDI_TOSTRING(n) RTMIDI_TOSTRING2(n)
69#if RTMIDI_VERSION_BETA > 0
70 #define RTMIDI_VERSION RTMIDI_TOSTRING(RTMIDI_VERSION_MAJOR) \
71 "." RTMIDI_TOSTRING(RTMIDI_VERSION_MINOR) \
72 "." RTMIDI_TOSTRING(RTMIDI_VERSION_PATCH) \
73 "beta" RTMIDI_TOSTRING(RTMIDI_VERSION_BETA)
75 #define RTMIDI_VERSION RTMIDI_TOSTRING(RTMIDI_VERSION_MAJOR) \
76 "." RTMIDI_TOSTRING(RTMIDI_VERSION_MINOR) \
77 "." RTMIDI_TOSTRING(RTMIDI_VERSION_PATCH)
120 : message_(message), type_(type) {}
126 virtual void printMessage(
void )
const throw() { std::cerr <<
'\n' << message_ <<
"\n\n"; }
129 virtual const Type&
getType(
void )
const throw() {
return type_; }
132 virtual const std::string&
getMessage(
void )
const throw() {
return message_; }
135 virtual const char*
what(
void )
const throw() {
return message_.c_str(); }
138 std::string message_;
154class RTMIDI_DLL_PUBLIC RtMidi
158 RtMidi(RtMidi&& other)
noexcept;
230 virtual void openPort(
unsigned int portNumber = 0,
const std::string &portName = std::string(
"RtMidi" ) ) = 0;
233 virtual void openVirtualPort(
const std::string &portName = std::string(
"RtMidi" ) ) = 0;
239 virtual std::string
getPortName(
unsigned int portNumber = 0 ) = 0;
244 void setClientName(
const std::string &clientName );
245 void setPortName(
const std::string &portName );
281 bool isAutoReconnectEnabled(
void )
const;
296 RtMidi(RtMidi& other) =
delete;
297 RtMidi& operator=(RtMidi& other) =
delete;
334 typedef void (*
RtMidiCallback)(
double timeStamp, std::vector<unsigned char> *message,
void *userData );
363 const std::string& clientName =
"RtMidi Input Client",
364 unsigned int queueSizeLimit = 100 );
380 void openPort(
unsigned int portNumber = 0,
const std::string &portName = std::string(
"RtMidi Input" ) );
392 void openVirtualPort(
const std::string &portName = std::string(
"RtMidi Input" ) );
441 std::string
getPortName(
unsigned int portNumber = 0 );
457 void ignoreTypes(
bool midiSysex =
true,
bool midiTime =
true,
bool midiSense =
true );
467 double getMessage( std::vector<unsigned char> *message );
489 virtual void setBufferSize(
unsigned int size,
unsigned int count );
492 void openMidiApi(
RtMidi::Api api,
const std::string &clientName,
unsigned int queueSizeLimit );
523 const std::string& clientName =
"RtMidi Output Client" );
540 void openPort(
unsigned int portNumber = 0,
const std::string &portName = std::string(
"RtMidi Output" ) );
561 void openVirtualPort(
const std::string &portName = std::string(
"RtMidi Output" ) );
572 std::string
getPortName(
unsigned int portNumber = 0 );
593 void sendMessage(
const std::vector<unsigned char> *message );
617 void sendMessage(
const unsigned char *message,
size_t size );
627 void openMidiApi(
RtMidi::Api api,
const std::string &clientName );
644class RTMIDI_DLL_PUBLIC MidiApi
651 virtual void openPort(
unsigned int portNumber,
const std::string &portName ) = 0;
652 virtual void openVirtualPort(
const std::string &portName ) = 0;
653 virtual void closePort(
void ) = 0;
654 virtual void setClientName(
const std::string &clientName ) = 0;
655 virtual void setPortName(
const std::string &portName ) = 0;
657 virtual unsigned int getPortCount(
void ) = 0;
658 virtual std::string getPortName(
unsigned int portNumber ) = 0;
660 inline bool isPortOpen()
const {
return connected_; }
673 void *userData = 0 );
679 bool supportsAutoReconnect(
void )
const;
680 void setAutoReconnect(
bool enabled );
681 bool isAutoReconnectEnabled(
void )
const;
684 virtual void initialize(
const std::string& clientName ) = 0;
688 std::string errorString_;
690 bool firstErrorOccurred_;
691 void *errorCallbackUserData_;
695 static void *defaultErrorCallbackUserData_;
699class RTMIDI_DLL_PUBLIC MidiInApi :
public MidiApi
703 MidiInApi(
unsigned int queueSizeLimit );
704 virtual ~MidiInApi(
void );
706 void cancelCallback(
void );
707 virtual void ignoreTypes(
bool midiSysex,
bool midiTime,
bool midiSense );
708 virtual double getMessage( std::vector<unsigned char> *message );
709 virtual void setBufferSize(
unsigned int size,
unsigned int count );
714 std::vector<unsigned char> bytes;
732 std::atomic<unsigned int> front;
733 std::atomic<unsigned int> back;
734 unsigned int ringSize;
739 : front(0), back(0), ringSize(0), ring(0) {}
741 bool pop( std::vector<unsigned char>*,
double* );
742 unsigned int size(
unsigned int *back=0,
unsigned int *front=0 );
747 struct RtMidiInData {
750 unsigned char ignoreFlags;
756 std::atomic<bool> usingCallback;
757 std::atomic<RtMidiIn::RtMidiCallback> userCallback;
758 std::atomic<void *> userData;
760 unsigned int bufferSize;
761 unsigned int bufferCount;
765 : ignoreFlags(7), doInput(
false), firstMessage(
true), apiData(0), usingCallback(
false),
766 userCallback(0), userData(0), continueSysex(
false), bufferSize(1024), bufferCount(4) {}
772 bool callUserCallback(
double timeStamp, std::vector<unsigned char> *bytes )
774 if ( !usingCallback.load( std::memory_order_acquire ) )
return false;
776 callback( timeStamp, bytes, userData.load( std::memory_order_relaxed ) );
785class RTMIDI_DLL_PUBLIC MidiOutApi :
public MidiApi
790 virtual ~MidiOutApi(
void );
791 virtual void sendMessage(
const unsigned char *message,
size_t size ) = 0;
800inline bool RtMidi :: supportsAutoReconnect(
void )
const {
return rtapi_->supportsAutoReconnect(); }
801inline void RtMidi :: setAutoReconnect(
bool enabled ) { rtapi_->setAutoReconnect( enabled ); }
802inline bool RtMidi :: isAutoReconnectEnabled(
void )
const {
return rtapi_->isAutoReconnectEnabled(); }
804inline RtMidi::Api RtMidiIn :: getCurrentApi(
void )
throw() {
return rtapi_->getCurrentApi(); }
805inline void RtMidiIn :: openPort(
unsigned int portNumber,
const std::string &portName ) { rtapi_->openPort( portNumber, portName ); }
806inline void RtMidiIn :: openVirtualPort(
const std::string &portName ) { rtapi_->openVirtualPort( portName ); }
807inline void RtMidiIn :: closePort(
void ) { rtapi_->closePort(); }
808inline bool RtMidiIn :: isPortOpen()
const {
return rtapi_->isPortOpen(); }
811inline unsigned int RtMidiIn :: getPortCount(
void ) {
return rtapi_->getPortCount(); }
812inline std::string RtMidiIn :: getPortName(
unsigned int portNumber ) {
return rtapi_->getPortName( portNumber ); }
813inline void RtMidiIn :: ignoreTypes(
bool midiSysex,
bool midiTime,
bool midiSense ) {
static_cast<MidiInApi *
>(rtapi_)->
ignoreTypes( midiSysex, midiTime, midiSense ); }
814inline double RtMidiIn :: getMessage( std::vector<unsigned char> *message ) {
return static_cast<MidiInApi *
>(rtapi_)->
getMessage( message ); }
815inline void RtMidiIn :: setErrorCallback(
RtMidiErrorCallback errorCallback,
void *userData ) { rtapi_->setErrorCallback(errorCallback, userData); }
816inline void RtMidiIn :: setBufferSize(
unsigned int size,
unsigned int count ) {
static_cast<MidiInApi *
>(rtapi_)->
setBufferSize(size, count); }
818inline RtMidi::Api RtMidiOut :: getCurrentApi(
void )
throw() {
return rtapi_->getCurrentApi(); }
819inline void RtMidiOut :: openPort(
unsigned int portNumber,
const std::string &portName ) { rtapi_->openPort( portNumber, portName ); }
820inline void RtMidiOut :: openVirtualPort(
const std::string &portName ) { rtapi_->openVirtualPort( portName ); }
821inline void RtMidiOut :: closePort(
void ) { rtapi_->closePort(); }
822inline bool RtMidiOut :: isPortOpen()
const {
return rtapi_->isPortOpen(); }
823inline unsigned int RtMidiOut :: getPortCount(
void ) {
return rtapi_->getPortCount(); }
824inline std::string RtMidiOut :: getPortName(
unsigned int portNumber ) {
return rtapi_->getPortName( portNumber ); }
825inline void RtMidiOut :: sendMessage(
const std::vector<unsigned char> *message ) {
static_cast<MidiOutApi *
>(rtapi_)->
sendMessage( &message->at(0), message->size() ); }
826inline void RtMidiOut :: sendMessage(
const unsigned char *message,
size_t size ) {
static_cast<MidiOutApi *
>(rtapi_)->
sendMessage( message, size ); }
827inline void RtMidiOut :: setErrorCallback(
RtMidiErrorCallback errorCallback,
void *userData ) { rtapi_->setErrorCallback(errorCallback, userData); }
834#ifndef RTMIDI_USE_NAMESPACE
835using namespace rt::midi;
void(* RtMidiErrorCallback)(RtMidiError::Type type, const std::string &errorText, void *userData)
RtMidi error callback function prototype.
Definition RtMidi.h:150
static void setDefaultErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)
Set a callback for objects that have none of their own.
void error(RtMidiError::Type type, std::string errorString)
A basic error reporting function for RtMidi classes.
virtual void printMessage(void) const
Prints thrown error message to stderr.
Definition RtMidi.h:126
virtual const Type & getType(void) const
Returns the thrown error message type.
Definition RtMidi.h:129
virtual const std::string & getMessage(void) const
Returns the thrown error message string.
Definition RtMidi.h:132
RtMidiError(const std::string &message, Type type=RtMidiError::UNSPECIFIED)
The constructor.
Definition RtMidi.h:119
Type
Defined RtMidiError types.
Definition RtMidi.h:103
@ INVALID_PARAMETER
Definition RtMidi.h:110
@ INVALID_USE
Definition RtMidi.h:111
@ NO_DEVICES_FOUND
Definition RtMidi.h:107
@ DRIVER_NOT_INSTALLED
Definition RtMidi.h:115
@ INVALID_DEVICE
Definition RtMidi.h:108
@ UNSPECIFIED
Definition RtMidi.h:106
@ MEMORY_ERROR
Definition RtMidi.h:109
@ DEBUG_WARNING
Definition RtMidi.h:105
@ THREAD_ERROR
Definition RtMidi.h:114
@ DRIVER_ERROR
Definition RtMidi.h:112
@ WARNING
Definition RtMidi.h:104
@ SYSTEM_ERROR
Definition RtMidi.h:113
virtual ~RtMidiError(void)
The destructor.
Definition RtMidi.h:123
virtual const char * what(void) const
Returns the thrown error message as a c-style string.
Definition RtMidi.h:135
RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiIn.
Definition RtMidi.h:804
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:805
std::string getPortName(unsigned int portNumber=0)
Return a string identifier for the specified MIDI input port number.
Definition RtMidi.h:812
void setCallback(RtMidiCallback callback, void *userData=0)
Set a callback function to be invoked for incoming MIDI messages.
Definition RtMidi.h:809
void closePort(void)
Close an open MIDI connection (if one exists).
Definition RtMidi.h:807
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)
Set an error callback function to be invoked when an error has occurred.
Definition RtMidi.h:815
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.
virtual void setBufferSize(unsigned int size, unsigned int count)
Set maximum expected incoming message size.
Definition RtMidi.h:816
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:814
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:806
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:813
~RtMidiIn(void)
If a MIDI connection is still open, it will be closed by the destructor.
void cancelCallback()
Cancel use of the current callback function (if one exists).
Definition RtMidi.h:810
unsigned int getPortCount()
Return the number of available MIDI input ports.
Definition RtMidi.h:811
virtual bool isPortOpen() const
Returns true if a port is open and false if not.
Definition RtMidi.h:808
void(* RtMidiCallback)(double timeStamp, std::vector< unsigned char > *message, void *userData)
User callback function type definition.
Definition RtMidi.h:334
unsigned int getPortCount(void)
Return the number of available MIDI output ports.
Definition RtMidi.h:823
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)
Set an error callback function to be invoked when an error has occurred.
Definition RtMidi.h:827
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:820
std::string getPortName(unsigned int portNumber=0)
Return a string identifier for the specified MIDI port type and number.
Definition RtMidi.h:824
void openPort(unsigned int portNumber=0, const std::string &portName=std::string("RtMidi Output"))
Open a MIDI output connection.
Definition RtMidi.h:819
virtual bool isPortOpen() const
Returns true if a port is open and false if not.
Definition RtMidi.h:822
RtMidiOut(RtMidi::Api api=UNSPECIFIED, const std::string &clientName="RtMidi Output Client")
Default constructor that allows an optional client name.
void closePort(void)
Close an open MIDI connection (if one exists).
Definition RtMidi.h:821
RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiOut.
Definition RtMidi.h:818
void sendMessage(const std::vector< unsigned char > *message)
Immediately send a single message out an open MIDI output port.
Definition RtMidi.h:825
~RtMidiOut(void)
The destructor closes any open MIDI connections.
virtual void openVirtualPort(const std::string &portName=std::string("RtMidi"))=0
Pure virtual openVirtualPort() function.
Api
MIDI API specifier arguments.
Definition RtMidi.h:160
@ LINUX_ALSA
Definition RtMidi.h:163
@ WINDOWS_MM
Definition RtMidi.h:165
@ ANDROID_AMIDI
Definition RtMidi.h:169
@ UNIX_JACK
Definition RtMidi.h:164
@ WEB_MIDI_API
Definition RtMidi.h:167
@ WINDOWS_UWP
Definition RtMidi.h:168
@ RTMIDI_DUMMY
Definition RtMidi.h:166
@ WINDOWS_MIDI_SERVICES
Definition RtMidi.h:170
@ MACOSX_CORE
Definition RtMidi.h:162
@ UNSPECIFIED
Definition RtMidi.h:161
@ NUM_APIS
Definition RtMidi.h:171
bool available
Definition RtMidi.h:176
std::string message
Definition RtMidi.h:177
static RtMidiApiAvailability checkApiAvailability(RtMidi::Api api)
Query whether an API can be used by this build on this system.
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.
void setAutoReconnect(bool enabled)
Enable or disable automatic recovery (enabled by default when supported).
Definition RtMidi.h:801
static void getCompiledApi(std::vector< RtMidi::Api > &apis)
A static function to determine the available compiled MIDI APIs.
static std::string getVersion(void)
A static function to determine the current RtMidi version.
virtual void closePort(void)=0
Pure virtual closePort() function.
static std::string getApiName(RtMidi::Api api)
Return the name of a specified compiled MIDI API.
bool supportsAutoReconnect(void) const
Whether this backend can restore connections after device removal.
Definition RtMidi.h:800
virtual void openPort(unsigned int portNumber=0, const std::string &portName=std::string("RtMidi"))=0
Pure virtual openPort() function.
std::string installUrl
Definition RtMidi.h:178
virtual std::string getPortName(unsigned int portNumber=0)=0
Pure virtual getPortName() function.
virtual void setErrorCallback(RtMidiErrorCallback errorCallback=NULL, void *userData=0)=0
Set an error callback function to be invoked when an error has occurred.
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.
Result returned by checkApiAvailability().
Definition RtMidi.h:175
double timeStamp
Time in seconds elapsed since the previous message.
Definition RtMidi.h:717