summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStephen Sinclair <sinclair@music.mcgill.ca>2013-10-11 15:14:23 +0200
committerStephen Sinclair <sinclair@music.mcgill.ca>2013-10-11 15:14:23 +0200
commit074083dff9003e86c3f307da312a35694e2db7aa (patch)
treedfe38b1bbaac221cdfeae7c0e1f65eb822fca9f5 /doc
parent7f9b19c0c889bf4b317cc0686275633713c484d8 (diff)
parent9bbab359f008990f89ec574558d528a2f3b55d04 (diff)
Merge 1.0.7 into releases
Diffstat (limited to 'doc')
-rw-r--r--doc/doxygen/Doxyfile2
-rw-r--r--doc/doxygen/footer.html2
-rw-r--r--doc/doxygen/tutorial.txt28
-rw-r--r--doc/release.txt6
4 files changed, 22 insertions, 16 deletions
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
index c0360cd..ace650e 100644
--- a/doc/doxygen/Doxyfile
+++ b/doc/doxygen/Doxyfile
@@ -4,7 +4,7 @@
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = RtMidi
-PROJECT_NUMBER =
+PROJECT_NUMBER = 1.0.7
OUTPUT_DIRECTORY = .
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
diff --git a/doc/doxygen/footer.html b/doc/doxygen/footer.html
index 200e499..debd75e 100644
--- a/doc/doxygen/footer.html
+++ b/doc/doxygen/footer.html
@@ -1,7 +1,7 @@
<HR>
<table><tr><td><img src="../images/mcgill.gif" width=165></td>
- <td>&copy;2003-2006 Gary P. Scavone, McGill University. All Rights Reserved.<br>
+ <td>&copy;2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr>
</table>
diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt
index 9a97a31..8505e5d 100644
--- a/doc/doxygen/tutorial.txt
+++ b/doc/doxygen/tutorial.txt
@@ -17,7 +17,7 @@ MIDI input and output functionality are separated into two classes, RtMidiIn and
\section download Download
-Latest Release (9 March 2006): <A href="http://music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.6.tar.gz">Version 1.0.6</A>
+Latest Release (7 December 2007): <A href="http://music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.7.tar.gz">Version 1.0.7</A>
\section start Getting Started
@@ -58,7 +58,7 @@ RtMidi uses a C++ exception handler called RtError, which is declared and define
A programmer may wish to query the available MIDI ports before deciding which to use. The following example outlines how this can be done.
\code
-// midiinfo.cpp
+// midiprobe.cpp
#include <iostream>
#include "RtMidi.h"
@@ -72,9 +72,9 @@ int main()
try {
midiin = new RtMidiIn();
}
- catch (RtError &error) {
+ catch ( RtError &error ) {
error.printMessage();
- exit(EXIT_FAILURE);
+ exit( EXIT_FAILURE );
}
// Check inputs.
@@ -85,7 +85,7 @@ int main()
try {
portName = midiin->getPortName(i);
}
- catch (RtError &error) {
+ catch ( RtError &error ) {
error.printMessage();
goto cleanup;
}
@@ -96,9 +96,9 @@ int main()
try {
midiout = new RtMidiOut();
}
- catch (RtError &error) {
+ catch ( RtError &error ) {
error.printMessage();
- exit(EXIT_FAILURE);
+ exit( EXIT_FAILURE );
}
// Check outputs.
@@ -330,21 +330,21 @@ In order to compile RtMidi for a specific OS and API, it is necessary to supply
<TD>ALSA Sequencer</TD>
<TD>__LINUX_ALSASEQ__</TD>
<TD><TT>asound, pthread</TT></TD>
- <TD><TT>g++ -Wall -D__LINUX_ALSASEQ__ -o midiinfo midiinfo.cpp RtMidi.cpp -lasound -lpthread</TT></TD>
+ <TD><TT>g++ -Wall -D__LINUX_ALSASEQ__ -o midiprobe midiprobe.cpp RtMidi.cpp -lasound -lpthread</TT></TD>
</TR>
<TR>
<TD>Macintosh OS X</TD>
<TD>CoreMidi</TD>
<TD>__MACOSX_CORE__</TD>
<TD><TT>CoreMidi, CoreAudio, CoreFoundation</TT></TD>
- <TD><TT>g++ -Wall -D__MACOSX_CORE__ -o midiinfo midiinfo.cpp RtMidi.cpp -framework CoreMidi -framework CoreAudio -framework CoreFoundation</TT></TD>
+ <TD><TT>g++ -Wall -D__MACOSX_CORE__ -o midiprobe midiprobe.cpp RtMidi.cpp -framework CoreMidi -framework CoreAudio -framework CoreFoundation</TT></TD>
</TR>
<TR>
<TD>Irix</TD>
<TD>MD</TD>
<TD>__IRIX_MD__</TD>
<TD><TT>md, pthread</TT></TD>
- <TD><TT>CC -Wall -D__IRIX_MD__ -o midiinfo midiinfo.cpp RtMidi.cpp -laudio -lpthread</TT></TD>
+ <TD><TT>CC -Wall -D__IRIX_MD__ -o midiprobe midiprobe.cpp RtMidi.cpp -laudio -lpthread</TT></TD>
</TR>
<TR>
<TD>Windows</TD>
@@ -356,11 +356,11 @@ In order to compile RtMidi for a specific OS and API, it is necessary to supply
</TABLE>
<P>
-The example compiler statements above could be used to compile the <TT>probe.cpp</TT> example file, assuming that <TT>midiinfo.cpp</TT>, <TT>RtMidi.h</TT>, <tt>RtError.h</tt>, and <TT>RtMidi.cpp</TT> all exist in the same directory.
+The example compiler statements above could be used to compile the <TT>midiprobe.cpp</TT> example file, assuming that <TT>midiprobe.cpp</TT>, <TT>RtMidi.h</TT>, <tt>RtError.h</tt>, and <TT>RtMidi.cpp</TT> all exist in the same directory.
\section debug Debugging
-If you are having problems getting RtMidi to run on your system, try passing the preprocessor definition <TT>__RTMIDI_DEBUG__</TT> to the compiler (or uncomment the definition at the bottom of RtMidi.h). A variety of warning messages will be displayed which may help in determining the problem. Also try using the programs included in the <tt>test</tt> directory. The program <tt>midiinfo</tt> displays the queried capabilities of all MIDI ports found.
+If you are having problems getting RtMidi to run on your system, try passing the preprocessor definition <TT>__RTMIDI_DEBUG__</TT> to the compiler (or uncomment the definition at the bottom of RtMidi.h). A variety of warning messages will be displayed which may help in determining the problem. Also try using the programs included in the <tt>test</tt> directory. The program <tt>midiprobe</tt> displays the queried capabilities of all MIDI ports found.
\section apinotes API Notes
@@ -382,6 +382,8 @@ The Irix version of RtMidi was written and tested on an SGI Indy running Irix ve
The Windows Multimedia library MIDI calls used in RtMidi do not make use of streaming functionality. RtMidi was originally developed with Visual C++ version 6.0.
+The \c configure script provides support for the MinGW compiler.
+
\section acknowledge Acknowledgements
Many thanks to the following people for providing bug fixes:
@@ -394,7 +396,7 @@ Many thanks to the following people for providing bug fixes:
\section license License
RtMidi: realtime MIDI i/o C++ classes<BR>
- Copyright (c) 2003-2006 Gary P. Scavone
+ Copyright (c) 2003-2007 Gary P. Scavone
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
diff --git a/doc/release.txt b/doc/release.txt
index fc3025b..f6f4711 100644
--- a/doc/release.txt
+++ b/doc/release.txt
@@ -1,6 +1,10 @@
RtMidi - a set of C++ classes that provides a common API for realtime MIDI input/output across Linux (ALSA), SGI, Macintosh OS X (CoreMidi), and Windows (Multimedia) operating systems.
-By Gary P. Scavone, 2003-2006.
+By Gary P. Scavone, 2003-2007.
+
+v1.0.7: (7 December 2007)
+- configure and Makefile changes for MinGW
+- renamed midiinfo.cpp to midiprobe.cpp and updated VC++ project/workspace
v1.0.6: (9 March 2006)
- bug fix for timestamp problem in ALSA (thanks to Pedro Lopez-Cabanillas)