changeset 34:e9517315d4e5

Build and doc fixes
author Chris Cannam
date Thu, 22 Nov 2012 17:01:04 +0000
parents f148034f55b7
children 11c7347afc10
files Makefile README.txt
diffstat 2 files changed, 33 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/Makefile	Thu Nov 22 16:24:30 2012 +0000
+++ b/Makefile	Thu Nov 22 17:01:04 2012 +0000
@@ -15,7 +15,7 @@
 
 $(JAR):	$(JAVAFILES)
 	javac $^
-	jar cf $@ $^
+	jar cf $@ org/vamp_plugins
 
 $(LIBRARY): $(OBJFILES)
 	$(CXX) -shared -o $@ $^ -lvamp-hostsdk
--- a/README.txt	Thu Nov 22 16:24:30 2012 +0000
+++ b/README.txt	Thu Nov 22 17:01:04 2012 +0000
@@ -13,3 +13,35 @@
 library (that is, jVamp) and both the wrapper and the plugin need to
 be compiled natively for the machine platform you are using.
 
+
+In this directory
+-----------------
+
+org/vamp_plugins -> Java interface for jVamp 
+src/ -> C++ source code for jVamp JNI wrapper
+host/ -> Simple Vamp host implemented as Java application
+test/ -> Self-contained basic exercise test
+
+
+Example
+-------
+
+On Linux:
+
+1. Run "make", to build the Java code (as jvamp.jar) and JNI wrapper
+   (as libvamp-jni.so).
+
+2. Build the host:
+
+   $ javac -classpath jvamp.jar host/host.java
+
+3. Pick a Vamp plugin (which must be installed in the Vamp plugin
+   path) and a 16-bit PCM WAV file, and run the host.  For example:
+
+   $ java -classpath jvamp.jar:host host vamp-example-plugins:fixedtempo:tempo testfile.wav
+
+   You should see some output -- in the case of the above plugin,
+   it will be one line of the form
+
+   0.002902494, 9.999092970: 142.07474 142.1 bpm
+