Finalize AL_SOFT_events
[openal-soft.git] / ChangeLog
blobdc8f4a7c973ad7fcd9da9396e9996a05a61b5593
1 openal-soft-1.21.0:
3     Updated library codebase to C++14.
5     Implemented the AL_SOFT_effect_target extension.
7     Implemented the ALC_SOFT_loopback_bformat extension.
9     Improved memory use for mixing voices.
11     Improved detection of NEON capabilities.
13     Improved handling of PulseAudio devices that lack manual start control.
15     Improved mixing performance with PulseAudio.
17     Improved high-frequency scaling quality for the HRTF B-Format decoder.
19     Improved makemhr's HRIR delay calculation.
21     Improved WASAPI capture of mono formats with multichannel input.
23     Reimplemented the modulation stage for reverb.
25     Enabled real-time mixing priority by default, for backends that use the
26     setting. It can still be disabled in the config file.
28     Enabled dual-band processing for the built-in quad and 7.1 output decoders.
30     Fixed building with the static runtime on MSVC.
32     Fixed using source stereo angles outside of -pi...+pi.
34     Fixed the buffer processed event count for sources that start with empty
35     buffers.
37     Fixed trying to open an unopenable WASAPI device causing all devices to
38     stop working.
40     Fixed stale devices when re-enumerating WASAPI devices.
42     Fixed using unicode paths with the log file on Windows.
44     Fixed DirectSound capture reporting the bad sample counts or erroring when
45     reading samples.
47     Added an in-progress extension for a callback-driven buffer type.
49     Added an in-progress extension for higher-order B-Format buffers.
51     Added an in-progress extension for convolution reverb.
53     Added an experimental Oboe backend for Android playback. This requires the
54     Oboe sources at build time, so that it's built as a static library included
55     in libopenal.
57     Added an option for auto-connecting JACK ports.
59     Added greater-than-stereo support to the SoundIO backend.
61     Modified the mixer to be fully asynchronous with the external API, and
62     should now be real-time safe. Although alcRenderSamplesSOFT is not due to
63     locking to check the device handle validity.
65     Modified the UHJ encoder to use an all-pass FIR filter that's less harmful
66     to non-filtered signal phase.
68     Converted examples from SDL_sound to libsndfile. To avoid issues when
69     combining SDL2 and SDL_sound.
71     Worked around a 32-bit GCC/MinGW bug with TLS destructors. See:
72     https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83562
74     Reduced the maximum number of source sends from 16 to 6.
76     Removed the QSA backend. It's been broken for who knows how long.
78     Got rid of the compile-time native-tools targets, using cmake and global
79     initialization instead. This should make cross-compiling less troublesome.
81 openal-soft-1.20.1:
83     Implemented the AL_SOFT_direct_channels_remix extension. This extends
84     AL_DIRECT_CHANNELS_SOFT to optionally remix input channels that don't have
85     a matching output channel.
87     Implemented the AL_SOFT_bformat_ex extension. This extends B-Format buffer
88     support for N3D or SN3D scaling, or ACN channel ordering.
90     Fixed a potential voice leak when a source is started and stopped or
91     restarted in quick succession.
93     Fixed a potential device reset failure with JACK.
95     Improved handling of unsupported channel configurations with WASAPI. Such
96     setups will now try to output at least a stereo mix.
98     Improved clarity a bit for the HRTF second-order ambisonic decoder.
100     Improved detection of compatible layouts for SOFA files in makemhr and
101     sofa-info.
103     Added the ability to resample HRTFs on load. MHR files no longer need to
104     match the device sample rate to be usable.
106     Added an option to limit the HRTF's filter length.
108 openal-soft-1.20.0:
110     Converted the library codebase to C++11. A lot of hacks and custom
111     structures have been replaced with standard or cleaner implementations.
113     Partially implemented the Vocal Morpher effect.
115     Fixed the bsinc SSE resamplers on non-GCC compilers.
117     Fixed OpenSL capture.
119     Fixed support for extended capture formats with OpenSL.
121     Fixed handling of WASAPI not reporting a default device.
123     Fixed performance problems relating to semaphores on macOS.
125     Modified the bsinc12 resampler's transition band to better avoid aliasing
126     noise.
128     Modified alcResetDeviceSOFT to attempt recovery of disconnected devices.
130     Modified the virtual speaker layout for HRTF B-Format decoding.
132     Modified the PulseAudio backend to use a custom processing loop.
134     Renamed the makehrtf utility to makemhr.
136     Improved the efficiency of the bsinc resamplers when up-sampling.
138     Improved the quality of the bsinc resamplers slightly.
140     Improved the efficiency of the HRTF filters.
142     Improved the HRTF B-Format decoder coefficient generation.
144     Improved reverb feedback fading to be more consistent with pan fading.
146     Improved handling of sources that end prematurely, avoiding loud clicks.
148     Improved the performance of some reverb processing loops.
150     Added fast_bsinc12 and 24 resamplers that improve efficiency at the cost of
151     some quality. Notably, down-sampling has less smooth pitch ramping.
153     Added support for SOFA input files with makemhr.
155     Added a build option to use pre-built native tools. For cross-compiling,
156     use with caution and ensure the native tools' binaries are kept up-to-date.
158     Added an adjust-latency config option for the PulseAudio backend.
160     Added basic support for multi-field HRTFs.
162     Added an option for mixing first- or second-order B-Format with HRTF
163     output. This can improve HRTF performance given a number of sources.
165     Added an RC file for proper DLL version information.
167     Disabled some old KDE workarounds by default. Specifically, PulseAudio
168     streams can now be moved (KDE may try to move them after opening).
170 openal-soft-1.19.1:
172     Implemented capture support for the SoundIO backend.
174     Fixed source buffer queues potentially not playing properly when a queue
175     entry completes.
177     Fixed possible unexpected failures when generating auxiliary effect slots.
179     Fixed a crash with certain reverb or device settings.
181     Fixed OpenSL capture.
183     Improved output limiter response, better ensuring the sample amplitude is
184     clamped for output.
186 openal-soft-1.19.0:
188     Implemented the ALC_SOFT_device_clock extension.
190     Implemented the Pitch Shifter, Frequency Shifter, and Autowah effects.
192     Fixed compiling on FreeBSD systems that use freebsd-lib 9.1.
194     Fixed compiling on NetBSD.
196     Fixed the reverb effect's density scale and panning parameters.
198     Fixed use of the WASAPI backend with certain games, which caused odd COM
199     initialization errors.
201     Increased the number of virtual channels for decoding Ambisonics to HRTF
202     output.
204     Changed 32-bit x86 builds to use SSE2 math by default for performance.
205     Build-time options are available to use just SSE1 or x87 instead.
207     Replaced the 4-point Sinc resampler with a more efficient cubic resampler.
209     Renamed the MMDevAPI backend to WASAPI.
211     Added support for 24-bit, dual-ear HRTF data sets. The built-in data set
212     has been updated to 24-bit.
214     Added a 24- to 48-point band-limited Sinc resampler.
216     Added an SDL2 playback backend. Disabled by default to avoid a dependency
217     on SDL2.
219     Improved the performance and quality of the Chorus and Flanger effects.
221     Improved the efficiency of the band-limited Sinc resampler.
223     Improved the Sinc resampler's transition band to avoid over-attenuating
224     higher frequencies.
226     Improved the performance of some filter operations.
228     Improved the efficiency of object ID lookups.
230     Improved the efficienty of internal voice/source synchronization.
232     Improved AL call error logging with contextualized messages.
234     Removed the reverb effect's modulation stage. Due to the lack of reference
235     for its intended behavior and strength.
237 openal-soft-1.18.2:
239     Fixed resetting the FPU rounding mode after certain function calls on
240     Windows.
242     Fixed use of SSE intrinsics when building with Clang on Windows.
244     Fixed a crash with the JACK backend when using JACK1.
246     Fixed use of pthread_setnane_np on NetBSD.
248     Fixed building on FreeBSD with an older freebsd-lib.
250     OSS now links with libossaudio if found at build time (for NetBSD).
252 openal-soft-1.18.1:
254     Fixed an issue where resuming a source might not restart playing it.
256     Fixed PulseAudio playback when the configured stream length is much less
257     than the requested length.
259     Fixed MMDevAPI capture with sample rates not matching the backing device.
261     Fixed int32 output for the Wave Writer.
263     Fixed enumeration of OSS devices that are missing device files.
265     Added correct retrieval of the executable's path on FreeBSD.
267     Added a config option to specify the dithering depth.
269     Added a 5.1 decoder preset that excludes front-center output.
271 openal-soft-1.18.0:
273     Implemented the AL_EXT_STEREO_ANGLES and AL_EXT_SOURCE_RADIUS extensions.
275     Implemented the AL_SOFT_gain_clamp_ex, AL_SOFT_source_resampler,
276     AL_SOFT_source_spatialize, and ALC_SOFT_output_limiter extensions.
278     Implemented 3D processing for some effects. Currently implemented for
279     Reverb, Compressor, Equalizer, and Ring Modulator.
281     Implemented 2-channel UHJ output encoding. This needs to be enabled with a
282     config option to be used.
284     Implemented dual-band processing for high-quality ambisonic decoding.
286     Implemented distance-compensation for surround sound output.
288     Implemented near-field emulation and compensation with ambisonic rendering.
289     Currently only applies when using the high-quality ambisonic decoder or
290     ambisonic output, with appropriate config options.
292     Implemented an output limiter to reduce the amount of distortion from
293     clipping.
295     Implemented dithering for 8-bit and 16-bit output.
297     Implemented a config option to select a preferred HRTF.
299     Implemented a run-time check for NEON extensions using /proc/cpuinfo.
301     Implemented experimental capture support for the OpenSL backend.
303     Fixed building on compilers with NEON support but don't default to having
304     NEON enabled.
306     Fixed support for JACK on Windows.
308     Fixed starting a source while alcSuspendContext is in effect.
310     Fixed detection of headsets as headphones, with MMDevAPI.
312     Added support for AmbDec config files, for custom ambisonic decoder
313     configurations. Version 3 files only.
315     Added backend-specific options to alsoft-config.
317     Added first-, second-, and third-order ambisonic output formats. Currently
318     only works with backends that don't rely on channel labels, like JACK,
319     ALSA, and OSS.
321     Added a build option to embed the default HRTFs into the lib.
323     Added AmbDec presets to enable high-quality ambisonic decoding.
325     Added an AmbDec preset for 3D7.1 speaker setups.
327     Added documentation regarding Ambisonics, 3D7.1, AmbDec config files, and
328     the provided ambdec presets.
330     Added the ability for MMDevAPI to open devices given a Device ID or GUID
331     string.
333     Added an option to the example apps to open a specific device.
335     Increased the maximum auxiliary send limit to 16 (up from 4). Requires
336     requesting them with the ALC_MAX_AUXILIARY_SENDS context creation
337     attribute.
339     Increased the default auxiliary effect slot count to 64 (up from 4).
341     Reduced the default period count to 3 (down from 4).
343     Slightly improved automatic naming for enumerated HRTFs.
345     Improved B-Format decoding with HRTF output.
347     Improved internal property handling for better batching behavior.
349     Improved performance of certain filter uses.
351     Removed support for the AL_SOFT_buffer_samples and AL_SOFT_buffer_sub_data
352     extensions. Due to conflicts with AL_EXT_SOURCE_RADIUS.
354 openal-soft-1.17.2:
356     Implemented device enumeration for OSSv4.
358     Fixed building on OSX.
360     Fixed building on non-Windows systems without POSIX-2008.
362     Fixed Dedicated Dialog and Dedicated LFE effect output.
364     Added a build option to override the share install dir.
366     Added a build option to static-link libgcc for MinGW.
368 openal-soft-1.17.1:
370     Fixed building with JACK and without PulseAudio.
372     Fixed building on FreeBSD.
374     Fixed the ALSA backend's allow-resampler option.
376     Fixed handling of inexact ALSA period counts.
378     Altered device naming scheme on Windows backends to better match other
379     drivers.
381     Updated the CoreAudio backend to use the AudioComponent API. This clears up
382     deprecation warnings for OSX 10.11, although requires OSX 10.6 or newer.
384 openal-soft-1.17.0:
386     Implemented a JACK playback backend.
388     Implemented the AL_EXT_BFORMAT and AL_EXT_MULAW_BFORMAT extensions.
390     Implemented the ALC_SOFT_HRTF extension.
392     Implemented C, SSE3, and SSE4.1 based 4- and 8-point Sinc resamplers.
394     Implemented a C and SSE based band-limited Sinc resampler. This does 12- to
395     24-point Sinc resampling, and performs anti-aliasing.
397     Implemented B-Format output support for the wave file writer. This creates
398     FuMa-style first-order Ambisonics wave files (AMB format).
400     Implemented a stereo-mode config option for treating stereo modes as either
401     speakers or headphones.
403     Implemented per-device configuration options.
405     Fixed handling of PulseAudio and MMDevAPI devices that have identical
406     descriptions.
408     Fixed a potential lockup when stopping playback of suspended PulseAudio devices.
410     Fixed logging of Unicode characters on Windows.
412     Fixed 5.1 surround sound channels. By default it will now use the side
413     channels for the surround output. A configuration using rear channels is
414     still available.
416     Fixed the QSA backend potentially altering the capture format.
418     Fixed detecting MMDevAPI's default device.
420     Fixed returning the default capture device name.
422     Fixed mixing property calculations when deferring context updates.
424     Altered the behavior of alcSuspendContext and alcProcessContext to better
425     match certain Windows drivers.
427     Altered the panning algorithm, utilizing Ambisonics for better side and
428     back positioning cues with surround sound output.
430     Improved support for certain older Windows apps.
432     Improved the alffplay example to support surround sound streams.
434     Improved support for building as a sub-project.
436     Added an HRTF playback example.
438     Added a tone generator output test.
440     Added a toolchain to help with cross-compiling to Android.
442 openal-soft-1.16.0:
444     Implemented EFX Chorus, Flanger, Distortion, Equalizer, and Compressor
445     effects.
447     Implemented high-pass and band-pass EFX filters.
449     Implemented the high-pass filter for the EAXReverb effect.
451     Implemented SSE2 and SSE4.1 linear resamplers.
453     Implemented Neon-enhanced non-HRTF mixers.
455     Implemented a QSA backend, for QNX.
457     Implemented the ALC_SOFT_pause_device, AL_SOFT_deferred_updates,
458     AL_SOFT_block_alignment, AL_SOFT_MSADPCM, and AL_SOFT_source_length
459     extensions.
461     Fixed resetting mmdevapi backend devices.
463     Fixed clamping when converting 32-bit float samples to integer.
465     Fixed modulation range in the Modulator effect.
467     Several fixes for the OpenSL playback backend.
469     Fixed device specifier names that have Unicode characters on Windows.
471     Added support for filenames and paths with Unicode (UTF-8) characters on
472     Windows.
474     Added support for alsoft.conf config files found in XDG Base Directory
475     Specification locations (XDG_CONFIG_DIRS and XDG_CONFIG_HOME, or their
476     defaults) on non-Windows systems.
478     Added a GUI configuration utility (requires Qt 4.8).
480     Added support for environment variable expansion in config options (not
481     keys or section names).
483     Added an example that uses SDL2 and ffmpeg.
485     Modified examples to use SDL_sound.
487     Modified CMake config option names for better sorting.
489     HRTF data sets specified in the hrtf_tables config option may now be
490     relative or absolute filenames.
492     Made the default HRTF data set an external file, and added a data set for
493     48khz playback in addition to 44.1khz.
495     Added support for C11 atomic methods.
497     Improved support for some non-GNU build systems.
499 openal-soft-1.15.1:
501     Fixed a regression with retrieving the source's AL_GAIN property.
503 openal-soft-1.15:
505     Fixed device enumeration with the OSS backend.
507     Reorganized internal mixing logic, so unneeded steps can potentially be
508     skipped for better performance.
510     Removed the lookup table for calculating the mixing pans. The panning is
511     now calculated directly for better precision.
513     Improved the panning of stereo source channels when using stereo output.
515     Improved source filter quality on send paths.
517     Added a config option to allow PulseAudio to move streams between devices.
519     The PulseAudio backend will now attempt to spawn a server by default.
521     Added a workaround for a DirectSound bug relating to float32 output.
523     Added SSE-based mixers, for HRTF and non-HRTF mixing.
525     Added support for the new AL_SOFT_source_latency extension.
527     Improved ALSA capture by avoiding an extra buffer when using sizes
528     supported by the underlying device.
530     Improved the makehrtf utility to support new options and input formats.
532     Modified the CFLAGS declared in the pkg-config file so the "AL/" portion of
533     the header includes can optionally be omitted.
535     Added a couple example code programs to show how to apply reverb, and
536     retrieve latency.
538     The configuration sample is now installed into the share/openal/ directory
539     instead of /etc/openal.
541     The configuration sample now gets installed by default.