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