Go to file
2016-07-30 16:24:46 -07:00
Alc Simplify a format check 2016-07-30 10:16:29 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Remove the MIDI code 2015-10-20 18:01:27 -07:00
common Fix a direct access to a UIntMap 2016-07-09 16:42:36 -07:00
docs Add some general info about how ambdec works to ambdec.txt 2016-04-23 15:01:44 -07:00
examples Fix for ffmpeg. 2016-07-21 08:09:31 -07:00
hrtf Add a 48khz HRTF data set 2014-08-07 04:26:06 -07:00
include Use separate arrays for UIntMap keys and values 2016-07-04 20:35:32 -07:00
OpenAL32 Add a stand-alone upsampler for higher-order ambisonic oputput 2016-07-30 09:29:21 -07:00
presets Provide a decoder preset for 5.1 Surround output 2016-04-24 21:11:24 -07:00
utils Add a cmake option to embed the HRTF data 2016-07-12 14:22:17 -07:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
.travis.yml Build on Linux and OSX with Travis 2015-12-11 10:34:38 -08:00
alsoftrc.sample Update alsoftrc.sample with the new channel configurations 2016-07-30 16:24:46 -07:00
ChangeLog Update ChangeLog 2016-01-17 22:38:27 -08:00
CMakeLists.txt Remove broken autowah effect code 2016-07-26 03:45:25 -07:00
config.h.in Add a cmake option to embed the HRTF data 2016-07-12 14:22:17 -07: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
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.