README.md

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