summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStephen Sinclair <sinclair@music.mcgill.ca>2013-10-11 01:51:47 +0200
committerStephen Sinclair <sinclair@music.mcgill.ca>2013-10-11 01:51:47 +0200
commit2572d0d544acf19943ae955059e1b64b0968a3ba (patch)
treef908ba7889e4e05614e7425a7ff69273ec3f498e /doc
parent64f75193375cc6ec0052e33131df5939b7926ecd (diff)
parent3dc6e2e86821303784512f86805683f1fda14ccb (diff)
Merge 4.0.3 into releases
Diffstat (limited to 'doc')
-rw-r--r--doc/doxygen/Doxyfile2
-rw-r--r--doc/doxygen/apinotes.txt4
-rw-r--r--doc/doxygen/compiling.txt12
-rw-r--r--doc/doxygen/probe.txt2
-rw-r--r--doc/doxygen/tutorial.txt6
-rw-r--r--doc/release.txt6
6 files changed, 21 insertions, 11 deletions
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
index e4b0cef..0b72a2a 100644
--- a/doc/doxygen/Doxyfile
+++ b/doc/doxygen/Doxyfile
@@ -23,7 +23,7 @@ PROJECT_NAME = RtAudio
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 4.0
+PROJECT_NUMBER = 4.0.3
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
diff --git a/doc/doxygen/apinotes.txt b/doc/doxygen/apinotes.txt
index 73e473e..1d369b6 100644
--- a/doc/doxygen/apinotes.txt
+++ b/doc/doxygen/apinotes.txt
@@ -22,12 +22,16 @@ The RtAudio Jack support can be compiled on Macintosh OS-X systems, as well as i
\section windowsds Windows (DirectSound):
+The \c configure script provides support for the MinGW compiler. DirectSound support is specified with the "--with-ds" flag.
+
In order to compile RtAudio under Windows for the DirectSound API, you must have the header and source files for DirectSound version 5.0 or higher. As far as I know, there is no DirectSoundCapture support for Windows NT. Audio output latency with DirectSound can be reasonably good, especially since RtAudio version 3.0.2. Input audio latency still tends to be bad but better since version 3.0.2. RtAudio was originally developed with Visual C++ version 6.0 but has been tested with .NET.
The DirectSound version of RtAudio can be compiled with or without the UNICODE preprocessor definition.
\section windowsasio Windows (ASIO):
+ASIO support using MinGW and the \c configure script is specified with the "--with-asio" flag.
+
The Steinberg ASIO audio API allows only a single device driver to be loaded and accessed at a time. ASIO device drivers must be supplied by audio hardware manufacturers, though ASIO emulation is possible on top of systems with DirectSound drivers. The <I>numberOfBuffers</I> parameter to the RtAudio::openStream() function has no affect in this implementation.
A number of ASIO source and header files are required for use with RtAudio. Specifically, an RtAudio project must include the following files: <TT>asio.h,cpp; asiodrivers.h,cpp; asiolist.h,cpp; asiodrvr.h; asiosys.h; ginclude.h; iasiodrv.h; iasiothiscallresolver.h,cpp</TT>. The Visual C++ projects found in <TT>/tests/Windows/</TT> compile both ASIO and DirectSound support.
diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt
index 4cc769f..d7b9a29 100644
--- a/doc/doxygen/compiling.txt
+++ b/doc/doxygen/compiling.txt
@@ -2,7 +2,7 @@
\section debug Debugging
-If you are having problems getting RtAudio to run on your system, make sure to pass a value of \e true to the RtAudio::showWarnings() function (this is the default setting). A variety of warning messages will be displayed which may help in determining the problem. Also, try using the programs included in the <tt>tests</tt> directory. The program <tt>probe</tt> displays the queried capabilities of all hardware devices found for all APIs compiled. When using the ALSA API, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.
+If you are having problems getting RtAudio to run on your system, make sure to pass a value of \e true to the RtAudio::showWarnings() function (this is the default setting). A variety of warning messages will be displayed which may help in determining the problem. Also, try using the programs included in the <tt>tests</tt> directory. The program <tt>audioprobe</tt> displays the queried capabilities of all hardware devices found for all APIs compiled. When using the ALSA API, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.
\section compile Compiling
@@ -24,7 +24,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
<TD>RtApiAlsa</TD>
<TD>__LINUX_ALSA__</TD>
<TD><TT>asound, pthread</TT></TD>
- <TD><TT>g++ -Wall -D__LINUX_ALSA__ -o probe probe.cpp RtAudio.cpp -lasound -lpthread</TT></TD>
+ <TD><TT>g++ -Wall -D__LINUX_ALSA__ -o audioprobe audioprobe.cpp RtAudio.cpp -lasound -lpthread</TT></TD>
</TR>
<TR>
<TD>Linux</TD>
@@ -32,7 +32,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
<TD>RtApiOss</TD>
<TD>__LINUX_OSS__</TD>
<TD><TT>pthread</TT></TD>
- <TD><TT>g++ -Wall -D__LINUX_OSS__ -o probe probe.cpp RtAudio.cpp -lpthread</TT></TD>
+ <TD><TT>g++ -Wall -D__LINUX_OSS__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread</TT></TD>
</TR>
<TR>
<TD>Linux or Macintosh OS-X</TD>
@@ -40,7 +40,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
<TD>RtApiJack</TD>
<TD>__UNIX_JACK__</TD>
<TD><TT>jack, pthread</TT></TD>
- <TD><TT>g++ -Wall -D__UNIX_JACK__ -o probe probe.cpp RtAudio.cpp `pkg-config --cflags --libs jack` -lpthread</TT></TD>
+ <TD><TT>g++ -Wall -D__UNIX_JACK__ -o audioprobe audioprobe.cpp RtAudio.cpp `pkg-config --cflags --libs jack` -lpthread</TT></TD>
</TR>
<TR>
@@ -49,7 +49,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
<TD>RtApiCore</TD>
<TD>__MACOSX_CORE__</TD>
<TD><TT>pthread, CoreAudio</TT></TD>
- <TD><TT>g++ -Wall -D__MACOSX_CORE__ -o probe probe.cpp RtAudio.cpp -framework CoreAudio -lpthread</TT></TD>
+ <TD><TT>g++ -Wall -D__MACOSX_CORE__ -o audioprobe audioprobe.cpp RtAudio.cpp -framework CoreAudio -lpthread</TT></TD>
</TR>
<TR>
<TD>Windows</TD>
@@ -70,7 +70,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
</TABLE>
<P>
-The example compiler statements above could be used to compile the <TT>probe.cpp</TT> example file, assuming that <TT>probe.cpp</TT>, <TT>RtAudio.h</TT>, <tt>RtError.h</tt>, and <TT>RtAudio.cpp</TT> all exist in the same directory.
+The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT>, <tt>RtError.h</tt>, and <TT>RtAudio.cpp</TT> all exist in the same directory.
*/
diff --git a/doc/doxygen/probe.txt b/doc/doxygen/probe.txt
index 761ae34..9fce97b 100644
--- a/doc/doxygen/probe.txt
+++ b/doc/doxygen/probe.txt
@@ -4,7 +4,7 @@ A programmer may wish to query the available audio device capabilities before de
\code
-// probe.cpp
+// audioprobe.cpp
#include <iostream>
#include "RtAudio.h"
diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt
index 76b28b0..89bb948 100644
--- a/doc/doxygen/tutorial.txt
+++ b/doc/doxygen/tutorial.txt
@@ -17,7 +17,7 @@ RtAudio incorporates the concept of audio streams, which represent audio output
\section whatsnew What's New (Version 4.0)
-RtAudio V4 represents a significant rewrite of the code and includes a number of API and functionality changes form previous versions. A partial list of the changes includes:
+RtAudio V4 represents a significant rewrite of the code and includes a number of API and functionality changes from previous versions. A partial list of the changes includes:
- new support for non-interleaved user data
- additional input/output parameter specifications, including channel offset
- new support for dynamic connection of devices
@@ -28,11 +28,11 @@ RtAudio V4 represents a significant rewrite of the code and includes a number of
- discontinued support of blocking functionality
- discontinued support of SGI
-Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio::getDeviceInfo(), and RtAudio::openStream() functions are called. This allows for the proper identification of hot-pluggable (USB, Firewire, ...) devices while a given RtAudio instance exists.
+Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio::getDeviceInfo(), and RtAudio::openStream() functions are called. This allows for the proper identification of hot-pluggable (USB, Firewire, ...) devices that are connected after an RtAudio instance is created.
\section download Download
-Latest Release (21 August 2007): <A href="http://music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.2.tar.gz">Version 4.0.2</A>
+Latest Release (7 December 2007): <A href="http://music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.3.tar.gz">Version 4.0.3</A>
\section documentation Documentation Links
diff --git a/doc/release.txt b/doc/release.txt
index 4ce42af..1fa678d 100644
--- a/doc/release.txt
+++ b/doc/release.txt
@@ -2,6 +2,12 @@ RtAudio - a set of C++ classes that provide a common API for realtime audio inpu
By Gary P. Scavone, 2001-2007.
+v4.0.3: (7 December 2007)
+- added support for MinGW compiler to configure script
+- a few MinGW-related changes to RtAudio.cpp
+- renamed test program probe.cpp to audioprobe.cpp
+- moved various header files into single "include" directory and updated VC++ project files
+
v4.0.2: (21 August 2007)
- fix to RtError::WARNING typo in RtAudio.h (RtApiDummy)
- removed "+1"s in RtApiCore c++ append when getting device name