Go to file
Chris Robinson 80c9008798 Add docs for OpenAL Soft and standard decoder presets 2016-04-23 14:12:43 -07:00
Alc Increase max output channels to 16 2016-04-19 18:58:19 -07:00
OpenAL32 Increase max output channels to 16 2016-04-19 18:58:19 -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 Move the aligned malloc functions to the common lib 2016-03-29 00:44:58 -07:00
docs Add docs for OpenAL Soft and standard decoder presets 2016-04-23 14:12:43 -07:00
examples fix audio play error in sample 2016-04-22 17:33:00 +08:00
hrtf Add a 48khz HRTF data set 2014-08-07 04:26:06 -07:00
include Move the aligned malloc functions to the common lib 2016-03-29 00:44:58 -07:00
presets Add docs for OpenAL Soft and standard decoder presets 2016-04-23 14:12:43 -07:00
utils Put the decoder options in a group box 2016-04-10 13:48:26 -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
CMakeLists.txt Move the aligned malloc functions to the common lib 2016-03-29 00:44:58 -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
ChangeLog Update ChangeLog 2016-01-17 22:38:27 -08: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
alsoft_ambdec.txt Fix xover_freq type in the ambdec doc 2016-04-10 13:03:00 -07:00
alsoftrc.sample Update a config option comment 2016-04-22 02:19:43 -07:00
config.h.in Remove unneeded check for io.h 2016-01-24 01:51:43 -08: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

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.