/[svn]/web/trunk/www.linuxsampler.org/jsampler/manual/html/jsampler.html
ViewVC logotype

Annotation of /web/trunk/www.linuxsampler.org/jsampler/manual/html/jsampler.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1760 - (hide annotations) (download) (as text)
Tue Aug 26 21:32:24 2008 UTC (13 years, 11 months ago) by iliev
File MIME type: text/html
File size: 39723 byte(s)
- updated the manual

1 iliev 1759 <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="id2423980"></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 © 2008 Grigor Iliev &lt;grigor@grigoriliev.com&gt;</p></div><div><div class="legalnotice"><a name="id2507296"></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: Tue, 26 August 2008</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#INTRODUCTION">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#WHAT_IS_JSAMPLER">What is JSampler?</a></span></dt><dt><span class="section"><a href="#WHAT_IS_JSAMPLER_DISTRIBUTION">What is a JSampler distribution?</a></span></dt></dl></dd><dt><span class="chapter"><a href="#SCREENSHOTS">2. Screenshots</a></span></dt><dt><span class="chapter"><a href="#INSTALLATION">3. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#DOWNLOAD">What to download?</a></span></dt><dt><span class="section"><a href="#REQUIREMENTS">Requirements</a></span></dt><dt><span class="section"><a href="#RUNNING_JSAMPLER">Running a JSampler distribution</a></span></dt><dt><span class="section"><a href="#USING_SCRIPT">Using a script to run a JSampler distribution</a></span></dt><dt><span class="section"><a href="#GNOME_JAR_ASSOCIATIONS">Telling Gnome how to handle jar files</a></span></dt><dt><span class="section"><a href="#GNOME_LAUNCHER">Adding an application launcher to a Gnome panel</a></span></dt><dt><span class="section"><a href="#RUNING_ON_WINDOWS">Running JSampler on Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="#BUILDING_FROM_SOURCE">4. Building from source</a></span></dt><dd><dl><dt><span class="section"><a href="#BUILDING_FROM_CVS">Building from CVS</a></span></dt><dt><span class="section"><a href="#COMPILATION">Compilation</a></span></dt></dl></dd><dt><span class="chapter"><a href="#USING_ORCHESTRAS">5. Using Orchestras</a></span></dt><dd><dl><dt><span class="section"><a href="#MANAGING_ORCHESTRAS">Managing Orchestras</a></span></dt><dt><span class="section"><a href="#MANAGING_INSTRUMENTS">Managing Instruments</a></span></dt><dt><span class="section"><a href="#LOADING_ORCHESTRA_INSTRUMENTS">Loading Instruments</a></span></dt></dl></dd><dt><span class="chapter"><a href="#MIDI_INSTRUMENTS">6. MIDI Instruments</a></span></dt><dd><dl><dt><span class="section"><a href="#id2479911">Managing MIDI Instrument Maps</a></span></dt><dt><span class="section"><a href="#id2480012">Managing MIDI Instruments</a></span></dt><dt><span class="section"><a href="#id2480118">Assigning MIDI Instrument Map To Sampler Channel</a></span></dt></dl></dd><dt><span class="chapter"><a href="#INSTRUMENTS_DATABASE">7. Instruments Database</a></span></dt><dd><dl><dt><span class="section"><a href="#id2480256">Adding Instruments To The Instruments Database</a></span></dt><dt><span class="section"><a href="#id2480326">Manging Instruments And Directories</a></span></dt><dt><span class="section"><a href="#id2480489">Loading Instruments From The Instruments Database</a></span></dt><dt><span class="section"><a href="#INSTRUMENTS_DB_ADD_TO_MAP">Adding Instruments To MIDI Instrument Map</a></span></dt><dt><span class="section"><a href="#id2480561">Adding Instruments To Orchestra From The Instruments
2     Database</a></span></dt><dt><span class="section"><a href="#id2480604">Finding Instruments</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="INTRODUCTION"></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="#WHAT_IS_JSAMPLER">What is JSampler?</a></span></dt><dt><span class="section"><a href="#WHAT_IS_JSAMPLER_DISTRIBUTION">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="WHAT_IS_JSAMPLER"></a>What is JSampler?</h2></div></div></div><p>JSampler is an opensource, platform-independent, GUI front-end for
3     <a href="http://www.linuxsampler.org" target="_top">LinuxSampler</a>, written
4     entirely in <a href="http://java.sun.com" target="_top">Java</a>. The main goal
5 iliev 1146 of the JSampler's design is to be extensible and more flexible regarding
6     the integration of different GUI implementations. JSampler consists of
7     two parts:</p><div class="itemizedlist"><ul type="disc"><li><p>JSampler core - handles the LSCP command processing and
8     event notifications, sent by LinuxSampler, and provides convenient
9     data models and controllers to be used instead. The core also
10     provides the necessary interfaces that should be implemented by
11     all JSamler views.</p></li><li><p>JSampler view - an extension to the JSampler core, which
12     provides the user interface part of JSampler.</p></li></ul></div><p>The main reason for that is the TCP/IP based
13     communication between the LinuxSampler and its front-ends, enabling the
14     sampler to be controlled from another computer or device, which may have
15 iliev 1584 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="WHAT_IS_JSAMPLER_DISTRIBUTION"></a>What is a JSampler distribution?</h2></div></div></div><p>A JSampler distribution consist of the JSampler core and at least
16 iliev 1146 one view, providing the GUI implementation. Each distribution has its
17     own name, which is based on the integrated view extension. Currently,
18     there are two distributions:</p><div class="itemizedlist"><ul type="disc"><li><p>JS Classic - A distribution with a standard GUI, capable of
19     controlling all features available in LinuxSampler at the time of
20     this writing. JS Classic also provides some additional features to
21     facilitate the every day work with the sampler and to automate the
22 iliev 1288 most frequently used configurations.</p></li><li><p>Fantasia - A distribution with a modern skin based view
23 iliev 1759 (initial 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="SCREENSHOTS"></a>Chapter 2. Screenshots</h2></div></div></div><p>JS Classic with left pane, LS console, statusbar and toolbars</p><p><a href="images/js-classic1.png" target="_top"><img src="images/js-classic1-preview.png"></a></p><p>JS Classic without left pane, LS console, statusbar and
24     toolbars</p><p><a href="images/js-classic2.png" target="_top"><img src="images/js-classic2-preview.png"></a></p><p>Fantasia</p><p><a href="images/fantasia.png" target="_top"><img src="images/fantasia-preview.png"></a></p></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="INSTALLATION"></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="#DOWNLOAD">What to download?</a></span></dt><dt><span class="section"><a href="#REQUIREMENTS">Requirements</a></span></dt><dt><span class="section"><a href="#RUNNING_JSAMPLER">Running a JSampler distribution</a></span></dt><dt><span class="section"><a href="#USING_SCRIPT">Using a script to run a JSampler distribution</a></span></dt><dt><span class="section"><a href="#GNOME_JAR_ASSOCIATIONS">Telling Gnome how to handle jar files</a></span></dt><dt><span class="section"><a href="#GNOME_LAUNCHER">Adding an application launcher to a Gnome panel</a></span></dt><dt><span class="section"><a href="#RUNING_ON_WINDOWS">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="DOWNLOAD"></a>What to download?</h2></div></div></div><p>Currently, there are two distributions available for download -
25     <a href="http://downloads.sourceforge.net/jsampler/JS_Classic-0.8a.jar" target="_top">JS
26     Classic</a> and <a href="http://downloads.sourceforge.net/jsampler/Fantasia-0.8a.jar" target="_top">Fantasia</a>.</p><p>The source code is available in the <a href="http://downloads.sourceforge.net/jsampler/JSampler-0.8a.tar.bz2" target="_top">JSampler
27 iliev 1146 package</a>, which also contains this manual and startup scripts
28     that can be used to run a particular JSampler distribution.</p><p>The latest source code can be obtained from cvs with the following
29 iliev 1759 command:</p><p><span><strong class="command">cvs -z3
30 iliev 1146 -d:pserver:anonymous@cvs.linuxsampler.org:/var/cvs/linuxsampler co
31 iliev 1584 jsampler</strong></span></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="REQUIREMENTS"></a>Requirements</h2></div></div></div><p>To run JSampler you need Java Runtime Environment (JRE) version 6
32 iliev 1759 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
33     6.0 or higher and the <a href="http://ant.apache.org/" target="_top">Ant
34 iliev 1584 tool</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="RUNNING_JSAMPLER"></a>Running a JSampler distribution</h2></div></div></div><p>Let's assume that you want to run from the command line
35     <code class="code">JS_Classic-0.8a.jar</code>, which is located in
36 iliev 1146 <code class="code">/home/me/soft</code> directory. First you should check whether the
37     <code class="code">java</code> command is in your path and the version requirements
38 iliev 1759 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
39     issuing the following command:</p><p><span><strong class="command">java -jar
40     /home/me/soft/JS_Classic-0.8a.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
41 iliev 1146 installed JRE (or JDK) with the proper version and find its
42 iliev 1759 location:</p><div class="literallayout"><p><span><strong class="command">updatedb<br>
43     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>
44 iliev 1146 /opt/jdk1.6.0/bin/javac<br>
45     /opt/jdk1.6.0/bin/javadoc<br>
46     /opt/jdk1.6.0/bin/javah<br>
47     /opt/jdk1.6.0/bin/javap<br>
48     /opt/jdk1.6.0/jre/bin/java<br>
49     /usr/bin/java</strong></span></p></div><p>Now, we know that we have a JDK with a proper version installed
50     and its location is <code class="code">/opt/jdk1.6.0</code>. In that case, to run JS
51 iliev 1759 Classic issue the following command:</p><p><span><strong class="command">/opt/jdk1.6.0/bin/java -jar
52 iliev 1584 /home/me/soft/JS_Classic-0.8a.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
53     enough.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="USING_SCRIPT"></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
54 iliev 1759 <a href="http://downloads.sourceforge.net/jsampler/JSampler-0.8a.tar.bz2" target="_top">JSampler
55 iliev 1146 package</a> that, with a little adjustments (if needed), can be used
56     to run a JSampler distribution. Copy them to a desired location and edit
57 iliev 1584 with your preferred editor.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="GNOME_JAR_ASSOCIATIONS"></a>Telling Gnome how to handle jar files</h2></div></div></div><p>This configuration is optional, but necessary if you want to run
58 iliev 1146 jar files by (double) clicking on them. In Gnome, by default jar files
59     are opened with the Archive Manager. To change that, run a file browser,
60     right click on an arbitrary jar file and choose
61     <span class="guimenu">Properties</span>, than go to the <span class="guilabel">Open
62     With</span> tab and click the <span class="guibutton">Add</span>
63     button.</p><div><img src="images/file-properties.png"></div><p>In the <span class="guilabel">Add Application</span> dialog click onto
64     <span class="guilabel">Use a custom command</span> label and a text field will
65     appear below. If the location of your JRE is <code class="code">/opt/jre1.6.0</code>,
66 iliev 1759 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="GNOME_LAUNCHER"></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
67 iliev 1146 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
68     click the <span class="guibutton">Add</span> button. In the
69     <span class="guilabel">Command</span> field, of the <span class="guilabel">Create
70     Launcher</span> dialog, fill in the exact command that you use to
71     run the JSampler. For more information on how to run a JSampler
72 iliev 1759 distribution from the command line <a href="#RUNNING_JSAMPLER" title="Running a JSampler distribution">click 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="RUNING_ON_WINDOWS"></a>Running JSampler on Windows</h2></div></div></div><p>To run JSampler distribution on Windows, put a shortcut on the
73 iliev 1146 Desktop or Quick Launch, right click on the shortcut and choose
74     <span class="guimenu">Properties</span>. In the <span class="guilabel">Target</span> field
75 iliev 1584 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="BUILDING_FROM_SOURCE"></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="#BUILDING_FROM_CVS">Building from CVS</a></span></dt><dt><span class="section"><a href="#COMPILATION">Compilation</a></span></dt></dl></div><p>If you want to build a JSampler distribution from source, first make
76 iliev 1759 sure that all <a href="#REQUIREMENTS" title="Requirements">requirements</a> are
77 iliev 1584 met.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="BUILDING_FROM_CVS"></a>Building from CVS</h2></div></div></div><p>When building from CVS, there are some additional steps that
78 iliev 1146 should be done. JSampler uses two additional libraries, that should be
79 iliev 1759 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
80     java LinuxSampler control protocol API</p></li><li><p><a href="http://sourceforge.net/projects/juife/" target="_top">juife</a> - Java
81 iliev 1146 User Interface Framework Extensions</p></li></ul></div><p>Download these libraries, create a
82     <code class="code">lib/required</code> directory in the JSampler root and copy the
83     <code class="code">jlscp.jar</code> and <code class="code">juife.jar</code> files in that
84 iliev 1759 directory:</p><div class="literallayout"><p><span><strong class="command">cd /home/me/soft<br>
85 iliev 1584 wget -c http://downloads.sourceforge.net/jlscp/jlscp-0.7a.tar.bz2<br>
86     tar -xjf jlscp-0.7a.tar.bz2<br>
87 iliev 1146 wget -c http://downloads.sourceforge.net/juife/juife-0.4a.tar.bz2<br>
88     tar -xjf juife-0.4a.tar.bz2<br>
89     cvs -z3 -d:pserver:anonymous@cvs.linuxsampler.org:/var/cvs/linuxsampler co jsampler<br>
90     cd jsampler<br>
91     mkdirhier lib/required<br>
92 iliev 1203 cp ../jlscp-0.5a/lib/jlscp.jar lib/required/jlscp.jar<br>
93 iliev 1758 cp ../juife-0.4a/lib/juife.jar lib/required/juife.jar</strong></span></p></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>In most cases it is sufficient just to copy the
94 iliev 1759 <span><strong class="command">lib</strong></span> directory from the last release, but first
95 iliev 1758 check if there are some significant recent changes to those
96     libraries.</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="COMPILATION"></a>Compilation</h2></div></div></div><p>To build a JSampler distribution, first set the
97 iliev 1146 <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 iliev 1759 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 iliev 1146 documentation for the JSampler core.</p></li></ul></div><p>So, if you want to build a JS Classic distribution, just issue the
107 iliev 1759 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 iliev 1584 desired location.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="USING_ORCHESTRAS"></a>Chapter 5. Using Orchestras</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#MANAGING_ORCHESTRAS">Managing Orchestras</a></span></dt><dt><span class="section"><a href="#MANAGING_INSTRUMENTS">Managing Instruments</a></span></dt><dt><span class="section"><a href="#LOADING_ORCHESTRA_INSTRUMENTS">Loading Instruments</a></span></dt></dl></div><p>Orchestras feature is like bookmarks/favorites for instruments.
109     Instead of having a thousands of unsorted instruments you can categorize
110     your most used instruments for quick access by adding them to orchestras.
111     You can create an arbitrary number of orchestras and in any orchestra you
112     can add an arbitrary number of instruments.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Orchestras are not handled by the back-end (LinuxSampler) and
113     does not depend on the <span class="guilabel">Instruments Database</span>. The
114     orchestras are handled by JSampler and are stored on the local machine
115     in <code class="code">&lt;jsampler-home&gt;/orchestras.xml</code>. To port the
116 iliev 1758 orchestras to another machine just copy that file.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="MANAGING_ORCHESTRAS"></a>Managing Orchestras</h2></div></div></div><p><span class="guilabel">Manage Orchestras</span> tool buttons:</p><p><img src="images/new16.png"> <span class="guilabel">Create new
117 iliev 1584 orchestra</span></p><p><img src="images/edit16.png"> <span class="guilabel">Edit
118     selected orchestra</span></p><p><img src="images/delete16.png"> <span class="guilabel">Remove
119     selected orchestra</span></p><p>To create a new orchestra, click on the
120     <span class="guilabel">Orchestras</span> tab then click the <span class="guibutton">Create new
121     orchestra</span> button in the <span class="guilabel">Manage
122     Orchestras</span> tool:</p><div align="center"><img src="images/new-orchestra.png" align="middle"></div><p>Then
123     choose orchestra name and description and click
124 iliev 1758 <span class="guibutton">OK</span> button.</p><p>To remove an orchestra, select the orchestra and click the
125 iliev 1584 <span class="guibutton">Remove selected orchestra</span> button. To edit an
126     orchestra, select the orchestra and click the <span class="guibutton">Edit selected
127     orchestra</span> button, or just double-click the orchestra to
128     edit.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>To change the position of an orchestra in the orchestra list,
129     select the orchestra and use <span class="guilabel">Alt+Up Arrow</span> and
130     <span class="guilabel">Alt+Down Arrow</span> to move the selected orchestra
131     up/down. You can also use <span class="guilabel">Alt+Shift+Up Arow</span> to
132     move the selected orchestra on top and <span class="guilabel">Alt+Shift+Down
133 iliev 1758 Arrow</span> to move the selected orchestra to bottom.</p></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="MANAGING_INSTRUMENTS"></a>Managing Instruments</h2></div></div></div><p><span class="guilabel">Managing Instruments</span> tool buttons:</p><p><img src="images/new16.png"> <span class="guilabel">Add new
134 iliev 1584 instrument</span></p><p><img src="images/edit16.png"> <span class="guilabel">Edit
135     selected instrument</span></p><p><img src="images/delete16.png"> <span class="guilabel">Remove
136     selected instrument</span></p><p>To add a new instrument to orchestra, first select the desired
137     orchestra from the combobox then click the <span class="guilabel">Add new
138     instrument</span> button:</p><div align="center"><img src="images/add-instrument-to-orchestra.png" align="middle"></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>The easiest way to add an instrument to orchestra is to
139     right-click an instrument in the <span class="guilabel">Instruments
140     Database</span>, then select <span class="guimenu">Add To Orchestra</span>
141     and choose the orchestra to which to add the selected instrument.
142     Note that you can select and add more than one instrument to
143     orchestra at once.</p></div><p>To remove an instrument, select the instrument and click the
144     <span class="guibutton">Remove selected instrument</span> button. To edit an
145     instrument, select the instrument and click the <span class="guibutton">Edit selected
146     instrument</span> button, or just double-click the instrument to
147     edit.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>To change the position of an instrument in the instrument
148     list, select the instrument and use <span class="guilabel">Alt+Up
149     Arrow</span> and <span class="guilabel">Alt+Down Arrow</span> to move the
150     selected instrument up/down. You can also use <span class="guilabel">Alt+Shift+Up
151     Arow</span> to move the selected instrument on top and
152     <span class="guilabel">Alt+Shift+Down Arrow</span> to move the selected
153     instrument to bottom.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="LOADING_ORCHESTRA_INSTRUMENTS"></a>Loading Instruments</h2></div></div></div><p>To load an instrument from orchestra to a sampler channel,
154     right-click on the instrument, select <span class="guimenu">Load
155     Instrument</span>, then choose on which channel to load the selected
156     instrument. You can also load an instrument from orchestra to a sampler
157     channel using the instrument chooser of the sampler channel - click
158     <span class="guilabel">Select instrument from orchestra</span> radio button,
159     choose orchestra and isntrument from the comboboxes and click
160 iliev 1759 <span class="guibutton">OK</span> button</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="MIDI_INSTRUMENTS"></a>Chapter 6. MIDI Instruments</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2479911">Managing MIDI Instrument Maps</a></span></dt><dt><span class="section"><a href="#id2480012">Managing MIDI Instruments</a></span></dt><dt><span class="section"><a href="#id2480118">Assigning MIDI Instrument Map To Sampler Channel</a></span></dt></dl></div><p>The sole purpose of the MIDI instrument mapping is to provide a way
161 iliev 1758 to change the loaded instrument on a specific sampler channel through the
162     MIDI keyboard by switching to different MIDI bank/program. To do that you
163     need at least one MIDI instrument map with MIDI instruments mapped for the
164     desired MIDI banks/programs and to assign that map to the sampler channels
165     which instruments should be switched using MIDI bank/program
166     changes.</p><p>Note that when stopping LinuxSampler all MIDI instrument mappings
167     are gone forever, so it is crucial to export the MIDI instrument maps
168     before quiting your session to be able to load them again next time you
169     start LinuxSampler. This can be done by choosing
170     <span class="guimenu">Actions</span>/<span class="guimenu">Export</span>/<span class="guimenu">MIDI
171 iliev 1759 Instrument Maps</span>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2479911"></a>Managing MIDI Instrument Maps</h2></div></div></div><p><span class="guilabel">MIDI Instrument Maps</span> tool buttons:</p><p><img src="images/new16.png"> <span class="guilabel">Add MIDI
172 iliev 1758 instrument map</span></p><p><img src="images/edit16.png"> <span class="guilabel">Edit
173     selected MIDI instrument map</span></p><p><img src="images/delete16.png"> <span class="guilabel">Remove
174     selected MIDI instrument map</span></p><p>To create a new MIDI instrument map, click the <span class="guilabel">MIDI
175     Instruments</span> tab in the Left-Side pane then click the
176     <span class="guibutton">Add MIDI instrument map</span> button.</p><div><img src="images/add-midi-map.png"></div><p>Then choose map name and click <span class="guibutton">OK</span>
177     button.</p><p>To remove a map, select the map and click the <span class="guibutton">Remove
178     selected MIDI instrument map</span> button. To edit a map, select
179     the map and click the <span class="guibutton">Edit selected MIDI instrument
180 iliev 1759 map</span> button, or just double-click the map to edit.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480012"></a>Managing MIDI Instruments</h2></div></div></div><p><span class="guilabel">Managing MIDI Instruments</span> tool
181 iliev 1758 buttons:</p><p><img src="images/new16.png"> <span class="guilabel">Add new
182     MIDI instrument</span></p><p><img src="images/edit16.png"> <span class="guilabel">Edit
183     selected MIDI instrument</span></p><p><img src="images/delete16.png"> <span class="guilabel">Remove
184     selected MIDI instrument or bank</span></p><p>To map a MIDI instrument, first select the desired MIDI instrument
185     map from the combobox then click the <span class="guilabel">Add new MIDI
186 iliev 1759 instrument</span> button:</p><div align="center"><img src="images/map-midi-instrument.png" align="middle"></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>The <a href="#INSTRUMENTS_DB_ADD_TO_MAP" title="Adding Instruments To MIDI Instrument Map">easiest way to
187     map a MIDI instrument</a> is from the <a href="#INSTRUMENTS_DATABASE" title="Chapter 7. Instruments Database">Instruments Database</a>.</p></div><p>To remove a MIDI bank/instrument, select the MIDI
188 iliev 1758 bank/instrument and click the <span class="guibutton">Remove selected MIDI instrument
189     or bank</span> button. To edit a MIDI instrument, select the MIDI
190     instrument and click the <span class="guibutton">Edit selected MIDI
191     instrument</span> button, or just double-click the MIDI instrument
192 iliev 1759 to edit.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480118"></a>Assigning MIDI Instrument Map To Sampler Channel</h2></div></div></div><p>To assign MIDI instrument map to specific sampler channel, click
193 iliev 1758 the <span class="guibutton">Options</span> button to expand the channel options
194     pane then select the desired map from the <span class="guilabel">MIDI Instrument
195 iliev 1759 Map</span> combobox:</p><div><img src="images/assign-midi-map.png"></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="INSTRUMENTS_DATABASE"></a>Chapter 7. Instruments Database</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2480256">Adding Instruments To The Instruments Database</a></span></dt><dt><span class="section"><a href="#id2480326">Manging Instruments And Directories</a></span></dt><dt><span class="section"><a href="#id2480489">Loading Instruments From The Instruments Database</a></span></dt><dt><span class="section"><a href="#INSTRUMENTS_DB_ADD_TO_MAP">Adding Instruments To MIDI Instrument Map</a></span></dt><dt><span class="section"><a href="#id2480561">Adding Instruments To Orchestra From The Instruments
196     Database</a></span></dt><dt><span class="section"><a href="#id2480604">Finding Instruments</a></span></dt></dl></div><p>The communication between LinuxSampler and its front-ends is TCP/IP
197 iliev 1758 based, which provides an option the sampler to be controlled from another
198     computer or device, and while instrument loading is a regular task in the
199     sampler, there should also be a convenient way to browse and load
200     instruments (located on the sampler box) from a front-end launched on a
201     remote host. This need is well covered by the <span class="guilabel">Instruments
202     Database</span>. However, this is not the only purpose of the
203     Instruments Database. It is a great tool that helps you to not get lost in
204     your instrument collection, providing you a flexible way to create your
205     own tree structure and to organize your instruments in more than one way,
206     without moving or altering the instrument files located all over your hard
207     drives. Another great feature is the search engine with enhanced search
208     capabilities providing you fast and easy way of finding instruments by
209 iliev 1759 various criteria.</p><p>It is crucial to understand that, unlike <a href="#USING_ORCHESTRAS" title="Chapter 5. Using Orchestras">Orchestras</a>, the Instruments Database is
210 iliev 1758 handled by LinuxSampler, not by JSampler, and by default the database file
211 iliev 1759 is located in <span><strong class="command">/var/lib/linuxsampler/instruments.db</strong></span> on
212 iliev 1758 the host where the back-end is started.</p><p>Note that you can have more than one instruments database and you
213     can specify which one to be used on LinuxSampler startup. To create a new
214 iliev 1759 database file issue the following command:</p><p><span><strong class="command">linuxsampler --create-instruments-db
215 iliev 1758 my_instruments.db</strong></span></p><p>which will create a new database file called
216 iliev 1759 <span><strong class="command">my_instruments.db</strong></span> in the current directory.</p><p>To start LinuxSampler using the newly created instruments database
217     use the <span><strong class="command">--instruments-db-location</strong></span> option:</p><p><span><strong class="command">linuxsampler --instruments-db-location
218 iliev 1758 my_instruments.db</strong></span></p><p>To backup the instruments database just copy the database
219 iliev 1760 file.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480256"></a>Adding Instruments To The Instruments Database</h2></div></div></div><p>Choose <span class="guimenu">Window</span>/<span class="guimenu">Instruments
220 iliev 1758 Database</span> to bring up the Instruments Database window, or
221     click the corresponding tool button. Initialy, the instruments database
222     is empty, so you should manually create the desired directories and add
223     instruments to them.</p><p>To create a new directory, select the directory, in which the new
224     directory should be created and choose
225     <span class="guimenu">Actions</span>/<span class="guimenu">Create Directory</span>, or
226     right-click a blank area and choose <span class="guimenuitem">Create
227     Directory</span>.</p><p>To add instruments to specific instruments database directory, go
228     to that directory and select <span class="guimenu">Actions</span>/<span class="guimenu">Add
229     Instruments</span> submenu, where you have two options - to scan a
230     specific instrument file and add the instruments in that file to the
231     instruments database or scan a file system directory for instrument
232 iliev 1759 files and add the instruments to the instruments database.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480326"></a>Manging Instruments And Directories</h2></div></div></div><p>Basic commands:</p><p><span><strong class="command">Cut</strong></span> -
233 iliev 1758 <span class="guimenu">Edit</span>/<span class="guimenu">Cut</span>, or right-click on a
234     selected file or directory and choose <span class="guibutton">Cut,</span> or
235 iliev 1759 Ctrl+X</p><p><span><strong class="command">Copy</strong></span> -
236 iliev 1758 <span class="guimenu">Edit</span>/<span class="guimenu">Copy</span>, or right-click on a
237     selected file or directory and choose <span class="guibutton">Copy,</span> or
238 iliev 1759 Ctrl+C</p><p><span><strong class="command">Paste</strong></span> -
239 iliev 1758 <span class="guimenu">Edit</span>/<span class="guimenu">Paste</span>, or right-click a blank
240 iliev 1759 area and choose <span class="guibutton">Paste,</span> or Ctrl+V</p><p><span><strong class="command">Rename</strong></span> -
241 iliev 1758 <span class="guimenu">Edit</span>/<span class="guimenu">Rename</span>, or right-click on a
242     selected file or directory and choose <span class="guibutton">Rename,</span> or
243 iliev 1759 press <span><strong class="command">F2</strong></span></p><p><span><strong class="command">Delete</strong></span> -
244 iliev 1758 <span class="guimenu">Actions</span>/<span class="guimenu">Delete</span>, or right-click on
245     a selected file or directory and choose <span class="guibutton">Delete,</span>
246 iliev 1759 or press the <span><strong class="command">Delete</strong></span> key from the keyboard</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>This commands also work on a multiple selection.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480489"></a>Loading Instruments From The Instruments Database</h2></div></div></div><p>To load an instrument to a sampler channel from the Instruments
247 iliev 1758 Database, right-click on the instrument and choose <span class="guimenu">Load
248     Instrument</span>, then choose the sampler channel where the
249     instrument should be loaded to. Note that you need to have at least one
250     sampler channel created, otherwise the <span class="guimenu">Load
251     Instrument</span> submenu is disabled.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="INSTRUMENTS_DB_ADD_TO_MAP"></a>Adding Instruments To MIDI Instrument Map</h2></div></div></div><p>To add an instrument to MIDI instrument map from the Instruments
252     Database, right-click on the instrument and choose <span class="guimenu">Add To MIDI
253     Map</span>, then choose the MIDI instrument map to which to add the
254     selected instrument. Note that you need to have at least one MIDI
255     instrument map, otherwise the <span class="guimenu">Add To MIDI Map</span> submenu
256 iliev 1759 is disabled. For more info read <a href="#MIDI_INSTRUMENTS" title="Chapter 6. MIDI Instruments">MIDI
257 iliev 1758 Instruments</a>.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>To add more than one instrument from an instrument directory
258     at a time, select the instruments and right-click on one of the
259 iliev 1759 selected instruments.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480561"></a>Adding Instruments To Orchestra From The Instruments
260 iliev 1758 Database</h2></div></div></div><p>To add an instrument to orchestra from the Instruments Database,
261     right-click on the instrument and choose <span class="guimenu">Add To
262     Orchestra</span>, then choose the orchestra to which to add the
263     selected instrument. Note that you need to have at least one orchestra,
264     otherwise the <span class="guimenu">Add To Orchestra</span> submenu is disabled.
265 iliev 1759 For more info read <a href="#USING_ORCHESTRAS" title="Chapter 5. Using Orchestras">Using
266 iliev 1758 Orchestras</a>.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>To add more than one instrument from an instrument directory
267     at a time, select the instruments and right-click on one of the
268 iliev 1759 selected instruments.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2480604"></a>Finding Instruments</h2></div></div></div><p>To start a search, choose
269 iliev 1758 <span class="guimenu">Edit</span>/<span class="guimenu">Find</span>, or Ctrl+F.</p></div></div></div></body></html>

  ViewVC Help
Powered by ViewVC