diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2013-10-11 15:04:06 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 15:04:06 +0200 |
| commit | 1f910fbc187d2f50004bb0f7e619bd39f043b5b5 (patch) | |
| tree | 8254a3a788c9cbf1e34a22f1320e865f525cfb36 /doc | |
| parent | eeca35408122b9fc020139a20255f3c1ad8254cd (diff) | |
Release 1.0.0 tarball1.0.0
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/RtError_8h-source.html | 62 | ||||
| -rw-r--r-- | doc/html/RtMidi_8h-source.html | 166 | ||||
| -rw-r--r-- | doc/html/annotated.html | 25 | ||||
| -rw-r--r-- | doc/html/classRtError-members.html | 26 | ||||
| -rw-r--r-- | doc/html/classRtError.html | 53 | ||||
| -rw-r--r-- | doc/html/classRtMidi-members.html | 20 | ||||
| -rw-r--r-- | doc/html/classRtMidi.html | 46 | ||||
| -rw-r--r-- | doc/html/classRtMidi.png | bin | 0 -> 412 bytes | |||
| -rw-r--r-- | doc/html/classRtMidiIn-members.html | 33 | ||||
| -rw-r--r-- | doc/html/classRtMidiIn.html | 376 | ||||
| -rw-r--r-- | doc/html/classRtMidiIn.png | bin | 0 -> 300 bytes | |||
| -rw-r--r-- | doc/html/classRtMidiOut-members.html | 28 | ||||
| -rw-r--r-- | doc/html/classRtMidiOut.html | 217 | ||||
| -rw-r--r-- | doc/html/classRtMidiOut.png | bin | 0 -> 317 bytes | |||
| -rw-r--r-- | doc/html/doxygen.css | 49 | ||||
| -rw-r--r-- | doc/html/doxygen.png | bin | 0 -> 2352 bytes | |||
| -rw-r--r-- | doc/html/files.html | 23 | ||||
| -rw-r--r-- | doc/html/functions.html | 42 | ||||
| -rw-r--r-- | doc/html/hierarchy.html | 27 | ||||
| -rw-r--r-- | doc/html/index.html | 336 |
20 files changed, 1529 insertions, 0 deletions
diff --git a/doc/html/RtError_8h-source.html b/doc/html/RtError_8h-source.html new file mode 100644 index 0000000..db0f4ce --- /dev/null +++ b/doc/html/RtError_8h-source.html @@ -0,0 +1,62 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtError.h</h1><div class="fragment"><pre>00001 <span class="comment">/************************************************************************/</span> +00010 <span class="comment">/************************************************************************/</span> +00011 +00012 <span class="preprocessor">#ifndef RTERROR_H</span> +00013 <span class="preprocessor"></span><span class="preprocessor">#define RTERROR_H</span> +00014 <span class="preprocessor"></span> +00015 <span class="preprocessor">#include <iostream></span> +00016 <span class="preprocessor">#include <string></span> +00017 +<a name="l00018"></a><a class="code" href="classRtError.html">00018</a> <span class="keyword">class </span><a class="code" href="classRtError.html">RtError</a> +00019 { +00020 <span class="keyword">public</span>: +<a name="l00022"></a><a class="code" href="classRtError.html#s11">00022</a> <span class="keyword">enum</span> <a class="code" href="classRtError.html#s11">Type</a> { +00023 WARNING, +00024 DEBUG_WARNING, +00025 UNSPECIFIED, +00026 NO_DEVICES_FOUND, +00027 INVALID_DEVICE, +00028 INVALID_STREAM, +00029 MEMORY_ERROR, +00030 INVALID_PARAMETER, +00031 DRIVER_ERROR, +00032 SYSTEM_ERROR, +00033 THREAD_ERROR +00034 }; +00035 +00036 <span class="keyword">protected</span>: +00037 std::string message_; +00038 <a class="code" href="classRtError.html#s11">Type</a> type_; +00039 +00040 <span class="keyword">public</span>: +<a name="l00042"></a><a class="code" href="classRtError.html#a0">00042</a> <a class="code" href="classRtError.html#a0">RtError</a>(<span class="keyword">const</span> std::string& message, Type type = RtError::UNSPECIFIED) : message_(message), type_(type) {} +00043 +<a name="l00045"></a><a class="code" href="classRtError.html#a1">00045</a> <span class="keyword">virtual</span> <a class="code" href="classRtError.html#a1">~RtError</a>(<span class="keywordtype">void</span>) {} +00046 +<a name="l00048"></a><a class="code" href="classRtError.html#a2">00048</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtError.html#a2">printMessage</a>(<span class="keywordtype">void</span>) { std::cout << <span class="charliteral">'\n'</span> << message_ << <span class="stringliteral">"\n\n"</span>; } +00049 +<a name="l00051"></a><a class="code" href="classRtError.html#a3">00051</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRtError.html#s11">Type</a>& <a class="code" href="classRtError.html#a3">getType</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> type_; } +00052 +<a name="l00054"></a><a class="code" href="classRtError.html#a4">00054</a> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="classRtError.html#a4">getMessage</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_; } +00055 }; +00056 +00057 <span class="preprocessor">#endif</span> +</pre></div><HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/RtMidi_8h-source.html b/doc/html/RtMidi_8h-source.html new file mode 100644 index 0000000..9bda7a2 --- /dev/null +++ b/doc/html/RtMidi_8h-source.html @@ -0,0 +1,166 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi.h</h1><div class="fragment"><pre>00001 <span class="comment">/**********************************************************************/</span> +00036 <span class="comment">/**********************************************************************/</span> +00037 +00038 <span class="comment">// RtMidi: Version 1.0.0, 17 September 2004</span> +00039 +00040 <span class="preprocessor">#ifndef RTMIDI_H</span> +00041 <span class="preprocessor"></span><span class="preprocessor">#define RTMIDI_H</span> +00042 <span class="preprocessor"></span> +00043 <span class="preprocessor">#include "RtError.h"</span> +00044 <span class="preprocessor">#include <string></span> +00045 +<a name="l00046"></a><a class="code" href="classRtMidi.html">00046</a> <span class="keyword">class </span><a class="code" href="classRtMidi.html">RtMidi</a> +00047 { +00048 <span class="keyword">protected</span>: +00049 +00050 <a class="code" href="classRtMidi.html">RtMidi</a>(); +00051 +00052 <span class="keyword">virtual</span> ~<a class="code" href="classRtMidi.html">RtMidi</a>() {}; +00053 +00054 <span class="comment">// A basic error reporting function for internal use in the RtMidi</span> +00055 <span class="comment">// subclasses. The behavior of this function can be modified to</span> +00056 <span class="comment">// suit specific needs.</span> +00057 <span class="keywordtype">void</span> error( RtError::Type type ); +00058 +00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span> openPort( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ) = 0; +00060 +00061 <span class="keywordtype">void</span> *apiData_; +00062 <span class="keywordtype">bool</span> connected_; +00063 std::string errorString_; +00064 }; +00065 +00066 <span class="comment">/**********************************************************************/</span> +00082 <span class="comment">/**********************************************************************/</span> +00083 +00084 <span class="preprocessor">#include <vector></span> +00085 <span class="preprocessor">#include <queue></span> +00086 +<a name="l00087"></a><a class="code" href="classRtMidiIn.html">00087</a> <span class="keyword">class </span><a class="code" href="classRtMidiIn.html">RtMidiIn</a> : <span class="keyword">public</span> <a class="code" href="classRtMidi.html">RtMidi</a> +00088 { +00089 <span class="keyword">public</span>: +00090 +<a name="l00092"></a><a class="code" href="classRtMidiIn.html#s0">00092</a> <span class="keyword">typedef</span> void (*RtMidiCallback)( <span class="keywordtype">double</span> timeStamp, std::vector<unsigned char> *message, <span class="keywordtype">void</span> *userData); +00093 +00095 +00098 <a class="code" href="classRtMidiIn.html#a0">RtMidiIn</a>(); +00099 +00101 <a class="code" href="classRtMidiIn.html#a1">~RtMidiIn</a>(); +00102 +00104 +00108 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a2">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); +00109 +00111 +00117 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a3">openVirtualPort</a>(); +00118 +00120 +00126 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a4">setCallback</a>( RtMidiCallback callback, <span class="keywordtype">void</span> *userData = 0 ); +00127 +00129 +00133 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a5">cancelCallback</a>(); +00134 +00136 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a6">closePort</a>( <span class="keywordtype">void</span> ); +00137 +00139 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); +00140 +00142 +00145 std::string <a class="code" href="classRtMidiIn.html#a8">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); +00146 +00148 +00152 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a9">setQueueSizeLimit</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> queueSize ); +00153 +00155 +00162 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a10">ignoreTypes</a>( <span class="keywordtype">bool</span> midiSysex = <span class="keyword">true</span>, <span class="keywordtype">bool</span> midiTime = <span class="keyword">true</span>, <span class="keywordtype">bool</span> midiSense = <span class="keyword">true</span> ); +00163 +00165 +00172 <span class="keywordtype">double</span> <a class="code" href="classRtMidiIn.html#a11">getMessage</a>( std::vector<unsigned char> *message ); +00173 +00174 <span class="comment">// A MIDI structure used internally by the class to store incoming</span> +00175 <span class="comment">// messages. Each message represents one and only one MIDI message.</span> +00176 <span class="keyword">struct </span>MidiMessage { +00177 std::vector<unsigned char> bytes; +00178 <span class="keywordtype">double</span> timeStamp; +00179 +00180 <span class="comment">// Default constructor.</span> +00181 MidiMessage() +00182 :bytes(3), timeStamp(0.0) {} +00183 }; +00184 +00185 <span class="comment">// The RtMidiInData structure is used to pass private class data to</span> +00186 <span class="comment">// the MIDI input handling function or thread.</span> +00187 <span class="keyword">struct </span>RtMidiInData { +00188 std::queue<MidiMessage> queue; +00189 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> queueLimit; +00190 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ignoreFlags; +00191 <span class="keywordtype">bool</span> doInput; +00192 <span class="keywordtype">bool</span> firstMessage; +00193 <span class="keywordtype">void</span> *apiData; +00194 <span class="keywordtype">bool</span> usingCallback; +00195 <span class="keywordtype">void</span> *userCallback; +00196 <span class="keywordtype">void</span> *userData; +00197 +00198 <span class="comment">// Default constructor.</span> +00199 RtMidiInData() +00200 : queueLimit(1024), ignoreFlags(7), doInput(false), firstMessage(true), +00201 apiData(0), usingCallback(false), userCallback(0), userData(0) {} +00202 }; +00203 +00204 <span class="keyword">private</span>: +00205 +00206 <span class="keywordtype">void</span> initialize( <span class="keywordtype">void</span> ); +00207 RtMidiInData inputData_; +00208 +00209 }; +00210 +00211 <span class="comment">/**********************************************************************/</span> +00223 <span class="comment">/**********************************************************************/</span> +00224 +<a name="l00225"></a><a class="code" href="classRtMidiOut.html">00225</a> <span class="keyword">class </span><a class="code" href="classRtMidiOut.html">RtMidiOut</a> : <span class="keyword">public</span> <a class="code" href="classRtMidi.html">RtMidi</a> +00226 { +00227 <span class="keyword">public</span>: +00228 +00230 +00233 <a class="code" href="classRtMidiOut.html#a0">RtMidiOut</a>(); +00234 +00236 <a class="code" href="classRtMidiOut.html#a1">~RtMidiOut</a>(); +00237 +00239 +00245 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a2">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); +00246 +00248 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a3">closePort</a>(); +00249 +00251 +00259 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a4">openVirtualPort</a>(); +00260 +00262 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidiOut.html#a5">getPortCount</a>(); +00263 +00265 +00268 std::string <a class="code" href="classRtMidiOut.html#a6">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber ); +00269 +00271 +00275 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( std::vector<unsigned char> *message ); +00276 +00277 <span class="keyword">private</span>: +00278 +00279 <span class="keywordtype">void</span> initialize( <span class="keywordtype">void</span> ); +00280 }; +00281 +00282 <span class="preprocessor">#endif</span> +</pre></div><HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/annotated.html b/doc/html/annotated.html new file mode 100644 index 0000000..3ad461c --- /dev/null +++ b/doc/html/annotated.html @@ -0,0 +1,25 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="classRtError.html">RtError</a></td><td class="indexvalue">Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a></td></tr> + <tr><td class="indexkey"><a class="el" href="classRtMidi.html">RtMidi</a></td><td class="indexvalue">An abstract base class for realtime MIDI input/output</td></tr> + <tr><td class="indexkey"><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td class="indexvalue">A realtime MIDI input class</td></tr> + <tr><td class="indexkey"><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td class="indexvalue">A realtime MIDI output class</td></tr> +</table> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtError-members.html b/doc/html/classRtError-members.html new file mode 100644 index 0000000..f3bb904 --- /dev/null +++ b/doc/html/classRtError-members.html @@ -0,0 +1,26 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtError Member List</h1>This is the complete list of members for <a class="el" href="classRtError.html">RtError</a>, including all inherited members.<table> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtError.html#a4">getMessage</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtError.html#a3">getType</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtError.html#a2">printMessage</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtError.html#a0">RtError</a>(const std::string &message, Type type=RtError::UNSPECIFIED)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline]</code></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtError.html#s11">Type</a> enum name</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtError.html#a1">~RtError</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> +</table><HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html new file mode 100644 index 0000000..395a949 --- /dev/null +++ b/doc/html/classRtError.html @@ -0,0 +1,53 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtError Class Reference</h1>Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="RtError_8h-source.html">RtError.h</a>></code> +<p> +<a href="classRtError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classRtError.html#s11">Type</a> </td></tr> +<tr><td> </td><td><font size=-1><em>Defined RtError types.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RtError::RtError"></a> + </td><td valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#s11">Type</a> type=RtError::UNSPECIFIED)</td></tr> +<tr><td> </td><td><font size=-1><em>The constructor.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtError::~RtError"></a> +virtual </td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="RtError::printMessage"></a> +virtual void </td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>Prints "thrown" error message to stdout.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="RtError::getType"></a> +virtual const <a class="el" href="classRtError.html#s11">Type</a> & </td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the "thrown" error message type.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtError::getMessage"></a> +virtual const std::string & </td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the "thrown" error message string.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a>. +<p> +The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#s11">RtError::Type</a>. See the RtAudio and <a class="el" href="classRtMidi.html">RtMidi</a> documentation to know which methods can "throw" an RtError. +<p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidi-members.html b/doc/html/classRtMidi-members.html new file mode 100644 index 0000000..18e99aa --- /dev/null +++ b/doc/html/classRtMidi-members.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi Member List</h1>This is the complete list of members for <a class="el" href="classRtMidi.html">RtMidi</a>, including all inherited members.<table> +</table><HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidi.html b/doc/html/classRtMidi.html new file mode 100644 index 0000000..e7be341 --- /dev/null +++ b/doc/html/classRtMidi.html @@ -0,0 +1,46 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi Class Reference</h1>An abstract base class for realtime MIDI input/output. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>></code> +<p> +<p>Inheritance diagram for RtMidi: +<p><center><img src="classRtMidi.png" usemap="#RtMidi_map" border="0" alt=""></center> +<map name="RtMidi_map"> +<area href="classRtMidiIn.html" alt="RtMidiIn" shape="rect" coords="0,56,67,80"> +<area href="classRtMidiOut.html" alt="RtMidiOut" shape="rect" coords="77,56,144,80"> +</map> +<a href="classRtMidi-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An abstract base class for realtime MIDI input/output. +<p> +This class implements some common functionality for the realtime MIDI input/output subclasses <a class="el" href="classRtMidiIn.html">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html">RtMidiOut</a>.<p> +RtMidi WWW site: <a href="http://music.mcgill.ca/~gary/rtmidi/">http://music.mcgill.ca/~gary/rtmidi/</a><p> +RtMidi: realtime MIDI i/o C++ classes Copyright (c) 2003-2004 Gary P. Scavone<p> +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> +Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version.<p> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +<p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="RtMidi_8h-source.html">RtMidi.h</a></ul> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidi.png b/doc/html/classRtMidi.png Binary files differnew file mode 100644 index 0000000..4114caf --- /dev/null +++ b/doc/html/classRtMidi.png diff --git a/doc/html/classRtMidiIn-members.html b/doc/html/classRtMidiIn-members.html new file mode 100644 index 0000000..f03b7c1 --- /dev/null +++ b/doc/html/classRtMidiIn-members.html @@ -0,0 +1,33 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidiIn Member List</h1>This is the complete list of members for <a class="el" href="classRtMidiIn.html">RtMidiIn</a>, including all inherited members.<table> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a5">cancelCallback</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a6">closePort</a>(void)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a11">getMessage</a>(std::vector< unsigned char > *message)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a7">getPortCount</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a8">getPortName</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a10">ignoreTypes</a>(bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a2">openPort</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a3">openVirtualPort</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#s0">RtMidiCallback</a> typedef</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a4">setCallback</a>(RtMidiCallback callback, void *userData=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a9">setQueueSizeLimit</a>(unsigned int queueSize)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiIn.html#a1">~RtMidiIn</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> +</table><HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidiIn.html b/doc/html/classRtMidiIn.html new file mode 100644 index 0000000..ced103b --- /dev/null +++ b/doc/html/classRtMidiIn.html @@ -0,0 +1,376 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidiIn Class Reference</h1>A realtime MIDI input class. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>></code> +<p> +<p>Inheritance diagram for RtMidiIn: +<p><center><img src="classRtMidiIn.png" usemap="#RtMidiIn_map" border="0" alt=""></center> +<map name="RtMidiIn_map"> +<area href="classRtMidi.html" alt="RtMidi" shape="rect" coords="0,0,57,24"> +</map> +<a href="classRtMidiIn-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="s0" doxytag="RtMidiIn::RtMidiCallback"></a> +typedef void(* </td><td valign=bottom><a class="el" href="classRtMidiIn.html#s0">RtMidiCallback</a> )(double timeStamp, std::vector< unsigned char > *message, void *userData)</td></tr> +<tr><td> </td><td><font size=-1><em>User callback function type definition.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtMidiIn::~RtMidiIn"></a> + </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a1">~RtMidiIn</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>If a MIDI connection is still open, it will be closed by the destructor.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a2">openPort</a> (unsigned int portNumber=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Open a MIDI input connection.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a3">openVirtualPort</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Create a virtual input port to allow software connections (OS X and ALSA only).</em> <a href="#a3"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a4">setCallback</a> (<a class="el" href="classRtMidiIn.html#s0">RtMidiCallback</a> callback, void *userData=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Set a callback function to be invoked for incoming MIDI messages.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a5">cancelCallback</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Cancel use of the current callback function (if one exists).</em> <a href="#a5"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="RtMidiIn::closePort"></a> +void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a6">closePort</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>Close an open MIDI connection (if one exists).</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="RtMidiIn::getPortCount"></a> +unsigned int </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a7">getPortCount</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of available MIDI input ports.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a8">getPortName</a> (unsigned int portNumber=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Return a string identifier for the specified MIDI input port number.</em> <a href="#a8"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a9">setQueueSizeLimit</a> (unsigned int queueSize)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the maximum number of MIDI messages to be saved in the queue.</em> <a href="#a9"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a10">ignoreTypes</a> (bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td></tr> +<tr><td> </td><td><font size=-1><em>Specify whether certain MIDI message types should be queued or ignored during input.</em> <a href="#a10"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>double </td><td valign=bottom><a class="el" href="classRtMidiIn.html#a11">getMessage</a> (std::vector< unsigned char > *message)</td></tr> +<tr><td> </td><td><font size=-1><em>Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds.</em> <a href="#a11"></a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A realtime MIDI input class. +<p> +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 <a class="el" href="classRtMidiIn.html#a11">getMessage()</a> 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.<p> +by Gary P. Scavone, 2003-2004. +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="RtMidiIn::RtMidiIn"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> RtMidiIn::RtMidiIn </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Default constructor. +<p> +An exception will be thrown if a MIDI system initialization error occurs. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="RtMidiIn::openPort"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiIn::openPort </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned int </td> + <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = 0 </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Open a MIDI input connection. +<p> +An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. +<p> +Implements <a class="el" href="classRtMidi.html">RtMidi</a>. </td> + </tr> +</table> +<a name="a3" doxytag="RtMidiIn::openVirtualPort"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiIn::openVirtualPort </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a virtual input port to allow software connections (OS X and ALSA only). +<p> +This function creates a virtual MIDI input port to which other software applications can connect. This type of functionality is currently only supported by the Macintosh OS-X and Linux ALSA APIs (the function does nothing for the other APIs). </td> + </tr> +</table> +<a name="a4" doxytag="RtMidiIn::setCallback"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiIn::setCallback </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classRtMidiIn.html#s0">RtMidiCallback</a> </td> + <td class="mdname" nowrap> <em>callback</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>userData</em> = 0</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set a callback function to be invoked for incoming MIDI messages. +<p> +The callback function will be called whenever an incoming MIDI message is received. While not absolutely necessary, it is best to set the callback function before opening a MIDI port to avoid leaving some messages in the queue. </td> + </tr> +</table> +<a name="a5" doxytag="RtMidiIn::cancelCallback"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiIn::cancelCallback </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Cancel use of the current callback function (if one exists). +<p> +Subsequent incoming MIDI messages will be written to the queue and can be retrieved with the <em>getMessage</em> function. </td> + </tr> +</table> +<a name="a8" doxytag="RtMidiIn::getPortName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string RtMidiIn::getPortName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned int </td> + <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = 0 </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a string identifier for the specified MIDI input port number. +<p> +An exception is thrown if an invalid port specifier is provided. </td> + </tr> +</table> +<a name="a9" doxytag="RtMidiIn::setQueueSizeLimit"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiIn::setQueueSizeLimit </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned int </td> + <td class="mdname1" valign="top" nowrap> <em>queueSize</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the maximum number of MIDI messages to be saved in the queue. +<p> +If the queue size limit is reached, incoming messages will be ignored. The default limit is 1024. </td> + </tr> +</table> +<a name="a10" doxytag="RtMidiIn::ignoreTypes"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiIn::ignoreTypes </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname" nowrap> <em>midiSysex</em> = true, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>midiTime</em> = true, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>midiSense</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Specify whether certain MIDI message types should be queued or ignored during input. +<p> +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. </td> + </tr> +</table> +<a name="a11" doxytag="RtMidiIn::getMessage"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> double RtMidiIn::getMessage </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< unsigned char > * </td> + <td class="mdname1" valign="top" nowrap> <em>message</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds. +<p> +This function returns immediately whether a new message is available or not. A valid message is indicated by a non-zero vector size. An exception is thrown if an error occurs during message retrieval or an input connection was not previously established. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="RtMidi_8h-source.html">RtMidi.h</a></ul> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidiIn.png b/doc/html/classRtMidiIn.png Binary files differnew file mode 100644 index 0000000..224cf6d --- /dev/null +++ b/doc/html/classRtMidiIn.png diff --git a/doc/html/classRtMidiOut-members.html b/doc/html/classRtMidiOut-members.html new file mode 100644 index 0000000..451ad23 --- /dev/null +++ b/doc/html/classRtMidiOut-members.html @@ -0,0 +1,28 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidiOut Member List</h1>This is the complete list of members for <a class="el" href="classRtMidiOut.html">RtMidiOut</a>, including all inherited members.<table> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a3">closePort</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a5">getPortCount</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a6">getPortName</a>(unsigned int portNumber)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a2">openPort</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a4">openVirtualPort</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a7">sendMessage</a>(std::vector< unsigned char > *message)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr bgcolor="#f0f0f0"><td><a class="el" href="classRtMidiOut.html#a1">~RtMidiOut</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> +</table><HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidiOut.html b/doc/html/classRtMidiOut.html new file mode 100644 index 0000000..3c75b27 --- /dev/null +++ b/doc/html/classRtMidiOut.html @@ -0,0 +1,217 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidiOut Class Reference</h1>A realtime MIDI output class. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>></code> +<p> +<p>Inheritance diagram for RtMidiOut: +<p><center><img src="classRtMidiOut.png" usemap="#RtMidiOut_map" border="0" alt=""></center> +<map name="RtMidiOut_map"> +<area href="classRtMidi.html" alt="RtMidi" shape="rect" coords="0,0,67,24"> +</map> +<a href="classRtMidiOut-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtMidiOut::~RtMidiOut"></a> + </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a1">~RtMidiOut</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor closes any open MIDI connections.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a2">openPort</a> (unsigned int portNumber=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Open a MIDI output connection.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="RtMidiOut::closePort"></a> +void </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a3">closePort</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Close an open MIDI connection (if one exists).</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a4">openVirtualPort</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Create a virtual output port to allow software connections (OS X and ALSA only).</em> <a href="#a4"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="RtMidiOut::getPortCount"></a> +unsigned int </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a5">getPortCount</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of available MIDI output ports.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a6">getPortName</a> (unsigned int portNumber)</td></tr> +<tr><td> </td><td><font size=-1><em>Return a string identifier for the specified MIDI port type and number.</em> <a href="#a6"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtMidiOut.html#a7">sendMessage</a> (std::vector< unsigned char > *message)</td></tr> +<tr><td> </td><td><font size=-1><em>Immediately send a single message out an open MIDI output port.</em> <a href="#a7"></a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A realtime MIDI output class. +<p> +This class provides a common, platform-independent API for MIDI output. It allows one to probe available MIDI output ports, to connect to one such port, and to send MIDI bytes immediately over the connection. Create multiple instances of this class to connect to more than one MIDI device at the same time.<p> +by Gary P. Scavone, 2003-2004. +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="RtMidiOut::RtMidiOut"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> RtMidiOut::RtMidiOut </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Default constructor. +<p> +An exception will be thrown if a MIDI system initialization error occurs. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="RtMidiOut::openPort"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiOut::openPort </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned int </td> + <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = 0 </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Open a MIDI output connection. +<p> +An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. An exception is thrown if an error occurs while attempting to make the port connection. +<p> +Implements <a class="el" href="classRtMidi.html">RtMidi</a>. </td> + </tr> +</table> +<a name="a4" doxytag="RtMidiOut::openVirtualPort"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiOut::openVirtualPort </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Create a virtual output port to allow software connections (OS X and ALSA only). +<p> +This function creates a virtual MIDI output port to which other software applications can connect. This type of functionality is currently only supported by the Macintosh OS-X and Linux ALSA APIs (the function does nothing with the other APIs). An exception is thrown if an error occurs while attempting to create the virtual port. </td> + </tr> +</table> +<a name="a6" doxytag="RtMidiOut::getPortName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string RtMidiOut::getPortName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned int </td> + <td class="mdname1" valign="top" nowrap> <em>portNumber</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a string identifier for the specified MIDI port type and number. +<p> +An exception is thrown if an invalid port specifier is provided. </td> + </tr> +</table> +<a name="a7" doxytag="RtMidiOut::sendMessage"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void RtMidiOut::sendMessage </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< unsigned char > * </td> + <td class="mdname1" valign="top" nowrap> <em>message</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Immediately send a single message out an open MIDI output port. +<p> +An exception is thrown if an error occurs during output or an output connection was not previously established. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="RtMidi_8h-source.html">RtMidi.h</a></ul> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/classRtMidiOut.png b/doc/html/classRtMidiOut.png Binary files differnew file mode 100644 index 0000000..6a41edc --- /dev/null +++ b/doc/html/classRtMidiOut.png diff --git a/doc/html/doxygen.css b/doc/html/doxygen.css new file mode 100644 index 0000000..8cb8b2e --- /dev/null +++ b/doc/html/doxygen.css @@ -0,0 +1,49 @@ +H1 { text-align: center; } +CAPTION { font-weight: bold } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #eeeeee } +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #f2f2ff; font-weight: bold; } +TD.mdname1 { background-color: #f2f2ff; font-weight: bold; color: #602020; } +TD.mdname { background-color: #f2f2ff; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +BODY { background: white; color: black } +TD.indexkey { + background-color: #eeeeff; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +TD.indexvalue { + background-color: #eeeeff; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +span.keyword { color: #008000 } +span.keywordtype { color: #604020 } +span.keywordflow { color: #e08000 } +span.comment { color: #800000 } +span.preprocessor { color: #806020 } +span.stringliteral { color: #002080 } +span.charliteral { color: #008080 } diff --git a/doc/html/doxygen.png b/doc/html/doxygen.png Binary files differnew file mode 100644 index 0000000..96ae72c --- /dev/null +++ b/doc/html/doxygen.png diff --git a/doc/html/files.html b/doc/html/files.html new file mode 100644 index 0000000..7be5c13 --- /dev/null +++ b/doc/html/files.html @@ -0,0 +1,23 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi File List</h1>Here is a list of all documented files with brief descriptions:<table> + <tr><td class="indexkey"><b>RtError.h</b> <a href="RtError_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><b>RtMidi.h</b> <a href="RtMidi_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr> +</table> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/functions.html b/doc/html/functions.html new file mode 100644 index 0000000..1195328 --- /dev/null +++ b/doc/html/functions.html @@ -0,0 +1,42 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi Compound Members</h1>Here is a list of all documented class members with links to the class documentation for each member:<ul> +<li>cancelCallback() +: <a class="el" href="classRtMidiIn.html#a5">RtMidiIn</a><li>closePort() +: <a class="el" href="classRtMidiOut.html#a3">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a6">RtMidiIn</a><li>getMessage() +: <a class="el" href="classRtError.html#a4">RtError</a>, <a class="el" href="classRtMidiIn.html#a11">RtMidiIn</a><li>getPortCount() +: <a class="el" href="classRtMidiOut.html#a5">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a7">RtMidiIn</a><li>getPortName() +: <a class="el" href="classRtMidiOut.html#a6">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a8">RtMidiIn</a><li>getType() +: <a class="el" href="classRtError.html#a3">RtError</a><li>ignoreTypes() +: <a class="el" href="classRtMidiIn.html#a10">RtMidiIn</a><li>openPort() +: <a class="el" href="classRtMidiOut.html#a2">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a2">RtMidiIn</a><li>openVirtualPort() +: <a class="el" href="classRtMidiOut.html#a4">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a3">RtMidiIn</a><li>printMessage() +: <a class="el" href="classRtError.html#a2">RtError</a><li>RtError() +: <a class="el" href="classRtError.html#a0">RtError</a><li>RtMidiCallback +: <a class="el" href="classRtMidiIn.html#s0">RtMidiIn</a><li>RtMidiIn() +: <a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a><li>RtMidiOut() +: <a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a><li>sendMessage() +: <a class="el" href="classRtMidiOut.html#a7">RtMidiOut</a><li>setCallback() +: <a class="el" href="classRtMidiIn.html#a4">RtMidiIn</a><li>setQueueSizeLimit() +: <a class="el" href="classRtMidiIn.html#a9">RtMidiIn</a><li>Type +: <a class="el" href="classRtError.html#s11">RtError</a><li>~RtError() +: <a class="el" href="classRtError.html#a1">RtError</a><li>~RtMidiIn() +: <a class="el" href="classRtMidiIn.html#a1">RtMidiIn</a><li>~RtMidiOut() +: <a class="el" href="classRtMidiOut.html#a1">RtMidiOut</a></ul> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/hierarchy.html b/doc/html/hierarchy.html new file mode 100644 index 0000000..548d919 --- /dev/null +++ b/doc/html/hierarchy.html @@ -0,0 +1,27 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>RtMidi Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> +<li><a class="el" href="classRtError.html">RtError</a> +<li><a class="el" href="classRtMidi.html">RtMidi</a> +<ul> +<li><a class="el" href="classRtMidiIn.html">RtMidiIn</a> +<li><a class="el" href="classRtMidiOut.html">RtMidiOut</a> +</ul> +<li><b>RtMidiIn::MidiMessage</b><li><b>RtMidiIn::RtMidiInData</b></ul> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 0000000..5972b27 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,336 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.3-rc3 --> +<h1>The <a class="el" href="classRtMidi.html">RtMidi</a> Tutorial</h1> +<p> +<center><a class="el" href="index.html#intro">Introduction</a> <a class="el" href="index.html#download">Download</a> <a class="el" href="index.html#start">Getting Started</a> <a class="el" href="index.html#error">Error Handling</a> <a class="el" href="index.html#probing">Probing Ports</a> <a class="el" href="index.html#output">MIDI Output</a> <a class="el" href="index.html#input">MIDI Input</a> <a class="el" href="index.html#virtual">Virtual Ports</a> <a class="el" href="index.html#compiling">Compiling</a> <a class="el" href="index.html#debug">Debugging</a> <a class="el" href="index.html#apinotes">API Notes</a> <a class="el" href="index.html#license">License</a> </center><h2><a name="intro"></a> +Introduction</h2> +<a class="el" href="classRtMidi.html">RtMidi</a> is a set of C++ classes (<a class="el" href="classRtMidiIn.html">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html">RtMidiOut</a>) which provide a common API (Application Programming Interface) for realtime MIDI input/output across Linux (ALSA), Macintosh OS X, SGI, and Windows (Multimedia Library) operating systems. <a class="el" href="classRtMidi.html">RtMidi</a> significantly simplifies the process of interacting with computer MIDI hardware and software. It was designed with the following goals:<p> +<ul> +<li> +object oriented C++ design </li> +<li> +simple, common API across all supported platforms </li> +<li> +only two header files and one source file for easy inclusion in programming projects </li> +<li> +MIDI device enumeration </li> +</ul> +<p> +MIDI input and output functionality are separated into two classes, <a class="el" href="classRtMidiIn.html">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html">RtMidiOut</a>. Each class instance supports only a single MIDI connection. <a class="el" href="classRtMidi.html">RtMidi</a> does not provide timing functionality (i.e., output messages are sent immediately). Input messages are timestamped with delta times in seconds (via a <code>double</code> floating point type). MIDI data is passed to the user as raw bytes using an std::vector<unsigned char>.<h2><a name="download"></a> +Download</h2> +Latest Release (17 September 2004): <a href="http://music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.0.tar.gz">Version 1.0.0 (154 kB tar/gzipped)</a><h2><a name="start"></a> +Getting Started</h2> +The first thing that must be done when using <a class="el" href="classRtMidi.html">RtMidi</a> is to create an instance of the <a class="el" href="classRtMidiIn.html">RtMidiIn</a> or <a class="el" href="classRtMidiOut.html">RtMidiOut</a> subclasses. <a class="el" href="classRtMidi.html">RtMidi</a> is an abstract base class, which itself cannot be instantiated. Each default constructor attempts to establish any necessary "connections" with the underlying MIDI system. <a class="el" href="classRtMidi.html">RtMidi</a> uses C++ exceptions to report errors, necessitating try/catch blocks around many member functions. An <a class="el" href="classRtError.html">RtError</a> can be thrown during instantiation in some circumstances. A warning message may also be reported if no MIDI devices are found during instantiation. The <a class="el" href="classRtMidi.html">RtMidi</a> classes have been designed to work with "hot pluggable" or virtual (software) MIDI devices, making it is possible to connect or start MIDI devices after the classes have been instantiated. The following code example demonstrates default object construction and destruction:<p> +<div class="fragment"><pre> + +<span class="preprocessor">#include "RtMidi.h"</span> + +<span class="keywordtype">int</span> main() +{ + <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = 0; + + <span class="comment">// RtMidiIn constructor</span> + <span class="keywordflow">try</span> { + midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + } + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { + <span class="comment">// Handle the exception here</span> + error.printMessage(); + } + + <span class="comment">// Clean up</span> + <span class="keyword">delete</span> midiin; +} +</pre></div><p> +Obviously, this example doesn't demonstrate any of the real functionality of <a class="el" href="classRtMidi.html">RtMidi</a>. However, all uses of <a class="el" href="classRtMidi.html">RtMidi</a> must begin with construction and must end with class destruction. Further, it is necessary that all class methods which can throw a C++ exception be called within a try/catch block.<h2><a name="error"></a> +Error Handling</h2> +<a class="el" href="classRtMidi.html">RtMidi</a> uses a C++ exception handler called <a class="el" href="classRtError.html">RtError</a>, which is declared and defined in <a class="el" href="RtError_8h.html">RtError.h</a>. The <a class="el" href="classRtError.html">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#s11">RtError::Type</a>. Many <a class="el" href="classRtMidi.html">RtMidi</a> methods can "throw" an <a class="el" href="classRtError.html">RtError</a>, most typically if a driver error occurs or an invalid function argument is specified. There are a number of cases within <a class="el" href="classRtMidi.html">RtMidi</a> where warning messages may be displayed but an exception is not thrown. There is a protected <a class="el" href="classRtMidi.html">RtMidi</a> method, error(), which can be modified to globally control how these messages are handled and reported. By default, error messages are not automatically displayed in <a class="el" href="classRtMidi.html">RtMidi</a> unless the preprocessor definition __RTMIDI_DEBUG__ is defined. Messages associated with caught exceptions can be displayed with, for example, the <a class="el" href="classRtError.html#a2">RtError::printMessage()</a> function.<h2><a name="probing"></a> +Probing Ports</h2> +A programmer may wish to query the available MIDI ports before deciding which to use. The following example outlines how this can be done.<p> +<div class="fragment"><pre> +<span class="comment">// midiinfo.cpp</span> + +<span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include "RtMidi.h"</span> + +<span class="keywordtype">int</span> main() +{ + <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = 0; + <a class="code" href="classRtMidiOut.html">RtMidiOut</a> *midiout = 0; + + <span class="comment">// RtMidiIn constructor</span> + <span class="keywordflow">try</span> { + midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + } + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { + error.printMessage(); + exit(EXIT_FAILURE); + } + + <span class="comment">// Check inputs.</span> + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); + std::cout << <span class="stringliteral">"\nThere are "</span> << nPorts << <span class="stringliteral">" MIDI input sources available.\n"</span>; + std::string portName; + <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<nPorts; i++ ) { + <span class="keywordflow">try</span> { + portName = midiin-><a class="code" href="classRtMidiIn.html#a8">getPortName</a>(i); + } + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { + error.printMessage(); + <span class="keywordflow">goto</span> cleanup; + } + std::cout << <span class="stringliteral">" Input Port #"</span> << i+1 << <span class="stringliteral">": "</span> << portName << <span class="charliteral">'\n'</span>; + } + + <span class="comment">// RtMidiOut constructor</span> + <span class="keywordflow">try</span> { + midiout = <span class="keyword">new</span> <a class="code" href="classRtMidiOut.html">RtMidiOut</a>(); + } + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { + error.printMessage(); + exit(EXIT_FAILURE); + } + + <span class="comment">// Check outputs.</span> + nPorts = midiout-><a class="code" href="classRtMidiOut.html#a5">getPortCount</a>(); + std::cout << <span class="stringliteral">"\nThere are "</span> << nPorts << <span class="stringliteral">" MIDI output ports available.\n"</span>; + <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<nPorts; i++ ) { + <span class="keywordflow">try</span> { + portName = midiout-><a class="code" href="classRtMidiOut.html#a6">getPortName</a>(i); + } + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { + error.printMessage(); + <span class="keywordflow">goto</span> cleanup; + } + std::cout << <span class="stringliteral">" Output Port #"</span> << i+1 << <span class="stringliteral">": "</span> << portName << <span class="charliteral">'\n'</span>; + } + std::cout << <span class="charliteral">'\n'</span>; + + <span class="comment">// Clean up</span> + cleanup: + <span class="keyword">delete</span> midiin; + <span class="keyword">delete</span> midiout; + + <span class="keywordflow">return</span> 0; +} +</pre></div><h2><a name="output"></a> +MIDI Output</h2> +The <a class="el" href="classRtMidiOut.html">RtMidiOut</a> class provides simple functionality to immediately send messages over a MIDI connection. No timing functionality is provided.<p> +In the following example, we omit necessary error checking and details regarding OS-dependent sleep functions. For a complete example, see the <code>midiout.cpp</code> program in the <code>tests</code> directory.<p> +<div class="fragment"><pre> +<span class="comment">// midiout.cpp</span> + +<span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include "RtMidi.h"</span> + +<span class="keywordtype">int</span> main() +{ + <a class="code" href="classRtMidiOut.html">RtMidiOut</a> *midiout = <span class="keyword">new</span> <a class="code" href="classRtMidiOut.html">RtMidiOut</a>(); + std::vector<unsigned char> message; + + <span class="comment">// Check available ports.</span> + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiout-><a class="code" href="classRtMidiOut.html#a5">getPortCount</a>(); + <span class="keywordflow">if</span> ( nPorts == 0 ) { + std::cout << <span class="stringliteral">"No ports available!\n"</span>; + <span class="keywordflow">goto</span> cleanup; + } + + <span class="comment">// Open first available port.</span> + midiout-><a class="code" href="classRtMidiOut.html#a2">openPort</a>( 0 ); + + <span class="comment">// Send out a series of MIDI messages.</span> + + <span class="comment">// Program change: 192, 5</span> + message.push_back( 192 ); + message.push_back( 5 ); + midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + + <span class="comment">// Control Change: 176, 7, 100 (volume)</span> + message[0] = 176; + message[1] = 7; + message.push_back( 100 ); + midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + + <span class="comment">// Note On: 144, 64, 90</span> + message[0] = 144; + message[1] = 64; + message[2] = 90; + midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + + SLEEP( 500 ); <span class="comment">// Platform-dependent ... see example in tests directory.</span> + + <span class="comment">// Note Off: 128, 64, 40</span> + message[0] = 128; + message[1] = 64; + message[2] = 40; + midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + + <span class="comment">// Clean up</span> + cleanup: + <span class="keyword">delete</span> midiout; + + <span class="keywordflow">return</span> 0; +} +</pre></div><h2><a name="input"></a> +MIDI Input</h2> +The <a class="el" href="classRtMidiIn.html">RtMidiIn</a> class uses an internal callback function or thread to receive incoming MIDI messages from a port or device. These messages are then either queued and read by the user via calls to the <a class="el" href="classRtMidiIn.html#a11">RtMidiIn::getMessage()</a> function or immediately passed to a user-specified callback function (which must be "registered" using the <a class="el" href="classRtMidiIn.html#a4">RtMidiIn::setCallback()</a> function). We'll provide examples of both usages.<p> +The <a class="el" href="classRtMidiIn.html">RtMidiIn</a> class provides the <a class="el" href="classRtMidiIn.html#a10">RtMidiIn::ignoreTypes()</a> function to specify that certain MIDI message types be ignored. By default, sysem exclusive, timing, and active sensing messages are ignored.<h3><a name="qmidiin"></a> +Queued MIDI Input</h3> +The <a class="el" href="classRtMidiIn.html#a11">RtMidiIn::getMessage()</a> function does not block. If a MIDI message is available in the queue, it is copied to the user-provided <code>std::vector<unsigned char></code> container. When no MIDI message is available, the function returns an empty container. The default maximum MIDI queue size is 1024 messages. This value may be modified with the <a class="el" href="classRtMidiIn.html#a9">RtMidiIn::setQueueSizeLimit()</a> function. If the maximum queue size limit is reached, subsequent MIDI messages are discarded until the queue size is reduced.<p> +In the following example, we omit some necessary error checking and details regarding OS-dependent sleep functions. For a more complete example, see the <code>qmidiin.cpp</code> program in the <code>tests</code> directory.<p> +<div class="fragment"><pre> +<span class="comment">// qmidiin.cpp</span> + +<span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include <signal.h></span> +<span class="preprocessor">#include "RtMidi.h"</span> + +<span class="keywordtype">bool</span> done; +<span class="keyword">static</span> <span class="keywordtype">void</span> finish(<span class="keywordtype">int</span> ignore){ done = <span class="keyword">true</span>; } + +<span class="keywordtype">int</span> main() +{ + <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + std::vector<unsigned char> message; + <span class="keywordtype">int</span> nBytes, i; + <span class="keywordtype">double</span> stamp; + + <span class="comment">// Check available ports.</span> + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); + <span class="keywordflow">if</span> ( nPorts == 0 ) { + std::cout << <span class="stringliteral">"No ports available!\n"</span>; + <span class="keywordflow">goto</span> cleanup; + } + midiin-><a class="code" href="classRtMidiIn.html#a2">openPort</a>( 0 ); + + <span class="comment">// Don't ignore sysex, timing, or active sensing messages.</span> + midiin-><a class="code" href="classRtMidiIn.html#a10">ignoreTypes</a>( <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="keyword">false</span> ); + + <span class="comment">// Install an interrupt handler function.</span> + done = <span class="keyword">false</span>; + (void) signal(SIGINT, finish); + + <span class="comment">// Periodically check input queue.</span> + std::cout << <span class="stringliteral">"Reading MIDI from port ... quit with Ctrl-C.\n"</span>; + <span class="keywordflow">while</span> ( !done ) { + stamp = midiin-><a class="code" href="classRtMidiIn.html#a11">getMessage</a>( &message ); + nBytes = message.size(); + <span class="keywordflow">for</span> ( i=0; i<nBytes; i++ ) + std::cout << <span class="stringliteral">"Byte "</span> << i << <span class="stringliteral">" = "</span> << (int)message[i] << <span class="stringliteral">", "</span>; + <span class="keywordflow">if</span> ( nBytes > 0 ) + std::cout << <span class="stringliteral">"stamp = "</span> << stamp << <span class="charliteral">'\n'</span>; + + <span class="comment">// Sleep for 10 milliseconds ... platform-dependent.</span> + SLEEP( 10 ); + } + + <span class="comment">// Clean up</span> + cleanup: + <span class="keyword">delete</span> midiin; + + <span class="keywordflow">return</span> 0; +} +</pre></div><h3><a name="cmidiin"></a> +MIDI Input with User Callback</h3> +When set, a user-provided callback function will be invoked after the input of a complete MIDI message. It is possible to provide a pointer to user data which can be accessed in the callback function (not shown here). It is necessary to set the callback function immediately after opening the port to avoid having incoming messages written to the queue (which is not emptied when a callback function is set). If you are worried about this happening, you can check the queue using the RtMidi::getMessage() function to verify it is empty (after the callback function is set).<p> +In the following example, we omit some necessary error checking. For a more complete example, see the <code>cmidiin.cpp</code> program in the <code>tests</code> directory.<p> +<div class="fragment"><pre> +<span class="comment">// cmidiin.cpp</span> + +<span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include "RtMidi.h"</span> + +<span class="keywordtype">void</span> mycallback( <span class="keywordtype">double</span> deltatime, std::vector< unsigned char > *message, <span class="keywordtype">void</span> *userData ) +{ + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBytes = message->size(); + <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<nBytes; i++ ) + std::cout << <span class="stringliteral">"Byte "</span> << i << <span class="stringliteral">" = "</span> << (int)message->at(i) << <span class="stringliteral">", "</span>; + <span class="keywordflow">if</span> ( nBytes > 0 ) + std::cout << <span class="stringliteral">"stamp = "</span> << deltatime << <span class="charliteral">'\n'</span>; +} + +<span class="keywordtype">int</span> main() +{ + <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + + <span class="comment">// Check available ports.</span> + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); + <span class="keywordflow">if</span> ( nPorts == 0 ) { + std::cout << <span class="stringliteral">"No ports available!\n"</span>; + <span class="keywordflow">goto</span> cleanup; + } + + midiin-><a class="code" href="classRtMidiIn.html#a2">openPort</a>( 0 ); + + <span class="comment">// Set our callback function. This should be done immediately after</span> + <span class="comment">// opening the port to avoid having incoming messages written to the</span> + <span class="comment">// queue.</span> + midiin-><a class="code" href="classRtMidiIn.html#a4">setCallback</a>( &mycallback ); + + <span class="comment">// Don't ignore sysex, timing, or active sensing messages.</span> + midiin-><a class="code" href="classRtMidiIn.html#a10">ignoreTypes</a>( <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="keyword">false</span> ); + + std::cout << <span class="stringliteral">"\nReading MIDI input ... press <enter> to quit.\n"</span>; + <span class="keywordtype">char</span> input; + std::cin.get(input); + + <span class="comment">// Clean up</span> + cleanup: + <span class="keyword">delete</span> midiin; + + <span class="keywordflow">return</span> 0; +} +</pre></div><h2><a name="virtual"></a> +Virtual Ports</h2> +The Linux ALSA and Macintosh CoreMIDI APIs allow for the establishment of virtual input and output MIDI ports to which other software clients can connect. <a class="el" href="classRtMidi.html">RtMidi</a> incorporates this functionality with the <a class="el" href="classRtMidiIn.html#a3">RtMidiIn::openVirtualPort()</a> and <a class="el" href="classRtMidiOut.html#a4">RtMidiOut::openVirtualPort()</a> functions. Any messages sent with the <a class="el" href="classRtMidiOut.html#a7">RtMidiOut::sendMessage()</a> function will also be transmitted through an open virtual output port. If a virtual input port is open and a user callback function is set, the callback function will be invoked when messages arrive via that port. If a callback function is not set, the user must poll the input queue to check whether messages have arrived. No notification is provided for the establishment of a client connection via a virtual port.<h2><a name="compiling"></a> +Compiling</h2> +In order to compile <a class="el" href="classRtMidi.html">RtMidi</a> for a specific OS and API, it is necessary to supply the appropriate preprocessor definition and library within the compiler statement: <p> +<table border="2" cols="5" width="100%" cellspacing="3" cellpadding="3"> +<tr bgcolor="beige"> +<td width="5%"><b>OS:</b> </td><td width="5%"><b>Audio API:</b> </td><td width="5%"><b>Preprocessor Definition:</b> </td><td width="5%"><b>Library or Framework:</b> </td><td><b>Example Compiler Statement:</b> </td></tr> +<tr> +<td>Linux </td><td>ALSA </td><td>__LINUX_ALSA__ </td><td><code>asound, pthread</code> </td><td><code>g++ -Wall -D__LINUX_ALSA__ -o midiinfo midiinfo.cpp RtMidi.cpp -lasound -lpthread</code> </td></tr> +<tr> +<td>Macintosh OS X </td><td>CoreAudio </td><td>__MACOSX_CORE__ </td><td><code>pthread, stdc++, CoreAudio</code> </td><td><code>g++ -Wall -D__MACOSX_CORE__ -o midiinfo midiinfo.cpp RtMidi.cpp -framework CoreMidi -lpthread</code> </td></tr> +<tr> +<td>Irix </td><td>MD </td><td>__IRIX_MD__ </td><td><code>md, pthread</code> </td><td><code>CC -Wall -D__IRIX_MD__ -o midiinfo midiinfo.cpp RtMidi.cpp -laudio -lpthread</code> </td></tr> +<tr> +<td>Windows </td><td>Multimedia Library </td><td>__WINDOWS_MM__ </td><td><code>winmm.lib, multithreaded</code> </td><td><em>compiler specific</em> </td></tr> +</table> +<p> +The example compiler statements above could be used to compile the <code>probe.cpp</code> example file, assuming that <code>midiinfo.cpp</code>, <code><a class="el" href="RtMidi_8h.html">RtMidi.h</a></code>, <code><a class="el" href="RtError_8h.html">RtError.h</a></code>, and <code>RtMidi.cpp</code> all exist in the same directory.<h2><a name="debug"></a> +Debugging</h2> +If you are having problems getting <a class="el" href="classRtMidi.html">RtMidi</a> to run on your system, try passing the preprocessor definition <code>__RTMIDI_DEBUG__</code> to the compiler (or uncomment the definition at the bottom of <a class="el" href="RtMidi_8h.html">RtMidi.h</a>). A variety of warning messages will be displayed which may help in determining the problem. Also try using the programs included in the <code>test</code> directory. The program <code>midiinfo</code> displays the queried capabilities of all MIDI ports found.<h2><a name="apinotes"></a> +API Notes</h2> +<a class="el" href="classRtMidi.html">RtMidi</a> is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, some issues should be mentioned with regard to each.<h3><a name="linux"></a> +Linux:</h3> +<a class="el" href="classRtMidi.html">RtMidi</a> for Linux was developed using the Fedora distribution. A decision was made to not include support for the OSS API because the OSS API provides such limited functionality and because <a href="http://www.alsa-project.org/">ALSA</a> support is now incorporated in the Linux kernel. <a class="el" href="classRtMidi.html">RtMidi</a> uses the ALSA sequencer API, which allows for virtual software input and output ports.<h3><a name="macosx"></a> +Macintosh OS X (CoreAudio):</h3> +The Apple CoreMidi API allows for the establishment of virtual input and output ports to which other software applications can connect.<h3><a name="irix"></a> +Irix (SGI):</h3> +The Irix version of <a class="el" href="classRtMidi.html">RtMidi</a> was written and tested on an SGI Indy running Irix version 6.5.4 and the MD audio library.<h3><a name="windowsds"></a> +Windows (Multimedia Library):</h3> +The Windows Multimedia library MIDI calls used in <a class="el" href="classRtMidi.html">RtMidi</a> do not make use of streaming functionality. <a class="el" href="classRtMidi.html">RtMidi</a> was originally developed with Visual C++ version 6.0.<h2><a name="license"></a> +License</h2> +<a class="el" href="classRtMidi.html">RtMidi</a>: realtime MIDI i/o C++ classes<br> + Copyright (c) 2003-2004 Gary P. Scavone<p> +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> +Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version.<p> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> |
