Bug fix for DS enumeration when devices are unplugged; bug fix if an error occurs...
[rtaudio-cdist.git] / doc / release.txt
1 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.
2
3 By Gary P. Scavone, 2001-2014.
4
5 v4.1.0: (?? April 2014)
6 - RtError class renamed RtAudioError and embedded in RtAudio.h (RtError.h deleted)
7 - new support for the Windows WASAPI API (thanks to Marcus Tomlinson)
8 - pulse audio update to support bufferFrames argument with audio input (thanks to Jonatan Wallmander)
9 - fixes for ALSA API to avoid high CPU usage during stops and to clear stale data before input (thanks to Pluto Hades)
10 - miscellaneous efficiency updates suggested by Martin Koegler
11 - bug fix for OS-X xrun reporting problem
12 - bug fix related to error when opening a stream after closing a previously open stream
13
14 v4.0.12: (16 April 2013)
15 - new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)
16 - new function to return the version number
17 - updated RtAudio.cpp and ASIO files for UNICODE support (thanks to Renaud Schoonbroodt)
18 - updates to PulseAudio API support (thanks to Peter Meerwald and Tristan Matthews)
19 - updates for pkg-config support in configure script
20 - 24-bit format changed to true 24-bit format, not sub-bytes of 32-bits (thanks to Marc Britton)
21 - bug fixes to make sure stream status is closed if error during probeDeviceOpen
22 - updates / fixes to SCHED_RR code in ALSA (thanks to Marc Lindahl)
23 - various changes to avoid global variables (thanks to Martin Koegler)
24
25 v4.0.11: (14 June 2012)
26 - fixes for memory leaks in ALSA (thanks to Martin Koegler)
27 - PulseAudio API support added (thanks to Peter Meerwald and Tristan Matthews)
28 - bitwise format flag fixes in OS-X (Benjamin Schroeder and Stefan Arisona)
29 - changes to stopStream / drain flag to avoid hung state in ASIO, DS, OS-X, and Jack APIs (Rasmus Ekman and Carlos Luna)
30
31 v4.0.10: (30 August 2011)
32 - fix for compile bug in Windows DS (counting devices)
33 - update to configure and library Makefile
34
35 v4.0.9: (14 August 2011)
36 - fix for ASIO problem enumerating devices after opening duplex stream (Oliver Larkin)
37 - fix for OS-X problems setting sample rate and bits-per-sample
38 - updates for OS-X "Lion"
39 - updates for wide character support in Windows DS (UNICODE)
40 - fix for possible ALSA callback thread hang (thanks to Tristan Matthews)
41 - fix for DS getDeviceCount bug (vector erase problem)
42
43 v4.0.8: (12 April 2011)
44 - fix for MinGW4 problem enumerating and setting sample rates (iasiothiscallresolver, Dmitry Kostjuchenko)
45 - fix for OS-X problem handling device names in some languages (CFString conversion, Vincent BĂ©nony)
46 - small change to OS-X mutex lock location to avoid lockups
47 - correction to documentation regarding 24-bit data (should be lower 3 bytes, not upper 3 bytes)
48 - bug fix for error handling of warnings (Antoine Lefebvre)
49 - added option to use the ALSA "default" device (Tristan Matthews)
50 - removed use of mutexes in Windows
51 - fix for ASIO4ALL behavior when stopping/closing streams (Antoine Lefebvre)
52 - included python binding in "contrib" directory (beta, Antoine Lefebvre)
53
54 v4.0.7: (4 February 2010)
55 - revised Windows DS code and device enumeration to speed up device queries
56 - OS-X 10.6 updates for deprecated functions
57 - updates to Jack shutdown code to avoid lockup
58
59 v4.0.6: (3 June 2009)
60 - bug fix in ALSA code to set period size to power of two (thanks to Joakim Karrstrom)
61 - bug fix in OS-X for OS < 10.5 ... need preprocessor definition around new variable type (thanks to Tristan Matthews)
62
63 v4.0.5: (2 February 2009)
64 - added support in CoreAudio for arbitrary stream channel configurations
65 - added getStreamSampleRate() function because the actual sample rate can sometimes vary slightly from the specified one (thanks to Theo Veenker)
66 - added new StreamOptions flag "RTAUDIO_SCHEDULE_REALTIME" and attribute "priority" to StreamOptions (thanks to Theo Veenker)
67 - replaced usleep(50000) in callbackEvent() by a wait on condition variable which gets signaled in startStream() (thanks to Theo Veenker)
68 - fix for Jack API when user callback function signals stop or abort calls
69 - fix to way stream state is changed to avoid infinite loop problem
70 - fix to int<->float conversion in convertBuffer() (thanks to Theo Veenker)
71 - bug fix in byteSwapBuffer() (thanks to Stefan Muller Arisona and Theo Veenker)
72 - fixed a few gcc 4.4 errors in OS-X
73 - fixed bug in rtaudio-config script
74 - revised configure script and Makefile structures
75 - 64-bit fixes in ALSA API (thanks to Stefan Muller Arisona)
76 - fixed ASIO sample rate selection bug (thanks to Sasha Zheligovsky)
77
78 v4.0.4: (24 January 2008)
79 - added functionality to allow getDeviceInfo() to work in ALSA for an open device (like ASIO)
80 - fixes in configure script
81 - fixed clearing of error message stream in error()
82 - fixed RtAudio::DeviceInfo description in "probing" documentation
83 - memory leak fixes in ALSA and OSS
84 - Jack in/out port flag fix
85 - Windows changes for thread priority and GLOBALFOCUS
86
87 v4.0.3: (7 December 2007)
88 - added support for MinGW compiler to configure script
89 - a few MinGW-related changes to RtAudio.cpp
90 - renamed test program probe.cpp to audioprobe.cpp
91 - moved various header files into single "include" directory and updated VC++ project files
92
93 v4.0.2: (21 August 2007)
94 - fix to RtError::WARNING typo in RtAudio.h (RtApiDummy)
95 - removed "+1"s in RtApiCore c++ append when getting device name
96
97 v4.0.1: (13 August 2007)
98 - fix to RtError::WARNING typo in RtAudio.cpp
99
100 v4.0.0: (7 August 2007)
101 - new support for non-interleaved user data
102 - additional input/output parameter specifications, including channel offset
103 - new support for dynamic connection of devices
104 - new support for stream time
105 - revised callback arguments, including separate input and output buffer arguments
106 - revised C++ exception handling
107 - revised OSS support for version 4.0
108 - discontinued support of blocking functionality
109 - discontinued support of SGI
110 - Windows DirectSound API bug fix
111 - NetBSD support (using OSS API) by Emmanuel Dreyfus
112 - changed default pthread scheduling priority to SCHED_RR when defined in the system
113 - new getCompiledApi() static function
114 - new getCurrentApi(), getStreamTime(), getStreamLatency(), and isStreamRunning() functions
115 - modified RtAudioDeviceInfo structure to distinguish default input and output devices
116
117 v3.0.3: (18 November 2005)
118 - UNICODE fix for Windows DirectSound API
119 - MinGW compiler fix for ASIO API
120
121 v3.0.2: (14 October 2005)
122 - modification of ALSA read/write order to fix duplex under/overruns
123 - added synchronization of input/output devices for ALSA duplex operation
124 - cleaned up and improved error reporting throughout
125 - bug fix in Windows DirectSound support for 8-bit audio
126 - bug fix in Windows DirectSound support during device capture query
127 - added ASIOOutputReady() call near end of callbackEvent to fix some driver behavior
128 - added #include <stdio.h> to RtAudio.cpp
129 - fixed bug in RtApiCore for duplex operation with different I/O devices
130 - improvements to DirectX pointer chasing (by Robin Davies)
131 - backdoor RtDsStatistics hook provides DirectX performance information (by Robin Davies)
132 - bug fix for non-power-of-two Asio granularity used by Edirol PCR-A30 (by Robin Davies)
133 - auto-call CoInitialize for DSOUND and ASIO platforms (by Robin Davies)
134
135 v3.0.1: (22 March 2004)
136 - bug fix in Windows DirectSound support for cards with output only
137
138 v3.0: (11 March 2004)
139 - added Linux Jack audio server support
140 - new multi-api support by subclassing all apis and making rtaudio a controller class
141 - added over/underload check to Mac OS X support
142 - new scheme for blocking functionality in callback-based apis (CoreAudio, ASIO, and JACK)
143 - removed multiple stream support (all stream indentifier arguments removed)
144 - various style and name changes to conform with standard C++ practice
145
146 v2.1.1: (24 October 2002)
147 - bug fix in duplex for Mac OS X and Windows ASIO code
148 - duplex example change in tutorial 
149
150 v2.1: (7 October 2002)
151 - added Mac OS X CoreAudio support
152 - added Windows ASIO support
153 - API change to getDeviceInfo(): device argument must be an integer between 1 - getDeviceCount().
154 - "configure" support added for unix systems
155 - adopted MIT-like license
156 - various internal structural changes and bug fixes
157
158 v2.01: (27 April 2002)
159 - Windows destructor bug fix when no devices available
160 - RtAudioError class renamed to RtError
161 - Preprocessor definitions changed slightly (i.e. __LINUX_OSS_ to __LINUX_OSS__) to conform with new Synthesis ToolKit distribution
162
163 v2.0: (22 January 2002)
164 - first release of new independent class
165