# HG changeset patch # User Robert McIntyre # Date 1319708848 25200 # Node ID a988ea53d982d4d20e4a78cdb10e4e3d7497a7fc # Parent c54fe2f7703072a7f36076e4564fdd02dd34bf5b added description of JNI stuff to README diff -r c54fe2f77030 -r a988ea53d982 README --- a/README Thu Oct 27 02:40:54 2011 -0700 +++ b/README Thu Oct 27 02:47:28 2011 -0700 @@ -6,35 +6,21 @@ 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). +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. +This is a special version of OpenAL Soft which supports only one +device, the "send" device, which supports multiple listeners in a +limited fashion. To compile the jni bindings, go into the java/ +directory and run : +ant -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. +*after* following the cmake process above. The JNI bindings will be + available in java/dist/audio-send.jar, and the compiled native + library will be in java/dist/audio-send-natives.jar. Acknowledgements @@ -44,10 +30,10 @@ 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 filter. +Christopher Fitzgerald for the current reverb effect implementation, +and helping with the low-pass filter. -Christian Borss for the 3D panning code the current implementation is heavilly -based on. +Christian Borss for the 3D panning code the current implementation is +heavilly based on. Ben Davis for the idea behind the current click-removal code.