Go to file
2014-12-22 18:56:15 -08:00
Alc Add an option for an increased ringbuffer size with JACK 2014-12-22 18:48:54 -08:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Add a cmake module to find JACK 2014-12-21 15:48:40 -08:00
common Only pass nano seconds to al_nssleep 2014-09-08 04:37:52 -07:00
examples Use the default channel layout in alffplay if one isn't specified 2014-12-12 06:10:23 -08:00
hrtf Add a 48khz HRTF data set 2014-08-07 04:26:06 -07:00
include Add a workaround for compilers without __COUNTER__ 2014-11-07 19:43:14 -08:00
OpenAL32 Use a macro for the record thread name 2014-12-21 10:38:40 -08:00
utils Add JACK to the config utility 2014-12-22 18:56:15 -08:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
alsoftrc.sample Add an option for an increased ringbuffer size with JACK 2014-12-22 18:48:54 -08:00
ChangeLog Add a changelog, detailing notable changes for each release 2014-08-15 00:06:59 -07:00
CMakeLists.txt Add a skeleton backend for JACK 2014-12-21 15:51:16 -08:00
config.h.in Add a skeleton backend for JACK 2014-12-21 15:51:16 -08:00
COPYING Update COPYING to the latest https://www.gnu.org/licenses/old-licenses/lgpl-2.0.txt to fix the FSF' address Fix the FSF' address in the source 2014-08-18 11:34:29 -07:00
env-vars.txt Minor clarification for __ALSOFT_SUSPEND_CONTEXT 2014-10-13 10:48:54 -07: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-Android.txt Add a toolchain for Android cross-compiling 2014-11-10 17:56:48 -08:00
XCompile.txt Update cross-compiler toolchain to work better with Qt 2014-11-06 23:18:42 -08: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.