diff options
| author | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 02:04:50 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 02:04:50 +0200 |
| commit | 2fbd57f91e68a10891087c9093ebf71ee4a0bc0d (patch) | |
| tree | 7273d3748e4fd76fcc6eb6ce23af3325d9c8dcb9 /doc | |
| parent | 89fa26771ee945ee233940fb09d8b41663249521 (diff) | |
| parent | 5d8514d7eb3918a947ec97b45f4105630c64468d (diff) | |
Merge 4.0.11 into releases
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/doxygen/acknowledge.txt | 9 | ||||
| -rw-r--r-- | doc/doxygen/apinotes.txt | 4 | ||||
| -rw-r--r-- | doc/doxygen/compiling.txt | 8 | ||||
| -rw-r--r-- | doc/doxygen/footer.html | 2 | ||||
| -rw-r--r-- | doc/doxygen/license.txt | 2 | ||||
| -rw-r--r-- | doc/doxygen/tutorial.txt | 4 | ||||
| -rw-r--r-- | doc/release.txt | 10 |
8 files changed, 31 insertions, 10 deletions
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index f3c509e..2c13b09 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -31,7 +31,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.10 +PROJECT_NUMBER = 4.0.11 # 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/acknowledge.txt b/doc/doxygen/acknowledge.txt index 81b17a8..8ea92e9 100644 --- a/doc/doxygen/acknowledge.txt +++ b/doc/doxygen/acknowledge.txt @@ -2,11 +2,20 @@ Many thanks to the following people for providing bug fixes and improvements: <UL> +<LI>Stefan Arisona</LI> +<LI>Vincent Bénony</LI> +<LI>Rasmus Ekman</LI> <LI>Anders Ervik</LI> <LI>Robin Davies (Windows DS and ASIO)</LI> +<LI>Martin Koegler</LI> +<LI>Dmitry Kostjuchenko</LI> +<LI>Oliver Larkin</LI> <LI>Antoine Lefebvre</LI> +<LI>Carlos Luna</LI> <LI>Dominic Mazzoni</LI> <LI>Tristan Matthews</LI> +<LI>Peter Meerwald (PulseAudio)</LI> +<LI>Benjamin Schroeder</LI> <LI>Ryan Williams (Windows non-MS compiler ASIO support)</LI> <LI>Ed Wildgoose (Linux ALSA and Jack)</LI> diff --git a/doc/doxygen/apinotes.txt b/doc/doxygen/apinotes.txt index 1d369b6..fc80714 100644 --- a/doc/doxygen/apinotes.txt +++ b/doc/doxygen/apinotes.txt @@ -4,14 +4,12 @@ RtAudio is designed to provide a common API across the various supported operati \section linux Linux: -RtAudio for Linux was developed under Redhat distributions 7.0 - Fedora. Three different audio APIs are supported on Linux platforms: <A href="http://www.opensound.com/oss.html">OSS</A> (versions >= 4.0), <A href="http://www.alsa-project.org/">ALSA</A>, and <A href="http://jackit.sourceforge.net/">Jack</A>. Note that RtAudio now only supports the newer version 4.0 OSS API. The ALSA API is now part of the Linux kernel and offers significantly better functionality than the OSS API. RtAudio provides support for the 1.0 and higher versions of ALSA. Jack is a low-latency audio server written primarily for the GNU/Linux operating system. It can connect a number of different applications to an audio device, as well as allow them to share audio between themselves. Input/output latency on the order of 15 milliseconds can typically be achieved using any of the Linux APIs by fine-tuning the RtAudio buffer parameters (without kernel modifications). Latencies on the order of 5 milliseconds or less can be achieved using a low-latency kernel patch and increasing FIFO scheduling priority. The pthread library, which is used for callback functionality, is a standard component of all Linux distributions. +RtAudio for Linux was developed under Redhat distributions 7.0 - Fedora. Four different audio APIs are supported on Linux platforms: <A href="http://www.opensound.com/oss.html">OSS</A> (versions >= 4.0), <A href="http://www.alsa-project.org/">ALSA</A>, <A href="http://jackit.sourceforge.net/">Jack</A>, and <A href="http://www.freedesktop.org/wiki/Software/PulseAudio">PulseAudio</A>. Note that RtAudio now only supports the newer version 4.0 OSS API. The ALSA API is now part of the Linux kernel and offers significantly better functionality than the OSS API. RtAudio provides support for the 1.0 and higher versions of ALSA. Jack is a low-latency audio server written primarily for the GNU/Linux operating system. It can connect a number of different applications to an audio device, as well as allow them to share audio between themselves. Input/output latency on the order of 15 milliseconds can typically be achieved using any of the Linux APIs by fine-tuning the RtAudio buffer parameters (without kernel modifications). Latencies on the order of 5 milliseconds or less can be achieved using a low-latency kernel patch and increasing FIFO scheduling priority. The pthread library, which is used for callback functionality, is a standard component of all Linux distributions. The ALSA library includes OSS emulation support. That means that you can run programs compiled for the OSS API even when using the ALSA drivers and library. It should be noted however that OSS emulation under ALSA is not perfect. Specifically, channel number queries seem to consistently produce invalid results. While OSS emulation is successful for the majority of RtAudio tests, it is recommended that the native ALSA implementation of RtAudio be used on systems which have ALSA drivers installed. The ALSA implementation of RtAudio makes no use of the ALSA "plug" interface. All necessary data format conversions, channel compensation, de-interleaving, and byte-swapping is handled by internal RtAudio routines. -At the moment, only one RtAudio instance can be connected to the Jack server. - \section macosx Macintosh OS-X (CoreAudio and Jack): The Apple CoreAudio API is designed to use a separate callback procedure for each of its audio devices. A single RtAudio duplex stream using two different devices is supported, though it cannot be guaranteed to always behave correctly because we cannot synchronize these two callbacks. The <I>numberOfBuffers</I> parameter to the RtAudio::openStream() function has no affect in this implementation. diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt index 79cb314..d9884d0 100644 --- a/doc/doxygen/compiling.txt +++ b/doc/doxygen/compiling.txt @@ -28,6 +28,14 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to </TR> <TR> <TD>Linux</TD> + <TD>PulseAudio</TD> + <TD>RtApiPulse</TD> + <TD>__LINUX_PULSE__</TD> + <TD><TT>pthread</TT></TD> + <TD><TT>g++ -Wall -D__LINUX_PULSE__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread</TT></TD> +</TR> +<TR> + <TD>Linux</TD> <TD>OSS</TD> <TD>RtApiOss</TD> <TD>__LINUX_OSS__</TD> diff --git a/doc/doxygen/footer.html b/doc/doxygen/footer.html index 114cdb0..18df8f2 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>©2001-2010 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> + <td>©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> </table> </BODY> diff --git a/doc/doxygen/license.txt b/doc/doxygen/license.txt index eda2be5..c595b4f 100644 --- a/doc/doxygen/license.txt +++ b/doc/doxygen/license.txt @@ -1,7 +1,7 @@ /*! \page license License RtAudio: a set of realtime audio i/o C++ classes<BR> - Copyright (c) 2001-2011 Gary P. Scavone + Copyright (c) 2001-2012 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/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt index 39cb76a..19ed170 100644 --- a/doc/doxygen/tutorial.txt +++ b/doc/doxygen/tutorial.txt @@ -1,6 +1,6 @@ /*! \mainpage The RtAudio Home Page -RtAudio is a set of C++ classes that provide a common API (Application Programming Interface) for realtime audio input/output across Linux, Macintosh OS-X and Windows (DirectSound and ASIO) operating systems. RtAudio significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives: +RtAudio is a set of C++ classes that provide a common API (Application Programming Interface) for realtime audio input/output across Linux, Macintosh OS-X and Windows operating systems. RtAudio significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives: <UL> <LI>object-oriented C++ design</LI> @@ -32,7 +32,7 @@ Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio: \section download Download -Latest Release (30 August 2011): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.10.tar.gz">Version 4.0.10</A> +Latest Release (14 June 2012): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.11.tar.gz">Version 4.0.11</A> \section documentation Documentation Links diff --git a/doc/release.txt b/doc/release.txt index a3dab35..a29a36c 100644 --- a/doc/release.txt +++ b/doc/release.txt @@ -1,6 +1,12 @@ -RtAudio - a set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound and ASIO) operating systems. +RtAudio - a set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound and ASIO) operating systems. -By Gary P. Scavone, 2001-2011. +By Gary P. Scavone, 2001-2012. + +v4.0.11: (14 June 2012) +- fixes for memory leaks in ALSA (thanks to Martin Koegler) +- PulseAudio API support added (thanks to Peter Meerwald and Tristan Matthews) +- bitwise format flag fixes in OS-X (Benjamin Schroeder and Stefan Arisona) +- changes to stopStream / drain flag to avoid hung state in ASIO, DS, OS-X, and Jack APIs (Rasmus Ekman and Carlos Luna) v4.0.10: (30 August 2011) - fix for compile bug in Windows DS (counting devices) |
