From eaead6c80cc693f795e26bcee5739104ce39263d Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Fri, 11 Oct 2013 15:37:48 +0200 Subject: Release 1.0.15 tarball --- doc/html/RtMidi_8h_source.html | 221 +++++++++++----------- doc/html/annotated.html | 1 + doc/html/classRtMidiIn-members.html | 3 +- doc/html/classRtMidiIn.html | 49 ++--- doc/html/classes.html | 4 +- doc/html/functions.html | 5 +- doc/html/functions_func.html | 54 +----- doc/html/hierarchy.html | 1 + doc/html/index.html | 6 +- doc/html/structRtMidiIn_1_1MidiQueue-members.html | 22 +++ doc/html/structRtMidiIn_1_1MidiQueue.html | 30 +++ 11 files changed, 195 insertions(+), 201 deletions(-) create mode 100644 doc/html/structRtMidiIn_1_1MidiQueue-members.html create mode 100644 doc/html/structRtMidiIn_1_1MidiQueue.html (limited to 'doc/html') diff --git a/doc/html/RtMidi_8h_source.html b/doc/html/RtMidi_8h_source.html index 5ba8c70..0867a7b 100644 --- a/doc/html/RtMidi_8h_source.html +++ b/doc/html/RtMidi_8h_source.html @@ -11,7 +11,7 @@

RtMidi.h

00001 /**********************************************************************/
 00036 /**********************************************************************/
 00037 
-00038 // RtMidi: Version 1.0.14
+00038 // RtMidi: Version 1.0.15
 00039 
 00040 #ifndef RTMIDI_H
 00041 #define RTMIDI_H
@@ -52,121 +52,128 @@
 00096 /**********************************************************************/
 00097 
 00098 #include <vector>
