1 |
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>JSampler Manual</title><link rel="stylesheet" href="jsampler.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.71.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id249551"></a>JSampler Manual</h1></div><div><div class="author"><h3 class="author"><span class="firstname">by Grigor</span> <span class="surname">Iliev</span></h3></div></div><div><p class="copyright">Copyright © 2007 Grigor Iliev <grigor@grigoriliev.com></p></div><div><div class="legalnotice"><a name="id257667"></a><p>This document is released under the terms of the <a href="gfdl.html" target="_top">GNU Free Documentation License</a>.</p></div></div><div><p class="pubdate">Updated: Thu, 17 May 2007</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#id249707">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id249712">What is JSampler?</a></span></dt><dt><span class="section"><a href="#id249760">What is a JSampler distribution?</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id249967">2. Screenshots</a></span></dt><dt><span class="chapter"><a href="#id249994">3. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id250002">What to download?</a></span></dt><dt><span class="section"><a href="#id250145">Requirements</a></span></dt><dt><span class="section"><a href="#id250175">Running a JSampler distribution</a></span></dt><dt><span class="section"><a href="#id250286">Using a script to run a JSampler distribution</a></span></dt><dt><span class="section"><a href="#id250308">Telling Gnome how to handle jar files</a></span></dt><dt><span class="section"><a href="#id250385">Adding an application launcher to a Gnome panel</a></span></dt><dt><span class="section"><a href="#id250449">Running JSampler on Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id251445">4. Building from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id251461">Building from CVS</a></span></dt><dt><span class="section"><a href="#id251537">Compilation</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id249707"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id249712">What is JSampler?</a></span></dt><dt><span class="section"><a href="#id249760">What is a JSampler distribution?</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id249712"></a>What is JSampler?</h2></div></div></div><p>JSampler is an opensource, platform-independent, GUI front-end for |
2 |
<a href="http://www.linuxsampler.org" target="_top">LinuxSampler</a>, written |
3 |
entirely in <a href="http://java.sun.com" target="_top">Java</a>. The main goal |
4 |
of the JSampler's design is to be extensible and more flexible regarding |
5 |
the integration of different GUI implementations. JSampler consists of |
6 |
two parts:</p><div class="itemizedlist"><ul type="disc"><li><p>JSampler core - handles the LSCP command processing and |
7 |
event notifications, sent by LinuxSampler, and provides convenient |
8 |
data models and controllers to be used instead. The core also |
9 |
provides the necessary interfaces that should be implemented by |
10 |
all JSamler views.</p></li><li><p>JSampler view - an extension to the JSampler core, which |
11 |
provides the user interface part of JSampler.</p></li></ul></div><p>The main reason for that is the TCP/IP based |
12 |
communication between the LinuxSampler and its front-ends, enabling the |
13 |
sampler to be controlled from another computer or device, which may have |
14 |
different display requirements and limitations.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id249760"></a>What is a JSampler distribution?</h2></div></div></div><p>A JSampler distribution consist of the JSampler core and at least |
15 |
one view, providing the GUI implementation. Each distribution has its |
16 |
own name, which is based on the integrated view extension. Currently, |
17 |
there are two distributions:</p><div class="itemizedlist"><ul type="disc"><li><p>JS Classic - A distribution with a standard GUI, capable of |
18 |
controlling all features available in LinuxSampler at the time of |
19 |
this writing. JS Classic also provides some additional features to |
20 |
facilitate the every day work with the sampler and to automate the |
21 |
most frequently used configurations.</p></li><li><p>Fantasia - A distribution with a skin based view, which is |
22 |
in early development stage and is only partially implemented |
23 |
(graphic design by Olivier Boyer).</p></li></ul></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id249967"></a>Chapter 2. Screenshots</h2></div></div></div><p>JS Classic with left pane, LS console, statusbar and |
24 |
toolbars</p><div><img src="images/js-classic1.png"></div><p>JS Classic without left pane, LS console, statusbar and |
25 |
toolbars</p><div><img src="images/js-classic2.png"></div><p>Fantasia</p><div><img src="images/fantasia.png"></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id249994"></a>Chapter 3. Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id250002">What to download?</a></span></dt><dt><span class="section"><a href="#id250145">Requirements</a></span></dt><dt><span class="section"><a href="#id250175">Running a JSampler distribution</a></span></dt><dt><span class="section"><a href="#id250286">Using a script to run a JSampler distribution</a></span></dt><dt><span class="section"><a href="#id250308">Telling Gnome how to handle jar files</a></span></dt><dt><span class="section"><a href="#id250385">Adding an application launcher to a Gnome panel</a></span></dt><dt><span class="section"><a href="#id250449">Running JSampler on Windows</a></span></dt></dl></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250002"></a>What to download?</h2></div></div></div><p>Currently, there are two distributions available for download - JS |
26 |
Classic and Fantasia. However, for now the preferred choice is JS |
27 |
Classic, because Fantasia is only partially implemented. The latest |
28 |
version of JS Classic is available for download from <a href="http://downloads.sourceforge.net/jsampler/JS_Classic-0.5a.jar" target="_top">here</a>.</p><p>The source code is available in the <a href="http://downloads.sourceforge.net/jsampler/JSampler-0.5a.tar.bz2" target="_top">JSampler |
29 |
package</a>, which also contains this manual and startup scripts |
30 |
that can be used to run a particular JSampler distribution.</p><p>The latest source code can be obtained from cvs with the following |
31 |
command:</p><p><span><strong class="command">cvs -z3 |
32 |
-d:pserver:anonymous@cvs.linuxsampler.org:/var/cvs/linuxsampler co |
33 |
jsampler</strong></span></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250145"></a>Requirements</h2></div></div></div><p>To run JSampler you need Java Runtime Environment (JRE) version 6 |
34 |
or higher. The latest version can be downloaded from <a href="http://java.sun.com/javase/downloads/" target="_top">here</a>.</p><p>To build JSampler distribution from source you need JDK version |
35 |
6.0 or higher and the <a href="http://ant.apache.org/" target="_top">Ant |
36 |
tool</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250175"></a>Running a JSampler distribution</h2></div></div></div><p>Let's assume that you want to run from the command line |
37 |
<code class="code">JS_Classic-0.5a.jar</code>, which is located in |
38 |
<code class="code">/home/me/soft</code> directory. First you should check whether the |
39 |
<code class="code">java</code> command is in your path and the version requirements |
40 |
are met. This can be done by issuing the following command:</p><p><span><strong class="command">java -version</strong></span></p><p>If the version is 1.6.0 or higher you can run JS Classic by |
41 |
issuing the following command:</p><p><span><strong class="command">java -jar |
42 |
/home/me/soft/JS_Classic-0.5a.jar</strong></span></p><p>Otherwise, if the shell response is something like</p><p><span><strong class="command">bash: java: command not found</strong></span></p><p>or the version requirements are not met, make sure that you have |
43 |
installed JRE (or JDK) with the proper version and find its |
44 |
location:</p><div class="literallayout"><p><span><strong class="command">updatedb<br> |
45 |
locate bin/java</strong></span></p></div><p>The shell should return something like:</p><div class="literallayout"><p><span><strong class="command">/opt/jdk1.6.0/bin/java<br> |
46 |
/opt/jdk1.6.0/bin/javac<br> |
47 |
/opt/jdk1.6.0/bin/javadoc<br> |
48 |
/opt/jdk1.6.0/bin/javah<br> |
49 |
/opt/jdk1.6.0/bin/javap<br> |
50 |
/opt/jdk1.6.0/jre/bin/java<br> |
51 |
/usr/bin/java</strong></span></p></div><p>Now, we know that we have a JDK with a proper version installed |
52 |
and its location is <code class="code">/opt/jdk1.6.0</code>. In that case, to run JS |
53 |
Classic issue the following command:</p><p><span><strong class="command">/opt/jdk1.6.0/bin/java -jar |
54 |
/home/me/soft/JS_Classic-0.5a.jar</strong></span></p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>On some systems double clicking on the jar file will be |
55 |
enough.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250286"></a>Using a script to run a JSampler distribution</h2></div></div></div><p>There are scripts In the <code class="code">scripts</code> directory of the |
56 |
<a href="http://downloads.sourceforge.net/jsampler/JSampler-0.5a.tar.bz2" target="_top">JSampler |
57 |
package</a> that, with a little adjustments (if needed), can be used |
58 |
to run a JSampler distribution. Copy them to a desired location and edit |
59 |
with your preferred editor.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250308"></a>Telling Gnome how to handle jar files</h2></div></div></div><p>This configuration is optional, but necessary if you want to run |
60 |
jar files by (double) clicking on them. In Gnome, by default jar files |
61 |
are opened with the Archive Manager. To change that, run a file browser, |
62 |
right click on an arbitrary jar file and choose |
63 |
<span class="guimenu">Properties</span>, than go to the <span class="guilabel">Open |
64 |
With</span> tab and click the <span class="guibutton">Add</span> |
65 |
button.</p><div><img src="images/file-properties.png"></div><p>In the <span class="guilabel">Add Application</span> dialog click onto |
66 |
<span class="guilabel">Use a custom command</span> label and a text field will |
67 |
appear below. If the location of your JRE is <code class="code">/opt/jre1.6.0</code>, |
68 |
then enter the following command in the text box:</p><p><span><strong class="command">/opt/jre1.6.0/bin/java -jar</strong></span></p><p>And then click the <span class="guibutton">Add</span> button.</p><div><img src="images/add-application.png"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250385"></a>Adding an application launcher to a Gnome panel</h2></div></div></div><p>To add an application launcher to a Gnome panel, right click on |
69 |
the panel and choose <span class="guimenu">Add to Panel</span>.</p><div><img src="images/add-to-panel.png"></div><p>Then select <span class="guilabel">Custom Application Launcher</span> and |
70 |
click the <span class="guibutton">Add</span> button. In the |
71 |
<span class="guilabel">Command</span> field, of the <span class="guilabel">Create |
72 |
Launcher</span> dialog, fill in the exact command that you use to |
73 |
run the JSampler. For more information on how to run a JSampler |
74 |
distribution from the command line <a href="#running-js-dist">click |
75 |
here</a>.</p><div><img src="images/add-to-panel-create-launcher.png"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id250449"></a>Running JSampler on Windows</h2></div></div></div><p>To run JSampler distribution on Windows, put a shortcut on the |
76 |
Desktop or Quick Launch, right click on the shortcut and choose |
77 |
<span class="guimenu">Properties</span>. In the <span class="guilabel">Target</span> field |
78 |
insert the command <code class="code">javaw -jar</code> in the beginning.</p><div><img src="images/win-shortcut.png"></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id251445"></a>Chapter 4. Building from source</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id251461">Building from CVS</a></span></dt><dt><span class="section"><a href="#id251537">Compilation</a></span></dt></dl></div><p>If you want to build a JSampler distribution from source, first make |
79 |
sure that all <a href="#requirements">requirements</a> are |
80 |
met.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id251461"></a>Building from CVS</h2></div></div></div><p>When building from CVS, there are some additional steps that |
81 |
should be done. JSampler uses two additional libraries, that should be |
82 |
downloaded and placed in the <code class="code">lib/required</code> directory:</p><div class="itemizedlist"><ul type="disc"><li><p><a href="http://sourceforge.net/projects/jlscp/" target="_top">jlscp</a> - A |
83 |
java LinuxSampler control protocol API</p></li><li><p><a href="http://sourceforge.net/projects/juife/" target="_top">juife</a> - Java |
84 |
User Interface Framework Extensions</p></li></ul></div><p>Download these libraries, create a |
85 |
<code class="code">lib/required</code> directory in the JSampler root and copy the |
86 |
<code class="code">jlscp.jar</code> and <code class="code">juife.jar</code> files in that |
87 |
directory:</p><div class="literallayout"><p><span><strong class="command">cd /home/me/soft<br> |
88 |
wget -c http://downloads.sourceforge.net/jlscp/jlscp-0.5a.tar.bz2<br> |
89 |
tar -xjf jlscp-0.5a.tar.bz2<br> |
90 |
wget -c http://downloads.sourceforge.net/juife/juife-0.4a.tar.bz2<br> |
91 |
tar -xjf juife-0.4a.tar.bz2<br> |
92 |
cvs -z3 -d:pserver:anonymous@cvs.linuxsampler.org:/var/cvs/linuxsampler co jsampler<br> |
93 |
cd jsampler<br> |
94 |
mkdirhier lib/required<br> |
95 |
cp ../jlscp-0.5a/lib/jlscp.jar lib/required/jlscp.jar<br> |
96 |
cp ../juife-0.4a/lib/juife.jar lib/required/juife.jar</strong></span></p></div><p>Then follow the steps in the next section.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id251537"></a>Compilation</h2></div></div></div><p>To build a JSampler distribution, first set the |
97 |
<code class="code">JAVA_HOME</code> environment variable to point to your JDK |
98 |
directory. If the JDK is installed in /opt/jdk1.6.0 directory, this can |
99 |
be done by issuing the following command:</p><p><span><strong class="command">export JAVA_HOME=/opt/jdk1.6.0</strong></span></p><p>Windows users should do something like:</p><p><span><strong class="command">set JAVA_HOME=c:\jdk1.6.0</strong></span></p><p>Go to the JSampler root directory and issue the following |
100 |
command:</p><p><span><strong class="command">ant [target]</strong></span></p><p>Where <code class="code">target</code> can be one of the following:</p><div class="itemizedlist"><ul type="disc"><li><p><span><strong class="command">build-jsclassic</strong></span> - Builds a JS Classic |
101 |
distribution.</p></li><li><p><span><strong class="command">clean-jsclassic</strong></span> - Removes the JS Classic |
102 |
distribution.</p></li><li><p><span><strong class="command">build-fantasia</strong></span> - Builds a Fantasia |
103 |
distribution.</p></li><li><p><span><strong class="command">clean-fantasia</strong></span> - Removes the Fantasia |
104 |
distribution.</p></li><li><p><span><strong class="command">build-coredoc</strong></span> - Generates the API |
105 |
documentation for the JSampler core.</p></li><li><p><span><strong class="command">clean-coredoc</strong></span> - Removes the API |
106 |
documentation for the JSampler core.</p></li></ul></div><p>So, if you want to build a JS Classic distribution, just issue the |
107 |
following command:</p><p><span><strong class="command">ant build-jsclassic</strong></span></p><p>Then copy the jar file from the <code class="code">dist</code> directory to the |
108 |
desired location.</p></div></div></div></body></html> |