Mercurial > audio-send
diff 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 |
line wrap: on
line diff
1.1 --- a/README Thu Oct 27 02:40:54 2011 -0700 1.2 +++ b/README Thu Oct 27 02:47:28 2011 -0700 1.3 @@ -6,35 +6,21 @@ 1.4 1.5 cmake .. 1.6 1.7 -Assuming configuration went well, you can then build it, typically using GNU 1.8 -Make (KDevelop, MSVC, and others are possible depending on your system setup 1.9 -and CMake configuration). 1.10 +Assuming configuration went well, you can then build it, typically 1.11 +using GNU Make (KDevelop, MSVC, and others are possible depending on 1.12 +your system setup and CMake configuration). 1.13 1.14 -Please Note: Double check that the appropriate backends were detected. Often, 1.15 -complaints of no sound, crashing, and missing devices can be solved by making 1.16 -sure the correct backends are being used. CMake's output will identify which 1.17 -backends were enabled. 1.18 1.19 -For most systems, you will likely want to make sure ALSA, OSS, and PulseAudio 1.20 -were detected (if your target system uses them). For Windows, make sure 1.21 -DirectSound was detected. 1.22 +This is a special version of OpenAL Soft which supports only one 1.23 +device, the "send" device, which supports multiple listeners in a 1.24 +limited fashion. To compile the jni bindings, go into the java/ 1.25 +directory and run : 1.26 1.27 +ant 1.28 1.29 -Utilities 1.30 -========= 1.31 - 1.32 -The source package comes with an informational utility, openal-info, and is 1.33 -built by default. It prints out information provided by the ALC and AL sub- 1.34 -systems, including discovered devices, version information, and extensions. 1.35 - 1.36 - 1.37 -Configuration 1.38 -============= 1.39 - 1.40 -OpenAL Soft can be configured on a per-user and per-system basis. This allows 1.41 -users and sysadmins to control information provided to applications, as well 1.42 -as application-agnostic behavior of the library. See alsoftrc.sample for 1.43 -available settings. 1.44 +*after* following the cmake process above. The JNI bindings will be 1.45 + available in java/dist/audio-send.jar, and the compiled native 1.46 + library will be in java/dist/audio-send-natives.jar. 1.47 1.48 1.49 Acknowledgements 1.50 @@ -44,10 +30,10 @@ 1.51 1.52 Creative Labs for the original source code this is based off of. 1.53 1.54 -Christopher Fitzgerald for the current reverb effect implementation, and 1.55 -helping with the low-pass filter. 1.56 +Christopher Fitzgerald for the current reverb effect implementation, 1.57 +and helping with the low-pass filter. 1.58 1.59 -Christian Borss for the 3D panning code the current implementation is heavilly 1.60 -based on. 1.61 +Christian Borss for the 3D panning code the current implementation is 1.62 +heavilly based on. 1.63 1.64 Ben Davis for the idea behind the current click-removal code.