Go to file
Chris Robinson 1b104dd77b More robustly generate the git commit ID and branch 2016-12-21 11:41:45 -08:00
Alc Add missing macros for OSS3/Free compatibility 2016-12-21 10:54:19 -08:00
OpenAL32 Trace the commit ID and branch the library was built from 2016-12-21 01:12:47 -08:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Update cmake scripts to handle policy 0054 2016-11-22 14:50:55 -08:00
common Use atomic flags for boolean atomic locks 2016-11-25 23:25:16 -08:00
docs Cleanup and clarify a bit of the ambisonic docs 2016-10-28 06:27:01 -07:00
examples Skip audio packets that fail to decode in alffplay 2016-09-14 13:37:20 -07:00
hrtf Add a 48khz HRTF data set 2014-08-07 04:26:06 -07:00
include Use separate macros for atomics that don't take a memory order 2016-12-20 20:49:37 -08:00
presets Provide a decoder preset for 5.1 Surround output 2016-04-24 21:11:24 -07:00
utils More robustly generate the git commit ID and branch 2016-12-21 11:41:45 -08:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
.travis.yml Build on Linux and OSX with Travis 2015-12-11 10:34:38 -08:00
CMakeLists.txt More robustly generate the git commit ID and branch 2016-12-21 11:41:45 -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
ChangeLog Initial ChangeLog update for 1.18 changes 2016-10-30 11:09:34 -07:00
README Update README acknowledgements 2015-08-26 13:06:19 -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
alsoftrc.sample Add a volume-adjust config option to adjust the source output volume 2016-09-24 18:46:41 -07:00
appveyor.yml build: added appveyour-ci script to verify windows build 2016-09-13 15:08:47 +03:00
config.h.in Trace the commit ID and branch the library was built from 2016-12-21 01:12:47 -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
version.cmake More robustly generate the git commit ID and branch 2016-12-21 11:41:45 -08:00
version.h.in Trace the commit ID and branch the library was built from 2016-12-21 01:12:47 -08:00

README

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 and HRTF filters.

Christian Borss for the 3D panning code previous versions used as a base.

Ben Davis for the idea behind a previous version of the click-removal code.

Richard Furse for helping with my understanding of Ambisonics that is used by
the various parts of the library.