Torque3D/Engine/lib/openal-soft
marauder2k7 a745fc3757 Initial commit
added libraries:
opus
flac
libsndfile

updated:
libvorbis
libogg
openal

- Everything works as expected for now. Bare in mind libsndfile needed the check for whether or not it could find the xiph libraries removed in order for this to work.
2024-03-21 17:33:47 +00:00
..
.github/workflows Initial commit 2024-03-21 17:33:47 +00:00
al Initial commit 2024-03-21 17:33:47 +00:00
alc Initial commit 2024-03-21 17:33:47 +00:00
cmake Initial commit 2024-03-21 17:33:47 +00:00
common Initial commit 2024-03-21 17:33:47 +00:00
core Initial commit 2024-03-21 17:33:47 +00:00
docs Initial commit 2024-03-21 17:33:47 +00:00
examples Initial commit 2024-03-21 17:33:47 +00:00
hrtf Initial commit 2024-03-21 17:33:47 +00:00
include/AL Initial commit 2024-03-21 17:33:47 +00:00
presets Initial commit 2024-03-21 17:33:47 +00:00
resources update openal-soft 2021-01-26 13:01:35 -06:00
router Initial commit 2024-03-21 17:33:47 +00:00
utils Initial commit 2024-03-21 17:33:47 +00:00
.gitignore update openal-soft 2021-01-26 13:01:35 -06:00
.travis.yml * BugFix: Correct convexDecomp compilation by setting the LINUX flag when necessary. 2022-05-30 16:32:45 -04:00
alsoftrc.sample Initial commit 2024-03-21 17:33:47 +00:00
appveyor.yml Initial commit 2024-03-21 17:33:47 +00:00
BSD-3Clause * BugFix: Correct convexDecomp compilation by setting the LINUX flag when necessary. 2022-05-30 16:32:45 -04:00
ChangeLog Initial commit 2024-03-21 17:33:47 +00:00
CMakeLists.txt Initial commit 2024-03-21 17:33:47 +00:00
config.h.in Initial commit 2024-03-21 17:33:47 +00:00
COPYING update openal-soft 2021-01-26 13:01:35 -06:00
libopenal.version Initial commit 2024-03-21 17:33:47 +00:00
openal.pc.in openal-soft updates 2018-05-09 20:48:18 +10:00
OpenALConfig.cmake.in * BugFix: Correct convexDecomp compilation by setting the LINUX flag when necessary. 2022-05-30 16:32:45 -04:00
README.md Initial commit 2024-03-21 17:33:47 +00:00
version.cmake openal-soft updates 2018-05-09 20:48:18 +10:00
version.h.in update openal-soft 2021-01-26 13:01:35 -06:00
XCompile-Android.txt * BugFix: Correct convexDecomp compilation by setting the LINUX flag when necessary. 2022-05-30 16:32:45 -04:00
XCompile.txt OpenAL-soft for windows 2016-10-22 09:22:33 +10:00

OpenAL Soft

master branch CI status : GitHub Actions Status Windows Build Status

OpenAL Soft is an LGPL-licensed, cross-platform, software implementation of the OpenAL 3D audio API. It's forked from the open-sourced Windows version available originally from openal.org's SVN repository (now defunct). OpenAL provides capabilities for playing audio in a virtual 3D environment. Distance attenuation, doppler shift, and directional sound emitters are among the features handled by the API. More advanced effects, including air absorption, occlusion, and environmental reverb, are available through the EFX extension. It also facilitates streaming audio, multi-channel buffers, and audio capture.

More information is available on the official website.

Source Install

To install OpenAL Soft, use your favorite shell to go into the build/ directory, and run:

cmake ..

Alternatively, you can use any available CMake front-end, like cmake-gui, ccmake, or your preferred IDE's CMake project parser.

Assuming configuration went well, you can then build it. The command cmake --build . will instruct CMake to build the project with the toolchain chosen during configuration (often GNU Make or NMake, although others are possible).

Please Note: Double check that the appropriate backends were detected. Often, complaints of no sound, crashing, and missing devices can be solved by making sure the correct backends are being used. CMake's output will identify which backends were enabled.

For most systems, you will likely want to make sure PipeWire, PulseAudio, and ALSA were detected (if your target system uses them). For Windows, make sure WASAPI was detected.

Building openal-soft - Using vcpkg

You can download and install openal-soft using the vcpkg dependency manager:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install openal-soft

The openal-soft port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

Utilities

The source package comes with an informational utility, openal-info, and is built by default. It prints out information provided by the ALC and AL sub- systems, including discovered devices, version information, and extensions.

Configuration

OpenAL Soft can be configured on a per-user and per-system basis. This allows users and sysadmins to control information provided to applications, as well as application-agnostic behavior of the library. See alsoftrc.sample for available settings.

Acknowledgements

Special thanks go to:

  • Creative Labs for the original source code this is based off of.
  • Christopher Fitzgerald for the current reverb effect implementation, and helping with the low-pass and HRTF filters.
  • Christian Borss for the 3D panning code previous versions used as a base.
  • Ben Davis for the idea behind a previous version of the click-removal code.
  • Richard Furse for helping with my understanding of Ambisonics that is used by the various parts of the library.