Go to file
2010-09-07 22:38:29 -07:00
Alc Remove unused struct member 2010-09-07 16:07:35 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Define ARGSTACK and CALLSTACK only when needed for testing shared libs 2010-05-16 08:03:05 -07:00
include/AL Add an empty efx-creative.h header 2010-05-21 11:21:35 -07:00
OpenAL32 Remove unnecessary check 2010-09-07 22:38:29 -07:00
utils Rename examples to utilities 2010-07-17 01:02:51 -07:00
.gitignore Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
alsoftrc.sample Update PulseAudio using period-sized chunks 2010-07-17 23:30:25 -07:00
CMakeLists.txt Move the core mixer functions to a separate source file 2010-08-03 23:19:36 -07:00
config.h.in Make the Wave Writer backend optional 2010-06-08 02:01:11 -07:00
COPYING Initial import 2007-11-13 18:02:18 -08:00
openal.pc.in Move the pkg-config file to the base directory 2009-12-09 07:36:06 -08:00
README Add a bit more information to the README 2010-08-15 16:55:11 -07:00
XCompile.txt Update comment 2009-09-12 20:02:45 -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.