Java Bindings for libshout
andy@benow.ca - http://benow.ca

Description:

 Allows for easy streaming from a java application to an icecast2 server in either
 ogg/vorbis or mp3 format.    


Requirements:

 - libshout 2.0 (http://icecast.org/download.html)
 - icecast 2.0 (http://icecast.org/download.html) 
 - apache ant  (http://ant.apache.org)
 - gcc, make


Compilation:

	You will probably need to recompile to match your platform.  To do so:

	> ant clean all
	
 NOTE: the os and jdk home are autodetected by the ant script, and then passed to the Makefile during native
 compilation.  Linux, freebsd and win32 (ming) have been tested and worked once upon a time.  
	
 Targets of note within the ant build file include:

	compile: compile java sources
	native: compile native code
	javadoc: compile javadoc
	clean: clean binaries
	jar: create a jar or the java source
  all: do everything


Usage:

 Usage is essentially identical to libshout.  See the javadocs and the included example.


Example:

 A quick streamer example is included:  src/test/org/xiph/libshout/Example.  The example can be run (under linux) by:

	> bin/example --help
		
 for detailed usage info.

 Where <file|url> is a file or url to stream.  Supported formats include mp3 and ogg.  Format is guessed according 
 to input, with mp3 being the default.


Testing:

 If you are having errors running the example, you might want to validate that the build and native linking works
 by doing the following:
 
  > ant clean all
  > bin/test
  
 It should print a message that it is working (printed from native code).  This means the native linking is working and
 libshout errors probably aren't due to compilation and linking (but rather to incorrect server parameters, etc).  If
 this test does not work, take a look at the native/Makefile and try to refine the failed commands.  Fire me an email 
 (andy@benow.ca) if still no luck.
  

Deployment:
 
 For use in your apps, the dist/libshout.jar must appear in your path.  The path to the native glue must also
 be visible within your library path.  An example startup would be:
 
 	> java -cp lib/libshout.jar -Djava.library.path=/path/to/libshoutjava/ org.my.Streamer /some/playlist.pls


Contact:

 Any questions or comments?  Contact me: andy@benow.ca

