Pas the output device channel count to ALeffectState::process
[openal-soft.git] / README
blobebca8f91558647ba5fcf91a34a47cc5841e92958
1 Source Install
2 ==============
4 To install OpenAL Soft, use your favorite shell to go into the build/
5 directory, and run:
7 cmake ..
9 Assuming configuration went well, you can then build it, typically using GNU
10 Make (KDevelop, MSVC, and others are possible depending on your system setup
11 and CMake configuration).
13 Please Note: Double check that the appropriate backends were detected. Often,
14 complaints of no sound, crashing, and missing devices can be solved by making
15 sure the correct backends are being used. CMake's output will identify which
16 backends were enabled.
18 For most systems, you will likely want to make sure ALSA, OSS, and PulseAudio
19 were detected (if your target system uses them). For Windows, make sure
20 DirectSound was detected.
23 Utilities
24 =========
26 The source package comes with an informational utility, openal-info, and is
27 built by default. It prints out information provided by the ALC and AL sub-
28 systems, including discovered devices, version information, and extensions.
31 Configuration
32 =============
34 OpenAL Soft can be configured on a per-user and per-system basis. This allows
35 users and sysadmins to control information provided to applications, as well
36 as application-agnostic behavior of the library. See alsoftrc.sample for
37 available settings.
40 Acknowledgements
41 ================
43 Special thanks go to:
45 Creative Labs for the original source code this is based off of.
47 Christopher Fitzgerald for the current reverb effect implementation, and
48 helping with the low-pass filter.
50 Christian Borss for the 3D panning code the current implementation is heavilly
51 based on.
53 Ben Davis for the idea behind the current click-removal code.