Go to file
2017-04-08 12:27:30 -07:00
Alc Clean up some formatting 2017-04-08 12:27:30 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Don't require SDL_sound for alffplay 2017-02-11 12:56:13 -08:00
common Use an array of pointers for effects instead of a linked list 2017-03-27 23:16:23 -07:00
docs Update the ambisonic docs to mention the near-field effect 2017-03-29 00:11:38 -07:00
examples Ensure SDL_AUDIO_BITSIZE is defined for older SDL2 versions 2017-04-07 03:33:03 -07:00
hrtf Add a 48khz HRTF data set 2014-08-07 04:26:06 -07:00
include Use an array of pointers for effects instead of a linked list 2017-03-27 23:16:23 -07:00
OpenAL32 Reference count HRTFs and unload them when unused 2017-04-06 13:00:29 -07:00
presets Provide a decoder preset for 5.1 Surround output 2016-04-24 21:11:24 -07:00
utils Properly update the resampler label in the UI 2017-03-24 15:34:36 -07:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
.travis.yml Only download and strip Android NDK when not cached 2017-03-06 11:39:39 +01:00
alsoftrc.sample Handle the nfc-ref-delay config option 2017-03-12 13:24:16 -07:00
appveyor.yml Configure CMake to require available backends on CI services 2017-03-06 10:26:03 +01:00
ChangeLog Update ChangeLog 2017-03-22 03:13:36 -07:00
CMakeLists.txt Require CMake 3.0.2 2017-03-26 21:24:20 -07:00
config.h.in Porperly check for and use __builtin_assume_aligned 2017-02-13 07:36:49 -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
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
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
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.