annotate 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
rev   line source
rlm@0 1 Source Install
rlm@0 2 ==============
rlm@0 3
rlm@0 4 To install OpenAL Soft, use your favorite shell to go into the build/
rlm@0 5 directory, and run:
rlm@0 6
rlm@0 7 cmake ..
rlm@0 8
rlm@9 9 Assuming configuration went well, you can then build it, typically
rlm@9 10 using GNU Make (KDevelop, MSVC, and others are possible depending on
rlm@9 11 your system setup and CMake configuration).
rlm@0 12
rlm@0 13
rlm@9 14 This is a special version of OpenAL Soft which supports only one
rlm@9 15 device, the "send" device, which supports multiple listeners in a
rlm@9 16 limited fashion. To compile the jni bindings, go into the java/
rlm@9 17 directory and run :
rlm@0 18
rlm@9 19 ant
rlm@0 20
rlm@9 21 *after* following the cmake process above. The JNI bindings will be
rlm@9 22 available in java/dist/audio-send.jar, and the compiled native
rlm@9 23 library will be in java/dist/audio-send-natives.jar.
rlm@0 24
rlm@0 25
rlm@0 26 Acknowledgements
rlm@0 27 ================
rlm@0 28
rlm@0 29 Special thanks go to:
rlm@0 30
rlm@0 31 Creative Labs for the original source code this is based off of.
rlm@0 32
rlm@9 33 Christopher Fitzgerald for the current reverb effect implementation,
rlm@9 34 and helping with the low-pass filter.
rlm@0 35
rlm@9 36 Christian Borss for the 3D panning code the current implementation is
rlm@9 37 heavilly based on.
rlm@0 38
rlm@0 39 Ben Davis for the idea behind the current click-removal code.