-00099 #include <queue>
-00100 
-00101 class RtMidiIn : public RtMidi
-00102 {
-00103  public:
-00104 
-00106   typedef void (*RtMidiCallback)( double timeStamp, std::vector<unsigned char> *message, void *userData);
-00107 
-00109 
-00112   RtMidiIn( const std::string clientName = std::string( "RtMidi Input Client") );
-00113 
-00115   ~RtMidiIn();
+00099 
+00100 class RtMidiIn : public RtMidi
+00101 {
+00102  public:
+00103 
+00105   typedef void (*RtMidiCallback)( double timeStamp, std::vector<unsigned char> *message, void *userData);
+00106 
+00108 
+00115   RtMidiIn( const std::string clientName = std::string( "RtMidi Input Client"), unsigned int queueSizeLimit = 100 );
 00116 
-00118 
-00122   void openPort( unsigned int portNumber = 0, const std::string Portname = std::string( "RtMidi Input" ) );
-00123 
-00125 
-00131   void openVirtualPort( const std::string portName = std::string( "RtMidi Input" ) );
-00132 
-00134 
-00140   void setCallback( RtMidiCallback callback, void *userData = 0 );
-00141 
-00143 
-00147   void cancelCallback();
-00148 
-00150   void closePort( void );
+00118   ~RtMidiIn();
+00119 
+00121 
+00125   void openPort( unsigned int portNumber = 0, const std::string Portname = std::string( "RtMidi Input" ) );
+00126 
+00128 
+00134   void openVirtualPort( const std::string portName = std::string( "RtMidi Input" ) );
+00135 
+00137 
+00143   void setCallback( RtMidiCallback callback, void *userData = 0 );
+00144 
+00146 
+00150   void cancelCallback();
 00151 
-00153   unsigned int getPortCount();
+00153   void closePort( void );
 00154 
-00156 
-00159   std::string getPortName( unsigned int portNumber = 0 );
-00160 
-00162 
-00166   void setQueueSizeLimit( unsigned int queueSize );
-00167 
-00169 
-00176   void ignoreTypes( bool midiSysex = true, bool midiTime = true, bool midiSense = true );
-00177 
-00179 
-00186   double getMessage( std::vector<unsigned char> *message );
-00187 
-00188   // A MIDI structure used internally by the class to store incoming
-00189   // messages.  Each message represents one and only one MIDI message.
-00190   struct MidiMessage { 
-00191     std::vector<unsigned char> bytes; 
-00192     double timeStamp;
-00193 
-00194     // Default constructor.
-00195     MidiMessage()
-00196       :bytes(3), timeStamp(0.0) {}
-00197   };
-00198 
-00199   // The RtMidiInData structure is used to pass private class data to
-00200   // the MIDI input handling function or thread.
-00201   struct RtMidiInData {
-00202     std::queue<MidiMessage> queue;
-00203     MidiMessage message;
-00204     unsigned int queueLimit;
-00205     unsigned char ignoreFlags;
-00206     bool doInput;
-00207     bool firstMessage;
-00208     void *apiData;
-00209     bool usingCallback;
-00210     void *userCallback;
-00211     void *userData;
-00212     bool continueSysex;
-00213 
-00214     // Default constructor.
-00215     RtMidiInData()
-00216       : queueLimit(1024), ignoreFlags(7), doInput(false), firstMessage(true),
-00217         apiData(0), usingCallback(false), userCallback(0), userData(0),
-00218         continueSysex(false) {}
-00219   };
+00156   unsigned int getPortCount();
+00157 
+00159 
+00162   std::string getPortName( unsigned int portNumber = 0 );
+00163 
+00165 
+00172   void ignoreTypes( bool midiSysex = true, bool midiTime = true, bool midiSense = true );
+00173 
+00175 
+00182   double getMessage( std::vector<unsigned char> *message );
+00183 
+00184   // A MIDI structure used internally by the class to store incoming
+00185   // messages.  Each message represents one and only one MIDI message.
+00186   struct MidiMessage { 
+00187     std::vector<unsigned char> bytes; 
+00188     double timeStamp;
+00189 
+00190     // Default constructor.
+00191     MidiMessage()
+00192       :bytes(0), timeStamp(0.0) {}
+00193   };
+00194 
+00195   struct MidiQueue {
+00196     unsigned int front;
+00197     unsigned int back;
+00198     unsigned int size;
+00199     unsigned int ringSize;
+00200                 MidiMessage *ring;
+00201 
+00202     // Default constructor.
+00203     MidiQueue()
+00204       :front(0), back(0), size(0), ringSize(0) {}
+00205   };
+00206 
+00207   // The RtMidiInData structure is used to pass private class data to
+00208   // the MIDI input handling function or thread.
+00209   struct RtMidiInData {
+00210     MidiQueue queue;
+00211     MidiMessage message;
+00212     unsigned char ignoreFlags;
+00213     bool doInput;
+00214     bool firstMessage;
+00215     void *apiData;
+00216     bool usingCallback;
+00217     void *userCallback;
+00218     void *userData;
+00219     bool continueSysex;
 00220 
-00221  private:
-00222 
-00223   void initialize( const std::string& clientName );
-00224   RtMidiInData inputData_;
-00225 
-00226 };
+00221     // Default constructor.
+00222     RtMidiInData()
+00223       : ignoreFlags(7), doInput(false), firstMessage(true),
+00224         apiData(0), usingCallback(false), userCallback(0), userData(0),
+00225         continueSysex(false) {}
+00226   };
 00227 
-00228 /**********************************************************************/
-00240 /**********************************************************************/
-00241 
-00242 class RtMidiOut : public RtMidi
-00243 {
-00244  public:
-00245 
-00247 
-00250   RtMidiOut( const std::string clientName = std::string( "RtMidi Output Client" ) );
-00251 
-00253   ~RtMidiOut();
+00228  private:
+00229 
+00230   void initialize( const std::string& clientName );
+00231   RtMidiInData inputData_;
+00232 
+00233 };
+00234 
+00235 /**********************************************************************/
+00247 /**********************************************************************/
+00248 
+00249 class RtMidiOut : public RtMidi
+00250 {
+00251  public:
+00252 
 00254 
-00256 
-00262   void openPort( unsigned int portNumber = 0, const std::string portName = std::string( "RtMidi Output" ) );
+00257   RtMidiOut( const std::string clientName = std::string( "RtMidi Output Client" ) );
+00258 
+00260   ~RtMidiOut();
+00261 
 00263 
-00265   void closePort();
-00266 
-00268 
-00276   void openVirtualPort( const std::string portName = std::string( "RtMidi Output" ) );
-00277 
-00279   unsigned int getPortCount();
-00280 
-00282 
-00285   std::string getPortName( unsigned int portNumber = 0 );
-00286 
-00288 
-00292   void sendMessage( std::vector<unsigned char> *message );
+00269   void openPort( unsigned int portNumber = 0, const std::string portName = std::string( "RtMidi Output" ) );
+00270 
+00272   void closePort();
+00273 
+00275 
+00283   void openVirtualPort( const std::string portName = std::string( "RtMidi Output" ) );
+00284 
+00286   unsigned int getPortCount();
+00287 
+00289 
+00292   std::string getPortName( unsigned int portNumber = 0 );
 00293 
-00294  private:
 00295 
-00296   void initialize( const std::string& clientName );
-00297 };
-00298 
-00299 #endif
+00299   void sendMessage( std::vector<unsigned char> *message );
+00300 
+00301  private:
+00302 
+00303   void initialize( const std::string& clientName );
+00304 };
+00305 
+00306 #endif
diff --git a/doc/html/annotated.html b/doc/html/annotated.html index db6bad0..9ce3d99 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -11,6 +11,7 @@

