Go to file
Chris Robinson 2f5b86dd38 Add an "un-exposed" method to get the library version
This reports the same ALSOFT version as alGetString(AL_VERSION), but doesn't
require a current context (which requires a ALCdevice) to call. Do *NOT* use
this version to determine feature support, use the standard interfaces. If you
think you need to use this, you probably don't, and shouldn't.
2017-10-16 05:47:12 -07:00
Alc Add casts for assigning the SSE bsinc filter pointers 2017-10-07 15:28:35 -07:00
build Move the default out-of-tree build dir to build 2009-09-12 17:54:27 -07:00
cmake Handle libossaudio as an optional OSS library 2017-09-15 22:22:45 -07:00
common Use _wfopen_s to silence MSVC security warnings 2017-10-07 14:48:07 -07:00
docs Add an option to ignore the app's speed of sound for reverb decay 2017-09-22 05:42:04 -07:00
examples Add missing include for std::array 2017-07-23 00:18:32 -07:00
hrtf Replace makehrtf's dither 2017-08-01 23:43:25 -07:00
include/AL Finalize ALC_SOFT_output_limiter 2017-05-25 04:16:07 -07:00
native-tools Don't hide the log2 macro behind an Android-only macro 2017-10-07 14:39:41 -07:00
OpenAL32 Add an "un-exposed" method to get the library version 2017-10-16 05:47:12 -07:00
presets Add a 5.1 preset that excludes the front-center speaker 2017-07-18 20:30:45 -07:00
router Use a typedef to declare extern atomic variables 2017-10-07 14:58:35 -07:00
utils Avoid using wmain on Windows 2017-08-30 16:33:44 -07:00
.gitignore Add another directory to .gitignore 2014-03-17 15:20:32 -07:00
.travis.yml Enable embedding of HRTF data in CI config files 2017-05-05 14:30:06 +03:00
alsoftrc.sample Add a higher quality bsinc resampler using 24 sample points 2017-08-27 10:16:36 -07:00
appveyor.yml Update version for 1.18.2 release 2017-09-24 07:06:50 -07:00
ChangeLog Update ChangeLog with JACK fix 2017-09-23 15:11:07 -07:00
CMakeLists.txt Update version for 1.18.2 release 2017-09-24 07:06:50 -07:00
config.h.in Add a check for pthread_setname_np with three parameters 2017-09-15 22:09:37 -07: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
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 Update README acknowledgements 2015-08-26 13:06:19 -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
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 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.