Go to file
2012-02-28 04:04:52 -08:00
Alc Give "OpenAL Soft" for the standard device name 2012-02-28 03:36:16 -08: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 Print out unsupported audio format info from ffmpeg 2012-02-28 04:04:52 -08:00
include/AL Fix typo in the "CarpetedHallway" reverb preset 2012-02-01 16:31:37 -08:00
OpenAL32 Use an enum for the device type 2012-02-23 15:25:30 -08:00
utils Use alGetEnumValue to check for supported filters and effects 2011-09-10 02:09:18 -07:00
.gitignore Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
alsoftrc.sample Recognize "none" to disable the default reverb 2012-02-19 17:41:42 -08:00
CMakeLists.txt Link with AudioToolbox.framework for the CoreAudio backend if it's found 2012-01-23 03:45:04 -08:00
config.h.in Set the FPU into single-precision mode for mixer updates 2011-09-29 05:10:15 -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
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.