Go to file
Chris Robinson af8be56f17 Use an ALCbackend object to access playback backends
This is the start of a backend redesign. Currently, a wrapper object is used to
avoid having to redo all the backends at once, but they should slowly be
converted to derive from ALCbackend instead. The ALCbackend interface can
change as needed.
2013-10-27 14:24:55 -07:00
Alc Use an ALCbackend object to access playback backends 2013-10-27 14:24:55 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Add a custom FindSDL_sound cmake module 2013-06-05 19:21:09 -07:00
examples Handle non-native endian formats with SDL_sound 2013-06-19 22:47:17 -07:00
include/AL Finalize AL_SOFT_deferred_updates 2013-10-05 06:14:04 -07:00
OpenAL32 Use an ALCbackend object to access playback backends 2013-10-27 14:24:55 -07:00
utils Some .ui changes that Qt Designer insists on 2013-07-10 10:53:01 -07:00
.gitignore Add win64build to .gitignore 2013-03-19 08:36:06 -07:00
alsoftrc.sample Implement the Compressor effect 2013-10-03 07:55:12 -07:00
CMakeLists.txt Rework threading functions 2013-10-27 08:14:13 -07:00
config.h.in Add a method to set the running thread's name 2013-10-26 12:39:19 -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 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.