Go to file
2015-09-05 14:33:21 -07:00
Alc Avoid setting an HRTF-compatible format when it's disabled 2015-09-05 14:33:21 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Add a cmake module to find JACK 2014-12-21 15:48:40 -08:00
common Only pass nano seconds to al_nssleep 2014-09-08 04:37:52 -07:00
examples Use the default channel layout in alffplay if one isn't specified 2014-12-12 06:10:23 -08:00
hrtf Add a 48khz HRTF data set 2014-08-07 04:26:06 -07:00
include Don't define struct timespec with VS2015 2015-06-07 12:01:15 -07:00
OpenAL32 Don't store the HRTF request mode in the device flags 2015-09-05 01:32:12 -07:00
utils Reorganize some HRTF config options 2015-09-04 17:06:23 -07:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
alsoftrc.sample Change the hrtf config option to expect auto/true/false instead of a bool 2015-09-04 20:16:48 -07:00
ChangeLog Add word wrapping to the changelog 2015-09-05 00:07:05 -07:00
CMakeLists.txt Check for pthread_*_np functions in pthread_np.h when it exists 2015-08-13 15:20:34 -07:00
config.h.in Remove some IN_IDE_PARSER uses 2014-12-24 17:15:50 -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
env-vars.txt Minor clarification for __ALSOFT_SUSPEND_CONTEXT 2014-10-13 10:48:54 -07:00
hrtf.txt Update the hrtf.txt about the 48khz default dataset. 2015-08-26 12:52:18 -07: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
README Update README acknowledgements 2015-08-26 13:06:19 -07: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

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.