Rename some struct members for clarity
[openal-soft.git] / ChangeLog
blobda6698f88ed03847941e5da388dab9ecd6c9866a
1 openal-soft-1.23.0:
3     Fixed CoreAudio capture support.
5     Fixed handling per-version EAX properties.
7     Fixed interpolating changes to the Super Stereo width source property.
9     Fixed detection of the update and buffer size from PipeWire.
11     Fixed resuming playback devices with OpenSL.
13     Fixed support for certain OpenAL implementations with the router.
15     Improved reverb environment transitions.
17     Improved performance of convolution reverb.
19     Improved quality and performance of the pitch shifter effect slightly.
21     Improved sub-sample precision for resampled sources.
23     Improved blending spatialized multi-channel sources that use the source
24     radius property.
26     Improved mixing 2D ambisonic sources for higher-order 3D ambisonic mixing.
28     Improved quadraphonic and 7.1 surround sound output slightly.
30     Added config options for UHJ encoding/decoding quality. Including Super
31     Stereo processing.
33     Added a config option for specifying the speaker distance.
35     Added a compatibility config option for specifying the NFC distance
36     scaling.
38     Added a config option for mixing on PipeWire's non-real-time thread.
40     Added support for virtual source nodes with PipeWire capture.
42     Added the ability for the WASAPI backend to use different playback rates.
44     Added support for SOFA files that define per-response delays in makemhr.
46     Changed the default fallback playback sample rate to 48khz. This doesn't
47     affect most backends, which can detect a default rate from the system.
49     Changed the default resampler to cubic.
51     Changed the default HRTF size from 32 to 64 points.
53 openal-soft-1.22.2:
55     Fixed PipeWire version check.
57     Fixed building with PipeWire versions before 0.3.33.
59 openal-soft-1.22.1:
61     Fixed CoreAudio capture.
63     Fixed air absorption strength.
65     Fixed handling 5.1 devices on Windows that use Rear channels instead of
66     Side channels.
68     Fixed some compilation issues on MinGW.
70     Fixed ALSA not being used on some systems without PipeWire and PulseAudio.
72     Fixed OpenSL capturing noise.
74     Fixed Oboe capture failing with some buffer sizes.
76     Added checks for the runtime PipeWire version. The same or newer version
77     than is used for building will be needed at runtime for the backend to
78     work.
80     Separated 3D7.1 into its own speaker configuration.
82 openal-soft-1.22.0:
84     Implemented the ALC_SOFT_reopen_device extension. This allows for moving
85     devices to different outputs without losing object state.
87     Implemented the ALC_SOFT_output_mode extension.
89     Implemented the AL_SOFT_callback_buffer extension.
91     Implemented the AL_SOFT_UHJ extension. This supports native UHJ buffer
92     formats and Super Stereo processing.
94     Implemented the legacy EAX extensions. Enabled by default only on Windows.
96     Improved sound positioning stability when a source is near the listener.
98     Improved the default 5.1 output decoder.
100     Improved the high frequency response for the HRTF second-order ambisonic
101     decoder.
103     Improved SoundIO capture behavior.
105     Fixed UHJ output on NEON-capable CPUs.
107     Fixed redundant effect updates when setting an effect property to the
108     current value.
110     Fixed WASAPI capture using really low sample rates, and sources with very
111     high pitch shifts when using a bsinc resampler.
113     Added a PipeWire backend.
115     Added enumeration for the JACK and CoreAudio backends.
117     Added optional support for RTKit to get real-time priority. Only used as a
118     backup when pthread_setschedparam fails.
120     Added an option for JACK playback to render directly in the real-time
121     processing callback. For lower playback latency, on by default.
123     Added an option for custom JACK devices.
125     Added utilities to encode and decode UHJ audio files. Files are decoded to
126     the .amb format, and are encoded from libsndfile-compatible formats.
128     Added an in-progress extension to hold sources in a playing state when a
129     device disconnects. Allows devices to be reset or reopened and have sources
130     resume from where they left off.
132     Lowered the priority of the JACK backend. To avoid it getting picked when
133     PipeWire is providing JACK compatibility, since the JACK backend is less
134     robust with auto-configuration.
136 openal-soft-1.21.1:
138     Improved alext.h's detection of standard types.
140     Improved slightly the local source position when the listener and source
141     are near each other.
143     Improved click/pop prevention for sounds that stop prematurely.
145     Fixed compilation for Windows ARM targets with MSVC.
147     Fixed ARM NEON detection on Windows.
149     Fixed CoreAudio capture when the requested sample rate doesn't match the
150     system configuration.
152     Fixed OpenSL capture desyncing from the internal capture buffer.
154     Fixed sources missing a batch update when applied after quickly restarting
155     the source.
157     Fixed missing source stop events when stopping a paused source.
159     Added capture support to the experimental Oboe backend.
161 openal-soft-1.21.0:
163     Updated library codebase to C++14.
165     Implemented the AL_SOFT_effect_target extension.
167     Implemented the AL_SOFT_events extension.
169     Implemented the ALC_SOFT_loopback_bformat extension.
171     Improved memory use for mixing voices.
173     Improved detection of NEON capabilities.
175     Improved handling of PulseAudio devices that lack manual start control.
177     Improved mixing performance with PulseAudio.
179     Improved high-frequency scaling quality for the HRTF B-Format decoder.
181     Improved makemhr's HRIR delay calculation.
183     Improved WASAPI capture of mono formats with multichannel input.
185     Reimplemented the modulation stage for reverb.
187     Enabled real-time mixing priority by default, for backends that use the
188     setting. It can still be disabled in the config file.
190     Enabled dual-band processing for the built-in quad and 7.1 output decoders.
192     Fixed a potential crash when deleting an effect slot immediately after the
193     last source using it stops.
195     Fixed building with the static runtime on MSVC.
197     Fixed using source stereo angles outside of -pi...+pi.
199     Fixed the buffer processed event count for sources that start with empty
200     buffers.
202     Fixed trying to open an unopenable WASAPI device causing all devices to
203     stop working.
205     Fixed stale devices when re-enumerating WASAPI devices.
207     Fixed using unicode paths with the log file on Windows.
209     Fixed DirectSound capture reporting bad sample counts or erroring when
210     reading samples.
212     Added an in-progress extension for a callback-driven buffer type.
214     Added an in-progress extension for higher-order B-Format buffers.
216     Added an in-progress extension for convolution reverb.
218     Added an experimental Oboe backend for Android playback. This requires the
219     Oboe sources at build time, so that it's built as a static library included
220     in libopenal.
222     Added an option for auto-connecting JACK ports.
224     Added greater-than-stereo support to the SoundIO backend.
226     Modified the mixer to be fully asynchronous with the external API, and
227     should now be real-time safe. Although alcRenderSamplesSOFT is not due to
228     locking to check the device handle validity.
230     Modified the UHJ encoder to use an all-pass FIR filter that's less harmful
231     to non-filtered signal phase.
233     Converted examples from SDL_sound to libsndfile. To avoid issues when
234     combining SDL2 and SDL_sound.
236     Worked around a 32-bit GCC/MinGW bug with TLS destructors. See:
237     https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83562
239     Reduced the maximum number of source sends from 16 to 6.
241     Removed the QSA backend. It's been broken for who knows how long.
243     Got rid of the compile-time native-tools targets, using cmake and global
244     initialization instead. This should make cross-compiling less troublesome.
246 openal-soft-1.20.1:
248     Implemented the AL_SOFT_direct_channels_remix extension. This extends
249     AL_DIRECT_CHANNELS_SOFT to optionally remix input channels that don't have
250     a matching output channel.
252     Implemented the AL_SOFT_bformat_ex extension. This extends B-Format buffer
253     support for N3D or SN3D scaling, or ACN channel ordering.
255     Fixed a potential voice leak when a source is started and stopped or
256     restarted in quick succession.
258     Fixed a potential device reset failure with JACK.
260     Improved handling of unsupported channel configurations with WASAPI. Such
261     setups will now try to output at least a stereo mix.
263     Improved clarity a bit for the HRTF second-order ambisonic decoder.
265     Improved detection of compatible layouts for SOFA files in makemhr and
266     sofa-info.
268     Added the ability to resample HRTFs on load. MHR files no longer need to
269     match the device sample rate to be usable.
271     Added an option to limit the HRTF's filter length.
273 openal-soft-1.20.0:
275     Converted the library codebase to C++11. A lot of hacks and custom
276     structures have been replaced with standard or cleaner implementations.
278     Partially implemented the Vocal Morpher effect.
280     Fixed the bsinc SSE resamplers on non-GCC compilers.
282     Fixed OpenSL capture.
284     Fixed support for extended capture formats with OpenSL.
286     Fixed handling of WASAPI not reporting a default device.
288     Fixed performance problems relating to semaphores on macOS.
290     Modified the bsinc12 resampler's transition band to better avoid aliasing
291     noise.
293     Modified alcResetDeviceSOFT to attempt recovery of disconnected devices.
295     Modified the virtual speaker layout for HRTF B-Format decoding.
297     Modified the PulseAudio backend to use a custom processing loop.
299     Renamed the makehrtf utility to makemhr.
301     Improved the efficiency of the bsinc resamplers when up-sampling.
303     Improved the quality of the bsinc resamplers slightly.
305     Improved the efficiency of the HRTF filters.
307     Improved the HRTF B-Format decoder coefficient generation.
309     Improved reverb feedback fading to be more consistent with pan fading.
311     Improved handling of sources that end prematurely, avoiding loud clicks.
313     Improved the performance of some reverb processing loops.
315     Added fast_bsinc12 and 24 resamplers that improve efficiency at the cost of
316     some quality. Notably, down-sampling has less smooth pitch ramping.
318     Added support for SOFA input files with makemhr.
320     Added a build option to use pre-built native tools. For cross-compiling,
321     use with caution and ensure the native tools' binaries are kept up-to-date.
323     Added an adjust-latency config option for the PulseAudio backend.
325     Added basic support for multi-field HRTFs.
327     Added an option for mixing first- or second-order B-Format with HRTF
328     output. This can improve HRTF performance given a number of sources.
330     Added an RC file for proper DLL version information.
332     Disabled some old KDE workarounds by default. Specifically, PulseAudio
333     streams can now be moved (KDE may try to move them after opening).
335 openal-soft-1.19.1:
337     Implemented capture support for the SoundIO backend.
339     Fixed source buffer queues potentially not playing properly when a queue
340     entry completes.
342     Fixed possible unexpected failures when generating auxiliary effect slots.
344     Fixed a crash with certain reverb or device settings.
346     Fixed OpenSL capture.
348     Improved output limiter response, better ensuring the sample amplitude is
349     clamped for output.
351 openal-soft-1.19.0:
353     Implemented the ALC_SOFT_device_clock extension.
355     Implemented the Pitch Shifter, Frequency Shifter, and Autowah effects.
357     Fixed compiling on FreeBSD systems that use freebsd-lib 9.1.
359     Fixed compiling on NetBSD.
361     Fixed the reverb effect's density scale and panning parameters.
363     Fixed use of the WASAPI backend with certain games, which caused odd COM
364     initialization errors.
366     Increased the number of virtual channels for decoding Ambisonics to HRTF
367     output.
369     Changed 32-bit x86 builds to use SSE2 math by default for performance.
370     Build-time options are available to use just SSE1 or x87 instead.
372     Replaced the 4-point Sinc resampler with a more efficient cubic resampler.
374     Renamed the MMDevAPI backend to WASAPI.
376     Added support for 24-bit, dual-ear HRTF data sets. The built-in data set
377     has been updated to 24-bit.
379     Added a 24- to 48-point band-limited Sinc resampler.
381     Added an SDL2 playback backend. Disabled by default to avoid a dependency
382     on SDL2.
384     Improved the performance and quality of the Chorus and Flanger effects.
386     Improved the efficiency of the band-limited Sinc resampler.
388     Improved the Sinc resampler's transition band to avoid over-attenuating
389     higher frequencies.
391     Improved the performance of some filter operations.
393     Improved the efficiency of object ID lookups.
395     Improved the efficienty of internal voice/source synchronization.
397     Improved AL call error logging with contextualized messages.
399     Removed the reverb effect's modulation stage. Due to the lack of reference
400     for its intended behavior and strength.
402 openal-soft-1.18.2:
404     Fixed resetting the FPU rounding mode after certain function calls on
405     Windows.
407     Fixed use of SSE intrinsics when building with Clang on Windows.
409     Fixed a crash with the JACK backend when using JACK1.
411     Fixed use of pthread_setnane_np on NetBSD.
413     Fixed building on FreeBSD with an older freebsd-lib.
415     OSS now links with libossaudio if found at build time (for NetBSD).
417 openal-soft-1.18.1:
419     Fixed an issue where resuming a source might not restart playing it.
421     Fixed PulseAudio playback when the configured stream length is much less
422     than the requested length.
424     Fixed MMDevAPI capture with sample rates not matching the backing device.
426     Fixed int32 output for the Wave Writer.
428     Fixed enumeration of OSS devices that are missing device files.
430     Added correct retrieval of the executable's path on FreeBSD.
432     Added a config option to specify the dithering depth.
434     Added a 5.1 decoder preset that excludes front-center output.
436 openal-soft-1.18.0:
438     Implemented the AL_EXT_STEREO_ANGLES and AL_EXT_SOURCE_RADIUS extensions.
440     Implemented the AL_SOFT_gain_clamp_ex, AL_SOFT_source_resampler,
441     AL_SOFT_source_spatialize, and ALC_SOFT_output_limiter extensions.
443     Implemented 3D processing for some effects. Currently implemented for
444     Reverb, Compressor, Equalizer, and Ring Modulator.
446     Implemented 2-channel UHJ output encoding. This needs to be enabled with a
447     config option to be used.
449     Implemented dual-band processing for high-quality ambisonic decoding.
451     Implemented distance-compensation for surround sound output.
453     Implemented near-field emulation and compensation with ambisonic rendering.
454     Currently only applies when using the high-quality ambisonic decoder or
455     ambisonic output, with appropriate config options.
457     Implemented an output limiter to reduce the amount of distortion from
458     clipping.
460     Implemented dithering for 8-bit and 16-bit output.
462     Implemented a config option to select a preferred HRTF.
464     Implemented a run-time check for NEON extensions using /proc/cpuinfo.
466     Implemented experimental capture support for the OpenSL backend.
468     Fixed building on compilers with NEON support but don't default to having
469     NEON enabled.
471     Fixed support for JACK on Windows.
473     Fixed starting a source while alcSuspendContext is in effect.
475     Fixed detection of headsets as headphones, with MMDevAPI.
477     Added support for AmbDec config files, for custom ambisonic decoder
478     configurations. Version 3 files only.
480     Added backend-specific options to alsoft-config.
482     Added first-, second-, and third-order ambisonic output formats. Currently
483     only works with backends that don't rely on channel labels, like JACK,
484     ALSA, and OSS.
486     Added a build option to embed the default HRTFs into the lib.
488     Added AmbDec presets to enable high-quality ambisonic decoding.
490     Added an AmbDec preset for 3D7.1 speaker setups.
492     Added documentation regarding Ambisonics, 3D7.1, AmbDec config files, and
493     the provided ambdec presets.
495     Added the ability for MMDevAPI to open devices given a Device ID or GUID
496     string.
498     Added an option to the example apps to open a specific device.
500     Increased the maximum auxiliary send limit to 16 (up from 4). Requires
501     requesting them with the ALC_MAX_AUXILIARY_SENDS context creation
502     attribute.
504     Increased the default auxiliary effect slot count to 64 (up from 4).
506     Reduced the default period count to 3 (down from 4).
508     Slightly improved automatic naming for enumerated HRTFs.
510     Improved B-Format decoding with HRTF output.
512     Improved internal property handling for better batching behavior.
514     Improved performance of certain filter uses.
516     Removed support for the AL_SOFT_buffer_samples and AL_SOFT_buffer_sub_data
517     extensions. Due to conflicts with AL_EXT_SOURCE_RADIUS.
519 openal-soft-1.17.2:
521     Implemented device enumeration for OSSv4.
523     Fixed building on OSX.
525     Fixed building on non-Windows systems without POSIX-2008.
527     Fixed Dedicated Dialog and Dedicated LFE effect output.
529     Added a build option to override the share install dir.
531     Added a build option to static-link libgcc for MinGW.
533 openal-soft-1.17.1:
535     Fixed building with JACK and without PulseAudio.
537     Fixed building on FreeBSD.
539     Fixed the ALSA backend's allow-resampler option.
541     Fixed handling of inexact ALSA period counts.
543     Altered device naming scheme on Windows backends to better match other
544     drivers.
546     Updated the CoreAudio backend to use the AudioComponent API. This clears up
547     deprecation warnings for OSX 10.11, although requires OSX 10.6 or newer.
549 openal-soft-1.17.0:
551     Implemented a JACK playback backend.
553     Implemented the AL_EXT_BFORMAT and AL_EXT_MULAW_BFORMAT extensions.
555     Implemented the ALC_SOFT_HRTF extension.
557     Implemented C, SSE3, and SSE4.1 based 4- and 8-point Sinc resamplers.
559     Implemented a C and SSE based band-limited Sinc resampler. This does 12- to
560     24-point Sinc resampling, and performs anti-aliasing.
562     Implemented B-Format output support for the wave file writer. This creates
563     FuMa-style first-order Ambisonics wave files (AMB format).
565     Implemented a stereo-mode config option for treating stereo modes as either
566     speakers or headphones.
568     Implemented per-device configuration options.
570     Fixed handling of PulseAudio and MMDevAPI devices that have identical
571     descriptions.
573     Fixed a potential lockup when stopping playback of suspended PulseAudio devices.
575     Fixed logging of Unicode characters on Windows.
577     Fixed 5.1 surround sound channels. By default it will now use the side
578     channels for the surround output. A configuration using rear channels is
579     still available.
581     Fixed the QSA backend potentially altering the capture format.
583     Fixed detecting MMDevAPI's default device.
585     Fixed returning the default capture device name.
587     Fixed mixing property calculations when deferring context updates.
589     Altered the behavior of alcSuspendContext and alcProcessContext to better
590     match certain Windows drivers.
592     Altered the panning algorithm, utilizing Ambisonics for better side and
593     back positioning cues with surround sound output.
595     Improved support for certain older Windows apps.
597     Improved the alffplay example to support surround sound streams.
599     Improved support for building as a sub-project.
601     Added an HRTF playback example.
603     Added a tone generator output test.
605     Added a toolchain to help with cross-compiling to Android.
607 openal-soft-1.16.0:
609     Implemented EFX Chorus, Flanger, Distortion, Equalizer, and Compressor
610     effects.
612     Implemented high-pass and band-pass EFX filters.
614     Implemented the high-pass filter for the EAXReverb effect.
616     Implemented SSE2 and SSE4.1 linear resamplers.
618     Implemented Neon-enhanced non-HRTF mixers.
620     Implemented a QSA backend, for QNX.
622     Implemented the ALC_SOFT_pause_device, AL_SOFT_deferred_updates,
623     AL_SOFT_block_alignment, AL_SOFT_MSADPCM, and AL_SOFT_source_length
624     extensions.
626     Fixed resetting mmdevapi backend devices.
628     Fixed clamping when converting 32-bit float samples to integer.
630     Fixed modulation range in the Modulator effect.
632     Several fixes for the OpenSL playback backend.
634     Fixed device specifier names that have Unicode characters on Windows.
636     Added support for filenames and paths with Unicode (UTF-8) characters on
637     Windows.
639     Added support for alsoft.conf config files found in XDG Base Directory
640     Specification locations (XDG_CONFIG_DIRS and XDG_CONFIG_HOME, or their
641     defaults) on non-Windows systems.
643     Added a GUI configuration utility (requires Qt 4.8).
645     Added support for environment variable expansion in config options (not
646     keys or section names).
648     Added an example that uses SDL2 and ffmpeg.
650     Modified examples to use SDL_sound.
652     Modified CMake config option names for better sorting.
654     HRTF data sets specified in the hrtf_tables config option may now be
655     relative or absolute filenames.
657     Made the default HRTF data set an external file, and added a data set for
658     48khz playback in addition to 44.1khz.
660     Added support for C11 atomic methods.
662     Improved support for some non-GNU build systems.
664 openal-soft-1.15.1:
666     Fixed a regression with retrieving the source's AL_GAIN property.
668 openal-soft-1.15:
670     Fixed device enumeration with the OSS backend.
672     Reorganized internal mixing logic, so unneeded steps can potentially be
673     skipped for better performance.
675     Removed the lookup table for calculating the mixing pans. The panning is
676     now calculated directly for better precision.
678     Improved the panning of stereo source channels when using stereo output.
680     Improved source filter quality on send paths.
682     Added a config option to allow PulseAudio to move streams between devices.
684     The PulseAudio backend will now attempt to spawn a server by default.
686     Added a workaround for a DirectSound bug relating to float32 output.
688     Added SSE-based mixers, for HRTF and non-HRTF mixing.
690     Added support for the new AL_SOFT_source_latency extension.
692     Improved ALSA capture by avoiding an extra buffer when using sizes
693     supported by the underlying device.
695     Improved the makehrtf utility to support new options and input formats.
697     Modified the CFLAGS declared in the pkg-config file so the "AL/" portion of
698     the header includes can optionally be omitted.
700     Added a couple example code programs to show how to apply reverb, and
701     retrieve latency.
703     The configuration sample is now installed into the share/openal/ directory
704     instead of /etc/openal.
706     The configuration sample now gets installed by default.