Go to file
2012-10-09 06:54:21 -07:00
Alc Set Hrtf.Moving after setting the source params instead of after mixing 2012-10-09 06:54:21 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Use a better method for determining if shared functions exist 2011-07-23 00:48:19 -07:00
examples Update the example to use avcodec_decode_audio4 2012-10-03 02:01:52 -07:00
include/AL Clarify some comments, fix some definition ordering, and add some includes 2012-06-15 23:46:09 -07:00
OpenAL32 Build the listener matrix separately 2012-10-09 06:19:36 -07:00
utils Properly scale the HRTF delays when writing them 2012-09-12 05:11:53 -07:00
.gitignore Add some more entries to .gitignore 2012-05-09 16:30:22 -07:00
alsoftrc.sample Add a note about the hrtf_tables filename markers 2012-09-12 05:34:42 -07:00
CMakeLists.txt Define RESTRICT in config.h instead of alMain.h 2012-10-09 01:46:02 -07:00
config.h.in Define RESTRICT in config.h instead of alMain.h 2012-10-09 01:46:02 -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 Fix HRTF data format description 2012-09-11 19:55:45 -07:00
openal.pc.in Improve static builds with MinGW 2010-11-28 16:19:11 -08: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.