Go to file
Arthur Brainville 58fd9d70d2
Additional corrections as mentionned in the PR
2018-01-28 03:26:02 +01:00
Alc Use an array lookup for source IDs 2018-01-27 14:34:05 -08:00
OpenAL32 Use an array lookup for source IDs 2018-01-27 14:34:05 -08:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Handle libossaudio as an optional OSS library 2017-09-15 22:22:45 -07:00
common Add a method to get the system's page size 2018-01-16 19:28:10 -08:00
docs Update mhr format for 24-bit, multi-field, stereo measurements 2017-10-22 15:36:42 -07:00
examples Enable events in alffplay 2018-01-24 20:04:57 -08:00
hrtf Update default HRTFs for 24-bit samples 2017-10-22 15:45:30 -07:00
include/AL Finalize ALC_SOFT_device_clock 2018-01-15 06:45:53 -08:00
native-tools Use a -40dB drop for bsinc12 2018-01-07 06:43:35 -08:00
presets Add a 5.1 preset that excludes the front-center speaker 2017-07-18 20:30:45 -07:00
router Use a typedef to declare extern atomic variables 2017-10-07 14:58:35 -07:00
utils Fix the return type of the al_fwrite wrapper 2018-01-22 10:48:55 -08:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
.travis.yml Use the right path for android's cmake toolchain 2017-12-16 15:15:11 -08:00
CMakeLists.txt Add a ctz64 fallback using _BitScanForward when available 2018-01-27 14:34:05 -08:00
COPYING Update COPYING to the latest https://www.gnu.org/licenses/old-licenses/lgpl-2.0.txt to fix the FSF' address Fix the FSF' address in the source 2014-08-18 11:34:29 -07:00
ChangeLog Update ChangeLog with JACK fix 2017-09-23 15:11:07 -07:00
README.md Additional corrections as mentionned in the PR 2018-01-28 03:26:02 +01:00
XCompile-Android.txt Add a toolchain for Android cross-compiling 2014-11-10 17:56:48 -08:00
XCompile.txt Update cross-compiler toolchain to work better with Qt 2014-11-06 23:18:42 -08:00
alsoftrc.sample Remove standard reverb specific processing functions 2018-01-07 22:48:03 -08:00
appveyor.yml Update version for 1.18.2 release 2017-09-24 07:06:50 -07:00
config.h.in Add a ctz64 fallback using _BitScanForward when available 2018-01-27 14:34:05 -08:00
openal.pc.in Add the AL subdir to the list of include flags in the pkg-config file 2012-10-26 00:02:39 -07:00
version.cmake More robustly generate the git commit ID and branch 2016-12-21 11:41:45 -08:00
version.h.in Trace the commit ID and branch the library was built from 2016-12-21 01:12:47 -08: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.