Class List

Here are the classes, structs, unions and interfaces with brief descriptions: + diff --git a/doc/html/classRtMidiIn-members.html b/doc/html/classRtMidiIn-members.html index 2d5a83f..4cb8ef3 100644 --- a/doc/html/classRtMidiIn-members.html +++ b/doc/html/classRtMidiIn-members.html @@ -19,9 +19,8 @@ - + -
RtMidiIn::MidiMessage
RtMidiIn::MidiQueue
RtErrorException handling class for RtAudio & RtMidi
RtMidiAn abstract base class for realtime MIDI input/output
RtMidiInA realtime MIDI input class
openPort(unsigned int portNumber=0, const std::string Portname=std::string("RtMidi Input"))RtMidiIn [virtual]
openVirtualPort(const std::string portName=std::string("RtMidi Input"))RtMidiIn [virtual]
RtMidiCallback typedefRtMidiIn
RtMidiIn(const std::string clientName=std::string("RtMidi Input Client"))RtMidiIn
RtMidiIn(const std::string clientName=std::string("RtMidi Input Client"), unsigned int queueSizeLimit=100)RtMidiIn
setCallback(RtMidiCallback callback, void *userData=0)RtMidiIn
setQueueSizeLimit(unsigned int queueSize)RtMidiIn
~RtMidiIn()RtMidiIn
diff --git a/doc/html/classRtMidiIn.html b/doc/html/classRtMidiIn.html index 5ce8db8..241fd88 100644 --- a/doc/html/classRtMidiIn.html +++ b/doc/html/classRtMidiIn.html @@ -29,14 +29,15 @@ Inheritance diagram for RtMidiIn: + - - + + @@ -56,8 +57,6 @@ unsigned int  - - @@ -68,7 +67,7 @@ unsigned int 

Classes

struct  MidiMessage
struct  MidiQueue
struct  RtMidiInData

Public Types

typedef void(* RtMidiCallback )(double timeStamp, std::vector< unsigned char > *message, void *userData)
 User callback function type definition.

Public Member Functions

 RtMidiIn (const std::string clientName=std::string("RtMidi Input Client"))
 Default constructor that allows an optional client name.
 RtMidiIn (const std::string clientName=std::string("RtMidi Input Client"), unsigned int queueSizeLimit=100)
 Default constructor that allows an optional client name and queue size.
 ~RtMidiIn ()
 If a MIDI connection is still open, it will be closed by the destructor.
 Return the number of available MIDI input ports.
