Go to file
Chris Robinson bf97f58edb Append the number of bits, not bytes, to types
Also use ALuint64SOFT from alext.h for uint64
2014-05-08 00:28:34 -07:00
Alc Move RWLock and UIntMap implementations to common 2014-05-07 19:16:49 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Include FindALSA.cmake 2014-04-23 02:12:34 -07:00
common Move RWLock and UIntMap implementations to common 2014-05-07 19:16:49 -07:00
examples Handle non-native endian formats with SDL_sound 2013-06-19 22:47:17 -07:00
hrtf Move the default hrtf table to an external file 2014-02-23 21:02:11 -08:00
include Always use unsigned int for RefCount 2014-05-07 23:49:06 -07:00
OpenAL32 Move the static_assert definition to its own header 2014-05-07 02:28:25 -07:00
utils Append the number of bits, not bytes, to types 2014-05-08 00:28:34 -07:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
alsoftrc.sample Update config file comments 2014-03-09 00:32:57 -08:00
CMakeLists.txt Build a common static lib for reusable code 2014-05-07 19:51:42 -07:00
config.h.in Check for C99 _Bool support 2014-05-06 23:10:50 -07:00
COPYING Initial import 2007-11-13 18:02:18 -08:00
env-vars.txt Add a text file describing the available environment variables 2012-02-19 23:03:04 -08:00
hrtf.txt Move the default hrtf table to an external file 2014-02-23 21:02:11 -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
README Add a bit more information to the README 2010-08-15 16:55:11 -07:00
XCompile.txt Fix CMAKE_FIND_ROOT_PATH in XCompile.txt 2011-07-13 01:31:17 -07: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 filter.

Christian Borss for the 3D panning code the current implementation is heavilly
based on.

Ben Davis for the idea behind the current click-removal code.