Go to file
Chris Robinson f2ff2bb2f6 Use the difference in HF scale for upsampling ambisonics 2022-09-03 21:06:39 -07:00
.github/workflows Upload Win32 and x64 artifacts to Github actions (#708) 2022-05-30 15:51:05 -07:00
al Clear the buffer from X-RAM before updating its size 2022-08-05 12:11:02 -07:00
alc Use the difference in HF scale for upsampling ambisonics 2022-09-03 21:06:39 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Update alffplay to support newer ffmpeg versions 2022-08-20 20:59:15 -07:00
common Use a bind statement instead of a lambda 2022-08-29 01:12:09 -07:00
core Use the difference in HF scale for upsampling ambisonics 2022-09-03 21:06:39 -07:00
docs Update the default HRTF 2022-08-13 22:51:47 -07:00
examples Update alffplay to support newer ffmpeg versions 2022-08-20 20:59:15 -07:00
hrtf Update the default HRTF 2022-08-13 22:51:47 -07:00
include/AL Finalize ALC_SOFT_output_mode 2022-04-17 13:56:01 -07:00
presets Use a more precise 3D7.1 decoder 2022-08-30 08:00:55 -07:00
resources Remove BOM markers and set UTF-8 codepage for rc files 2019-07-01 00:28:06 -07:00
router Add EFX functions back to the router 2022-06-18 08:20:34 -07:00
utils Resample before frequency analysis 2022-05-13 15:40:15 -07: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
BSD-3Clause Update some license notices 2021-04-27 11:56:29 -07:00
CMakeLists.txt More updates for making an OSX framework 2022-08-28 04:36:15 -07:00
COPYING Fix COPYING 2018-07-02 17:09:53 -07:00
ChangeLog Update changelog 2022-06-27 01:11:09 -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 Additional corrections as mentionned in the PR 2018-01-28 03:26:02 +01: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
alsoftrc.sample Update the default HRTF 2022-08-13 22:51:47 -07:00
appveyor.yml Release 1.22.2 2022-06-27 01:33:53 -07:00
config.h.in Search the installation data directory (#693) 2022-05-13 13:55:17 -07:00
openal.pc.in Specify Libs.private for the pkg-config file 2018-03-29 18:57:48 -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

README.md

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.

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.