std::string getPortName (unsigned int portNumber=0)
 Return a string identifier for the specified MIDI input port number.
void setQueueSizeLimit (unsigned int queueSize)
 Set the maximum number of MIDI messages to be saved in the queue.
void ignoreTypes (bool midiSysex=true, bool midiTime=true, bool midiSense=true)
 Specify whether certain MIDI message types should be queued or ignored during input.
double getMessage (std::vector< unsigned char > *message)
This class provides a common, platform-independent API for realtime MIDI input. It allows access to a single MIDI input port. Incoming MIDI messages are either saved to a queue for retrieval using the getMessage() function or immediately passed to a user-specified callback function. Create multiple instances of this class to connect to more than one MIDI device at the same time. With the OS-X and Linux ALSA MIDI APIs, it is also possible to open a virtual input port to which other MIDI software clients can connect.

by Gary P. Scavone, 2003-2008.

Constructor & Destructor Documentation

- +
@@ -76,16 +75,25 @@ unsigned int  - - + + + + + + + + + + +
RtMidiIn::RtMidiIn ( const std::string  clientName = std::string("RtMidi Input Client") )  clientName = std::string("RtMidi Input Client"),
unsigned int  queueSizeLimit = 100 
)
-

Default constructor that allows an optional client name.

-

An exception will be thrown if a MIDI system initialization error occurs.

+

Default constructor that allows an optional client name and queue size.

+

An exception will be thrown if a MIDI system initialization error occurs. The queue size defines the maximum number of messages that can be held in the MIDI queue (when not using a callback function). If the queue size limit is reached, incoming messages will be ignored.

@@ -216,27 +224,6 @@ unsigned int 		Implements RtMidi.

- - - -
-
- - - - - - - - - -
void RtMidiIn::setQueueSizeLimit (unsigned int  queueSize ) 
-
-
- -

Set the maximum number of MIDI messages to be saved in the queue.

-

If the queue size limit is reached, incoming messages will be ignored. The default limit is 1024.

-
@@ -271,7 +258,7 @@ unsigned int 

Specify whether certain MIDI message types should be queued or ignored during input.

-

By default, MIDI timing and active sensing messages are ignored during message input because of their relative high data rates. MIDI sysex messages are ignored by default as well. Variable values of "true" imply that the respective message type will be ignored.

+

o By default, MIDI timing and active sensing messages are ignored during message input because of their relative high data rates. MIDI sysex messages are ignored by default as well. Variable values of "true" imply that the respective message type will be ignored.

diff --git a/doc/html/classes.html b/doc/html/classes.html index 4406999..0804176 100644 --- a/doc/html/classes.html +++ b/doc/html/classes.html @@ -12,8 +12,8 @@

Class Index

M | R
  M  
-
  R  
-		RtMidi   RtMidiIn::RtMidiInData   RtMidiOut   
RtMidiIn::MidiMessage   RtError   RtMidiIn   
M | R
+		RtMidiIn::MidiQueue   RtError   RtMidiIn   RtMidiOut   
RtMidiIn::MidiMessage   
  R  
+		RtMidi   RtMidiIn::RtMidiInData   
M | R
diff --git a/doc/html/functions.html b/doc/html/functions.html index 536ec09..ada21ba 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -140,7 +140,7 @@ Here is a list of all documented class members with links to the class documenta : RtMidiIn
  • RtMidiIn() -: RtMidiIn +: RtMidiIn
  • RtMidiOut() : RtMidiOut @@ -155,9 +155,6 @@ Here is a list of all documented class members with links to the class documenta
  • setCallback() : RtMidiIn
    • -
  • setQueueSizeLimit() -: RtMidiIn -
  • SYSTEM_ERROR : RtError
    • diff --git a/doc/html/functions_func.html b/doc/html/functions_func.html index 5544856..91e777e 100644 --- a/doc/html/functions_func.html +++ b/doc/html/functions_func.html @@ -17,23 +17,8 @@
  • Enumerator
    • -
    - -
    -  - -

    - c -