comparison README @ 9:a988ea53d982

added description of JNI stuff to README
author Robert McIntyre <rlm@mit.edu>
date Thu, 27 Oct 2011 02:47:28 -0700
parents f9476ff7637e
children 1fc162d84343
comparison
equal deleted inserted replaced
8:c54fe2f77030 9:a988ea53d982
4 To install OpenAL Soft, use your favorite shell to go into the build/ 4 To install OpenAL Soft, use your favorite shell to go into the build/
5 directory, and run: 5 directory, and run:
6 6
7 cmake .. 7 cmake ..
8 8
9 Assuming configuration went well, you can then build it, typically using GNU 9 Assuming configuration went well, you can then build it, typically
10 Make (KDevelop, MSVC, and others are possible depending on your system setup 10 using GNU Make (KDevelop, MSVC, and others are possible depending on
11 and CMake configuration). 11 your system setup and CMake configuration).
12
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.
17
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.
21 12
22 13
23 Utilities 14 This is a special version of OpenAL Soft which supports only one
24 ========= 15 device, the "send" device, which supports multiple listeners in a
16 limited fashion. To compile the jni bindings, go into the java/
17 directory and run :
25 18
26 The source package comes with an informational utility, openal-info, and is 19 ant
27 built by default. It prints out information provided by the ALC and AL sub-
28 systems, including discovered devices, version information, and extensions.
29 20
30 21 *after* following the cmake process above. The JNI bindings will be
31 Configuration 22 available in java/dist/audio-send.jar, and the compiled native
32 ============= 23 library will be in java/dist/audio-send-natives.jar.
33
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.
38 24
39 25
40 Acknowledgements 26 Acknowledgements
41 ================ 27 ================
42 28
43 Special thanks go to: 29 Special thanks go to:
44 30
45 Creative Labs for the original source code this is based off of. 31 Creative Labs for the original source code this is based off of.
46 32
47 Christopher Fitzgerald for the current reverb effect implementation, and 33 Christopher Fitzgerald for the current reverb effect implementation,
48 helping with the low-pass filter. 34 and helping with the low-pass filter.
49 35
50 Christian Borss for the 3D panning code the current implementation is heavilly 36 Christian Borss for the 3D panning code the current implementation is
51 based on. 37 heavilly based on.
52 38
53 Ben Davis for the idea behind the current click-removal code. 39 Ben Davis for the idea behind the current click-removal code.