Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update master

  • Loading branch information...
commit 0944bf84db9cc5bdac32c2ee4b6de8a43d8e6a0a 1 parent dfb85f8
@mhroth authored
Showing with 13 additions and 35 deletions.
  1. +13 −35 README.md
View
48 README.md
@@ -2,14 +2,14 @@
JVstHost is an open-source Java-based VST host for Linux, OS X, and Windows written by Martin Roth and Matthew Yee-King. It aims to load and manipulate all audio plugins conforming to the Steinberg VST standard, including those generated with jVSTwRapper.
-Note that the (only) constructor of JVstHost throws an exception of type `com.synthbot.audioplugin.vst.JVstLoadException`. There are several things which may go wrong while loading a VST. For this reason, an exception is thrown with the details (see [JVstLoadException.getMessage()]()). See PROGRAMMING API.
+Note that the (only) constructor of JVstHost throws an exception of type `com.synthbot.audioplugin.vst.JVstLoadException`. There are several things which may go wrong while loading a VST. For this reason, an exception is thrown with the details (see `JVstLoadException.getMessage()`).
A class implementing the `com.synthbot.audioplugin.vst.JVstHostListener` interface can also register itself with a JvstHost object. It will receive callbacks from the plugin.
-JVstHost is licensed under the GNU [Lesser General Public License](http://www.gnu.org/copyleft/lesser.html) (LGPL)
+JVstHost is licensed under the GNU [Lesser General Public License](http://www.gnu.org/copyleft/lesser.html) (LGPL).
-## GETTING STARTED
+## Getting Started
All that you really need is to put JVstHost.jar into your java class path, and to put:
* `libjvsthost2.jnilib` into `/Library/Java/Extensions` (Mac OS X)
@@ -17,10 +17,10 @@ All that you really need is to put JVstHost.jar into your java class path, and t
* `jvsthost2.dll` into `C:\WINDOWS\system32` (Windows)
The directories may be system dependent. They must simply by listed in the Java classpath so that Java will know where to look for them.
-NOTE: Not all synths work. If you have one that you are particularly keen on working with, please e-mail us and we'll try to debug it with you.
+**NOTE:** Not all synths work. If you have one that you are particularly keen on working with, please e-mail us and we'll try to debug it with you.
-## TESTING IT OUT
+## Testing It Out
To run the test program:
@@ -40,41 +40,19 @@ e.g. (MAC)
JVstHost does interoperate with [jVSTwRapper](http://jvstwrapper.sourceforge.net/ ). Ensure that the `jVSTsYstem.jar` library (included with jVSTwRapper) is included in the classpath when starting the host. In Mac OS X, this library is most commonly found in the jVSTwRapper vst directory, `./Contents/Resources`
-## COMPILATION
+## Compilation
-###Mac OS X
-A script file, buildJvh.sh, is included for compiling the
-JVstHost native library under Mac OS X. The script is made for 10.5,
-however it should be easily modifiable for any other version of the
-operating system. The script assumes that the Steinberg VST libraries
-(not included in this distribution due to Steinberg's licensing terms)
-are in the package subdirectory, ./vst2.x
+### Mac OS X
+A script file, buildJvh.sh, is included for compiling the JVstHost native library under Mac OS X. The script is made for 10.5, however it should be easily modifiable for any other version of the operating system. The script assumes that the Steinberg VST libraries (not included in this distribution due to Steinberg's licensing terms) are in the package subdirectory, `./vst2.x`. The script will also copy the resulting library, `libjvsthost2.jnilib`, to `/Library/Java/Extensions`. An ant build script is included to build and test the Java parts of JVstHost. To build the jar: `ant jar`.
-The script will also copy the resulting library, libjvsthost2.jnilib,
-to /Library/Java/Extensions.
+### Linux
+A script file, `buildJvh_linux.sh`, is included for compiling the JVstHost native library under Linux. The script assumes that the Steinberg VST libraries (not included in this distribution due to Steinberg's licensing terms) are in the package subdirectory, `./vst2.x`.
-###Linux
-A script file, buildJvh_linux.sh, is included for compiling the
-JVstHost native library under Linux. The script assumes that the
-Steinberg VST libraries (not included in this distribution due to
-Steinberg's licensing terms) are in the package subdirectory, ./vst2.x
-
-###Windows
-Compiling the native library is unfortunately somewhat more complicated under Windows.
-We use Cygwin (http://www.cygwin.com/) and MinGW (http://www.mingw.org/), and not
-Visual Studio (it was hard enough for us to get a hold of a Windows machine to develop on,
-let alone Visual Studio). Use the buildJvh_win.sh script.
-
-
-Mac OS X / Linux
-
-An ant build script is included to build and test the Java parts of JVstHost. to build the jar:
-
-cd jvsthost
-ant jar
+### Windows
+Compiling the native library is unfortunately somewhat more complicated under Windows. We use [Cygwin](http://www.cygwin.com/) and [MinGW](http://www.mingw.org/), and not Visual Studio (it was hard enough for us to get a hold of a Windows machine to develop on, let alone Visual Studio). Use the `buildJvh_win.sh` script.
-## PROGRAMMING API
+## Programming API
There is a basic idiom to loading a VST, which is written below.
Please sign in to comment.
Something went wrong with that request. Please try again.