Go to file
2023-01-05 01:47:55 -08:00
.github/workflows Include the build type in the CI job names 2022-12-18 11:38:38 -08:00
al Avoid some explicit casts and references 2023-01-01 16:06:19 -08:00
alc Add and use mixers that process one input and output channel 2023-01-05 01:47:55 -08:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Use SDL2's sdl2-config.cmake 2022-11-16 18:58:24 -08:00
common Handle UHJ better with convolution reverb 2023-01-01 19:50:05 -08:00
core Add and use mixers that process one input and output channel 2023-01-05 01:47:55 -08:00
docs Add preliminary support for 7.1.4 output modes 2022-11-03 19:42:08 -07:00
examples Add more formats for displaying in examples 2022-11-29 11:57:53 -08:00
hrtf Update the default HRTF 2022-08-13 22:51:47 -07:00
include/AL Update some header comments 2022-12-30 16:20:45 -08:00
presets Add preliminary support for 7.1.4 output modes 2022-11-03 19:42:08 -07:00
resources Remove BOM markers and set UTF-8 codepage for rc files 2019-07-01 00:28:06 -07:00
router Fix router not loading on Creative's hardware OpenAL (#773) 2022-11-16 22:19:45 -08:00
utils Display the device sample rate in openal-info 2022-12-31 11:49:44 -08:00
.gitignore Update .gitignore for QtCreator files 2020-08-11 10:11:20 -07:00
.travis.yml Don't require RTKit for Xenial CI 2021-04-18 01:52:22 -07:00
alsoftrc.sample Add a config option to prevent WASAPI from using a resampler 2022-11-12 23:41:11 -08:00
appveyor.yml Release 1.22.2 2022-06-27 01:33:53 -07:00
BSD-3Clause Update some license notices 2021-04-27 11:56:29 -07:00
ChangeLog Update changelog 2022-06-27 01:11:09 -07:00
CMakeLists.txt Don't warn for attributes being in a later standard 2022-12-05 22:29:26 -08:00
config.h.in Search the installation data directory (#693) 2022-05-13 13:55:17 -07:00
COPYING Fix COPYING 2018-07-02 17:09:53 -07:00
openal.pc.in Specify Libs.private for the pkg-config file 2018-03-29 18:57:48 -07:00
OpenALConfig.cmake.in Make OpenALConfig.cmake compatible with CMake's FindOpenAL.cmake (#581) 2021-07-06 00:34:40 -07:00
README.md Add vcpkg installation instructions (#768) 2022-09-14 01:34:15 -07:00
version.cmake More robustly generate the git commit ID and branch 2016-12-21 11:41:45 -08:00
version.h.in Added rc scripts for dll (#306) 2019-06-30 22:01:04 -07:00
XCompile-Android.txt Add a comment about using lld on Android 2021-01-31 13:24:58 -08:00
XCompile.txt Update cross-compiler toolchain to work better with Qt 2014-11-06 23:18:42 -08:00

OpenAL soft

master branch CI status : Build 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 ..

Assuming configuration went well, you can then build it, typically using GNU Make (KDevelop, MSVC, and others are possible depending on your system setup and CMake configuration).

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 ALSA, OSS, and PulseAudio were detected (if your target system uses them). For Windows, make sure DirectSound 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.