/[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 1002 by schoenebeck,
Wed Dec 27 16:23:46 2006 UTC
+revision 1685 by schoenebeck,
Thu Feb 14 14:41:08 2008 UTC
 Line 3
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <meta name="description" content="LinuxSampler Control Protocol">
  <meta name="keywords" content="LSCP">
- <meta name="generator" content="xml2rfc v1.31 (http://xml.resource.org/)">
+ <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
  <style type='text/css'><!--
          body {
                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
                  font-size: small; color: #000; background-color: #FFF;
                  margin: 2em;
          }
          h1, h2, h3, h4, h5, h6 {
                  font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
                  font-weight: bold; font-style: normal;
          }
          h1 { color: #900; background-color: transparent; text-align: right; }
          h3 { color: #333; background-color: transparent; }
          td.RFCbug {
                  font-size: x-small; text-decoration: none;
                  width: 30px; height: 30px; padding-top: 2px;
                  text-align: justify; vertical-align: middle;
                  background-color: #000;
          }
          td.RFCbug span.RFC {
                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
                  font-weight: bold; color: #666;
          }
          td.RFCbug span.hotText {
                  font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
                  font-weight: normal; text-align: center; color: #FFF;
          }
          table.TOCbug { width: 30px; height: 15px; }
          td.TOCbug {
                  text-align: center; width: 30px; height: 15px;
                  color: #FFF; background-color: #900;
          }
          td.TOCbug a {
                  font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
                  font-weight: bold; font-size: x-small; text-decoration: none;
                  color: #FFF; background-color: transparent;
          }
          td.header {
                  font-family: arial, helvetica, sans-serif; font-size: x-small;
                  vertical-align: top; width: 33%;
                  color: #FFF; background-color: #666;
          }
          td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
          td.author-text { font-size: x-small; }
          /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
          a.info {
                  /* This is the key. */
                  position: relative;
                  z-index: 24;
                  text-decoration: none;
          }
          a.info:hover {
                  z-index: 25;
                  color: #FFF; background-color: #900;
          }
          a.info span { display: none; }
          a.info:hover span.info {
                  /* The span will display just on :hover state. */
                  display: block;
                  position: absolute;
                  font-size: smaller;
                  top: 2em; left: -5em; width: 15em;
                  padding: 2px; border: 1px solid #333;
                  color: #900; background-color: #EEE;
                  text-align: left;
          }
          a { font-weight: bold; }
          a:link    { color: #900; background-color: transparent; }
          a:visited { color: #633; background-color: transparent; }
          a:active  { color: #633; background-color: transparent; }
          p { margin-left: 2em; margin-right: 2em; }
          p.copyright { font-size: x-small; }
          p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
          table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
          td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
          ol.text { margin-left: 2em; margin-right: 2em; }
          ul.text { margin-left: 2em; margin-right: 2em; }
          li      { margin-left: 3em; }
          /* RFC-2629 <spanx>s and <artwork>s. */
          em     { font-style: italic; }
          strong { font-weight: bold; }
          dfn    { font-weight: bold; font-style: normal; }
          cite   { font-weight: normal; font-style: normal; }
          tt     { color: #036; }
          tt, pre, pre dfn, pre em, pre cite, pre span {
                  font-family: "Courier New", Courier, monospace; font-size: small;
          }
          pre {
                  text-align: left; padding: 4px;
                  color: #000; background-color: #CCC;
          }
          pre dfn  { color: #900; }
          pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
          pre .key { color: #33C; font-weight: bold; }
          pre .id  { color: #900; }
          pre .str { color: #000; background-color: #CFF; }
          pre .val { color: #066; }
          pre .rep { color: #909; }
          pre .oth { color: #000; background-color: #FCF; }
          pre .err { background-color: #FCC; }
          /* RFC-2629 <texttable>s. */
-         table.full, table.headers, table.none {
+         table.all, table.full, table.headers, table.none {
                  font-size: small; text-align: center; border-width: 2px;
                  vertical-align: top; border-collapse: collapse;
          }
-         table.full { border-style: solid; border-color: black; }
+         table.all, table.full { border-style: solid; border-color: black; }
          table.headers, table.none { border-style: none; }
          th {
                  font-weight: bold; border-color: black;
                  border-width: 2px 2px 3px 2px;
          }
-         table.full th { border-style: solid; }
+         table.all th, table.full th { border-style: solid; }
          table.headers th { border-style: none none solid none; }
          table.none th { border-style: none; }
-         table.full td {
+         table.all td {
                  border-style: solid; border-color: #333;
                  border-width: 1px 2px;
          }
-         table.headers td, table.none td { border-style: none; }
+         table.full td, table.headers td, table.none td { border-style: none; }
          hr { height: 1px; }
          hr.insert {
                  width: 80%; border-style: none; border-width: 0;
                  color: #CCC; background-color: #CCC;
          }
  --></style>
  </head>
  <body>
 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: June 30, 2007</td><td class="header">December 27, 2006</td></tr>
+ <tr><td class="header">Expires: August 17, 2008</td><td class="header">February 14, 2008</td></tr>
  </table></td></tr></table>
- <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
+ <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</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 June 30, 2007.</p>
+ This Internet-Draft will expire on August 17, 2008.</p>
  <h3>Copyright Notice</h3>
  <p>
- Copyright &copy; The Internet Society (2006).</p>
+ Copyright &copy; The IETF Trust (2008).</p>
  <h3>Abstract</h3>
 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="#RESET CHANNEL">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.33.</a>&nbsp;
+ Altering effect send's send level<br />
+ &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 348 
 Global commands<br />
+Line 354 
 Global commands<br />
  Current number of active voices<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_VOICE_COUNT_MAX">6.6.2.</a>&nbsp;
  Maximum amount of active voices<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.3.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET TOTAL_STREAM_COUNT">6.6.3.</a>&nbsp;
+ Current number of active disk streams<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET">6.6.4.</a>&nbsp;
  Reset sampler<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.5.</a>&nbsp;
  General sampler informations<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.6.</a>&nbsp;
+ Getting global volume attenuation<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;
+ Setting global volume attenuation<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
  MIDI Instrument Mapping<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a>&nbsp;
  Create a new MIDI instrument map<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
  Delete one particular or all MIDI instrument maps<br />
-Line 378 
 Remove an entry from the MIDI instrument
+Line 390 
 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 />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#file_management">6.10.</a>&nbsp;
+ Managing Files<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENTS">6.10.1.</a>&nbsp;
+ Retrieving amount of instruments of a file<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST FILE INSTRUMENTS">6.10.2.</a>&nbsp;
+ Retrieving all instruments of a file<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FILE INSTRUMENT INFO">6.10.3.</a>&nbsp;
+ Retrieving informations about one instrument in a file<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 392 
 Number of MIDI input devices changed<br
+Line 464 
 Number of MIDI input devices changed<br
  MIDI input device's settings changed<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_COUNT">8.5.</a>&nbsp;
  Number of sampler channels changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.6.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_MIDI">8.6.</a>&nbsp;
+ MIDI data on a sampler channel arrived<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.7.</a>&nbsp;
  Number of active voices changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.7.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE STREAM_COUNT">8.8.</a>&nbsp;
  Number of active disk streams changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.8.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE BUFFER_FILL">8.9.</a>&nbsp;
  Disk stream buffer fill state changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.9.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE CHANNEL_INFO">8.10.</a>&nbsp;
  Channel information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.10.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.11.</a>&nbsp;
+ Number of effect sends changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.12.</a>&nbsp;
+ Effect send information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.13.</a>&nbsp;
  Total number of active voices changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.11.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.14.</a>&nbsp;
+ Total number of active disk streams changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.15.</a>&nbsp;
  Number of MIDI instrument maps changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.12.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.16.</a>&nbsp;
  MIDI instrument map information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.13.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.17.</a>&nbsp;
  Number of MIDI instruments changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.14.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.18.</a>&nbsp;
  MIDI instrument information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.15.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.19.</a>&nbsp;
+ Global settings changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.20.</a>&nbsp;
+ Number of database instrument directories changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.21.</a>&nbsp;
+ Database instrument directory information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.22.</a>&nbsp;
+ Number of database instruments changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.23.</a>&nbsp;
+ Database instrument information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.24.</a>&nbsp;
+ Database job status information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.25.</a>&nbsp;
  Miscellaneous and debugging events<br />
  <a href="#anchor14">9.</a>&nbsp;
  Security Considerations<br />
-Line 442 
 Requirements notation</h3>
+Line 534 
 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 3229 
 Changing settings of MIDI input ports</h
+Line 3321 
 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 3270 
 Changing settings of MIDI input ports</h
+Line 3363 
 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 3305 
 Loading an instrument</h3>
+Line 3410 
 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 3352 
 Loading an instrument</h3>
+Line 3463 
 Loading an instrument</h3>
  </blockquote><p>
  </p>
- <p>Example:
+ <p>Example (Unix):
  </p>
  <p>
                          </p>
  <blockquote class="text">
+ <p>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0
+ </p>
+ <p>S: OK
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Example (Windows):
+ </p>
  <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0
+ </p>
+ <p>S: OK
  </p>
  </blockquote><p>
-Line 3772 
 Getting information about an engine</h3>
+Line 3897 
 Getting information about an engine</h3>
                                          </p>
  <blockquote class="text">
  <p>arbitrary description text about the engine
+                                             (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>
-Line 3891 
 Getting sampler channel information</h3>
+Line 4018 
 Getting sampler channel information</h3>
  <blockquote class="text">
  <p>the file name of the loaded instrument, "NONE" if
                                              there's no instrument yet loaded for this sampler
-                                             channel
+                                             channel (note: since LSCP 1.2 this path 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>
-Line 3908 
 Getting sampler channel information</h3>
+Line 4036 
 Getting sampler channel information</h3>
                                          </p>
  <blockquote class="text">
  <p>the instrument name of the loaded instrument
+                                             (note: since LSCP 1.2 this 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>
-Line 3954 
 Getting sampler channel information</h3>
+Line 4084 
 Getting sampler channel information</h3>
                                          </p>
  <blockquote class="text">
  <p>optionally dotted number for the channel volume factor
-                                             (where a value < 1.0 means attenuation and a value >
+                                             (where a value &lt; 1.0 means attenuation and a value >
 .0 means amplification)
  </p>
  </blockquote>
-Line 4983 
 Adding an effect send to a sampler chann
+Line 5113 
 Adding an effect send to a sampler chann
                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
                      is a number between 0..127 defining the MIDI controller which can alter the
                      effect send level and &lt;name&gt; is an optional argument defining a name
-                     for the effect send entity. The name does not have to be unique.
+                     for the effect send entity. The name does not have to be unique, but MUST be
+                     encapsulated into apostrophes and supports 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>By default, that is as initial routing, the effect send's audio channels
                      are automatically routed to the last audio channels of the sampler channel's
-Line 5252 
 Getting effect send information</h3>
+Line 5384 
 Getting effect send information</h3>
                                          </p>
  <blockquote class="text">
  <p>name of the effect send entity
+                                             (note that this 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>MIDI_CONTROLLER -
+                                         </p>
+ <blockquote class="text">
+ <p>a value between 0 and 127 reflecting the MIDI controller
+                                             which is able to modify the effect send's send level
+ </p>
+ </blockquote>
+ <p>LEVEL -
+                                         </p>
+ <blockquote class="text">
+ <p>optionally dotted number reflecting the effect send's
+                                             current send level (where a value &lt; 1.0 means attenuation
+                                             and a value > 1.0 means amplification)
  </p>
  </blockquote>
-Line 5289 
 Getting effect send information</h3>
+Line 5442 
 Getting effect send information</h3>
  </p>
  <p>S: "NAME: Reverb Send"
  </p>
+ <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
+ </p>
  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
  </p>
  <p>&nbsp;&nbsp;&nbsp;"."
-Line 5296 
 Getting effect send information</h3>
+Line 5453 
 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 (name MUST be encapsulated into apostrophes
+                     and supports 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 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 5379 
 Altering effect send's audio routing</h3
+Line 5600 
 Altering effect send's audio routing</h3
  </blockquote><p>
  </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.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
+                     send entity by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&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;midi-ctrl&gt; reflects the MIDI controller which shall be
+                     able to modify the effect send's send level.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if MIDI controller was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message
+ </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 MIDI_CONTROLLER 0 0 91"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </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.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
+                     send entity by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&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;volume&gt; is an optionally dotted positive number (a value
+                     smaller than 1.0 means attenuation, whereas a value greater than
+.0 means amplification) reflecting the new send level.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if new send level was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message
+ </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 LEVEL 0 0 0.15"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </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.31"></a><h3>6.4.31.&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 5716 
 Maximum amount of active voices</h3>
+Line 6080 
 Maximum amount of active voices</h3>
  </blockquote><p>
  </p>
- <a name="RESET"></a><br /><hr />
+ <a name="GET TOTAL_STREAM_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.6.6.3"></a><h3>6.6.3.&nbsp;
+ Current number of active disk streams</h3>
+ <p>The front-end can ask for the current number of active disk streams on
+                     the sampler by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET TOTAL_STREAM_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by returning the number of all active
+                             disk streams on the sampler.
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="RESET"></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.6.4"></a><h3>6.6.4.&nbsp;
  Reset sampler</h3>
  <p>The front-end can reset the whole sampler by sending the following command:
-Line 5759 
 Reset sampler</h3>
+Line 6150 
 Reset sampler</h3>
  </p>
  <a name="GET SERVER 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.6.4"></a><h3>6.6.4.&nbsp;
+ <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
  General sampler informations</h3>
  <p>The client can ask for general informations about the LinuxSampler
-Line 5792 
 General sampler informations</h3>
+Line 6183 
 General sampler informations</h3>
                                          </p>
  <blockquote class="text">
  <p>arbitrary textual description about the sampler
+                                             (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>
-Line 5813 
 General sampler informations</h3>
+Line 6206 
 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 5822 
 General sampler informations</h3>
+Line 6224 
 General sampler informations</h3>
  <p>The mentioned fields above don't have to be in particular order.
                      Other fields might be added in future.
  </p>
+ <a name="GET VOLUME"></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.6.6"></a><h3>6.6.6.&nbsp;
+ Getting global volume attenuation</h3>
+ <p>The client can ask for the current global sampler-wide volume
+                     attenuation by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET VOLUME
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will always answer by returning the optional
+                             dotted floating point coefficient, reflecting the current
+                             global volume attenuation.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Note: it is up to the respective sampler engine whether to obey
+                     that global volume parameter or not, but in general all engines SHOULD
+                     use this parameter.
+ </p>
+ <a name="SET VOLUME"></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.6.7"></a><h3>6.6.7.&nbsp;
+ Setting global volume attenuation</h3>
+ <p>The client can alter the current global sampler-wide volume
+                     attenuation by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET VOLUME &lt;volume&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;volume&gt; should be replaced by the optional dotted
+                    floating point value, reflecting the new global volume parameter.
+                    This value might usually be in the range between 0.0 and 1.0, that
+                    is for attenuating the overall volume.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the global volume was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message
+ </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>
  <a name="MIDI Instrument Mapping"></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.7"></a><h3>6.7.&nbsp;
-Line 5856 
 MIDI Instrument Mapping</h3>
+Line 6346 
 MIDI Instrument Mapping</h3>
                  cause the sampler to switch to the respective instrument as
                  reflected by the current MIDI instrument map.
  </p>
- <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />
+ <a name="ADD MIDI_INSTRUMENT_MAP"></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.7.1"></a><h3>6.7.1.&nbsp;
  Create a new MIDI instrument map</h3>
-Line 5874 
 Create a new MIDI instrument map</h3>
+Line 6364 
 Create a new MIDI instrument map</h3>
  </p>
  <p>Where &lt;name&gt; is an optional argument allowing to
                      assign a custom name to the new map. MIDI instrument Map
-                     names do not have to be unique.
+                     names do not have to be unique, but MUST be encapsulated
+                     into apostrophes and 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>Possible Answers:
  </p>
-Line 6132 
 Getting MIDI instrument map information<
+Line 6625 
 Getting MIDI instrument map information<
  <blockquote class="text">
  <p>custom name of the given map,
                                              which does not have to be unique
+                                             (note that this 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>DEFAULT -
+                                         </p>
+ <blockquote class="text">
+ <p>either true or false,
+                                             defines whether this map is the default map
  </p>
  </blockquote>
-Line 6153 
 Getting MIDI instrument map information<
+Line 6657 
 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 6176 
 Renaming a MIDI instrument map</h3>
+Line 6682 
 Renaming a MIDI instrument map</h3>
  </p>
  <p>Where &lt;map&gt; is the numerical ID of the map and
                      &lt;name&gt; the new custom name of the map, which does not
-                     have to be unique.
+                     have to be unique (name MUST be encapsulated into apostrophes
+                     and supports 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>
-Line 6226 
 Create or replace a MIDI instrument map
+Line 6735 
 Create or replace a MIDI instrument map
  <p>
                          </p>
  <blockquote class="text">
- <p>MAP MIDI_INSTRUMENT &lt;map&gt;
+ <p>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]
-Line 6242 
 Create or replace a MIDI instrument map
+Line 6751 
 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
-                     value < 1.0 means attenuation and a value > 1.0 means
+                     value &lt; 1.0 means attenuation and a value > 1.0 means
                      amplification). This parameter easily allows to adjust the
                      volume of all intruments within a custom instrument map
                      without having to adjust their instrument files. The
-Line 6290 
 Create or replace a MIDI instrument map
+Line 6801 
 Create or replace a MIDI instrument map
                                  </p>
  <blockquote class="text">
  <p>The instrument will immediately be loaded
-                                     into memory in the background when this mapping
+                                     into memory when this mapping
                                      command is sent and the instrument is kept all
                                      the time. Instruments with this mode are
                                      only freed when the sampler is reset or all
-Line 6339 
 Create or replace a MIDI instrument map
+Line 6850 
 Create or replace a MIDI instrument map
                      load modes of entries, the frontend should retrieve the actual
                      mode by i.e. sending
                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
-                     command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
+                     command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
-                     set a custom name (encapsulated into apostrophes) for the mapping
+                     (encapsulated into apostrophes, supporting escape sequences as described in chapter
-                     entry, useful for frontends for displaying an appropriate name for
+                     "<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 the
+                     mapping entry, useful for frontends for displaying an appropriate name for
                      mapped instruments (using
                      <a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>).
  </p>
  <p>
-                     The "MAP MIDI_INSTRUMENT" command
+                     By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
-                     will immediately return, thus it will not block when an
+                     completely established in the sampler. The OPTIONAL "NON_MODAL" argument
-                     instrument is to be loaded due to a "PERSISTENT" type
+                     however causes the respective "MAP MIDI_INSTRUMENT" command to return
-                     entry as instruments are loaded in the background. As a
+                     immediately, that is to let the sampler establish the mapping in the
-                     consequence this command may not necessarily return an error
+                     background. So this argument might be especially useful for mappings with
-                     i.e. when the given instrument file does not exist or may
+                     a "PERSISTENT" type, because these have to load the respective instruments
-                     turn out to be corrupt.
+                     immediately and might thus block for a very long time. It is recommended
+                     however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
+                     because it has the following drawbacks: as "NON_MODAL" instructions return
+                     immediately, they may not necessarily return an error i.e. when the given
+                     instrument file turns out to be corrupt, beside that subsequent commands
+                     in a LSCP instruction sequence might fail, because mandatory mappings are
+                     not yet completed.
  </p>
  <p>Possible Answers:
-Line 6420 
 Create or replace a MIDI instrument map
+Line 6938 
 Create or replace a MIDI instrument map
  <p>
                          </p>
  <blockquote class="text">
- <p>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
+ <p>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
  </p>
  <p>S: "OK"
  </p>
-Line 6657 
 Get current settings of MIDI instrument
+Line 7175 
 Get current settings of MIDI instrument
                                      changed with the
                                      <a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
                                      command and does not have to be unique.
+                                     (note that this 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>
-Line 6673 
 Get current settings of MIDI instrument
+Line 7193 
 Get current settings of MIDI instrument
  <p>"INSTRUMENT_FILE" -
                                  </p>
  <blockquote class="text">
- <p>File name of the instrument.
+ <p>File name of the instrument
+                                     (note that this path 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>
-Line 6691 
 Get current settings of MIDI instrument
+Line 7213 
 Get current settings of MIDI instrument
  <blockquote class="text">
  <p>Name of the loaded instrument as reflected by its file.
                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
-                                     cannot be changed.
+                                     cannot be changed (note that this 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>
-Line 6709 
 Get current settings of MIDI instrument
+Line 7232 
 Get current settings of MIDI instrument
                                  </p>
  <blockquote class="text">
  <p>master volume of the instrument as optionally
-                                     dotted number (where a value < 1.0 means attenuation
+                                     dotted number (where a value &lt; 1.0 means attenuation
                                      and a value > 1.0 means amplification)
  </p>
  </blockquote>
-Line 6818 
 Clear MIDI instrument map</h3>
+Line 7341 
 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 CHANNEL 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 CHANNEL INSTRUMENT 0"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="file_management"></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.10"></a><h3>6.10.&nbsp;
+ Managing Files</h3>
+ <p>You can query detailed informations about files located
+                 at the same system where the sampler instance is running on.
+                 Using this command set allows to retrieve file informations
+                 even remotely from another machine.
+ </p>
+ <a name="GET FILE 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.10.1"></a><h3>6.10.1.&nbsp;
+ Retrieving amount of instruments of a file</h3>
+ <p>The front-end can retrieve the amount of instruments
+                     within a given instrument file by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET FILE INSTRUMENTS &lt;filename&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;filename&gt; is the name of the instrument
+                     file (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>The sampler will try to ask all sampler engines,
+                     whether they support the given file and ask the first
+                     engine with a positive answer for the amount of
+                     instruments.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>On success, the sampler will answer by
+                                returning the amount of instruments.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the file could not be handled
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
+ </p>
+ <p>S: "10"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST FILE 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.10.2"></a><h3>6.10.2.&nbsp;
+ Retrieving all instruments of a file</h3>
+ <p>The front-end can retrieve a list of all instruments
+                     within a given instrument file by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST FILE INSTRUMENTS &lt;filename&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;filename&gt; is the name of the instrument
+                     file (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>The sampler will try to ask all sampler engines,
+                     whether they support the given file and ask the first
+                     engine with a positive answer for a list of IDs for the
+                     instruments in the given file.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>On success, the sampler will answer by
+                                returning a comma separated list of
+                                instrument IDs.
+ </p>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the file could not be handled
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"
+ </p>
+ <p>S: "0,1,2,3,4,5,6,7,8,9"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET FILE 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.10.3"></a><h3>6.10.3.&nbsp;
+ Retrieving informations about one instrument in a file</h3>
+ <p>The front-end can retrieve detailed informations
+                     about a specific instrument within a given instrument
+                     file by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET FILE INSTRUMENT INFO &lt;filename&gt;
+                             &lt;instr-id&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;filename&gt; is the name of the instrument
+                     file (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>") and &lt;instr-id&gt; is the numeric
+                     instrument ID as returned by the
+                     <a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a> command.
+ </p>
+ <p>The sampler will try to ask all sampler engines,
+                     whether they support the given file and ask the first
+                     engine with a positive answer for informations about the
+                     specific instrument in the given file.
+ </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>NAME -
+                                         </p>
+ <blockquote class="text">
+ <p>name of the instrument as
+                                             stored in the instrument file
+ </p>
+ </blockquote>
+ <p>FORMAT_FAMILY -
+                                         </p>
+ <blockquote class="text">
+ <p>name of the sampler format
+                                             of the given instrument
+ </p>
+ </blockquote>
+ <p>FORMAT_VERSION -
+                                         </p>
+ <blockquote class="text">
+ <p>version of the sampler format
+                                             the instrumen is stored as
+ </p>
+ </blockquote>
+ <p>PRODUCT -
+                                         </p>
+ <blockquote class="text">
+ <p>official product name of the
+                                             instrument as stored in the file
+ </p>
+ </blockquote>
+ <p>ARTISTS -
+                                         </p>
+ <blockquote class="text">
+ <p>artists / sample library
+                                             vendor of the instrument
+ </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 FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"
+ </p>
+ <p>S: "NAME: Lunatic Loops"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </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 6918 
 Command Syntax</h3>
+Line 9555 
 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 6942 
 Command Syntax</h3>
+Line 9591 
 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 6969 
 Command Syntax</h3>
+Line 9639 
 Command Syntax</h3>
  <p>/ CHANNEL_COUNT
  </p>
+ <p>/ CHANNEL_MIDI
+ </p>
  <p>/ VOICE_COUNT
  </p>
-Line 6981 
 Command Syntax</h3>
+Line 9654 
 Command Syntax</h3>
  <p>/ CHANNEL_INFO
  </p>
+ <p>/ FX_SEND_COUNT
+ </p>
+ <p>/ FX_SEND_INFO
+ </p>
  <p>/ MIDI_INSTRUMENT_MAP_COUNT
  </p>
-Line 6993 
 Command Syntax</h3>
+Line 9672 
 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>
+ <p>/ TOTAL_STREAM_COUNT
+ </p>
  <p>/ TOTAL_VOICE_COUNT
  </p>
+ <p>/ GLOBAL_INFO
+ </p>
  </blockquote><p>
  </p>
-Line 7020 
 Command Syntax</h3>
+Line 9720 
 Command Syntax</h3>
  <p>/ CHANNEL_COUNT
  </p>
+ <p>/ CHANNEL_MIDI
+ </p>
  <p>/ VOICE_COUNT
  </p>
-Line 7032 
 Command Syntax</h3>
+Line 9735 
 Command Syntax</h3>
  <p>/ CHANNEL_INFO
  </p>
+ <p>/ FX_SEND_COUNT
+ </p>
+ <p>/ FX_SEND_INFO
+ </p>
  <p>/ MIDI_INSTRUMENT_MAP_COUNT
  </p>
-Line 7044 
 Command Syntax</h3>
+Line 9753 
 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>
+ <p>/ TOTAL_STREAM_COUNT
+ </p>
  <p>/ TOTAL_VOICE_COUNT
  </p>
+ <p>/ GLOBAL_INFO
+ </p>
  </blockquote><p>
  </p>
  <p>map_instruction =
          </p>
  <blockquote class="text">
- <p>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
+ <p>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
  </p>
- <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
+ <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
  </p>
- <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
+ <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
  </p>
- <p>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
+ <p>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
  </p>
  </blockquote><p>
-Line 7092 
 Command Syntax</h3>
+Line 9822 
 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 7170 
 Command Syntax</h3>
+Line 9909 
 Command Syntax</h3>
  <p>/ SERVER SP INFO
  </p>
+ <p>/ TOTAL_STREAM_COUNT
+ </p>
  <p>/ TOTAL_VOICE_COUNT
  </p>
-Line 7197 
 Command Syntax</h3>
+Line 9939 
 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>
+ <p>/ FILE SP INSTRUMENTS SP filename
+ </p>
+ <p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
+ </p>
  </blockquote><p>
  </p>
-Line 7212 
 Command Syntax</h3>
+Line 9984 
 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 7221 
 Command Syntax</h3>
+Line 9996 
 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>
+ <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
+ </p>
+ <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>
+ <p>/ VOLUME SP volume_value
+ </p>
  </blockquote><p>
  </p>
-Line 7275 
 Command Syntax</h3>
+Line 10074 
 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 7350 
 Command Syntax</h3>
+Line 10191 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>edit_instruction =
+         </p>
+ <blockquote class="text">
+ <p>CHANNEL SP 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">
+ <p>/* epsilon (empty argument) */
+ </p>
+ <p>/ NON_MODAL SP
+ </p>
+ </blockquote><p>
+ </p>
  <p>key_val_list =
          </p>
  <blockquote class="text">
-Line 7407 
 Command Syntax</h3>
+Line 10278 
 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>
+ <p>/ FILE SP INSTRUMENTS SP filename
+ </p>
  </blockquote><p>
  </p>
-Line 7590 
 Command Syntax</h3>
+Line 10476 
 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 7599 
 Command Syntax</h3>
+Line 10494 
 Command Syntax</h3>
  <p>map_name =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>stringval_escaped
  </p>
  </blockquote><p>
-Line 7608 
 Command Syntax</h3>
+Line 10503 
 Command Syntax</h3>
  <p>entry_name =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>stringval_escaped
  </p>
  </blockquote><p>
-Line 7617 
 Command Syntax</h3>
+Line 10512 
 Command Syntax</h3>
  <p>fx_send_name =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>stringval_escaped
  </p>
  </blockquote><p>
-Line 7653 
 Command Syntax</h3>
+Line 10548 
 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>text_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>
+ <p>The following LSCP commands support escape sequences as part
+                 of their filename / path based arguments and / or may contain
+                 a filename / path with escape sequences in their response:
+                 </p>
+ <blockquote class="text">
+ <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#ADD DB_INSTRUMENT_DIRECTORY'>"ADD DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Creating a new instrument directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#ADD DB_INSTRUMENTS'>"ADD DB_INSTRUMENTS"<span> (</span><span class='info'>Adding instruments to the instruments database</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET FILE INSTRUMENT INFO'>"GET FILE INSTRUMENT INFO"<span> (</span><span class='info'>Retrieving informations about one instrument in a file</span><span>)</span></a>
+ </p>
+ </blockquote><p>
+                 Note that the forward slash character ('/') has a special meaning in
+                 filename / path based arguments: it acts as separator of the nodes in
+                 the path, thus if a directory- or filename includes a forward slash
+                 (not intended as path node separator), you MUST escape that slash
+                 either with the respective hex escape sequence ("\x2f") or with the
+                 respective octal escape sequence ("\057").
+ </p>
+ <p>
+                 Note for Windows: file path arguments in LSCP are expected
+                 to use forward slashes as directory node separator similar
+                 to Unix based operating systems. In contrast to Unix however
+                 a Windows typical drive character is expected to be
+                 prefixed to the path. That is an original Windows file path
+                 like "D:\Sounds\My.gig" would become in LSCP:
+                 "D:/Sounds/My.gig".
+ </p>
+ <p>
+                 The following LSCP commands even support escape sequences as
+                 part of at least one of their text-based arguments (i.e. entity name,
+                 description) and / or may contain escape sequences in at least one of
+                 their text-based fields in their response:
+                 </p>
+ <blockquote class="text">
+ <p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET ENGINE INFO'>"GET ENGINE INFO"<span> (</span><span class='info'>Getting information about an engine</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
+ </p>
+ <p><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>
+ </p>
+ <p><a class='info' href='#GET FX_SEND INFO'>"GET FX_SEND INFO"<span> (</span><span class='info'>Getting effect send information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET FX_SEND NAME'>"SET FX_SEND NAME"<span> (</span><span class='info'>Changing effect send's name</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET MIDI_INSTRUMENT_MAP INFO'>"GET MIDI_INSTRUMENT_MAP INFO"<span> (</span><span class='info'>Getting MIDI instrument map information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#ADD MIDI_INSTRUMENT_MAP'>"ADD MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Create a new MIDI instrument map</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET MIDI_INSTRUMENT_MAP NAME'>"SET MIDI_INSTRUMENT_MAP NAME"<span> (</span><span class='info'>Renaming a MIDI instrument map</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
+ </p>
+ </blockquote><p>
+                 Please note that these lists are manually maintained. If you
+                 find a command that also supports escape sequences we forgot to
+                 mention here, please report it!
+ </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 7813 
 Number of sampler channels changed</h3>
+Line 10942 
 Number of sampler channels changed</h3>
  <p>where &lt;channels&gt; will be replaced by the new number
                  of sampler channels.
  </p>
- <a name="SUBSCRIBE VOICE_COUNT"></a><br /><hr />
+ <a name="SUBSCRIBE CHANNEL_MIDI"></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.6"></a><h3>8.6.&nbsp;
+ MIDI data on a sampler channel arrived</h3>
+ <p>Client may want to be notified when MIDI data arrive on sampler channels on
+                 back-end side, by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE CHANNEL_MIDI
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending one of the the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"
+ </p>
+ <p>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
+                 data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
+.. 127, reflecting the analog meaning of the MIDI specification.
+ </p>
+ <p>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
+                 delivered by this mechanism! With other words: events could be lost at any time!
+                 This restriction was made to keep the RT-safeness of the backend's MIDI and audio
+                 thread unaffected by this feature.
+ </p>
+ <a name="SUBSCRIBE VOICE_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.7"></a><h3>8.7.&nbsp;
  Number of active voices changed</h3>
  <p>Client may want to be notified when the number of voices on the
-Line 7834 
 Number of active voices changed</h3>
+Line 11001 
 Number of active voices changed</h3>
  <p>
                      </p>
  <blockquote class="text">
- <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;
+ <p>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"
  </p>
  </blockquote><p>
-Line 7845 
 Number of active voices changed</h3>
+Line 11012 
 Number of active voices changed</h3>
  </p>
  <a name="SUBSCRIBE STREAM_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.7"></a><h3>8.7.&nbsp;
+ <a name="rfc.section.8.8"></a><h3>8.8.&nbsp;
  Number of active disk streams changed</h3>
  <p>Client may want to be notified when the number of streams on the back-end
-Line 7875 
 Number of active disk streams changed</h
+Line 11042 
 Number of active disk streams changed</h
  </p>
  <a name="SUBSCRIBE BUFFER_FILL"></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.8"></a><h3>8.8.&nbsp;
+ <a name="rfc.section.8.9"></a><h3>8.9.&nbsp;
  Disk stream buffer fill state changed</h3>
  <p>Client may want to be notified when the buffer fill state of a disk stream
-Line 7906 
 Disk stream buffer fill state changed</h
+Line 11073 
 Disk stream buffer fill state changed</h
  </p>
  <a name="SUBSCRIBE CHANNEL_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.9"></a><h3>8.9.&nbsp;
+ <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
  Channel information changed</h3>
  <p>Client may want to be notified when changes were made to sampler channels on the
-Line 7937 
 Channel information changed</h3>
+Line 11104 
 Channel information changed</h3>
                  time events happening on the server, it is believed that an empty notification
                  message is sufficient here.
  </p>
+ <a name="SUBSCRIBE FX_SEND_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.11"></a><h3>8.11.&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>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE FX_SEND_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
+                 channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
+                 be replaced by the new number of effect sends on that channel.
+ </p>
+ <a name="SUBSCRIBE FX_SEND_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.12"></a><h3>8.12.&nbsp;
+ Effect send information changed</h3>
+ <p>Client may want to be notified when changes were made to effect sends on a
+                 a particular sampler channel by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE FX_SEND_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
+                 channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
+                 be replaced by the numerical ID of the changed effect send.
+ </p>
  <a name="SUBSCRIBE TOTAL_VOICE_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.10"></a><h3>8.10.&nbsp;
+ <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
  Total number of active voices changed</h3>
  <p>Client may want to be notified when the total number of voices on the
-Line 7958 
 Total number of active voices changed</h
+Line 11185 
 Total number of active voices changed</h
  <p>
                      </p>
  <blockquote class="text">
- <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;
+ <p>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"
  </p>
  </blockquote><p>
-Line 7966 
 Total number of active voices changed</h
+Line 11193 
 Total number of active voices changed</h
  <p>where &lt;voices&gt; will be replaced by the new number of
                  all currently active voices.
  </p>
+ <a name="SUBSCRIBE TOTAL_STREAM_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.14"></a><h3>8.14.&nbsp;
+ Total number of active disk streams changed</h3>
+ <p>Client may want to be notified when the total number of disk streams on the
+                 back-end changes by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE TOTAL_STREAM_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;streams&gt; will be replaced by the new number of
+                 all currently active disk streams.
+ </p>
  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_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.11"></a><h3>8.11.&nbsp;
+ <a name="rfc.section.8.15"></a><h3>8.15.&nbsp;
  Number of MIDI instrument maps changed</h3>
  <p>Client may want to be notified when the number of MIDI instrument maps on the
-Line 7997 
 Number of MIDI instrument maps changed</
+Line 11253 
 Number of MIDI instrument maps changed</
  </p>
  <a name="SUBSCRIBE MIDI_INSTRUMENT_MAP_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.12"></a><h3>8.12.&nbsp;
+ <a name="rfc.section.8.16"></a><h3>8.16.&nbsp;
  MIDI instrument map information changed</h3>
  <p>Client may want to be notified when changes were made to MIDI instrument maps on the
-Line 8030 
 MIDI instrument map information changed<
+Line 11286 
 MIDI instrument map information changed<
  </p>
  <a name="SUBSCRIBE MIDI_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.13"></a><h3>8.13.&nbsp;
+ <a name="rfc.section.8.17"></a><h3>8.17.&nbsp;
  Number of MIDI instruments changed</h3>
  <p>Client may want to be notified when the number of MIDI instrument maps on the
-Line 8060 
 Number of MIDI instruments changed</h3>
+Line 11316 
 Number of MIDI instruments changed</h3>
  </p>
  <a name="SUBSCRIBE MIDI_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.14"></a><h3>8.14.&nbsp;
+ <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
  MIDI instrument information changed</h3>
  <p>Client may want to be notified when changes were made to MIDI instruments on the
-Line 8092 
 MIDI instrument information changed</h3>
+Line 11348 
 MIDI instrument information changed</h3>
                  time events happening on the server, it is believed that an empty notification
                  message is sufficient here.
  </p>
+ <a name="SUBSCRIBE GLOBAL_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;
+ Global settings changed</h3>
+ <p>Client may want to be notified when changes to the global settings
+                 of the sampler were made by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE GLOBAL_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following types of notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
+                         golbal volume of the sampler is changed, where &lt;volume&gt; will be
+                         replaced by the optional dotted floating point value, reflecting the
+                         new global volume parameter.
+ </p>
+ </blockquote><p>
+ </p>
+ <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.20"></a><h3>8.20.&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.21"></a><h3>8.21.&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.22"></a><h3>8.22.&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.23"></a><h3>8.23.&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.24"></a><h3>8.24.&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.15"></a><h3>8.15.&nbsp;
+ <a name="rfc.section.8.25"></a><h3>8.25.&nbsp;
  Miscellaneous and debugging events</h3>
  <p>Client may want to be notified of miscellaneous and debugging events occurring at
-Line 8159 
 Acknowledgments</h3>
+Line 11635 
 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 8189 
 Schoenebeck</td></tr>
+Line 11667 
 Schoenebeck</td></tr>
  <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>Full Copyright Statement</h3>
  <p class='copyright'>
- Copyright &copy; The Internet Society (2006).</p>
+ Copyright &copy; The IETF Trust (2008).</p>
  <p class='copyright'>
  This document is subject to the rights,
  licenses and restrictions contained in BCP&nbsp;78,
-Line 8198 
 the authors retain all their rights.</p>
+Line 11676 
 the authors retain all their rights.</p>
  <p class='copyright'>
  This document and the information contained herein are provided
  on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
- THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY),
+ THE ORGANIZATION HE/SHE REPRESENTS
- THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM
+ OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
- ALL WARRANTIES,
+ AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
- EXPRESS OR IMPLIED,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
- INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
+ THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
- INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
+ IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
- WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.</p>
+ PURPOSE.</p>
  <h3>Intellectual Property</h3>
  <p class='copyright'>
  The IETF takes no position regarding the validity or scope of any
-Line 8236 
 Please address the information to the IE
+Line 11714 
 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.1002
 


changed lines


 
Added in v.1685
 Legend:



Removed from v.1002
 


changed lines


 
Added in v.1685
-Removed from v.1002
+Added in v.1685

	ViewVC Help
Powered by ViewVC