/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html

Parent Directory | Revision Log | View Patch Patch

-revision 1110 by iliev,
Thu Mar 22 21:12:10 2007 UTC
+revision 1363 by schoenebeck,
Sun Sep 30 21:51:14 2007 UTC
 Line 1
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html lang="en"><head><title>LinuxSampler Control Protocol</title>
+ <html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="description" content="LinuxSampler Control Protocol">
+ <meta name="description" content="LinuxSampler Control Protocol (draft)">
  <meta name="keywords" content="LSCP">
  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
  <style type='text/css'><!--
 Line 145
  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
- <tr><td class="header">Expires: September 23, 2007</td><td class="header">March 22, 2007</td></tr>
+ <tr><td class="header">Expires: March 4, 2008</td><td class="header">September 2007</td></tr>
  </table></td></tr></table>
- <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
+ <h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1>
  <h3>Status of this Memo</h3>
  <p>
 Line 173 
 The list of current Internet-Drafts can
  The list of Internet-Draft Shadow Directories can be accessed at
  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
  <p>
- This Internet-Draft will expire on September 23, 2007.</p>
+ This Internet-Draft will expire on March 4, 2008.</p>
  <h3>Copyright Notice</h3>
  <p>
 Line 328 
 Getting amount of effect sends on a samp
  Listing all effect sends on a sampler channel<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
  Getting effect send information<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.30.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
+ Changing effect send's name<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
  Altering effect send's audio routing<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.31.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
  Altering effect send's MIDI controller<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.32.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
  Altering effect send's send level<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.33.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
  Resetting a sampler channel<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
  Controlling connection<br />
-Line 386 
 Remove an entry from the MIDI instrument
+Line 388 
 Remove an entry from the MIDI instrument
  Get current settings of MIDI instrument map entry<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CLEAR MIDI_INSTRUMENTS">6.7.12.</a>&nbsp;
  Clear MIDI instrument map<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Managing Instruments Database">6.8.</a>&nbsp;
+ Managing Instruments Database<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENT_DIRECTORY">6.8.1.</a>&nbsp;
+ Creating a new instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT_DIRECTORY">6.8.2.</a>&nbsp;
+ Deleting an instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORIES">6.8.3.</a>&nbsp;
+ Getting amount of instrument directories<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENT_DIRECTORIES">6.8.4.</a>&nbsp;
+ Listing all directories in specific directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT_DIRECTORY INFO">6.8.5.</a>&nbsp;
+ Getting instrument directory information<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY NAME">6.8.6.</a>&nbsp;
+ Renaming an instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT_DIRECTORY">6.8.7.</a>&nbsp;
+ Moving an instrument directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT_DIRECTORY">6.8.8.</a>&nbsp;
+ Copying instrument directories<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.9.</a>&nbsp;
+ Changing the description of directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENT_DIRECTORIES">6.8.10.</a>&nbsp;
+ Finding directories<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD DB_INSTRUMENTS">6.8.11.</a>&nbsp;
+ Adding instruments to the instruments database<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE DB_INSTRUMENT">6.8.12.</a>&nbsp;
+ Removing an instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS">6.8.13.</a>&nbsp;
+ Getting amount of instruments<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST DB_INSTRUMENTS">6.8.14.</a>&nbsp;
+ Listing all instruments in specific directory<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENT INFO">6.8.15.</a>&nbsp;
+ Getting instrument information<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT NAME">6.8.16.</a>&nbsp;
+ Renaming an instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#MOVE DB_INSTRUMENT">6.8.17.</a>&nbsp;
+ Moving an instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#COPY DB_INSTRUMENT">6.8.18.</a>&nbsp;
+ Copying instruments<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT DESCRIPTION">6.8.19.</a>&nbsp;
+ Changing the description of instrument<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;
+ Finding instruments<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;
+ Getting job status information<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
+ Formatting the instruments database<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
+ Editing Instruments<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
+ Opening an appropriate instrument editor application<br />
  <a href="#command_syntax">7.</a>&nbsp;
  Command Syntax<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
+ Character Set and Escape Sequences<br />
  <a href="#events">8.</a>&nbsp;
  Events<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
-Line 424 
 Number of MIDI instruments changed<br />
+Line 478 
 Number of MIDI instruments changed<br />
  MIDI instrument information changed<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
  Global settings changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.18.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;
+ Number of database instrument directories changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;
+ Database instrument directory information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;
+ Number of database instruments changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
+ Database instrument information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a>&nbsp;
+ Database job status information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;
  Miscellaneous and debugging events<br />
  <a href="#anchor14">9.</a>&nbsp;
  Security Considerations<br />
-Line 456 
 Requirements notation</h3>
+Line 520 
 Requirements notation</h3>
              (front-end) and server (LinuxSampler) respectively. Lines in
              examples must be interpreted as every line being CRLF
              terminated (carriage return character followed by line feed
-             character as defined in the ASCII standard), thus the following
+             character as defined in the ASCII standard <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>),
-             example:
+             thus the following example:
  </p>
  <p>
                  </p>
-Line 3243 
 Changing settings of MIDI input ports</h
