/[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 1162 by iliev,
Mon Apr 16 16:02:19 2007 UTC
+revision 2189 by iliev,
Fri Jun 24 19:57:07 2011 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.32 (http://xml.resource.org/)">
+ <meta name="generator" content="xml2rfc v1.34 (http://xml.resource.org/)">
  <style type='text/css'><!--
          body {
                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
 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: October 18, 2007</td><td class="header">April 16, 2007</td></tr>
+ <tr><td class="header">Expires: December 26, 2011</td><td class="header">June 24, 2011</td></tr>
  </table></td></tr></table>
- <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
+ <h1><br />LinuxSampler Control Protocol<br />LSCP 1.5</h1>
+ <h3>Abstract</h3>
+ <p>The LinuxSampler Control Protocol (LSCP) is an
+             application-level protocol primarily intended for local and
+             remote controlling the LinuxSampler backend application, which is a
+             sophisticated server-like console application essentially playing
+             back audio samples and manipulating the samples in real time to
+             certain extent.
+ </p>
  <h3>Status of this Memo</h3>
  <p>
  By submitting this Internet-Draft,
-Line 173 
 The list of current Internet-Drafts can
+Line 182 
 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 October 18, 2007.</p>
+ This Internet-Draft will expire on December 26, 2011.</p>
+ <a name="toc"></a><br /><hr />
- <h3>Copyright Notice</h3>
- <p>
- Copyright &copy; The IETF Trust (2007).</p>
- <h3>Abstract</h3>
- <p>The LinuxSampler Control Protocol (LSCP) is an
-             application-level protocol primarily intended for local and
-             remote controlling the LinuxSampler backend application, which is a
-             sophisticated server-like console application essentially playing
-             back audio samples and manipulating the samples in real time to
-             certain extent.
- </p><a name="toc"></a><br /><hr />
  <h3>Table of Contents</h3>
  <p class="toc">
  <a href="#anchor1">1.</a>&nbsp;
-Line 332 
 Getting effect send information<br />
+Line 328 
 Getting effect send information<br />
  Changing effect send's name<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
  Altering effect send's audio routing<br />
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND EFFECT">6.4.32.</a>&nbsp;
+ Assigning destination effect to an effect send<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE FX_SEND EFFECT">6.4.33.</a>&nbsp;
+ Removing destination effect from an effect send<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.34.</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;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.35.</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;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SEND CHANNEL MIDI_DATA">6.4.36.</a>&nbsp;
+ Sending MIDI messages to sampler channel<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.37.</a>&nbsp;
  Resetting a sampler channel<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
  Controlling connection<br />
-Line 354 
 Global commands<br />
+Line 356 
 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.5.</a>&nbsp;
+ &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.6.</a>&nbsp;
+ &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;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOICES">6.6.8.</a>&nbsp;
+ Getting global voice limit<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOICES">6.6.9.</a>&nbsp;
+ Setting global voice limit<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET STREAMS">6.6.10.</a>&nbsp;
+ Getting global disk stream limit<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET STREAMS">6.6.11.</a>&nbsp;
+ Setting global disk stream limit<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 404 
 Getting instrument directory information
+Line 416 
 Getting instrument directory information
  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="#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">6.8.8.</a>&nbsp;
+ &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="#ADD DB_INSTRUMENTS">6.8.9.</a>&nbsp;
+ &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.10.</a>&nbsp;
+ &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.11.</a>&nbsp;
+ &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.12.</a>&nbsp;
+ &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.13.</a>&nbsp;
+ &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.14.</a>&nbsp;
+ &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.15.</a>&nbsp;
+ &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="#SET DB_INSTRUMENT DESCRIPTION">6.8.16.</a>&nbsp;
+ &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;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a>&nbsp;
+ Checking for lost instrument files<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a>&nbsp;
+ Replacing an instrument file<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 />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#effects">6.11.</a>&nbsp;
+ Managing Effects<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET AVAILABLE_EFFECTS">6.11.1.</a>&nbsp;
+ Retrieve amount of available effects<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST AVAILABLE_EFFECTS">6.11.2.</a>&nbsp;
+ Get list of available effects<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT INFO">6.11.3.</a>&nbsp;
+ Retrieving general information about an effect<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE EFFECT_INSTANCE">6.11.4.</a>&nbsp;
+ Creating an instance of an effect by its portable ID<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#CREATE EFFECT_INSTANCE (non-portable)">6.11.5.</a>&nbsp;
+ Creating an instance of an effect by its numerical ID<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#DESTROY EFFECT_INSTANCE">6.11.6.</a>&nbsp;
+ Destroy an effect instance<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT_INSTANCES">6.11.7.</a>&nbsp;
+ Retrieve amount of effect instances<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST EFFECT_INSTANCES">6.11.8.</a>&nbsp;
+ Get list of effect instances<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT_INSTANCE INFO">6.11.9.</a>&nbsp;
+ Retrieving current information about an effect instance<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET EFFECT_INSTANCE_INPUT_CONTROL INFO">6.11.10.</a>&nbsp;
+ Retrieving information about an effect parameter<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">6.11.11.</a>&nbsp;
+ Altering an effect parameter<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SEND_EFFECT_CHAINS">6.11.12.</a>&nbsp;
+ Retrieve amount of send effect chains<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#LIST SEND_EFFECT_CHAINS">6.11.13.</a>&nbsp;
+ Retrieve list of send effect chains<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD SEND_EFFECT_CHAIN">6.11.14.</a>&nbsp;
+ Add send effect chain<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE SEND_EFFECT_CHAIN">6.11.15.</a>&nbsp;
+ Remove send effect chain<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SEND_EFFECT_CHAIN INFO">6.11.16.</a>&nbsp;
+ Retrieving information about a send effect chain<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#APPEND SEND_EFFECT_CHAIN EFFECT">6.11.17.</a>&nbsp;
+ Append effect instance to a send effect chain<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#INSERT SEND_EFFECT_CHAIN EFFECT">6.11.18.</a>&nbsp;
+ Insert effect instance to a send effect chain<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE SEND_EFFECT_CHAIN EFFECT">6.11.19.</a>&nbsp;
+ Remove effect instance from send effect chain<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 436 
 Number of MIDI input devices changed<br
+Line 518 
 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 DEVICE_MIDI">8.7.</a>&nbsp;
+ MIDI data on a MIDI input device arrived<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE VOICE_COUNT">8.8.</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.9.</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.10.</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.11.</a>&nbsp;
  Channel information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.10.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_COUNT">8.12.</a>&nbsp;
  Number of effect sends changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.11.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE FX_SEND_INFO">8.13.</a>&nbsp;
  Effect send information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.12.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_VOICE_COUNT">8.14.</a>&nbsp;
  Total number of active voices changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.13.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE TOTAL_STREAM_COUNT">8.15.</a>&nbsp;
+ Total number of active disk streams changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">8.16.</a>&nbsp;
  Number of MIDI instrument maps changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.14.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">8.17.</a>&nbsp;
  MIDI instrument map information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.15.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_COUNT">8.18.</a>&nbsp;
  Number of MIDI instruments changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.16.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MIDI_INSTRUMENT_INFO">8.19.</a>&nbsp;
  MIDI instrument information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.17.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE GLOBAL_INFO">8.20.</a>&nbsp;
  Global settings changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.18.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">8.21.</a>&nbsp;
  Number of database instrument directories changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.19.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">8.22.</a>&nbsp;
  Database instrument directory information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.20.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_COUNT">8.23.</a>&nbsp;
  Number of database instruments changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.21.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENT_INFO">8.24.</a>&nbsp;
  Database instrument information changed<br />
- &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.22.</a>&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.25.</a>&nbsp;
+ Database job status information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE EFFECT_INSTANCE_COUNT">8.26.</a>&nbsp;
+ Number of effect instances changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE EFFECT_INSTANCE_INFO">8.27.</a>&nbsp;
+ Effect instance information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE SEND_EFFECT_CHAIN_COUNT">8.28.</a>&nbsp;
+ Number of send effect chains changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE SEND_EFFECT_CHAIN_INFO">8.29.</a>&nbsp;
+ Send effect chain information changed<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.30.</a>&nbsp;
  Miscellaneous and debugging events<br />
  <a href="#anchor14">9.</a>&nbsp;
  Security Considerations<br />
-Line 500 
 Requirements notation</h3>
+Line 598 
 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 3287 
 Changing settings of MIDI input ports</h
+Line 3385 
 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 3328 
 Changing settings of MIDI input ports</h
+Line 3427 
 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 3363 
 Loading an instrument</h3>
+Line 3474 
 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 3410 
 Loading an instrument</h3>
+Line 3527 
 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 3830 
 Getting information about an engine</h3>
+Line 3961 
 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 3915 
 Getting sampler channel information</h3>
+Line 4048 
 Getting sampler channel information</h3>
  <blockquote class="text">
  <p>numerical ID of the audio output device which is
                                              currently connected to this sampler channel to output
-                                             the audio signal, "NONE" if there's no device
+                                             the audio signal, "-1" if there's no device
                                              connected to this sampler channel
  </p>
  </blockquote>
-Line 3949 
 Getting sampler channel information</h3>
+Line 4082 
 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 3957 
 Getting sampler channel information</h3>
+Line 4091 
 Getting sampler channel information</h3>
  <p>INSTRUMENT_NR -
                                          </p>
  <blockquote class="text">
- <p>the instrument index number of the loaded instrument
+ <p>the instrument index number of the loaded instrument,
+                                             "-1" if there's no instrument loaded for this sampler
+                                             channel
  </p>
  </blockquote>
-Line 3966 
 Getting sampler channel information</h3>
+Line 4102 
 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 3973 
 Getting sampler channel information</h3>
+Line 4111 
 Getting sampler channel information</h3>
  <p>INSTRUMENT_STATUS -
                                          </p>
  <blockquote class="text">
- <p>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative
+ <p>Integer values 0 to 100 indicating loading progress
-                                             value indicates a loading exception. Value of 100 indicates that the instrument is fully
+                                             percentage for the instrument. Negative
+                                             value indicates a loading exception (also returns "-1" in case no
+                                             instrument was yet to be loaded on the sampler channel).
+                                             Value of 100 indicates that the instrument is fully
                                              loaded.
  </p>
  </blockquote>
-Line 3985 
 Getting sampler channel information</h3>
+Line 4126 
 Getting sampler channel information</h3>
  <blockquote class="text">
  <p>numerical ID of the MIDI input device which is
                                              currently connected to this sampler channel to deliver
-                                             MIDI input commands, "NONE" if there's no device
+                                             MIDI input commands, "-1" if there's no device
                                              connected to this sampler channel
  </p>
  </blockquote>
-Line 3994 
 Getting sampler channel information</h3>
+Line 4135 
 Getting sampler channel information</h3>
  <p>MIDI_INPUT_PORT -
                                          </p>
  <blockquote class="text">
- <p>port number of the MIDI input device
+ <p>port number of the MIDI input device (in case a
+                                             MIDI device was already assigned to the sampler
+                                             channel)
  </p>
  </blockquote>
-Line 5041 
 Adding an effect send to a sampler chann
+Line 5184 
 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 5310 
 Getting effect send information</h3>
+Line 5455 
 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>
-Line 5344 
 Getting effect send information</h3>
+Line 5491 
 Getting effect send information</h3>
                                              channel 1 is routed to the channel 3 of the audio
                                              output device (see
                                              <a class='info' href='#SET FX_SEND AUDIO_OUTPUT_CHANNEL'>"SET FX_SEND AUDIO_OUTPUT_CHANNEL"<span> (</span><span class='info'>Altering effect send's audio routing</span><span>)</span></a>
-                                             for details)
+                                             for details), if an internal send
+                                             effect is assigned to the effect
+                                             send, then this setting defines the
+                                             audio channel routing to that
+                                             effect instance respectively
+ </p>
+ </blockquote>
+ <p>EFFECT -
+                                         </p>
+ <blockquote class="text">
+ <p>destination send effect chain ID
+                                             and destination effect chain
+                                             position, separated by comma in the
+                                             form "&lt;effect-chain&gt;,&lt;chain-pos&gt;"
+                                             or "NONE" if there is no send effect
+                                             assigned to the effect send
  </p>
  </blockquote>
-Line 5372 
 Getting effect send information</h3>
+Line 5536 
 Getting effect send information</h3>
  </p>
  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
  </p>
+ <p>&nbsp;&nbsp;&nbsp;"EFFECT: NONE"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET FX_SEND INFO 0 1"
+ </p>
+ <p>S: "NAME: Delay Send (Internal)"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 93"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.51"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 1,2"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"EFFECT: 2,0"
+ </p>
  <p>&nbsp;&nbsp;&nbsp;"."
  </p>
  </blockquote><p>
-Line 5400 
 Changing effect send's name</h3>
+Line 5586 
 Changing effect send's name</h3>
                      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.
+                     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>
-Line 5463 
 Altering effect send's audio routing</h3
+Line 5652 
 Altering effect send's audio routing</h3
                      &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
                      which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
                      the audio channel of the selected audio output device where &lt;audio-src&gt;
-                     should be routed to.
+                     should be routed to. If an internal send effect is assigned
+                     to the effect send, then this setting defines the audio
+                     channel routing to that effect instance respectively.
  </p>
  <p>Note that effect sends can only route audio to the same audio output
                      device as assigned to the effect send's sampler channel. Also note that an
-Line 5521 
 Altering effect send's audio routing</h3
+Line 5712 
 Altering effect send's audio routing</h3
  </blockquote><p>
  </p>
- <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
+ <a name="SET FX_SEND EFFECT"></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;
+ Assigning destination effect to an effect send</h3>
+ <p>The front-end can (re-)assign a destination effect to an
+                     effect send by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;effect-chain&gt; &lt;chain-pos&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,
+                     &lt;effect-chain&gt; by the numerical ID of the destination
+                     effect chain as returned by the
+                     <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
+                     command and &lt;chain-pos&gt; reflects the exact effect
+                     chain position in the effect chain which hosts the actual
+                     destination effect.
+ </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 EFFECT 0 0 2 5"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE FX_SEND EFFECT"></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;
+ Removing destination effect from an effect send</h3>
+ <p>The front-end can (re-)assign a destination effect to an
+                     effect send by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE FX_SEND EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&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.
+ </p>
+ <p>After the destination effect has been removed from the
+                     effect send, the audio signal of the effect send will be
+                     routed directly to the audio output device, according to the
+                     audio channel routing setting of the effect send.
+ </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: "REMOVE FX_SEND EFFECT 0 0"
+ </p>
+ <p>S: "OK"
+ </p>
+ </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.34"></a><h3>6.4.34.&nbsp;
  Altering effect send's MIDI controller</h3>
  <p>The front-end can alter the MIDI controller of an effect
-Line 5594 
 Altering effect send's MIDI controller</
+Line 5917 
 Altering effect send's MIDI controller</
  </p>
  <a name="SET FX_SEND LEVEL"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
+ <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
  Altering effect send's send level</h3>
  <p>The front-end can alter the current send level of an effect
-Line 5664 
 Altering effect send's send level</h3>
+Line 5987 
 Altering effect send's send level</h3>
  </blockquote><p>
  </p>
+ <a name="SEND CHANNEL MIDI_DATA"></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.36"></a><h3>6.4.36.&nbsp;
+ Sending MIDI messages to sampler channel</h3>
+ <p>The front-end can send MIDI events to a specific sampler channel
+                     by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&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;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
+                     specifies the MIDI message type. Currently, the following MIDI messages are supported:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"NOTE_ON" -
+                                 </p>
+ <blockquote class="text">
+ <p>For turning on MIDI notes, where &lt;arg1&gt;
+                                     specifies the key number and &lt;arg2&gt; the velocity
+                                     as described in the MIDI specification.
+ </p>
+ </blockquote>
+ <p>"NOTE_OFF" -
+                                 </p>
+ <blockquote class="text">
+ <p>For turning a currently playing MIDI note off, where &lt;arg1&gt;
+                                     specifies the key number and &lt;arg2&gt; the velocity
+                                     as described in the MIDI specification.
+ </p>
+ </blockquote>
+ <p>"CC" -
+                                 </p>
+ <blockquote class="text">
+ <p>For changing a MIDI controller, where &lt;arg1&gt;
+                                     specifies the controller number and &lt;arg2&gt; the
+                                     new value of the controller as described in the Control
+                                     Change section of the MIDI specification.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>CAUTION: This command is provided for implementations of virtual MIDI keyboards
+                     and no realtime guarantee whatsoever will be made!
+ </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: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
+ </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.34"></a><h3>6.4.34.&nbsp;
+ <a name="rfc.section.6.4.37"></a><h3>6.4.37.&nbsp;
  Resetting a sampler channel</h3>
  <p>The front-end can reset a particular sampler channel by sending the following command:
-Line 6001 
 Maximum amount of active voices</h3>
+Line 6422 
 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 6044 
 Reset sampler</h3>
+Line 6492 
 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 6077 
 General sampler informations</h3>
+Line 6525 
 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 6118 
 General sampler informations</h3>
+Line 6568 
 General sampler informations</h3>
  </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.5"></a><h3>6.6.5.&nbsp;
+ <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
-Line 6151 
 Getting global volume attenuation</h3>
+Line 6601 
 Getting global volume attenuation</h3>
  </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.6"></a><h3>6.6.6.&nbsp;
+ <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
-Line 6204 
 Setting global volume attenuation</h3>
+Line 6654 
 Setting global volume attenuation</h3>
  </blockquote><p>
  </p>
+ <a name="GET VOICES"></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.8"></a><h3>6.6.8.&nbsp;
+ Getting global voice limit</h3>
+ <p>The client can ask for the current global sampler-wide limit
+                        for maximum voices by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET VOICES
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by returning the number for
+                                the current limit of maximum voices.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>The voice limit setting defines how many voices should maximum
+                        be processed by the sampler at the same time. If the user
+                        triggers new notes which would exceed that voice limit, the
+                        sampler engine will react by stealing old voices for those
+                        newly triggered notes. Note that the amount of voices triggered
+                        by a new note can be larger than one and is dependent to the
+                        respective instrument and probably further criterias.
+ </p>
+ <a name="SET VOICES"></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.9"></a><h3>6.6.9.&nbsp;
+ Setting global voice limit</h3>
+ <p>The client can alter the current global sampler-wide limit
+                     for maximum voices by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET VOICES &lt;max-voices&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;max-voices&gt; should be replaced by the integer
+                    value, reflecting the new global amount limit of maximum voices.
+                    This value has to be larger than 0.
+ </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 voice limit 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>Note: the given value will be passed to all sampler engine instances.
+                        The total amount of maximum voices on the running system might thus
+                        be as big as the given value multiplied by the current amount of engine
+                        instances.
+ </p>
+ <p>Caution: when adjusting the voice limit, you SHOULD also
+                         adjust the disk stream limit respectively and vice versa.
+ </p>
+ <a name="GET STREAMS"></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.10"></a><h3>6.6.10.&nbsp;
+ Getting global disk stream limit</h3>
+ <p>The client can ask for the current global sampler-wide limit
+                        for maximum disk streams by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET STREAMS
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by returning the number for
+                                the current limit of maximum disk streams.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>The disk stream limit setting defines how many disk streams should
+                        maximum be processed by a sampler engine at the same time. The
+                        higher this value, the more memory (RAM) will be occupied, since
+                        every disk streams allocates a certain buffer size for being able
+                        to perform its streaming operations.
+ </p>
+ <a name="SET STREAMS"></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.11"></a><h3>6.6.11.&nbsp;
+ Setting global disk stream limit</h3>
+ <p>The client can alter the current global sampler-wide limit
+                     for maximum disk streams by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET STREAMS &lt;max-streams&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;max-streams&gt; should be replaced by the integer
+                    value, reflecting the new global amount limit of maximum disk streams.
+                    This value has to be positive.
+ </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 disk stream limit 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>Note: the given value will be passed to all sampler engine instances.
+                        The total amount of maximum disk streams on the running system might
+                        thus be as big as the given value multiplied by the current amount of
+                        engine instances.
+ </p>
+ <p>Caution: when adjusting the disk stream limit, you SHOULD also
+                         adjust the voice limit respectively and vice versa.
+ </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 6238 
 MIDI Instrument Mapping</h3>
+Line 6880 
 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 6256 
 Create a new MIDI instrument map</h3>
+Line 6898 
 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 6514 
 Getting MIDI instrument map information<
+Line 7159 
 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>
-Line 6569 
 Renaming a MIDI instrument map</h3>
+Line 7216 
 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 6635 
 Create or replace a MIDI instrument map
+Line 7285 
 Create or replace a MIDI instrument map
                      index, &lt;engine_name&gt; a sampler engine name as returned by
                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
-                     of the instrument's file to be deployed (encapsulated into apostrophes),
+                     of the instrument's file to be deployed (encapsulated into apostrophes,
+                     supporting escape sequences as described in chapter
+                     "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"),
                      &lt;instrument_index&gt; the index (integer value) of the instrument
                      within the given file, &lt;volume_value&gt; reflects the master
                      volume of the instrument as optionally dotted number (where a
-Line 6732 
 Create or replace a MIDI instrument map
+Line 7384 
 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>).
-Line 7056 
 Get current settings of MIDI instrument
+Line 7709 
 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 7072 
 Get current settings of MIDI instrument
+Line 7727 
 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 7090 
 Get current settings of MIDI instrument
+Line 7747 
 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 7225 
 Managing Instruments Database</h3>
+Line 7883 
 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;
-Line 7351 
 Getting amount of instrument directories
+Line 8026 
 Getting amount of instrument directories
  <p>
                          </p>
  <blockquote class="text">
- <p>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;
+ <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.
+                     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>
-Line 7401 
 Listing all directories in specific dire
+Line 8078 
 Listing all directories in specific dire
  <p>
                          </p>
  <blockquote class="text">
- <p>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;
+ <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.
+                     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>
-Line 7440 
 Listing all directories in specific dire
+Line 8119 
 Listing all directories in specific dire
  </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;
-Line 7476 
 Getting instrument directory information
+Line 8165 
 Getting instrument directory information
  <p>DESCRIPTION -
                                          </p>
  <blockquote class="text">
- <p>A brief description of the directory content
+ <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>
-Line 7643 
 Moving an instrument directory</h3>
+Line 8334 
 Moving an instrument directory</h3>
  </blockquote><p>
  </p>
- <a name="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"></a><br /><hr />
+ <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
-Line 7660 
 Changing the description of directory</h
+Line 8412 
 Changing the description of directory</h
  </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.
+                     &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>
-Line 7698 
 Changing the description of directory</h
+Line 8452 
 Changing the description of directory</h
  </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.9"></a><h3>6.8.9.&nbsp;
+ <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
-Line 7709 
 Adding instruments to the instruments da
+Line 8592 
 Adding instruments to the instruments da
  <p>
                          </p>
  <blockquote class="text">
- <p>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
+ <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
  </p>
  </blockquote><p>
-Line 7731 
 Adding instruments to the instruments da
+Line 8614 
 Adding instruments to the instruments da
  <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">
-Line 7753 
 Adding instruments to the instruments da
+Line 8647 
 Adding instruments to the instruments da
  </blockquote>
- <p>not supplied -
-                                 </p>
- <blockquote class="text">
- <p>The subdirectory tree structure will be recreated
-                                     in the instruments database and all instruments will be
-                                     processed and added to the respective subdirectory
-                                     in the instruments database.
- </p>
- </blockquote>
  </blockquote><p>
  </p>
+ <p> If FILE_AS_DIR argument is supplied, all instruments in an instrument
+                  file will be added to a separate directory in the instruments database, which
+                  name will be the name of the instrument file with the file extension stripped off.
+ </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>
-Line 7775 
 Adding instruments to the instruments da
+Line 8669 
 Adding instruments to the instruments da
  <p>"OK" -
                                  </p>
  <blockquote class="text">
- <p>on success
+ <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>
-Line 7805 
 Adding instruments to the instruments da
+Line 8710 
 Adding instruments to the instruments da
  </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.10"></a><h3>6.8.10.&nbsp;
+ <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
-Line 7861 
 Removing an instrument</h3>
+Line 8766 
 Removing an instrument</h3>
  </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.11"></a><h3>6.8.11.&nbsp;
+ <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
-Line 7870 
 Getting amount of instruments</h3>
+Line 8775 
 Getting amount of instruments</h3>
  <p>
                          </p>
  <blockquote class="text">
- <p>GET DB_INSTRUMENTS &lt;dir&gt;
+ <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.
+                     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>
-Line 7911 
 Getting amount of instruments</h3>
+Line 8818 
 Getting amount of instruments</h3>
  </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.12"></a><h3>6.8.12.&nbsp;
+ <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
-Line 7920 
 Listing all instruments in specific dire
+Line 8827 
 Listing all instruments in specific dire
  <p>
                          </p>
  <blockquote class="text">
- <p>LIST DB_INSTRUMENTS &lt;dir&gt;
+ <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.
+                     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>
-Line 7959 
 Listing all instruments in specific dire
+Line 8868 
 Listing all instruments in specific dire
  </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.13"></a><h3>6.8.13.&nbsp;
+ <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
-Line 7996 
 Getting instrument information</h3>
+Line 8915 
 Getting instrument information</h3>
                                          </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>
-Line 8055 
 Getting instrument information</h3>
+Line 8976 
 Getting instrument information</h3>
  <p>DESCRIPTION -
                                          </p>
  <blockquote class="text">
- <p>A brief description of the instrument
+ <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>
-Line 8072 
 Getting instrument information</h3>
+Line 8995 
 Getting instrument information</h3>
  <p>PRODUCT -
                                          </p>
  <blockquote class="text">
- <p>The product title of the instrument
+ <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>
-Line 8080 
 Getting instrument information</h3>
+Line 9005 
 Getting instrument information</h3>
  <p>ARTISTS -
                                          </p>
  <blockquote class="text">
- <p>Lists the artist names
+ <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>
-Line 8090 
 Getting instrument information</h3>
+Line 9017 
 Getting instrument information</h3>
  <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>
-Line 8140 
 Getting instrument information</h3>
+Line 9069 
 Getting instrument information</h3>
  </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.14"></a><h3>6.8.14.&nbsp;
+ <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
-Line 8197 
 Renaming an instrument</h3>
+Line 9126 
 Renaming an instrument</h3>
  </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.15"></a><h3>6.8.15.&nbsp;
+ <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
-Line 8254 
 Moving an instrument</h3>
+Line 9183 
 Moving an instrument</h3>
  </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.16"></a><h3>6.8.16.&nbsp;
+ <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
-Line 8271 
 Changing the description of instrument</
+Line 9259 
 Changing the description of instrument</
  </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.
+                     &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>
-Line 8309 
 Changing the description of instrument</
+Line 9299 
 Changing the description of instrument</
  </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="FIND LOST DB_INSTRUMENT_FILES"></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.23"></a><h3>6.8.23.&nbsp;
+ Checking for lost instrument files</h3>
+ <p>The front-end can retrieve the list of all instrument files in the instruments database
+                     that don't exist in the filesystem by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>FIND LOST DB_INSTRUMENT_FILES
+ </p>
+ </blockquote><p>
+ </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 lost instrument files.
+ </p>
+ <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: "FIND LOST DB_INSTRUMENT_FILES"
+ </p>
+ <p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT FILE_PATH"></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.24"></a><h3>6.8.24.&nbsp;
+ Replacing an instrument file</h3>
+ <p>The front-end can substitute all occurrences of an instrument file
+                     in the instruments database with a new one by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;old_path&gt; is the absolute path name of the instrument file
+                     to substitute with &lt;new_path&gt;.
+ </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 DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </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>
+ <p>KEY_BINDINGS -
+                                         </p>
+ <blockquote class="text">
+ <p>comma separated list of integer values representing
+                                                the instrument's key mapping in the range between 0 .. 127,
+                                                reflecting the analog meaning of the MIDI specification.
+ </p>
+ </blockquote>
+ <p>KEYSWITCH_BINDINGS -
+                                         </p>
+ <blockquote class="text">
+ <p>comma separated list of integer values representing
+                                                the instrument's keyswitch mapping in the range between 0 .. 127,
+                                                reflecting the analog meaning of the MIDI specification.
+ </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="effects"></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.11"></a><h3>6.11.&nbsp;
+ Managing Effects</h3>
+ <p>Audio effects (e.g. reverb, delay, compression) can be
+                 applied to the audio signals generated by the sampler. The
+                 sampler usually provides a set of internal audio effects for
+                 this task. The exact set of effects depends on the availability
+                 of third party effect plugins installed on the system where the
+                 sampler runs on.
+ </p>
+ <p>At the moment only "send effects" are supported. Support for
+                 "insert effects" and "master effects" is planned to be added at
+                 a later point.
+ </p>
+ <p>The following commands allow to retrieve the set of internal
+                 effects available to the sampler, detailed informations about
+                 those effects and to create and destroy instances of such
+                 effects. After an instance of an effect is created, the effect
+                 instance can be inserted into the audio signal path of the
+                 sampler, e.g. as send effect.
+ </p>
+ <p>The sampler allows to create an arbitrary amount of so called
+                 send effect chains. Each effect chain can host an arbitrary
+                 amount of effect instances. The output of the first effect
+                 instance in an effect chain is fed to the input of the second
+                 effect instance of the chain and so on. So effects in one chain
+                 are processed sequentially. Send effect chains however are
+                 processed in parallel to other send effect chains. Audio signals
+                 of sampler channels are fed to send effects by creating FX sends
+                 to the respective sampler channel and assigning a destination
+                 send effect to that FX by using the
+                 <a class='info' href='#SET FX_SEND EFFECT'>"SET FX_SEND EFFECT"<span> (</span><span class='info'>Assigning destination effect to an effect send</span><span>)</span></a>
+                 command. The latter allows to route the FX send to the beginning
+                 of a send effect chain, as well as directly to any other
+                 position of the send effect chain.
+ </p>
+ <a name="GET AVAILABLE_EFFECTS"></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.11.1"></a><h3>6.11.1.&nbsp;
+ Retrieve amount of available effects</h3>
+ <p>The front-end can retrieve the amount of internal
+                     effects, available to the sampler by sending
+                     the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET AVAILABLE_EFFECTS
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will answer by returning the current
+                             number of effects available to the sampler.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET AVAILABLE_EFFECTS"
+ </p>
+ <p>S: "129"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST AVAILABLE_EFFECTS"></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.11.2"></a><h3>6.11.2.&nbsp;
+ Get list of available effects</h3>
+ <p>The set of available internal effects can change at
+                     runtime. The front-end can retrieve the list of internal
+                     effects, available to the sampler by sending the following
+                     command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST AVAILABLE_EFFECTS
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will answer by returning a comma
+                             separated list with numerical IDs of effects. Note:
+                             the numercial ID of an effect is generated by the
+                             sampler for the current moment. The numerical ID of
+                             the same effect can change at runtime, e.g. when the
+                             user requests a rescan of available effect plugins.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST AVAILABLE_EFFECTS"
+ </p>
+ <p>S: "5,6,7,120,121,122,123,124"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET EFFECT 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.11.3"></a><h3>6.11.3.&nbsp;
+ Retrieving general information about an effect</h3>
+ <p>The front-end can ask for general informations about an
+                     effect by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET EFFECT INFO &lt;effect-index&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-index&gt; is the numerical ID of an
+                     effect as returned by the
+                     <a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a>
+                     command.
+ </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 effect information
+                             category name, followed by a colon and then a space
+                             character &lt;SP&gt; and finally the info character
+                             string to that effect information category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>SYSTEM -
+                                         </p>
+ <blockquote class="text">
+ <p>name of the effect plugin system
+                                             the effect is based on
+                                             (e.g. "LADSPA")
+ </p>
+ </blockquote>
+ <p>MODULE -
+                                         </p>
+ <blockquote class="text">
+ <p>module of the effect plugin
+                                             system that contains this effect,
+                                             the module is usually the
+                                             dynamic-linked library (DLL)
+                                             filename of the effect plugin,
+                                             including full path (note that this
+                                             filename 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>NAME -
+                                         </p>
+ <blockquote class="text">
+ <p>character string defining the
+                                             unique name of the effect within its
+                                             module (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>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>human readable name of the
+                                             effect, intended to be displayed in
+                                             user interfaces (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 EFFECT INFO 121"
+ </p>
+ <p>S: "SYSTEM: LADSPA"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"NAME: lowpass_iir"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Glame Lowpass Filter"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="CREATE EFFECT_INSTANCE"></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.11.4"></a><h3>6.11.4.&nbsp;
+ Creating an instance of an effect by its portable ID</h3>
+ <p>The front-end can spawn an instance of the desired
+                     effect by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>CREATE EFFECT_INSTANCE &lt;effect-system&gt; &lt;module&gt; &lt;effect-name&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-system&gt; is the "SYSTEM" field,
+                     &lt;module&gt; the "MODULE" field and &lt;effect-name&gt;
+                     the "NAME" field as returned by the
+                     <a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a>
+                     command. The filename of argument &lt;module&gt; and the
+                     character string of argument &lt;effect-name&gt; 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>
+ <p>The sampler will try to load the requested effect and to
+                     create an instance of it. To allow loading the same effect
+                     on a different machine, probably even running a completely
+                     different operating system (e.g. Linux vs. Windows), the
+                     sampler tries to match &lt;module&gt; "softly". That means
+                     it first tries to find an effect that exactly matches the
+                     given &lt;module&gt; argument. If there is no exact match,
+                     the sampler will try to lower the restrictions on matching
+                     the &lt;module&gt; argument more and more, e.g. by ignoring
+                     upper / lower case differences and by ignoring the path of
+                     the DLL filename and file extension. If there is still no
+                     match at the end, the sampler will try to ignore the
+                     &lt;module&gt; argument completely and as a last resort
+                     search for an effect that only matches the given
+                     &lt;effect-system&gt; and &lt;effect-name&gt; arguments.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK[&lt;effect-instance&gt;]" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was
+                                     successfully created, where
+                                     &lt;effect-instance&gt; is the numerical ID
+                                     of the new effect instance
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was spawned
+                                     successfully, 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>if the effect could not be instantiated
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"
+ </p>
+ <p>S: "OK[0]"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="CREATE EFFECT_INSTANCE (non-portable)"></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.11.5"></a><h3>6.11.5.&nbsp;
+ Creating an instance of an effect by its numerical ID</h3>
+ <p>The front-end can spawn an instance of the desired
+                     effect by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>CREATE EFFECT_INSTANCE &lt;effect-index&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-index&gt; is the numerical ID of the
+                     effect as returned by the
+                     <a class='info' href='#LIST AVAILABLE_EFFECTS'>"LIST AVAILABLE_EFFECTS"<span> (</span><span class='info'>Get list of available effects</span><span>)</span></a>
+                     command.
+ </p>
+ <p>The sampler will try to load the requested effect and to
+                     create an instance of it.
+ </p>
+ <p>Note: Since the numerical ID of a certain effect can
+                     change at any time, you should not use this command in
+                     LSCP files to restore a certain effect at a later time! To
+                     store a sampler session including all its effects, use the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>portable text-based
+                     version of "CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> instead! This
+                     allows to restore a sampler session with all its effects
+                     also on other machines, possibly even running a completely
+                     different operating system (e.g. Linux vs. Windows), with
+                     different plugin directories or plugin DLL names.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK[&lt;effect-instance&gt;]" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was
+                                     successfully created, where
+                                     &lt;effect-instance&gt; is the numerical ID
+                                     of the new effect instance
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was spawned
+                                     successfully, 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>if the effect could not be instantiated
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "CREATE EFFECT_INSTANCE 72"
+ </p>
+ <p>S: "OK[5]"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="DESTROY EFFECT_INSTANCE"></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.11.6"></a><h3>6.11.6.&nbsp;
+ Destroy an effect instance</h3>
+ <p>The front-end can destroy an unusued effect instance and
+                     thus freeing it from memory by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>DESTROY EFFECT_INSTANCE &lt;effect-instance&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-instance&gt; is the numerical ID of the
+                     effect instance as returned by the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
+                     <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
+                     command.
+ </p>
+ <p>The effect instance can only be destroyed if it's not
+                     used in any part of the sampler's audio signal path anymore.
+                     If the effect instance is still in use somewhere, trying to
+                     destroy the effect instance will result in an error
+                     message.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was successfully destroyed
+ </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>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "DESTROY EFFECT_INSTANCE 5"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET EFFECT_INSTANCES"></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.11.7"></a><h3>6.11.7.&nbsp;
+ Retrieve amount of effect instances</h3>
+ <p>The front-end can retrieve the current amount of effect
+                     instances by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET EFFECT_INSTANCES
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will answer by returning the current
+                             number of effect instances created and not yet
+                             destroyed in the current sampler session.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET EFFECT_INSTANCES"
+ </p>
+ <p>S: "14"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST EFFECT_INSTANCES"></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.11.8"></a><h3>6.11.8.&nbsp;
+ Get list of effect instances</h3>
+ <p>The front-end can retrieve the current list of effect
+                     instances by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST EFFECT_INSTANCES
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will answer by returning a comma
+                             separated list with numerical IDs of effects
+                             instances.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST EFFECT_INSTANCES"
+ </p>
+ <p>S: "9,11,14,15,16,17,25"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET EFFECT_INSTANCE 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.11.9"></a><h3>6.11.9.&nbsp;
+ Retrieving current information about an effect instance</h3>
+ <p>The front-end can ask for the current informations about
+                     a particular effect instance by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET EFFECT_INSTANCE INFO &lt;effect-instance&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-instance&gt; is the numerical ID of an
+                     effect instance as returned by the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
+                     command.
+ </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 information
+                             category name, followed by a colon and then a space
+                             character &lt;SP&gt; and finally the info character
+                             string to that information category. At the
+                             moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>SYSTEM -
+                                         </p>
+ <blockquote class="text">
+ <p>name of the effect plugin system
+                                             the effect is based on
+                                             (e.g. "LADSPA")
+ </p>
+ </blockquote>
+ <p>MODULE -
+                                         </p>
+ <blockquote class="text">
+ <p>module of the effect plugin
+                                             system that contains this effect,
+                                             the module is usually the
+                                             dynamic-linked library (DLL)
+                                             filename of the effect plugin,
+                                             including full path (note that this
+                                             filename 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>NAME -
+                                         </p>
+ <blockquote class="text">
+ <p>character string defining the
+                                             unique name of the effect within its
+                                             module (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>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>human readable name of the
+                                             effect, intended to be displayed in
+                                             user interfaces (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>INPUT_CONTROLS -
+                                         </p>
+ <blockquote class="text">
+ <p>amount of input controls the
+                                             effect instance provides, to allow
+                                             controlling the effect parameters in
+                                             realtime
+ </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 EFFECT_INSTANCE INFO 3"
+ </p>
+ <p>S: "SYSTEM: LADSPA"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/mod_delay_1419.so"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"NAME: modDelay"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Modulatable delay"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"INPUT_CONTROLS: 1"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET EFFECT_INSTANCE_INPUT_CONTROL 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.11.10"></a><h3>6.11.10.&nbsp;
+ Retrieving information about an effect parameter</h3>
+ <p>Effects typically provide a certain set of effect
+                     parameters which can be altered by the user in realtime
+                     (e.g. depth of a reverb effect, duration of a delay effect,
+                     dry / wet signal ratio). Those controllable effect parameters
+                     are called "input controls". The front-end can ask for the
+                     current informations of an effect instance's input control
+                     by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET EFFECT_INSTANCE_INPUT_CONTROL INFO &lt;effect-instance&gt; &lt;input-control&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-instance&gt; is the numerical ID of an
+                     effect instance as returned by the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
+                     command and &lt;input-control&gt; is the index of the input
+                     control within the numerical bounds as returned by the
+                     "INPUT_CONTROLS" field of the
+                     <a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
+                     command.
+ </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 information
+                             category name, followed by a colon and then a space
+                             character &lt;SP&gt; and finally the info character
+                             string to that information category. There are
+                             information categories which are always returned,
+                             independent of the respective effect parameter and
+                             there are optional information categories
+                             which are only shown for certain effect parameters.
+                             At the moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>DESCRIPTION -
+                                         </p>
+ <blockquote class="text">
+ <p>(always returned)
+                                             human readable name of the
+                                             effect parameter, intended to be
+                                             displayed in user interfaces (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>VALUE -
+                                         </p>
+ <blockquote class="text">
+ <p>
+                                             (always returned)
+                                             current (optional dotted)
+                                             floating point value of this effect
+                                             parameter
+ </p>
+ </blockquote>
+ <p>RANGE_MIN -
+                                         </p>
+ <blockquote class="text">
+ <p>
+                                             (optionally returned)
+                                             minimum allowed value for this
+                                             effect parameter
+ </p>
+ </blockquote>
+ <p>RANGE_MAX -
+                                         </p>
+ <blockquote class="text">
+ <p>
+                                             (optionally returned)
+                                             maximum allowed value for this
+                                             effect parameter
+ </p>
+ </blockquote>
+ <p>POSSIBILITIES -
+                                         </p>
+ <blockquote class="text">
+ <p>
+                                             (optionally returned)
+                                             comma separated list of
+                                             (optional dotted) floating point
+                                             numbers, reflecting the exact set of
+                                             possible values for this effect
+                                             parameter
+ </p>
+ </blockquote>
+ <p>DEFAULT -
+                                         </p>
+ <blockquote class="text">
+ <p>
+                                             (optionally returned)
+                                             default value of this effect
+                                             parameter
+ </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 EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"
+ </p>
+ <p>S: "DESCRIPTION: Base delay (s)"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"VALUE: 0.500"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 0.000"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"></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.11.11"></a><h3>6.11.11.&nbsp;
+ Altering an effect parameter</h3>
+ <p>The front-end can alter the current value of an effect
+                     parameter by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE &lt;effect-instance&gt; &lt;input-control&gt; &lt;value&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;effect-instance&gt; is the numerical ID of the
+                     effect instance as returned by the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
+                     <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
+                     command, &lt;input-control&gt; is the index of the input
+                     control within the numerical bounds as returned by the
+                     "INPUT_CONTROLS" field of the
+                     <a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
+                     command and &lt;value&gt; is the new (optional dotted)
+                     floating point value for this effect parameter.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect was altered successfully
+ </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>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET SEND_EFFECT_CHAINS"></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.11.12"></a><h3>6.11.12.&nbsp;
+ Retrieve amount of send effect chains</h3>
+ <p>The front-end can retrieve the current amount of send
+                     effect chains of an audio output device by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET SEND_EFFECT_CHAINS &lt;audio-device&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will answer by returning the current
+                             number of send effect chains of the supplied audio
+                             output device.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "GET SEND_EFFECT_CHAINS 0"
+ </p>
+ <p>S: "4"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="LIST SEND_EFFECT_CHAINS"></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.11.13"></a><h3>6.11.13.&nbsp;
+ Retrieve list of send effect chains</h3>
+ <p>The front-end can retrieve the current list of send
+                     effect chains of an audio output device by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LIST SEND_EFFECT_CHAINS &lt;audio-device&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>The sampler will answer by returning a comma
+                             separated list with numerical IDs of send effect
+                             chains of the supplied audio output device.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "LIST SEND_EFFECT_CHAINS 0"
+ </p>
+ <p>S: "3,4,7"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="ADD SEND_EFFECT_CHAIN"></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.11.14"></a><h3>6.11.14.&nbsp;
+ Add send effect chain</h3>
+ <p>The front-end can add a send effect chain by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>ADD SEND_EFFECT_CHAIN &lt;audio-device&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK[&lt;effect-chain&gt;]" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the send effect chain was
+                                     added successfully, where
+                                     &lt;effect-chain&gt; is the numerical ID
+                                     of the new send effect chain
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the send effect chain could not be added
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "ADD SEND_EFFECT_CHAIN 0"
+ </p>
+ <p>S: "OK[2]"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE SEND_EFFECT_CHAIN"></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.11.15"></a><h3>6.11.15.&nbsp;
+ Remove send effect chain</h3>
+ <p>The front-end can remove a send effect chain by sending
+                     the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE SEND_EFFECT_CHAIN &lt;audio-device&gt; &lt;effect-chain&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command and &lt;effect-chain&gt; by the numerical ID as
+                     returned by the
+                     <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
+                     command.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the send effect chain was
+                                     removed successfully
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the send effect chain could not be removed
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "REMOVE SEND_EFFECT_CHAIN 0 2"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="GET SEND_EFFECT_CHAIN 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.11.16"></a><h3>6.11.16.&nbsp;
+ Retrieving information about a send effect chain</h3>
+ <p>The front-end can ask for informations of a send effect
+                     chain by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET SEND_EFFECT_CHAIN INFO &lt;audio-device&gt; &lt;effect-chain&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command and &lt;effect-chain&gt; by the numerical ID as
+                     returned by the
+                     <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
+                     command.
+ </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 information
+                             category name, followed by a colon and then a space
+                             character &lt;SP&gt; and finally the info character
+                             string to that information category.
+                             At the moment the following categories are defined:
+ </p>
+ <p>
+                                 </p>
+ <blockquote class="text">
+ <p>EFFECT_COUNT -
+                                         </p>
+ <blockquote class="text">
+ <p>amount of effects in this send
+                                             effect chain
+ </p>
+ </blockquote>
+ <p>EFFECT_SEQUENCE -
+                                         </p>
+ <blockquote class="text">
+ <p>comma separated list of the
+                                             numerical IDs of the effect
+                                             instances in this send effect chain,
+                                             in the order as they are procssed in
+                                             the effect chain
+ </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 SEND_EFFECT_CHAIN INFO 0 2"
+ </p>
+ <p>S: "EFFECT_COUNT: 3"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"EFFECT_SEQUENCE: 31,4,7"
+ </p>
+ <p>&nbsp;&nbsp;&nbsp;"."
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="APPEND SEND_EFFECT_CHAIN EFFECT"></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.11.17"></a><h3>6.11.17.&nbsp;
+ Append effect instance to a send effect chain</h3>
+ <p>The front-end can add an unused effect instance to the
+                     end of a send effect chain by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>APPEND SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;effect-instance&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command and &lt;effect-chain&gt; by the numerical ID as
+                     returned by the
+                     <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
+                     command and &lt;effect-instance&gt; as returned by the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
+                     <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
+                     command.
+ </p>
+ <p>Only unused effect instances can be added to the effect
+                     chain. Trying to add an effect instance which is already in
+                     use somewhere in the audio signal path of the sampler will
+                     result in an error.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was
+                                     added successfully to the chain
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the effect instance could not be added
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="INSERT SEND_EFFECT_CHAIN EFFECT"></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.11.18"></a><h3>6.11.18.&nbsp;
+ Insert effect instance to a send effect chain</h3>
+ <p>The front-end can add an unused effect instance to a
+                     certain position of a send effect chain by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>INSERT SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt; &lt;effect-instance&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command, &lt;effect-chain&gt; by the numerical ID as
+                     returned by the
+                     <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
+                     command, &lt;effect-instance&gt; as returned by the
+                     <a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</span><span>)</span></a> or
+                     <a class='info' href='#LIST EFFECT_INSTANCES'>"LIST EFFECT_INSTANCES"<span> (</span><span class='info'>Get list of effect instances</span><span>)</span></a>
+                     command and &lt;chain-pos&gt; the exact position of the
+                     effect chain where the supplied effect shall be inserted
+                     to.
+ </p>
+ <p>Only unused effect instances can be added to the effect
+                     chain. Trying to add an effect instance which is already in
+                     use somewhere in the audio signal path of the sampler will
+                     result in an error.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was
+                                     added successfully to the chain
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the effect instance could not be added
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="REMOVE SEND_EFFECT_CHAIN EFFECT"></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.11.19"></a><h3>6.11.19.&nbsp;
+ Remove effect instance from send effect chain</h3>
+ <p>The front-end can remove an effect instance from a
+                     certain position of a send effect chain by sending the
+                     following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>REMOVE SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;audio-device&gt; should be replaced by the
+                     numerical ID of the audio output device as given by the
+                     <a class='info' href='#CREATE AUDIO_OUTPUT_DEVICE'>"CREATE AUDIO_OUTPUT_DEVICE"<span> (</span><span class='info'>Creating an audio output device</span><span>)</span></a>
+                     or <a class='info' href='#LIST AUDIO_OUTPUT_DEVICES'>"LIST AUDIO_OUTPUT_DEVICES"<span> (</span><span class='info'>Getting all created audio output device list</span><span>)</span></a>
+                     command, &lt;effect-chain&gt; by the numerical ID as
+                     returned by the
+                     <a class='info' href='#ADD SEND_EFFECT_CHAIN'>"ADD SEND_EFFECT_CHAIN"<span> (</span><span class='info'>Add send effect chain</span><span>)</span></a>
+                     or
+                     <a class='info' href='#LIST SEND_EFFECT_CHAINS'>"LIST SEND_EFFECT_CHAINS"<span> (</span><span class='info'>Retrieve list of send effect chains</span><span>)</span></a>
+                     command and &lt;chain-pos&gt; the exact position of the
+                     effect instance to be removed from the effect chain.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case the effect instance was
+                                     removed successfully
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the effect instance could not be removed
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Examples:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
  <a name="command_syntax"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
  <a name="rfc.section.7"></a><h3>7.&nbsp;
-Line 8415 
 Command Syntax</h3>
+Line 11641 
 Command Syntax</h3>
  <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>/ SEND SP send_instruction
+ </p>
+ <p>/ APPEND SP append_instruction
+ </p>
+ <p>/ INSERT SP insert_instruction
+ </p>
  <p>/ RESET
  </p>
-Line 8433 
 Command Syntax</h3>
+Line 11680 
 Command Syntax</h3>
  <p>CHANNEL
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
+ <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 NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
  </p>
- <p>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname
+ <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
  </p>
- <p>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
+ <p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
  </p>
- <p>/ DB_INSTRUMENTS SP pathname SP pathname
+ <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
  </p>
- <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
+ <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
-Line 8454 
 Command Syntax</h3>
+Line 11713 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_MAP SP map_name
  </p>
+ <p>/ SEND_EFFECT_CHAIN SP device_index
+ </p>
  </blockquote><p>
  </p>
-Line 8475 
 Command Syntax</h3>
+Line 11737 
 Command Syntax</h3>
  <p>/ CHANNEL_COUNT
  </p>
+ <p>/ CHANNEL_MIDI
+ </p>
+ <p>/ DEVICE_MIDI
+ </p>
  <p>/ VOICE_COUNT
  </p>
-Line 8517 
 Command Syntax</h3>
+Line 11785 
 Command Syntax</h3>
  <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>
+ <p>/ EFFECT_INSTANCE_COUNT
+ </p>
+ <p>/ EFFECT_INSTANCE_INFO
+ </p>
+ <p>/ SEND_EFFECT_CHAIN_COUNT
+ </p>
+ <p>/ SEND_EFFECT_CHAIN_INFO
+ </p>
  </blockquote><p>
  </p>
-Line 8547 
 Command Syntax</h3>
+Line 11833 
 Command Syntax</h3>
  <p>/ CHANNEL_COUNT
  </p>
+ <p>/ CHANNEL_MIDI
+ </p>
+ <p>/ DEVICE_MIDI
+ </p>
  <p>/ VOICE_COUNT
  </p>
-Line 8589 
 Command Syntax</h3>
+Line 11881 
 Command Syntax</h3>
  <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>
+ <p>/ EFFECT_INSTANCE_COUNT
+ </p>
+ <p>/ EFFECT_INSTANCE_INFO
+ </p>
+ <p>/ SEND_EFFECT_CHAIN_COUNT
+ </p>
+ <p>/ SEND_EFFECT_CHAIN_INFO
+ </p>
  </blockquote><p>
  </p>
-Line 8640 
 Command Syntax</h3>
+Line 11950 
 Command Syntax</h3>
  <p>/ MIDI_INSTRUMENT_MAP SP ALL
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
+ <p>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain
+ </p>
+ <p>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos
+ </p>
+ <p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORY SP pathname
+ <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
  </p>
- <p>/ DB_INSTRUMENT SP pathname
+ <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT SP db_path
  </p>
  </blockquote><p>
-Line 8658 
 Command Syntax</h3>
+Line 11977 
 Command Syntax</h3>
  <p>AVAILABLE_ENGINES
  </p>
+ <p>/ AVAILABLE_EFFECTS
+ </p>
+ <p>/ EFFECT_INSTANCES
+ </p>
+ <p>/ EFFECT SP INFO SP effect_index
+ </p>
+ <p>/ EFFECT_INSTANCE SP INFO SP effect_instance
+ </p>
+ <p>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control
+ </p>
+ <p>/ SEND_EFFECT_CHAINS SP device_index
+ </p>
+ <p>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
+ </p>
  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
  </p>
-Line 8727 
 Command Syntax</h3>
+Line 12067 
 Command Syntax</h3>
  <p>/ SERVER SP INFO
  </p>
+ <p>/ TOTAL_STREAM_COUNT
+ </p>
  <p>/ TOTAL_VOICE_COUNT
  </p>
-Line 8754 
 Command Syntax</h3>
+Line 12097 
 Command Syntax</h3>
  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
  </p>
- <p>/ DB_INSTRUMENTS SP pathname
+ <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
  </p>
- <p>/ DB_INSTRUMENT SP INFO SP pathname
+ <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>/ VOICES
+ </p>
+ <p>/ STREAMS
+ </p>
+ <p>/ FILE SP INSTRUMENTS SP filename
+ </p>
+ <p>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
+ </p>
  </blockquote><p>
  </p>
-Line 8784 
 Command Syntax</h3>
+Line 12148 
 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>
+ <p>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value
+ </p>
  <p>/ CHANNEL SP set_chan_instruction
  </p>
-Line 8805 
 Command Syntax</h3>
+Line 12175 
 Command Syntax</h3>
  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
+ <p>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
+ <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
  </p>
- <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
+ <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
  </p>
- <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
+ <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>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
  </p>
  <p>/ ECHO SP boolean
-Line 8823 
 Command Syntax</h3>
+Line 12199 
 Command Syntax</h3>
  <p>/ VOLUME SP volume_value
  </p>
+ <p>/ VOICES SP number
+ </p>
+ <p>/ STREAMS SP number
+ </p>
  </blockquote><p>
  </p>
-Line 8847 
 Command Syntax</h3>
+Line 12229 
 Command Syntax</h3>
  <p>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
  </p>
+ <p>/ EFFECT_INSTANCE SP effect_index
+ </p>
+ <p>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name
+ </p>
  </blockquote><p>
  </p>
-Line 8871 
 Command Syntax</h3>
+Line 12259 
 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>
+ <p>/ LOST SP DB_INSTRUMENT_FILES
+ </p>
+ </blockquote><p>
+ </p>
  <p>move_instruction =
          </p>
  <blockquote class="text">
- <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
+ <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
  </p>
- <p>/ DB_INSTRUMENT SP pathname SP pathname
+ <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>
-Line 8895 
 Command Syntax</h3>
+Line 12316 
 Command Syntax</h3>
  <p>/ FX_SEND SP sampler_channel SP fx_send_id
  </p>
+ <p>/ EFFECT_INSTANCE SP number
+ </p>
  </blockquote><p>
  </p>
-Line 8910 
 Command Syntax</h3>
+Line 12334 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>append_instruction =
+         </p>
+ <blockquote class="text">
+ <p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance
+ </p>
+ </blockquote><p>
+ </p>
+ <p>insert_instruction =
+         </p>
+ <blockquote class="text">
+ <p>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance
+ </p>
+ </blockquote><p>
+ </p>
  <p>set_chan_instruction =
          </p>
  <blockquote class="text">
-Line 8958 
 Command Syntax</h3>
+Line 12400 
 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">
-Line 9009 
 Command Syntax</h3>
+Line 12469 
 Command Syntax</h3>
  <p>/ AVAILABLE_ENGINES
  </p>
+ <p>/ AVAILABLE_EFFECTS
+ </p>
+ <p>/ EFFECT_INSTANCES
+ </p>
+ <p>/ SEND_EFFECT_CHAINS SP number
+ </p>
  <p>/ AVAILABLE_MIDI_INPUT_DRIVERS
  </p>
-Line 9027 
 Command Syntax</h3>
+Line 12496 
 Command Syntax</h3>
  <p>/ FX_SENDS SP sampler_channel
  </p>
- <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
+ </p>
+ <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
  </p>
- <p>/ DB_INSTRUMENTS SP pathname
+ <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>
+ <p>send_instruction =
+         </p>
+ <blockquote class="text">
+ <p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
  </p>
  </blockquote><p>
-Line 9072 
 Command Syntax</h3>
+Line 12559 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>effect_instance =
+         </p>
+ <blockquote class="text">
+ <p>number
+ </p>
+ </blockquote><p>
+ </p>
  <p>device_index =
          </p>
  <blockquote class="text">
-Line 9177 
 Command Syntax</h3>
+Line 12673 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>control_value =
+         </p>
+ <blockquote class="text">
+ <p>real
+ </p>
+ </blockquote><p>
+ </p>
  <p>sampler_channel =
          </p>
  <blockquote class="text">
-Line 9213 
 Command Syntax</h3>
+Line 12718 
 Command Syntax</h3>
  </blockquote><p>
  </p>
- <p>pathname =
+ <p>filename =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>path
  </p>
  </blockquote><p>
  </p>
- <p>dirname =
+ <p>db_path =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>path
  </p>
  </blockquote><p>
  </p>
- <p>filename =
+ <p>map_name =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>stringval_escaped
  </p>
  </blockquote><p>
  </p>
- <p>map_name =
+ <p>entry_name =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>stringval_escaped
  </p>
  </blockquote><p>
  </p>
- <p>entry_name =
+ <p>fx_send_name =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>stringval_escaped
  </p>
  </blockquote><p>
  </p>
- <p>fx_send_name =
+ <p>effect_name =
+         </p>
+ <blockquote class="text">
+ <p>stringval_escaped
+ </p>
+ </blockquote><p>
+ </p>
+ <p>effect_index =
+         </p>
+ <blockquote class="text">
+ <p>number
+ </p>
+ </blockquote><p>
+ </p>
+ <p>effect_chain =
+         </p>
+ <blockquote class="text">
+ <p>number
+ </p>
+ </blockquote><p>
+ </p>
+ <p>chain_pos =
          </p>
  <blockquote class="text">
- <p>stringval
+ <p>number
+ </p>
+ </blockquote><p>
+ </p>
+ <p>input_control =
+         </p>
+ <blockquote class="text">
+ <p>number
  </p>
  </blockquote><p>
-Line 9297 
 Command Syntax</h3>
+Line 12838 
 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>
+ <p>effect_system =
+         </p>
+ <blockquote class="text">
+ <p>string
+ </p>
+ </blockquote><p>
+ </p>
+ <p>module =
+         </p>
+ <blockquote class="text">
+ <p>filename
+ </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>
+ <br clear="all" />
+ <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='#FIND LOST DB_INSTRUMENT_FILES'>"FIND LOST DB_INSTRUMENT_FILES"<span> (</span><span class='info'>Checking for lost instrument files</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#SET DB_INSTRUMENT FILE_PATH'>"SET DB_INSTRUMENT FILE_PATH"<span> (</span><span class='info'>Replacing an instrument file</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>
+ <p><a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</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>
+ <p><a class='info' href='#GET EFFECT INFO'>"GET EFFECT INFO"<span> (</span><span class='info'>Retrieving general information about an effect</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#GET EFFECT_INSTANCE INFO'>"GET EFFECT_INSTANCE INFO"<span> (</span><span class='info'>Retrieving current information about an effect instance</span><span>)</span></a>
+ </p>
+ <p><a class='info' href='#CREATE EFFECT_INSTANCE'>"CREATE EFFECT_INSTANCE"<span> (</span><span class='info'>Creating an instance of an effect by its portable ID</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 9457 
 Number of sampler channels changed</h3>
+Line 13267 
 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 DEVICE_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.7"></a><h3>8.7.&nbsp;
+ MIDI data on a MIDI input device arrived</h3>
+ <p>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:
+ </p>
+ <p>
+                             </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE DEVICE_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:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"
+ </p>
+ <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
+                        by the IDs of the respective MIDI input device and the device's MIDI port 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.8"></a><h3>8.8.&nbsp;
  Number of active voices changed</h3>
  <p>Client may want to be notified when the number of voices on the
-Line 9489 
 Number of active voices changed</h3>
+Line 13375 
 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.9"></a><h3>8.9.&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 9519 
 Number of active disk streams changed</h
+Line 13405 
 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.10"></a><h3>8.10.&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 9550 
 Disk stream buffer fill state changed</h
+Line 13436 
 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.11"></a><h3>8.11.&nbsp;
  Channel information changed</h3>
  <p>Client may want to be notified when changes were made to sampler channels on the
-Line 9583 
 Channel information changed</h3>
+Line 13469 
 Channel information changed</h3>
  </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.10"></a><h3>8.10.&nbsp;
+ <a name="rfc.section.8.12"></a><h3>8.12.&nbsp;
  Number of effect sends changed</h3>
  <p>Client may want to be notified when the number of effect sends on
                  a particular sampler channel is changed by issuing the following command:
  </p>
  <p>
-Line 9613 
 Number of effect sends changed</h3>
+Line 13499 
 Number of effect sends changed</h3>
  </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.11"></a><h3>8.11.&nbsp;
+ <a name="rfc.section.8.13"></a><h3>8.13.&nbsp;
  Effect send information changed</h3>
  <p>Client may want to be notified when changes were made to effect sends on a
-Line 9643 
 Effect send information changed</h3>
+Line 13529 
 Effect send information changed</h3>
  </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.12"></a><h3>8.12.&nbsp;
+ <a name="rfc.section.8.14"></a><h3>8.14.&nbsp;
  Total number of active voices changed</h3>
  <p>Client may want to be notified when the total number of voices on the
-Line 9670 
 Total number of active voices changed</h
+Line 13556 
 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.15"></a><h3>8.15.&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.13"></a><h3>8.13.&nbsp;
+ <a name="rfc.section.8.16"></a><h3>8.16.&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 9701 
 Number of MIDI instrument maps changed</
+Line 13616 
 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.14"></a><h3>8.14.&nbsp;
+ <a name="rfc.section.8.17"></a><h3>8.17.&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 9734 
 MIDI instrument map information changed<
+Line 13649 
 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.15"></a><h3>8.15.&nbsp;
+ <a name="rfc.section.8.18"></a><h3>8.18.&nbsp;
  Number of MIDI instruments changed</h3>
  <p>Client may want to be notified when the number of MIDI instrument maps on the
-Line 9764 
 Number of MIDI instruments changed</h3>
+Line 13679 
 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.16"></a><h3>8.16.&nbsp;
+ <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
  MIDI instrument information changed</h3>
  <p>Client may want to be notified when changes were made to MIDI instruments on the
-Line 9798 
 MIDI instrument information changed</h3>
+Line 13713 
 MIDI instrument information changed</h3>
  </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.17"></a><h3>8.17.&nbsp;
+ <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
  Global settings changed</h3>
  <p>Client may want to be notified when changes to the global settings
-Line 9823 
 Global settings changed</h3>
+Line 13738 
 Global settings changed</h3>
                          new global volume parameter.
  </p>
  </blockquote><p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
+                         golbal limit of the sampler for maximum voices is changed, where
+                         &lt;max-voices&gt; will be an integer value, reflecting the
+                         new global voice limit parameter.
+ </p>
+ </blockquote><p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
+                         golbal limit of the sampler for maximum disk streams is changed, where
+                         &lt;max-streams&gt; will be an integer value, reflecting the
+                         new global disk streams limit 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.18"></a><h3>8.18.&nbsp;
+ <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
  Number of database instrument directories changed</h3>
  <p>Client may want to be notified when the number of instrument
-Line 9861 
 Number of database instrument directorie
+Line 13792 
 Number of database instrument directorie
  </p>
  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.8.19"></a><h3>8.19.&nbsp;
+ <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
  Database instrument directory information changed</h3>
  <p>Client may want to be notified when changes were made to directories
-Line 9906 
 Database instrument directory informatio
+Line 13837 
 Database instrument directory informatio
  </p>
  <a name="SUBSCRIBE DB_INSTRUMENT_COUNT"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.8.20"></a><h3>8.20.&nbsp;
+ <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
  Number of database instruments changed</h3>
  <p>Client may want to be notified when the number of instruments
-Line 9940 
 Number of database instruments changed</
+Line 13871 
 Number of database instruments changed</
  </p>
  <a name="SUBSCRIBE DB_INSTRUMENT_INFO"></a><br /><hr />
  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
- <a name="rfc.section.8.21"></a><h3>8.21.&nbsp;
+ <a name="rfc.section.8.24"></a><h3>8.24.&nbsp;
  Database instrument information changed</h3>
  <p>Client may want to be notified when changes were made to instruments
-Line 9983 
 Database instrument information changed<
+Line 13914 
 Database instrument information changed<
                  (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.25"></a><h3>8.25.&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 EFFECT_INSTANCE_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.26"></a><h3>8.26.&nbsp;
+ Number of effect instances changed</h3>
+ <p>Client may want to be notified when the number of effect instances
+                 is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE EFFECT_INSTANCE_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"EFFECT_INSTANCE_COUNT:&lt;instances&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;instances&gt; will be replaced by the new number
+                 of effect instances.
+ </p>
+ <a name="SUBSCRIBE EFFECT_INSTANCE_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.27"></a><h3>8.27.&nbsp;
+ Effect instance information changed</h3>
+ <p>Client may want to be notified when changes were made to effect instances
+                 on the back-end by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE EFFECT_INSTANCE_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                    </p>
+ <blockquote class="text">
+ <p>"EFFECT_INSTANCE_INFO:&lt;instance-id&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;instance-id&gt; will be replaced by the numerical ID
+                 of the effect instance.
+ </p>
+ <a name="SUBSCRIBE SEND_EFFECT_CHAIN_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.28"></a><h3>8.28.&nbsp;
+ Number of send effect chains changed</h3>
+ <p>Client may want to be notified when the number of send effect chains
+                 is changed by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE SEND_EFFECT_CHAIN_COUNT
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:SEND_EFFECT_CHAIN_COUNT:&lt;device-id&gt; &lt;chains&gt;"
+ </p>
+ </blockquote><p>
+ </p>
+ <p>where &lt;device-id&gt; will be replaced by the numerical ID of the audio
+                 output device, in which the number of send effect chains is changed and
+                 &lt;chains&gt; will be replaced by the new number of send effect chains.
+ </p>
+ <a name="SUBSCRIBE SEND_EFFECT_CHAIN_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.29"></a><h3>8.29.&nbsp;
+ Send effect chain information changed</h3>
+ <p>Client may want to be notified when changes were made to send effect chains
+                 on the back-end by issuing the following command:
+ </p>
+ <p>
+                     </p>
+ <blockquote class="text">
+ <p>SUBSCRIBE SEND_EFFECT_CHAIN_INFO
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Server will start sending the following notification messages:
+ </p>
+ <p>
+                    </p>
+ <blockquote class="text">
+ <p>"SEND_EFFECT_CHAIN_INFO:&lt;device-id&gt; &lt;chain-id&gt; &lt;instances&gt;" -
+                         Notifies that the number of effect instances in a particular send effect chain
+                         is changed, where &lt;device-id&gt; will be replaced by the numerical ID of the audio
+                         output device the send effect chain belongs to, &lt;chain-id&gt; will be replaced
+                         by the numerical ID of the send effect chain in which the number of effect instances
+                         has changed and &lt;instances&gt; will be replaced by the new number
+                         of effect instances in the specified send effect chain.
+ </p>
+ </blockquote><p>
+ </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.22"></a><h3>8.22.&nbsp;
+ <a name="rfc.section.8.30"></a><h3>8.30.&nbsp;
  Miscellaneous and debugging events</h3>
  <p>Client may want to be notified of miscellaneous and debugging events occurring at
-Line 10050 
 Acknowledgments</h3>
+Line 14134 
 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="http://tools.ietf.org/html/rfc20">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>
+ <td class="author-text">Bradner, S., &ldquo;<a href="http://tools.ietf.org/html/rfc2119">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>
- <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>
+ <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>
  <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>
- <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>
+ <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="http://tools.ietf.org/html/rfc793">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>
  </table>
  <a name="rfc.authors"></a><br /><hr />
-Line 10080 
 Schoenebeck</td></tr>
+Line 14166 
 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 IETF Trust (2007).</p>
+ Copyright &copy; The IETF Trust (2011).</p>
  <p class='copyright'>
  This document is subject to the rights,
  licenses and restrictions contained in BCP&nbsp;78,
-Line 10122 
 or other
+Line 14208 
 or other
  proprietary rights that may cover technology that may be required
  to implement this standard.
  Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
- <h3>Acknowledgment</h3>
- <p class='copyright'>
- Funding for the RFC Editor function is provided by
- the IETF Administrative Support Activity (IASA).</p>
  </body></html>

 Legend:



Removed from v.1162
 


changed lines


 
Added in v.2189
 Legend:



Removed from v.1162
 


changed lines


 
Added in v.2189
-Removed from v.1162
+Added in v.2189

	ViewVC Help
Powered by ViewVC