+Line 3307 
 Changing settings of MIDI input ports</h
                      or <a class='info' href='#LIST MIDI_INPUT_DEVICES'>"LIST MIDI_INPUT_DEVICES"<span> (</span><span class='info'>Getting all created MIDI input device list</span><span>)</span></a>
                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
                      the parameter to change and &lt;value&gt; by the new value for this
-                     parameter.
+                     parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
+                     for specifying no value for parameters allowing a list of values.
  </p>
  <p>Possible Answers:
  </p>
-Line 3284 
 Changing settings of MIDI input ports</h
+Line 3349 
 Changing settings of MIDI input ports</h
  <p>
                          </p>
  <blockquote class="text">
+ <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
  <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
+ </p>
+ <p>S: "OK"
  </p>
  </blockquote><p>
-Line 3319 
 Loading an instrument</h3>
+Line 3396 
 Loading an instrument</h3>
                      number of the sampler channel the instrument should be assigned to.
                      Each sampler channel can only have one instrument.
  </p>
+ <p>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
+                     escape characters for special characters (see chapter
+                     "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"
+                     for details) and accordingly backslash characters in the filename
+                     MUST now be escaped as well!
+ </p>
  <p>The difference between regular and NON_MODAL versions of the command
                      is that the regular command returns OK only after the instrument has been
                      fully loaded and the channel is ready to be used while NON_MODAL version
-Line 5333 
 Getting effect send information</h3>
+Line 5416 
 Getting effect send information</h3>
  </blockquote><p>
  </p>
- <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
+ <a name="SET FX_SEND NAME"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
  <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
+ Changing effect send's name</h3>
+ <p>The front-end can alter the current name of an effect
+                     send entity by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;sampler-chan&gt; is the sampler channel number
+                     as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
+                     or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
+                     &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
+                     as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
+                     or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
+                     &lt;name&gt; is the new name of the effect send entity, which
+                     does not have to be unique.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case it failed, providing an appropriate error code and error message
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
  Altering effect send's audio routing</h3>
  <p>The front-end can alter the destination of an effect send's audio channel on a specific
-Line 5418 
 Altering effect send's audio routing</h3
+Line 5562 
 Altering effect send's audio routing</h3
  </p>
  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
+ <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
  Altering effect send's MIDI controller</h3>
  <p>The front-end can alter the MIDI controller of an effect
-Line 5489 
 Altering effect send's MIDI controller</
+Line 5633 
 Altering effect send's MIDI controller</
  </p>
  <a name="SET FX_SEND LEVEL"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
+ <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
  Altering effect send's send level</h3>
  <p>The front-end can alter the current send level of an effect
-Line 5561 
 Altering effect send's send level</h3>
+Line 5705 
 Altering effect send's send level</h3>
  </p>
  <a name="RESET CHANNEL"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
+ <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
  Resetting a sampler channel</h3>
  <p>The front-end can reset a particular sampler channel by sending the following command:
-Line 5993 
 General sampler informations</h3>
+Line 6137 
 General sampler informations</h3>
  </blockquote>
+ <p>INSTRUMENTS_DB_SUPPORT -
+                                         </p>
+ <blockquote class="text">
+ <p>either yes or no, specifies whether the
+                                             sampler is build with instruments database support.
+ </p>
+ </blockquote>
  </blockquote>
-Line 6404 
 Getting MIDI instrument map information<
+Line 6557 
 Getting MIDI instrument map information<
  </blockquote>
+ <p>DEFAULT -
+                                         </p>
+ <blockquote class="text">
+ <p>either true or false,
+                                             defines whether this map is the default map
+ </p>
+ </blockquote>
  </blockquote>
-Line 6421 
 Getting MIDI instrument map information<
+Line 6583 
 Getting MIDI instrument map information<
  </p>
  <p>S: "NAME: Standard Map"
  </p>
+ <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
+ </p>
  <p>&nbsp;&nbsp;&nbsp;"."
  </p>
  </blockquote><p>
-Line 6510 
 Create or replace a MIDI instrument map
+Line 6674 
 Create or replace a MIDI instrument map
                      index, &lt;engine_name&gt; a sampler engine name as returned by
                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
-                     of the instrument's file to be deployed (encapsulated into apostrophes),
+                     of the instrument's file to be deployed (encapsulated into apostrophes,
+                     supporting escape sequences as described in chapter
+                     "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"),
                      &lt;instrument_index&gt; the index (integer value) of the instrument
                      within the given file, &lt;volume_value&gt; reflects the master
                      volume of the instrument as optionally dotted number (where a
-Line 7092 
 Clear MIDI instrument map</h3>
+Line 7258 
 Clear MIDI instrument map</h3>
  </blockquote><p>
  </p>
+ <a name="Managing Instruments Database"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8"></a><h3>6.8.&nbsp;
+ Managing Instruments Database</h3>
+ <p>The following commands describe how to use and manage
+                 the instruments database.
+ </p>
+ <p>Notice:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>All command arguments representing a path or
+                             instrument/directory name support escape sequences as described in chapter
+                             "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>".
+ </p>
+ <p>All occurrences of a forward slash in instrument and directory
+                                names are escaped with its hex (\x2f) or octal (\057) escape sequence.
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
+ Creating a new instrument directory</h3>
+ <p>The front-end can add a new instrument directory to the
+                     instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to be created (encapsulated into apostrophes).
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>when the directory could not be created, which
+                                     can happen if the directory already exists or the
+                                     name contains not allowed symbols
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.2"></a><h3>6.8.2.&nbsp;
+ Deleting an instrument directory</h3>
+ <p>The front-end can delete a particular instrument directory
+                     from the instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to delete. The optional FORCE argument can be used to
+                     force the deletion of a non-empty directory and all its content.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the directory is deleted successfully
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist, or
+                                     if trying to delete a non-empty directory,
+                                     without using the FORCE argument.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.3"></a><h3>6.8.3.&nbsp;
+ Getting amount of instrument directories</h3>
+ <p>The front-end can retrieve the current amount of
+                     directories in a specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory. If RECURSIVE is specified, the number of
+                     all directories, including those located in subdirectories of the
+                     specified directory, will be returned.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The current number of instrument directories
+                             in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
+ </p>
+ <p>S: "2"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.4"></a><h3>6.8.4.&nbsp;
+ Listing all directories in specific directory</h3>
+ <p>The front-end can retrieve the current list of directories
+                     in specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory. If RECURSIVE is specified, the absolute path names
+                     of all directories, including those located in subdirectories of the
+                     specified directory, will be returned.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list of all instrument directories
+                             (encapsulated into apostrophes) in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
+ </p>
+ <p>S: "'Piano Collection','Percussion Collection'"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
+ </p>
+ <p>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENT_DIRECTORY INFO"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.5"></a><h3>6.8.5.&nbsp;
+ Getting instrument directory information</h3>
+ <p>The front-end can ask for the current settings of an
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory the front-end is interested in.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>A brief description of the directory content.
+                                             Note that the character string may contain
+                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
+ </p>
+ </blockquote>
+ <p>CREATED -
+                                         </p>
+ <blockquote class="text">
+ <p>The creation date and time of the directory,
+                                             represented in "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ <p>MODIFIED -
+                                         </p>
+ <blockquote class="text">
+ <p>The date and time of the last modification of the
+                                             directory, represented in "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>The mentioned fields above don't have to be in particular order.
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
+ </p>
+ <p>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT_DIRECTORY NAME"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.6"></a><h3>6.8.6.&nbsp;
+ Renaming an instrument directory</h3>
+ <p>The front-end can alter the name of a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory and
+                     &lt;name&gt; is the new name for that directory.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given directory does not exists,
+                                     or if a directory with name equal to the new
+                                     name already exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="MOVE DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.7"></a><h3>6.8.7.&nbsp;
+ Moving an instrument directory</h3>
+ <p>The front-end can move a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to move and &lt;dst&gt; is the location where the directory will
+                     be moved to.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case a given directory does not exists,
+                                     or if a directory with name equal to the name
+                                     of the specified directory already exists in
+                                     the destination directory. Error is also thrown
+                                     when trying to move a directory to a subdirectory
+                                     of itself.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="COPY DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.8"></a><h3>6.8.8.&nbsp;
+ Copying instrument directories</h3>
+ <p>The front-end can copy a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory
+                     to copy and &lt;dst&gt; is the location where the directory will
+                     be copied to.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case a given directory does not exists,
+                                     or if a directory with name equal to the name
+                                     of the specified directory already exists in
+                                     the destination directory. Error is also thrown
+                                     when trying to copy a directory to a subdirectory
+                                     of itself.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.9"></a><h3>6.8.9.&nbsp;
+ Changing the description of directory</h3>
+ <p>The front-end can alter the description of a specific
+                     instrument directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; is the absolute path name of the directory and
+                     &lt;desc&gt; is the new description for the directory
+                     (encapsulated into apostrophes, supporting escape sequences as described in chapter
+                     "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given directory does not exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="FIND DB_INSTRUMENT_DIRECTORIES"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.10"></a><h3>6.8.10.&nbsp;
+ Finding directories</h3>
+ <p>The front-end can search for directories
+                     in specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory to search in. If NON_RECURSIVE is specified, the
+                     directories located in subdirectories of the specified directory will not
+                     be searched. &lt;criteria-list&gt; is a list of search criterias
+                     in form of "key1=val1 key2=val2 ...". The following criterias are
+                     allowed:
+ </p>
+ <p>
+ <p>NAME='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to directories, which names
+                               satisfy the supplied search string (encapsulated into apostrophes,
+                               supporting escape sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to directories, which creation
+                               date satisfies the specified period, where &lt;date-after&gt;
+                               and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
+                               If &lt;date-after&gt; is omitted the search is restricted to
+                               directories created before &lt;date-before&gt;. If
+                               &lt;date-before&gt; is omitted, the search is restricted
+                               to directories created after &lt;date-after&gt;.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to directories, which
+                               date of last modification satisfies the specified period, where
+                               &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
+                               format. If &lt;date-after&gt; is omitted the search is restricted to
+                               directories, which are last modified before &lt;date-before&gt;. If
+                               &lt;date-before&gt; is omitted, the search is restricted to directories,
+                               which are last modified after &lt;date-after&gt;.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>DESCRIPTION='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to directories with description
+                               that satisfies the supplied search string
+                               (encapsulated into apostrophes, supporting escape
+                               sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;search-string&gt; is either a regular expression, or a
+                     word list separated with spaces for OR search and with '+' for AND search.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list with the absolute path names (encapsulated into
+                             apostrophes) of all directories in the specified directory that satisfy
+                             the supplied search criterias.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
+ </p>
+ <p>S: "'/Piano Collection'"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"
+ </p>
+ <p>S: "'/Piano Collection','/Percussions'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="ADD DB_INSTRUMENTS"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.11"></a><h3>6.8.11.&nbsp;
+ Adding instruments to the instruments database</h3>
+ <p>The front-end can add one or more instruments
+                     to the instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;db_dir&gt; is the absolute path name of a directory
+                     (encapsulated into apostrophes) in the instruments database in which
+                     only the new instruments (that are not already in the database) will
+                     be added, &lt;file_path&gt; is the absolute path name of a file or
+                     directory in the file system (encapsulated into apostrophes). In case
+                     an instrument file is supplied, only the instruments in the specified
+                     file will be added to the instruments database. If the optional
+                     &lt;instr_index&gt; (the index of the instrument within the given file)
+                     is supplied too, then only the specified instrument will be added.
+                     In case a directory is supplied, the instruments in that directory
+                     will be added. The OPTIONAL &lt;mode&gt; argument is only applied
+                     when a directory is provided as &lt;file_path&gt; and specifies how the
+                     scanning will be done and has exactly the following possibilities:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"RECURSIVE" -
+                                 </p>
+ <blockquote class="text">
+ <p>All instruments will be processed, including those
+                                     in the subdirectories, and the respective subdirectory
+                                     tree structure will be recreated in the instruments
+                                     database
+ </p>
+ </blockquote>
+ <p>"NON_RECURSIVE" -
+                                 </p>
+ <blockquote class="text">
+ <p>Only the instruments in the specified directory
+                                     will be added, the instruments in the subdirectories
+                                     will not be processed.
+ </p>
+ </blockquote>
+ <p>"FLAT" -
+                                 </p>
+ <blockquote class="text">
+ <p>All instruments will be processed, including those
+                                     in the subdirectories, but the respective subdirectory
+                                     structure will not be recreated in the instruments
+                                     database. All instruments will be added directly in
+                                     the specified database directory.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>The difference between regular and NON_MODAL versions of the command
+                     is that the regular command returns when the scanning is finished
+                     while NON_MODAL version returns immediately and a background process is launched.
+                     The <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
+                     command can be used to monitor the scanning progress.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success when NON_MODAL is not supplied
+ </p>
+ </blockquote>
+ <p>"OK[&lt;job-id&gt;]" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success when NON_MODAL is supplied, where &lt;job-id&gt;
+                                     is a numerical ID used to obtain status information about the job progress.
+                                     See <a class='info' href='#GET DB_INSTRUMENTS_JOB INFO'>GET DB_INSTRUMENTS_JOB INFO<span> (</span><span class='info'>Getting job status information</span><span>)</span></a>
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if an invalid path is specified.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE DB_INSTRUMENT"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.12"></a><h3>6.8.12.&nbsp;
+ Removing an instrument</h3>
+ <p>The front-end can remove a particular instrument
+                     from the instruments database by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE DB_INSTRUMENT &lt;instr_path&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr_path&gt; is the absolute path name
+                     (in the instruments database) of the instrument to remove.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the instrument is removed successfully
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given path does not exist or
+                                     is a directory.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENTS"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.13"></a><h3>6.8.13.&nbsp;
+ Getting amount of instruments</h3>
+ <p>The front-end can retrieve the current amount of
+                     instruments in a specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path name
+                     of the directory. If RECURSIVE is specified, the number of all
+                     instruments, including those located in subdirectories of the
+                     specified directory, will be returned.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The current number of instruments
+                             in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENTS '/Piano Collection'"
+ </p>
+ <p>S: "2"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST DB_INSTRUMENTS"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.14"></a><h3>6.8.14.&nbsp;
+ Listing all instruments in specific directory</h3>
+ <p>The front-end can retrieve the current list of instruments
+                     in specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory. If RECURSIVE is specified, the absolute path
+                     names of all instruments, including those located in subdirectories
+                     of the specified directory, will be returned.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list of all instruments
+                             (encapsulated into apostrophes) in the specified directory.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST DB_INSTRUMENTS '/Piano Collection'"
+ </p>
+ <p>S: "'Bosendorfer 290','Steinway D'"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
+ </p>
+ <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENT INFO"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.15"></a><h3>6.8.15.&nbsp;
+ Getting instrument information</h3>
+ <p>The front-end can ask for the current settings of an
+                     instrument by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENT INFO &lt;instr_path&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr_path&gt; should be replaced by the absolute path
+                     name of the instrument the front-end is interested in.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>INSTRUMENT_FILE -
+                                         </p>
+ <blockquote class="text">
+ <p>File name of the instrument.
+                                             Note that the character string may contain
+                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
+ </p>
+ </blockquote>
+ <p>INSTRUMENT_NR -
+                                         </p>
+ <blockquote class="text">
+ <p>Index of the instrument within the file.
+ </p>
+ </blockquote>
+ <p>FORMAT_FAMILY -
+                                         </p>
+ <blockquote class="text">
+ <p>The format family of the instrument.
+ </p>
+ </blockquote>
+ <p>FORMAT_VERSION -
+                                         </p>
+ <blockquote class="text">
+ <p>The format version of the instrument.
+ </p>
+ </blockquote>
+ <p>SIZE -
+                                         </p>
+ <blockquote class="text">
+ <p>The size of the instrument in bytes.
+ </p>
+ </blockquote>
+ <p>CREATED -
+                                         </p>
+ <blockquote class="text">
+ <p>The date and time when the instrument is added
+                                             in the instruments database, represented in
+                                            "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ <p>MODIFIED -
+                                         </p>
+ <blockquote class="text">
+ <p>The date and time of the last modification of the
+                                             instrument's database settings, represented in
+                                             "YYYY-MM-DD HH:MM:SS" format
+ </p>
+ </blockquote>
+ <p>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>A brief description of the instrument.
+                                             Note that the character string may contain
+                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
+ </p>
+ </blockquote>
+ <p>IS_DRUM -
+                                         </p>
+ <blockquote class="text">
+ <p>either true or false, determines whether the
+                                             instrument is a drumkit or a chromatic instrument
+ </p>
+ </blockquote>
+ <p>PRODUCT -
+                                         </p>
+ <blockquote class="text">
+ <p>The product title of the instrument.
+                                             Note that the character string may contain
+                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
+ </p>
+ </blockquote>
+ <p>ARTISTS -
+                                         </p>
+ <blockquote class="text">
+ <p>Lists the artist names.
+                                             Note that the character string may contain
+                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
+ </p>
+ </blockquote>
+ <p>KEYWORDS -
+                                         </p>
+ <blockquote class="text">
+ <p>Provides a list of keywords that refer to the instrument.
+                                             Keywords are separated with semicolon and blank.
+                                             Note that the character string may contain
+                                             <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
+ </p>
+ </blockquote>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>The mentioned fields above don't have to be in particular order.
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
+ </p>
+ <p>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT NAME"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.16"></a><h3>6.8.16.&nbsp;
+ Renaming an instrument</h3>
+ <p>The front-end can alter the name of a specific
+                     instrument by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument and
+                     &lt;name&gt; is the new name for that instrument.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists,
+                                     or if an instrument with name equal to the new
+                                     name already exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="MOVE DB_INSTRUMENT"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.17"></a><h3>6.8.17.&nbsp;
+ Moving an instrument</h3>
+ <p>The front-end can move a specific instrument to another directory by
+                     sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument
+                     to move and &lt;dst&gt; is the directory where the instrument will
+                     be moved to.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists,
+                                     or if an instrument with name equal to the name of the
+                                     specified instrument already exists in the destination
+                                     directory.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="COPY DB_INSTRUMENT"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.18"></a><h3>6.8.18.&nbsp;
+ Copying instruments</h3>
+ <p>The front-end can copy a specific instrument to another directory by
+                     sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument
+                     to copy and &lt;dst&gt; is the directory where the instrument will
+                     be copied to.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists,
+                                     or if an instrument with name equal to the name of the
+                                     specified instrument already exists in the destination
+                                     directory.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT DESCRIPTION"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.19"></a><h3>6.8.19.&nbsp;
+ Changing the description of instrument</h3>
+ <p>The front-end can alter the description of a specific
+                     instrument by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;instr&gt; is the absolute path name of the instrument and
+                     &lt;desc&gt; is the new description for the instrument
+                     (encapsulated into apostrophes, supporting escape sequences as described in chapter
+                     "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the given instrument does not exists.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="FIND DB_INSTRUMENTS"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.20"></a><h3>6.8.20.&nbsp;
+ Finding instruments</h3>
+ <p>The front-end can search for instruments
+                     in specific directory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;dir&gt; should be replaced by the absolute path
+                     name of the directory to search in. If NON_RECURSIVE is specified, the
+                     directories located in subdirectories of the specified directory will not
+                     be searched. &lt;criteria-list&gt; is a list of search criterias
+                     in form of "key1=val1 key2=val2 ...". The following criterias are
+                     allowed:
+ </p>
+ <p>
+ <p>NAME='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments, which names
+                               satisfy the supplied search string (encapsulated into apostrophes,
+                               supporting escape sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments, which
+                               size is in the specified range. If &lt;min&gt; is omitted,
+                               the search results are restricted to instruments with size less then
+                               or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
+                               search is restricted to instruments with size greater then
+                               or equal to &lt;min&gt;.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments, which creation
+                               date satisfies the specified period, where &lt;date-after&gt;
+                               and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
+                               If &lt;date-after&gt; is omitted the search is restricted to
+                               instruments created before &lt;date-before&gt;. If
+                               &lt;date-before&gt; is omitted, the search is restricted
+                               to instruments created after &lt;date-after&gt;.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments, which
+                               date of last modification satisfies the specified period, where
+                               &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
+                               format. If &lt;date-after&gt; is omitted the search is restricted to
+                               instruments, which are last modified before &lt;date-before&gt;. If
+                               &lt;date-before&gt; is omitted, the search is restricted to instruments,
+                               which are last modified after &lt;date-after&gt;.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>DESCRIPTION='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments with description
+                               that satisfies the supplied search string (encapsulated into apostrophes,
+                               supporting escape sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>PRODUCT='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments with product info
+                               that satisfies the supplied search string (encapsulated into apostrophes,
+                               supporting escape sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>ARTISTS='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments with artists info
+                               that satisfies the supplied search string (encapsulated into apostrophes,
+                               supporting escape sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>KEYWORDS='&lt;search-string&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments with keyword list
+                               that satisfies the supplied search string (encapsulated into apostrophes,
+                               supporting escape sequences as described in chapter
+                               "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>").
+ </p>
+ </blockquote><p>
+ </p>
+ <p>IS_DRUM=true | false
+                           </p>
+ <blockquote class="text">
+ <p>Either true or false. Restricts the search to
+                               drum kits or chromatic instruments.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>FORMAT_FAMILIES='&lt;format-list&gt;'
+                           </p>
+ <blockquote class="text">
+ <p>Restricts the search to instruments of the supplied format families,
+                               where &lt;format-list&gt; is a comma separated list of format families.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;search-string&gt; is either a regular expression, or a
+                     word list separated with spaces for OR search and with '+' for AND search.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list with the absolute path names (encapsulated into
+                             apostrophes) of all instruments in the specified directory that satisfy
+                             the supplied search criterias.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the given directory does not exist.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"
+ </p>
+ <p>S: "'/Piano Collection/Bosendorfer 290'"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"
+ </p>
+ <p>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.21"></a><h3>6.8.21.&nbsp;
+ Getting job status information</h3>
+ <p>The front-end can ask for the current status of a
+                     particular database instruments job by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;job-id&gt; should be replaced by the numerical ID
+                     of the job the front-end is interested in.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                             Each answer line begins with the settings category name
+                             followed by a colon and then a space character &lt;SP&gt; and finally
+                             the info character string to that setting category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>FILES_TOTAL -
+                                         </p>
+ <blockquote class="text">
+ <p>The total number of files scheduled for scanning
+ </p>
+ </blockquote>
+ <p>FILES_SCANNED -
+                                         </p>
+ <blockquote class="text">
+ <p>The current number of scanned files
+ </p>
+ </blockquote>
+ <p>SCANNING -
+                                         </p>
+ <blockquote class="text">
+ <p>The absolute path name of the file which is currently
+                                             being scanned
+ </p>
+ </blockquote>
+ <p>STATUS -
+                                         </p>
+ <blockquote class="text">
+ <p>An integer value between 0 and 100 indicating the
+                                             scanning progress percentage of the file which is
+                                             currently being scanned
+ </p>
+ </blockquote>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>The mentioned fields above don't have to be in particular order.
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET DB_INSTRUMENTS_JOB INFO 2"
+ </p>
+ <p>S: "FILES_TOTAL: 12"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"STATUS: 42"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
+ Formatting the instruments database</h3>
+ <p>The front-end can remove all instruments and directories and re-create
+                     the instruments database structure (e.g., in case of a database corruption)
+                     by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>FORMAT INSTRUMENTS_DB
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>If the formatting of the instruments database
+                                     failed.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <a name="editing_instruments"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
+ Editing Instruments</h3>
+ <p>The sampler allows to edit instruments while playing with the
+                 sampler by spawning an external (3rd party) instrument editor
+                 application for a given instrument. The 3rd party instrument
+                 editor applications have to place a respective plugin DLL file
+                 into the sampler's plugins directory. The sampler will
+                 automatically try to load all plugin DLLs in that directory on
+                 startup and only on startup!
+ </p>
+ <p>At the moment there is only one command for this feature set,
+                 but this will most probably change in future.
+ </p>
+ <a name="EDIT INSTRUMENT"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
+ Opening an appropriate instrument editor application</h3>
+ <p>The front-end can request to open an appropriate instrument
+                     editor application by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>EDIT INSTRUMENT &lt;sampler-channel&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;sampler-channel&gt; should be replaced by the
+                     number of the sampler channel as given by the
+                     <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
+                     or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
+                     command.
+ </p>
+ <p>The sampler will try to ask all registered instrument
+                     editors (or to be more specific: their sampler plugins)
+                     whether they are capable to handle the instrument on the
+                     given sampler channel. The sampler will simply use the first
+                     instrument editor application which replied with a positive
+                     answer and spawn that instrument editor application within
+                     the sampler's process and provide that application access
+                     to the instrument's data structures, so both applications
+                     can share and access the same instruments data at the same
+                     time, thus allowing to immediately hear changes with the
+                     sampler made by the instrument editor.
+ </p>
+ <p>Note: consequently instrument editors are always spawned
+                     locally on the same machine where the sampler is running
+                     on!
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>when an appropriate instrument editor was
+                                     launched
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>when an appropriate instrument editor was
+                                     launched, but there are noteworthy issues
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>when an appropriate instrument editor
+                                     could not be launched
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "EDIT INSTRUMENT 0"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
  <a name="command_syntax"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
  <a name="rfc.section.7"></a><h3>7.&nbsp;
-Line 7192 
 Command Syntax</h3>
+Line 9220 
 Command Syntax</h3>
  <p>/ UNSUBSCRIBE SP unsubscribe_event
  </p>
- <p>/ SELECT SP text
- </p>
  <p>/ RESET SP reset_instruction
  </p>
  <p>/ CLEAR SP clear_instruction
  </p>
+ <p>/ FIND SP find_instruction
+ </p>
+ <p>/ MOVE SP move_instruction
+ </p>
+ <p>/ COPY SP copy_instruction
+ </p>
+ <p>/ EDIT SP edit_instruction
+ </p>
+ <p>/ FORMAT SP format_instruction
+ </p>
  <p>/ RESET
  </p>
-Line 7216 
 Command Syntax</h3>
+Line 9256 
 Command Syntax</h3>
  <p>CHANNEL
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
+ </p>
+ <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
+ </p>
+ <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
+ </p>
+ <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
+ </p>
+ <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
+ </p>
+ <p>/ DB_INSTRUMENTS SP db_path SP filename
+ </p>
+ <p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
+ </p>
  <p>/ MIDI_INSTRUMENT_MAP
  </p>
-Line 7273 
 Command Syntax</h3>
+Line 9334 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_INFO
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_INFO
+ </p>
+ <p>/ DB_INSTRUMENT_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_INFO
+ </p>
+ <p>/ DB_INSTRUMENTS_JOB_INFO
+ </p>
  <p>/ MISCELLANEOUS
  </p>
-Line 7333 
 Command Syntax</h3>
+Line 9409 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_INFO
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY_INFO
+ </p>
+ <p>/ DB_INSTRUMENT_COUNT
+ </p>
+ <p>/ DB_INSTRUMENT_INFO
+ </p>
+ <p>/ DB_INSTRUMENTS_JOB_INFO
+ </p>
  <p>/ MISCELLANEOUS
  </p>
-Line 7384 
 Command Syntax</h3>
+Line 9475 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_MAP SP ALL
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT SP db_path
+ </p>
  </blockquote><p>
  </p>
-Line 7489 
 Command Syntax</h3>
+Line 9589 
 Command Syntax</h3>
  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
+ </p>
+ <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
+ </p>
+ <p>/ DB_INSTRUMENTS SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT SP INFO SP db_path
+ </p>
+ <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
+ </p>
  <p>/ VOLUME
  </p>
-Line 7507 
 Command Syntax</h3>
+Line 9628 
 Command Syntax</h3>
  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
  </p>
+ <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
+ </p>
  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
  </p>
-Line 7516 
 Command Syntax</h3>
+Line 9640 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
  </p>
+ <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
+ </p>
  <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
  </p>
-Line 7525 
 Command Syntax</h3>
+Line 9652 
 Command Syntax</h3>
  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
+ </p>
+ <p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
+ </p>
+ <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
+ </p>
  <p>/ ECHO SP boolean
  </p>
-Line 7579 
 Command Syntax</h3>
+Line 9718 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>find_instruction =
+         </p>
+ <blockquote class="text">
+ <p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
+ </p>
+ <p>/ DB_INSTRUMENTS SP db_path SP query_val_list
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
+ </p>
+ </blockquote><p>
+ </p>
+ <p>move_instruction =
+         </p>
+ <blockquote class="text">
+ <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT SP db_path SP db_path
+ </p>
+ </blockquote><p>
+ </p>
+ <p>copy_instruction =
+         </p>
+ <blockquote class="text">
+ <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT SP db_path SP db_path
+ </p>
+ </blockquote><p>
+ </p>
  <p>destroy_instruction =
          </p>
  <blockquote class="text">
-Line 7654 
 Command Syntax</h3>
+Line 9835 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>edit_instruction =
+         </p>
+ <blockquote class="text">
+ <p>INSTRUMENT SP sampler_channel
+ </p>
+ </blockquote><p>
+ </p>
+ <p>format_instruction =
+         </p>
+ <blockquote class="text">
+ <p>INSTRUMENTS_DB
+ </p>
+ </blockquote><p>
+ </p>
  <p>modal_arg =
          </p>
  <blockquote class="text">
-Line 7723 
 Command Syntax</h3>
+Line 9922 
 Command Syntax</h3>
  <p>/ FX_SENDS SP sampler_channel
  </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
+ </p>
+ <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
+ </p>
+ <p>/ DB_INSTRUMENTS SP db_path
+ </p>
  </blockquote><p>
  </p>
-Line 7906 
 Command Syntax</h3>
+Line 10117 
 Command Syntax</h3>
  <p>filename =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>path
+ </p>
+ </blockquote><p>
+ </p>
+ <p>db_path =
+         </p>
+ <blockquote class="text">
+ <p>path
  </p>
  </blockquote><p>
-Line 7969 
 Command Syntax</h3>
+Line 10189 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>query_val_list =
+         </p>
+ <blockquote class="text">
+ <p>string '=' query_val
+ </p>
+ <p>/ query_val_list SP string '=' query_val
+ </p>
+ </blockquote><p>
+ </p>
+ <p>query_val =
+         </p>
+ <blockquote class="text">
+ <p>textval_escaped
+ </p>
+ <p>/ stringval_escaped
+ </p>
+ </blockquote><p>
+ </p>
+ <p>scan_mode =
+         </p>
+ <blockquote class="text">
+ <p>RECURSIVE
+ </p>
+ <p>/ NON_RECURSIVE
+ </p>
+ <p>/ FLAT
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="character_set"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
+ Character Set and Escape Sequences</h3>
+ <p>Older versions of this protocol up to and including v1.1 only
+                 supported the standard ASCII character set (ASCII code 0 - 127)
+                 <a class='info' href='#RFC20'>[RFC20]<span> (</span><span class='info'>UCLA, &ldquo;ASCII format for Network Interchange,&rdquo; 1969.</span><span>)</span></a>, all younger versions of this protocol
+                 however support the Extended ASCII character set (ASCII code
+- 255). The same group of younger protocols also support
+                 escape sequences, but only for certain, explicitly declared
+                 parts of the protocol. The supported escape sequences are
+                 defined as follows:
+ </p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
+ <col align="left"><col align="left">
+ <tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
+ <tr>
+ <td align="left">\n</td>
+ <td align="left">new line</td>
+ </tr>
+ <tr>
+ <td align="left">\r</td>
+ <td align="left">carriage return</td>
+ </tr>
+ <tr>
+ <td align="left">\f</td>
+ <td align="left">form feed</td>
+ </tr>
+ <tr>
+ <td align="left">\t</td>
+ <td align="left">horizontal tab</td>
+ </tr>
+ <tr>
+ <td align="left">\v</td>
+ <td align="left">vertical tab</td>
+ </tr>
+ <tr>
+ <td align="left">\'</td>
+ <td align="left">apostrophe</td>
+ </tr>
+ <tr>
+ <td align="left">\"</td>
+ <td align="left">quotation mark</td>
+ </tr>
+ <tr>
+ <td align="left">\\</td>
+ <td align="left">backslash</td>
+ </tr>
+ <tr>
+ <td align="left">\OOO</td>
+ <td align="left">three digit octal ASCII code of the character</td>
+ </tr>
+ <tr>
+ <td align="left">\xHH</td>
+ <td align="left">two digit hex ASCII code of the character</td>
+ </tr>
+ </table>
+ <p>Notice: due to the transition of certain parts of the
+                 protocol which now support escape sequences, a slight backward
+                 incompatibility to protocols version v1.1 and younger has been
+                 introduced. The only difference is that in parts of the protocol
+                 where escape characters are now supported, a backslash characters
+                 MUST be escaped as well (that is as double backslash), whereas
+                 in the old versions a single backslash was sufficient.
+ </p>
  <a name="events"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
  <a name="rfc.section.8"></a><h3>8.&nbsp;
-Line 8258 
 Channel information changed</h3>
+Line 10583 
 Channel information changed</h3>
  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
  Number of effect sends changed</h3>
  <p>Client may want to be notified when the number of effect sends on
                  a particular sampler channel is changed by issuing the following command:
  </p>
  <p>
-Line 8497 
 Global settings changed</h3>
+Line 10822 
 Global settings changed</h3>
  </blockquote><p>
  </p>
- <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
+ <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
  <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
+ Number of database instrument directories changed</h3>
+ <p>Client may want to be notified when the number of instrument
+                 directories in a particular directory in the instruments database
+                 is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;dir-path&gt; will be replaced by the absolute path
+                 name of the directory in the instruments database,
+                 in which the number of directories is changed.
+ </p>
+ <p>Note that when a non-empty directory is removed, this event
+                 is not sent for the subdirectories in that directory.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
+ Database instrument directory information changed</h3>
+ <p>Client may want to be notified when changes were made to directories
+                 in the instruments database by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;dir-path&gt; will be replaced by the absolute path name
+                 of the directory, for which information changes occurred. The front-end will have to send
+                 the respective command to actually get the updated directory info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;old-dir-path&gt; is the old absolute path name of the directory
+                 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
+                 the new name of the directory, encapsulated into apostrophes.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
+ Number of database instruments changed</h3>
+ <p>Client may want to be notified when the number of instruments
+                 in a particular directory in the instruments database
+                 is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;dir-path&gt; will be replaced by the absolute path
+                 name of the directory in the instruments database,
+                 in which the number of instruments is changed.
+ </p>
+ <p>Note that when a non-empty directory is removed, this event
+                 is not sent for the instruments in that directory.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
+ Database instrument information changed</h3>
+ <p>Client may want to be notified when changes were made to instruments
+                 in the instruments database by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENT_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;instr-path&gt; will be replaced by the absolute path name
+                 of the instrument, which settings are changed. The front-end will have to send
+                 the respective command to actually get the updated directory info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
+                 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
+                 the new name of the instrument, encapsulated into apostrophes.
+ </p>
+ <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
+ Database job status information changed</h3>
+ <p>Client may want to be notified when the status of particular database
+                 instruments job is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
+                 which status is changed. The front-end will have to send the respective
+                 command to actually get the status info. Because these messages
+                 will be triggered by LSCP commands issued by other clients rather than real
+                 time events happening on the server, it is believed that an empty notification
+                 message is sufficient here.
+ </p>
+ <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
+ <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
+ <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
  Miscellaneous and debugging events</h3>
  <p>Client may want to be notified of miscellaneous and debugging events occurring at
-Line 8564 
 Acknowledgments</h3>
+Line 11080 
 Acknowledgments</h3>
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
  <h3>11.&nbsp;References</h3>
  <table width="99%" border="0">
+ <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
+ <td class="author-text">UCLA, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
-Line 8641 
 Please address the information to the IE
+Line 11159 
 Please address the information to the IE
  Funding for the RFC Editor function is provided by
  the IETF Administrative Support Activity (IASA).</p>
  </body></html>

 Legend:



Removed from v.1110
 


changed lines


 
Added in v.1363
 Legend:



Removed from v.1110
 


changed lines


 
Added in v.1363
-Removed from v.1110
+Added in v.1363

	ViewVC Help
Powered by ViewVC