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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1189 by iliev, Wed May 16 14:42:04 2007 UTC revision 1400 by schoenebeck, Thu Oct 11 18:59:34 2007 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2  <html lang="en"><head><title>LinuxSampler Control Protocol</title>  <html lang="en"><head><title>LinuxSampler Control Protocol (draft)</title>
3  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
4  <meta name="description" content="LinuxSampler Control Protocol">  <meta name="description" content="LinuxSampler Control Protocol (draft)">
5  <meta name="keywords" content="LSCP">  <meta name="keywords" content="LSCP">
6  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
# Line 145  Line 145 
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">Expires: November 17, 2007</td><td class="header">May 16, 2007</td></tr>  <tr><td class="header">Expires: April 13, 2008</td><td class="header">October 11, 2007</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>  <h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1>
151    
152  <h3>Status of this Memo</h3>  <h3>Status of this Memo</h3>
153  <p>  <p>
# Line 173  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on November 17, 2007.</p>  This Internet-Draft will expire on April 13, 2008.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
# Line 364  Getting global volume attenuation<br /> Line 364  Getting global volume attenuation<br />
364  Setting global volume attenuation<br />  Setting global volume attenuation<br />
365  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
366  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
367  &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;
368  Create a new MIDI instrument map<br />  Create a new MIDI instrument map<br />
369  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a>&nbsp;
370  Delete one particular or all MIDI instrument maps<br />  Delete one particular or all MIDI instrument maps<br />
# Line 430  Copying instruments<br /> Line 430  Copying instruments<br />
430  Changing the description of instrument<br />  Changing the description of instrument<br />
431  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND DB_INSTRUMENTS">6.8.20.</a>&nbsp;
432  Finding instruments<br />  Finding instruments<br />
433    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET DB_INSTRUMENTS_JOB INFO">6.8.21.</a>&nbsp;
434    Getting job status information<br />
435    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
436    Formatting the instruments database<br />
437    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
438    Editing Instruments<br />
439    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
440    Opening an appropriate instrument editor application<br />
441  <a href="#command_syntax">7.</a>&nbsp;  <a href="#command_syntax">7.</a>&nbsp;
442  Command Syntax<br />  Command Syntax<br />
443    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#character_set">7.1.</a>&nbsp;
444    Character Set and Escape Sequences<br />
445  <a href="#events">8.</a>&nbsp;  <a href="#events">8.</a>&nbsp;
446  Events<br />  Events<br />
447  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">8.1.</a>&nbsp;
# Line 476  Database instrument directory informatio Line 486  Database instrument directory informatio
486  Number of database instruments changed<br />  Number of database instruments changed<br />
487  &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.21.</a>&nbsp;
488  Database instrument information changed<br />  Database instrument information changed<br />
489  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.22.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">8.22.</a>&nbsp;
490    Database job status information changed<br />
491    &nbsp;&nbsp;&nbsp;&nbsp;<a href="#SUBSCRIBE MISCELLANEOUS">8.23.</a>&nbsp;
492  Miscellaneous and debugging events<br />  Miscellaneous and debugging events<br />
493  <a href="#anchor14">9.</a>&nbsp;  <a href="#anchor14">9.</a>&nbsp;
494  Security Considerations<br />  Security Considerations<br />
# Line 508  Requirements notation</h3> Line 520  Requirements notation</h3>
520              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
521              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
522              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
523              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>),
524              example:              thus the following example:
525  </p>  </p>
526  <p>  <p>
527                  </p>                  </p>
# Line 3295  Changing settings of MIDI input ports</h Line 3307  Changing settings of MIDI input ports</h
3307                      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>                      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>
3308                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
3309                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
3310                      parameter.                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
3311                        for specifying no value for parameters allowing a list of values.
3312  </p>  </p>
3313  <p>Possible Answers:  <p>Possible Answers:
3314  </p>  </p>
# Line 3336  Changing settings of MIDI input ports</h Line 3349  Changing settings of MIDI input ports</h
3349  <p>  <p>
3350                          </p>                          </p>
3351  <blockquote class="text">  <blockquote class="text">
3352    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
3353    </p>
3354    <p>S: "OK"
3355    </p>
3356    </blockquote><p>
3357                        
3358    </p>
3359  <p>  <p>
3360                            </p>
3361    <blockquote class="text">
3362    <p>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
3363    </p>
3364    <p>S: "OK"
3365  </p>  </p>
3366  </blockquote><p>  </blockquote><p>
3367                                            
# Line 3371  Loading an instrument</h3> Line 3396  Loading an instrument</h3>
3396                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
3397                      Each sampler channel can only have one instrument.                      Each sampler channel can only have one instrument.
3398  </p>  </p>
3399    <p>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
3400                        escape characters for special characters (see chapter
3401                        "<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>"
3402                        for details) and accordingly backslash characters in the filename
3403                        MUST now be escaped as well!
3404    </p>
3405  <p>The difference between regular and NON_MODAL versions of the command  <p>The difference between regular and NON_MODAL versions of the command
3406                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
3407                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
# Line 3838  Getting information about an engine</h3> Line 3869  Getting information about an engine</h3>
3869                                          </p>                                          </p>
3870  <blockquote class="text">  <blockquote class="text">
3871  <p>arbitrary description text about the engine  <p>arbitrary description text about the engine
3872                                                (note that the character string may contain
3873                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
3874  </p>  </p>
3875  </blockquote>  </blockquote>
3876                                                                            
# Line 3957  Getting sampler channel information</h3> Line 3990  Getting sampler channel information</h3>
3990  <blockquote class="text">  <blockquote class="text">
3991  <p>the file name of the loaded instrument, "NONE" if  <p>the file name of the loaded instrument, "NONE" if
3992                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
3993                                              channel                                              channel (note: since LSCP 1.2 this path may contain
3994                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
3995  </p>  </p>
3996  </blockquote>  </blockquote>
3997                                                                            
# Line 3974  Getting sampler channel information</h3> Line 4008  Getting sampler channel information</h3>
4008                                          </p>                                          </p>
4009  <blockquote class="text">  <blockquote class="text">
4010  <p>the instrument name of the loaded instrument  <p>the instrument name of the loaded instrument
4011                                                (note: since LSCP 1.2 this character string may contain
4012                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
4013  </p>  </p>
4014  </blockquote>  </blockquote>
4015                                                                            
# Line 5049  Adding an effect send to a sampler chann Line 5085  Adding an effect send to a sampler chann
5085                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
5086                      is a number between 0..127 defining the MIDI controller which can alter the                      is a number between 0..127 defining the MIDI controller which can alter the
5087                      effect send level and &lt;name&gt; is an optional argument defining a name                      effect send level and &lt;name&gt; is an optional argument defining a name
5088                      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
5089                        encapsulated into apostrophes and supports escape sequences as described in chapter
5090                        "<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>".
5091  </p>  </p>
5092  <p>By default, that is as initial routing, the effect send's audio channels  <p>By default, that is as initial routing, the effect send's audio channels
5093                      are automatically routed to the last audio channels of the sampler channel's                      are automatically routed to the last audio channels of the sampler channel's
# Line 5318  Getting effect send information</h3> Line 5356  Getting effect send information</h3>
5356                                          </p>                                          </p>
5357  <blockquote class="text">  <blockquote class="text">
5358  <p>name of the effect send entity  <p>name of the effect send entity
5359                                                (note that this character string may contain
5360                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
5361  </p>  </p>
5362  </blockquote>  </blockquote>
5363                                                                            
# Line 5408  Changing effect send's name</h3> Line 5448  Changing effect send's name</h3>
5448                      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>                      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>
5449                      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                      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
5450                      &lt;name&gt; is the new name of the effect send entity, which                      &lt;name&gt; is the new name of the effect send entity, which
5451                      does not have to be unique.                      does not have to be unique (name MUST be encapsulated into apostrophes
5452                        and supports escape sequences as described in chapter
5453                        "<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>").
5454                        
5455  </p>  </p>
5456  <p>Possible Answers:  <p>Possible Answers:
5457  </p>  </p>
# Line 6085  General sampler informations</h3> Line 6128  General sampler informations</h3>
6128                                          </p>                                          </p>
6129  <blockquote class="text">  <blockquote class="text">
6130  <p>arbitrary textual description about the sampler  <p>arbitrary textual description about the sampler
6131                                                (note that the character string may contain
6132                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6133  </p>  </p>
6134  </blockquote>  </blockquote>
6135                                                                            
# Line 6246  MIDI Instrument Mapping</h3> Line 6291  MIDI Instrument Mapping</h3>
6291                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
6292                  reflected by the current MIDI instrument map.                  reflected by the current MIDI instrument map.
6293  </p>  </p>
6294  <a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr />  <a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr />
6295  <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>  <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>
6296  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;  <a name="rfc.section.6.7.1"></a><h3>6.7.1.&nbsp;
6297  Create a new MIDI instrument map</h3>  Create a new MIDI instrument map</h3>
# Line 6264  Create a new MIDI instrument map</h3> Line 6309  Create a new MIDI instrument map</h3>
6309  </p>  </p>
6310  <p>Where &lt;name&gt; is an optional argument allowing to  <p>Where &lt;name&gt; is an optional argument allowing to
6311                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
6312                      names do not have to be unique.                      names do not have to be unique, but MUST be encapsulated
6313                        into apostrophes and support escape sequences as described
6314                        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>".
6315                        
6316  </p>  </p>
6317  <p>Possible Answers:  <p>Possible Answers:
6318  </p>  </p>
# Line 6522  Getting MIDI instrument map information< Line 6570  Getting MIDI instrument map information<
6570  <blockquote class="text">  <blockquote class="text">
6571  <p>custom name of the given map,  <p>custom name of the given map,
6572                                              which does not have to be unique                                              which does not have to be unique
6573                                                (note that this character string may contain
6574                                                 <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
6575  </p>  </p>
6576  </blockquote>  </blockquote>
6577                                                                            
# Line 6577  Renaming a MIDI instrument map</h3> Line 6627  Renaming a MIDI instrument map</h3>
6627  </p>  </p>
6628  <p>Where &lt;map&gt; is the numerical ID of the map and  <p>Where &lt;map&gt; is the numerical ID of the map and
6629                      &lt;name&gt; the new custom name of the map, which does not                      &lt;name&gt; the new custom name of the map, which does not
6630                      have to be unique.                      have to be unique (name MUST be encapsulated into apostrophes
6631                        and supports escape sequences as described in chapter
6632                        "<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>").
6633                        
6634  </p>  </p>
6635  <p>Possible Answers:  <p>Possible Answers:
6636  </p>  </p>
# Line 6643  Create or replace a MIDI instrument map Line 6696  Create or replace a MIDI instrument map
6696                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
6697                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>                      the <a class='info' href='#LIST AVAILABLE_ENGINES'>"LIST AVAILABLE_ENGINES"<span> (</span><span class='info'>Getting all available engines</span><span>)</span></a>
6698                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
6699                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
6700                        supporting escape sequences as described in chapter
6701                        "<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>"),
6702                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
6703                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
6704                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 6740  Create or replace a MIDI instrument map Line 6795  Create or replace a MIDI instrument map
6795                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
6796                      mode by i.e. sending                      mode by i.e. sending
6797                      <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>                      <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>
6798                      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
6799                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
6800                      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
6801                        mapping entry, useful for frontends for displaying an appropriate name for
6802                      mapped instruments (using                      mapped instruments (using
6803                      <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>).                      <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>).
6804                                            
# Line 7064  Get current settings of MIDI instrument Line 7120  Get current settings of MIDI instrument
7120                                      changed with the                                      changed with the
7121                                      <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>                                      <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>
7122                                      command and does not have to be unique.                                      command and does not have to be unique.
7123                                        (note that this character string may contain
7124                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>)
7125  </p>  </p>
7126  </blockquote>  </blockquote>
7127                                                            
# Line 7080  Get current settings of MIDI instrument Line 7138  Get current settings of MIDI instrument
7138  <p>"INSTRUMENT_FILE" -  <p>"INSTRUMENT_FILE" -
7139                                  </p>                                  </p>
7140  <blockquote class="text">  <blockquote class="text">
7141  <p>File name of the instrument.  <p>File name of the instrument
7142                                        (note that this path may contain
7143                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7144  </p>  </p>
7145  </blockquote>  </blockquote>
7146                                                            
# Line 7098  Get current settings of MIDI instrument Line 7158  Get current settings of MIDI instrument
7158  <blockquote class="text">  <blockquote class="text">
7159  <p>Name of the loaded instrument as reflected by its file.  <p>Name of the loaded instrument as reflected by its file.
7160                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
7161                                      cannot be changed.                                      cannot be changed (note that this character string may contain
7162                                        <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>).
7163  </p>  </p>
7164  </blockquote>  </blockquote>
7165                                                            
# Line 7233  Managing Instruments Database</h3> Line 7294  Managing Instruments Database</h3>
7294  <p>The following commands describe how to use and manage  <p>The following commands describe how to use and manage
7295                  the instruments database.                  the instruments database.
7296  </p>  </p>
7297    <p>Notice:
7298    </p>
7299    <p>
7300                            </p>
7301    <blockquote class="text">
7302    <p>All command arguments representing a path or
7303                                instrument/directory name support escape sequences as described in chapter
7304                                "<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>".
7305                                
7306    </p>
7307    <p>All occurrences of a forward slash in instrument and directory
7308                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
7309                                
7310    </p>
7311    </blockquote><p>
7312                        
7313    </p>
7314  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7315  <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>  <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>
7316  <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;  <a name="rfc.section.6.8.1"></a><h3>6.8.1.&nbsp;
# Line 7498  Getting instrument directory information Line 7576  Getting instrument directory information
7576  <p>DESCRIPTION -  <p>DESCRIPTION -
7577                                          </p>                                          </p>
7578  <blockquote class="text">  <blockquote class="text">
7579  <p>A brief description of the directory content  <p>A brief description of the directory content.
7580                                                Note that the character string may contain
7581                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
7582  </p>  </p>
7583  </blockquote>  </blockquote>
7584                                                                            
# Line 7743  Changing the description of directory</h Line 7823  Changing the description of directory</h
7823                                            
7824  </p>  </p>
7825  <p>Where &lt;dir&gt; is the absolute path name of the directory and  <p>Where &lt;dir&gt; is the absolute path name of the directory and
7826                      &lt;desc&gt; is the new description for the directory.                      &lt;desc&gt; is the new description for the directory
7827                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
7828                        "<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>").
7829  </p>  </p>
7830  <p>Possible Answers:  <p>Possible Answers:
7831  </p>  </p>
# Line 7810  Finding directories</h3> Line 7892  Finding directories</h3>
7892                            </p>                            </p>
7893  <blockquote class="text">  <blockquote class="text">
7894  <p>Restricts the search to directories, which names  <p>Restricts the search to directories, which names
7895                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
7896                                  supporting escape sequences as described in chapter
7897                                  "<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>").
7898  </p>  </p>
7899  </blockquote><p>  </blockquote><p>
7900                                                
# Line 7853  Finding directories</h3> Line 7937  Finding directories</h3>
7937                            </p>                            </p>
7938  <blockquote class="text">  <blockquote class="text">
7939  <p>Restricts the search to directories with description  <p>Restricts the search to directories with description
7940                                that satisfies the supplied search string.                                that satisfies the supplied search string
7941                                  (encapsulated into apostrophes, supporting escape
7942                                  sequences as described in chapter
7943                                  "<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>").
7944  </p>  </p>
7945  </blockquote><p>  </blockquote><p>
7946                                                
# Line 7916  Adding instruments to the instruments da Line 8003  Adding instruments to the instruments da
8003  <p>  <p>
8004                          </p>                          </p>
8005  <blockquote class="text">  <blockquote class="text">
8006  <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;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
8007  </p>  </p>
8008  </blockquote><p>  </blockquote><p>
8009                                            
# Line 7938  Adding instruments to the instruments da Line 8025  Adding instruments to the instruments da
8025  <p>  <p>
8026                          </p>                          </p>
8027  <blockquote class="text">  <blockquote class="text">
8028    <p>"RECURSIVE" -
8029                                    </p>
8030    <blockquote class="text">
8031    <p>All instruments will be processed, including those
8032                                        in the subdirectories, and the respective subdirectory
8033                                        tree structure will be recreated in the instruments
8034                                        database
8035    </p>
8036    </blockquote>
8037                                
8038    
8039  <p>"NON_RECURSIVE" -  <p>"NON_RECURSIVE" -
8040                                  </p>                                  </p>
8041  <blockquote class="text">  <blockquote class="text">
# Line 7960  Adding instruments to the instruments da Line 8058  Adding instruments to the instruments da
8058  </blockquote>  </blockquote>
8059                                                            
8060    
 <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>  
                               
   
8061  </blockquote><p>  </blockquote><p>
8062                                            
8063  </p>  </p>
8064    <p>The difference between regular and NON_MODAL versions of the command
8065                        is that the regular command returns when the scanning is finished
8066                        while NON_MODAL version returns immediately and a background process is launched.
8067                        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>
8068                        command can be used to monitor the scanning progress.
8069    </p>
8070  <p>Possible Answers:  <p>Possible Answers:
8071  </p>  </p>
8072  <p>  <p>
# Line 7982  Adding instruments to the instruments da Line 8075  Adding instruments to the instruments da
8075  <p>"OK" -  <p>"OK" -
8076                                  </p>                                  </p>
8077  <blockquote class="text">  <blockquote class="text">
8078  <p>on success  <p>on success when NON_MODAL is not supplied
8079    </p>
8080    </blockquote>
8081                                
8082    
8083    <p>"OK[&lt;job-id&gt;]" -
8084                                    </p>
8085    <blockquote class="text">
8086    <p>on success when NON_MODAL is supplied, where &lt;job-id&gt;
8087                                        is a numerical ID used to obtain status information about the job progress.
8088                                        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>
8089                                        
8090  </p>  </p>
8091  </blockquote>  </blockquote>
8092                                                            
# Line 8217  Getting instrument information</h3> Line 8321  Getting instrument information</h3>
8321                                          </p>                                          </p>
8322  <blockquote class="text">  <blockquote class="text">
8323  <p>File name of the instrument.  <p>File name of the instrument.
8324                                                Note that the character string may contain
8325                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8326  </p>  </p>
8327  </blockquote>  </blockquote>
8328                                                                            
# Line 8276  Getting instrument information</h3> Line 8382  Getting instrument information</h3>
8382  <p>DESCRIPTION -  <p>DESCRIPTION -
8383                                          </p>                                          </p>
8384  <blockquote class="text">  <blockquote class="text">
8385  <p>A brief description of the instrument  <p>A brief description of the instrument.
8386                                                Note that the character string may contain
8387                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8388  </p>  </p>
8389  </blockquote>  </blockquote>
8390                                                                            
# Line 8293  Getting instrument information</h3> Line 8401  Getting instrument information</h3>
8401  <p>PRODUCT -  <p>PRODUCT -
8402                                          </p>                                          </p>
8403  <blockquote class="text">  <blockquote class="text">
8404  <p>The product title of the instrument  <p>The product title of the instrument.
8405                                                Note that the character string may contain
8406                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8407  </p>  </p>
8408  </blockquote>  </blockquote>
8409                                                                            
# Line 8301  Getting instrument information</h3> Line 8411  Getting instrument information</h3>
8411  <p>ARTISTS -  <p>ARTISTS -
8412                                          </p>                                          </p>
8413  <blockquote class="text">  <blockquote class="text">
8414  <p>Lists the artist names  <p>Lists the artist names.
8415                                                Note that the character string may contain
8416                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8417  </p>  </p>
8418  </blockquote>  </blockquote>
8419                                                                            
# Line 8311  Getting instrument information</h3> Line 8423  Getting instrument information</h3>
8423  <blockquote class="text">  <blockquote class="text">
8424  <p>Provides a list of keywords that refer to the instrument.  <p>Provides a list of keywords that refer to the instrument.
8425                                              Keywords are separated with semicolon and blank.                                              Keywords are separated with semicolon and blank.
8426                                                Note that the character string may contain
8427                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8428  </p>  </p>
8429  </blockquote>  </blockquote>
8430                                                                            
# Line 8551  Changing the description of instrument</ Line 8665  Changing the description of instrument</
8665                                            
8666  </p>  </p>
8667  <p>Where &lt;instr&gt; is the absolute path name of the instrument and  <p>Where &lt;instr&gt; is the absolute path name of the instrument and
8668                      &lt;desc&gt; is the new description for the instrument.                      &lt;desc&gt; is the new description for the instrument
8669                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
8670                        "<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>").
8671  </p>  </p>
8672  <p>Possible Answers:  <p>Possible Answers:
8673  </p>  </p>
# Line 8618  Finding instruments</h3> Line 8734  Finding instruments</h3>
8734                            </p>                            </p>
8735  <blockquote class="text">  <blockquote class="text">
8736  <p>Restricts the search to instruments, which names  <p>Restricts the search to instruments, which names
8737                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
8738                                  supporting escape sequences as described in chapter
8739                                  "<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>").
8740  </p>  </p>
8741  </blockquote><p>  </blockquote><p>
8742                                                
# Line 8628  Finding instruments</h3> Line 8746  Finding instruments</h3>
8746  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8747                            </p>                            </p>
8748  <blockquote class="text">  <blockquote class="text">
8749  <p>Restricts the search to instruments, which  <p>Restricts the search to instruments, which
8750                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
8751                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
8752                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
# Line 8676  Finding instruments</h3> Line 8794  Finding instruments</h3>
8794                            </p>                            </p>
8795  <blockquote class="text">  <blockquote class="text">
8796  <p>Restricts the search to instruments with description  <p>Restricts the search to instruments with description
8797                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8798                                  supporting escape sequences as described in chapter
8799                                  "<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>").
8800  </p>  </p>
8801  </blockquote><p>  </blockquote><p>
8802                                                
# Line 8687  Finding instruments</h3> Line 8807  Finding instruments</h3>
8807                            </p>                            </p>
8808  <blockquote class="text">  <blockquote class="text">
8809  <p>Restricts the search to instruments with product info  <p>Restricts the search to instruments with product info
8810                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8811                                  supporting escape sequences as described in chapter
8812                                  "<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>").
8813  </p>  </p>
8814  </blockquote><p>  </blockquote><p>
8815                                                
# Line 8698  Finding instruments</h3> Line 8820  Finding instruments</h3>
8820                            </p>                            </p>
8821  <blockquote class="text">  <blockquote class="text">
8822  <p>Restricts the search to instruments with artists info  <p>Restricts the search to instruments with artists info
8823                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8824                                  supporting escape sequences as described in chapter
8825                                  "<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>").
8826  </p>  </p>
8827  </blockquote><p>  </blockquote><p>
8828                                                
# Line 8709  Finding instruments</h3> Line 8833  Finding instruments</h3>
8833                            </p>                            </p>
8834  <blockquote class="text">  <blockquote class="text">
8835  <p>Restricts the search to instruments with keyword list  <p>Restricts the search to instruments with keyword list
8836                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8837                                  supporting escape sequences as described in chapter
8838                                  "<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>").
8839  </p>  </p>
8840  </blockquote><p>  </blockquote><p>
8841                                                
# Line 8719  Finding instruments</h3> Line 8845  Finding instruments</h3>
8845  <p>IS_DRUM=true | false  <p>IS_DRUM=true | false
8846                            </p>                            </p>
8847  <blockquote class="text">  <blockquote class="text">
8848  <p>Either true or false. Restricts the search to  <p>Either true or false. Restricts the search to
8849                                drum kits or chromatic instruments.                                drum kits or chromatic instruments.
8850  </p>  </p>
8851  </blockquote><p>  </blockquote><p>
# Line 8783  Finding instruments</h3> Line 8909  Finding instruments</h3>
8909  </blockquote><p>  </blockquote><p>
8910                                            
8911  </p>  </p>
8912    <a name="GET DB_INSTRUMENTS_JOB INFO"></a><br /><hr />
8913    <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>
8914    <a name="rfc.section.6.8.21"></a><h3>6.8.21.&nbsp;
8915    Getting job status information</h3>
8916    
8917    <p>The front-end can ask for the current status of a
8918                        particular database instruments job by sending the following command:
8919    </p>
8920    <p>
8921                            </p>
8922    <blockquote class="text">
8923    <p>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;
8924    </p>
8925    </blockquote><p>
8926                        
8927    </p>
8928    <p>Where &lt;job-id&gt; should be replaced by the numerical ID
8929                        of the job the front-end is interested in.
8930    </p>
8931    <p>Possible Answers:
8932    </p>
8933    <p>
8934                            </p>
8935    <blockquote class="text">
8936    <p>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
8937                                Each answer line begins with the settings category name
8938                                followed by a colon and then a space character &lt;SP&gt; and finally
8939                                the info character string to that setting category. At the
8940                                moment the following categories are defined:
8941    </p>
8942    <p>
8943                                    </p>
8944    <blockquote class="text">
8945    <p>FILES_TOTAL -
8946                                            </p>
8947    <blockquote class="text">
8948    <p>The total number of files scheduled for scanning
8949    </p>
8950    </blockquote>
8951                                        
8952    
8953    <p>FILES_SCANNED -
8954                                            </p>
8955    <blockquote class="text">
8956    <p>The current number of scanned files
8957    </p>
8958    </blockquote>
8959                                        
8960    
8961    <p>SCANNING -
8962                                            </p>
8963    <blockquote class="text">
8964    <p>The absolute path name of the file which is currently
8965                                                being scanned
8966    </p>
8967    </blockquote>
8968                                        
8969    
8970    <p>STATUS -
8971                                            </p>
8972    <blockquote class="text">
8973    <p>An integer value between 0 and 100 indicating the
8974                                                scanning progress percentage of the file which is
8975                                                currently being scanned
8976    </p>
8977    </blockquote>
8978                                        
8979    
8980    </blockquote>
8981                                
8982    
8983    </blockquote><p>
8984                        
8985    </p>
8986    <p>The mentioned fields above don't have to be in particular order.
8987    </p>
8988    <p>Example:
8989    </p>
8990    <p>
8991                            </p>
8992    <blockquote class="text">
8993    <p>C: "GET DB_INSTRUMENTS_JOB INFO 2"
8994    </p>
8995    <p>S: "FILES_TOTAL: 12"
8996    </p>
8997    <p>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"
8998    </p>
8999    <p>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"
9000    </p>
9001    <p>&nbsp;&nbsp;&nbsp;"STATUS: 42"
9002    </p>
9003    <p>&nbsp;&nbsp;&nbsp;"."
9004    </p>
9005    </blockquote><p>
9006                        
9007    </p>
9008    <a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
9009    <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>
9010    <a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
9011    Formatting the instruments database</h3>
9012    
9013    <p>The front-end can remove all instruments and directories and re-create
9014                        the instruments database structure (e.g., in case of a database corruption)
9015                        by sending the following command:
9016    </p>
9017    <p>
9018                            </p>
9019    <blockquote class="text">
9020    <p>FORMAT INSTRUMENTS_DB
9021    </p>
9022    </blockquote><p>
9023                        
9024    </p>
9025    <p>Possible Answers:
9026    </p>
9027    <p>
9028                            </p>
9029    <blockquote class="text">
9030    <p>"OK" -
9031                                    </p>
9032    <blockquote class="text">
9033    <p>on success
9034    </p>
9035    </blockquote>
9036                                
9037    
9038    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9039                                    </p>
9040    <blockquote class="text">
9041    <p>If the formatting of the instruments database
9042                                        failed.
9043    </p>
9044    </blockquote>
9045                                
9046    
9047    </blockquote><p>
9048                        
9049    </p>
9050    <a name="editing_instruments"></a><br /><hr />
9051    <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>
9052    <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
9053    Editing Instruments</h3>
9054    
9055    <p>The sampler allows to edit instruments while playing with the
9056                    sampler by spawning an external (3rd party) instrument editor
9057                    application for a given instrument. The 3rd party instrument
9058                    editor applications have to place a respective plugin DLL file
9059                    into the sampler's plugins directory. The sampler will
9060                    automatically try to load all plugin DLLs in that directory on
9061                    startup and only on startup!
9062    </p>
9063    <p>At the moment there is only one command for this feature set,
9064                    but this will most probably change in future.
9065    </p>
9066    <a name="EDIT INSTRUMENT"></a><br /><hr />
9067    <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>
9068    <a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
9069    Opening an appropriate instrument editor application</h3>
9070    
9071    <p>The front-end can request to open an appropriate instrument
9072                        editor application by sending the following command:
9073    </p>
9074    <p>
9075                            </p>
9076    <blockquote class="text">
9077    <p>EDIT INSTRUMENT &lt;sampler-channel&gt;
9078    </p>
9079    </blockquote><p>
9080                        
9081    </p>
9082    <p>Where &lt;sampler-channel&gt; should be replaced by the
9083                        number of the sampler channel as given by the
9084                        <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
9085                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
9086                        command.
9087    </p>
9088    <p>The sampler will try to ask all registered instrument
9089                        editors (or to be more specific: their sampler plugins)
9090                        whether they are capable to handle the instrument on the
9091                        given sampler channel. The sampler will simply use the first
9092                        instrument editor application which replied with a positive
9093                        answer and spawn that instrument editor application within
9094                        the sampler's process and provide that application access
9095                        to the instrument's data structures, so both applications
9096                        can share and access the same instruments data at the same
9097                        time, thus allowing to immediately hear changes with the
9098                        sampler made by the instrument editor.
9099    </p>
9100    <p>Note: consequently instrument editors are always spawned
9101                        locally on the same machine where the sampler is running
9102                        on!
9103    </p>
9104    <p>Possible Answers:
9105    </p>
9106    <p>
9107                            </p>
9108    <blockquote class="text">
9109    <p>"OK" -
9110                                    </p>
9111    <blockquote class="text">
9112    <p>when an appropriate instrument editor was
9113                                        launched
9114    </p>
9115    </blockquote>
9116                                
9117    
9118    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
9119                                    </p>
9120    <blockquote class="text">
9121    <p>when an appropriate instrument editor was
9122                                        launched, but there are noteworthy issues
9123    </p>
9124    </blockquote>
9125                                
9126    
9127    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9128                                    </p>
9129    <blockquote class="text">
9130    <p>when an appropriate instrument editor
9131                                        could not be launched
9132    </p>
9133    </blockquote>
9134                                
9135    
9136    </blockquote><p>
9137                        
9138    </p>
9139    <p>Examples:
9140    </p>
9141    <p>
9142                            </p>
9143    <blockquote class="text">
9144    <p>C: "EDIT INSTRUMENT 0"
9145    </p>
9146    <p>S: "OK"
9147    </p>
9148    </blockquote><p>
9149                        
9150    </p>
9151  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9152  <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>  <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>
9153  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 8898  Command Syntax</h3> Line 9263  Command Syntax</h3>
9263  <p>/ COPY SP copy_instruction  <p>/ COPY SP copy_instruction
9264                                    
9265  </p>  </p>
9266    <p>/ EDIT SP edit_instruction
9267                    
9268    </p>
9269    <p>/ FORMAT SP format_instruction
9270                    
9271    </p>
9272  <p>/ RESET  <p>/ RESET
9273                                    
9274  </p>  </p>
# Line 8913  Command Syntax</h3> Line 9284  Command Syntax</h3>
9284  <p>CHANNEL  <p>CHANNEL
9285                                    
9286  </p>  </p>
9287  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9288                    
9289    </p>
9290    <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
9291                    
9292    </p>
9293    <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
9294                                    
9295  </p>  </p>
9296  <p>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
9297                                    
9298  </p>  </p>
9299  <p>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
9300                                    
9301  </p>  </p>
9302  <p>/ DB_INSTRUMENTS SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP db_path SP filename
9303                                    
9304  </p>  </p>
9305  <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
9306                                    
9307  </p>  </p>
9308  <p>/ MIDI_INSTRUMENT_MAP  <p>/ MIDI_INSTRUMENT_MAP
# Line 8997  Command Syntax</h3> Line 9374  Command Syntax</h3>
9374  <p>/ DB_INSTRUMENT_INFO  <p>/ DB_INSTRUMENT_INFO
9375                                    
9376  </p>  </p>
9377    <p>/ DB_INSTRUMENTS_JOB_INFO
9378                    
9379    </p>
9380  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9381                                    
9382  </p>  </p>
# Line 9069  Command Syntax</h3> Line 9449  Command Syntax</h3>
9449  <p>/ DB_INSTRUMENT_INFO  <p>/ DB_INSTRUMENT_INFO
9450                                    
9451  </p>  </p>
9452    <p>/ DB_INSTRUMENTS_JOB_INFO
9453                    
9454    </p>
9455  <p>/ MISCELLANEOUS  <p>/ MISCELLANEOUS
9456                                    
9457  </p>  </p>
# Line 9120  Command Syntax</h3> Line 9503  Command Syntax</h3>
9503  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
9504                                    
9505  </p>  </p>
9506  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
9507                                    
9508  </p>  </p>
9509  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9510                                    
9511  </p>  </p>
9512  <p>/ DB_INSTRUMENT SP pathname  <p>/ DB_INSTRUMENT SP db_path
9513                                    
9514  </p>  </p>
9515  </blockquote><p>  </blockquote><p>
# Line 9234  Command Syntax</h3> Line 9617  Command Syntax</h3>
9617  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9618                                    
9619  </p>  </p>
9620  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9621                    
9622    </p>
9623    <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9624                                    
9625  </p>  </p>
9626  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
9627                                    
9628  </p>  </p>
9629  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9630                                    
9631  </p>  </p>
9632  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9633                                    
9634  </p>  </p>
9635  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENT SP INFO SP db_path
9636                                    
9637  </p>  </p>
9638  <p>/ DB_INSTRUMENT SP INFO SP pathname  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
9639                                    
9640  </p>  </p>
9641  <p>/ VOLUME  <p>/ VOLUME
# Line 9270  Command Syntax</h3> Line 9656  Command Syntax</h3>
9656  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
9657                                    
9658  </p>  </p>
9659    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
9660                    
9661    </p>
9662  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
9663                                    
9664  </p>  </p>
# Line 9291  Command Syntax</h3> Line 9680  Command Syntax</h3>
9680  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value  <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
9681                                    
9682  </p>  </p>
9683  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
9684                                    
9685  </p>  </p>
9686  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
9687                                    
9688  </p>  </p>
9689  <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
9690                                    
9691  </p>  </p>
9692  <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
9693                                    
9694  </p>  </p>
9695  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
# Line 9360  Command Syntax</h3> Line 9749  Command Syntax</h3>
9749  <p>find_instruction =  <p>find_instruction =
9750          </p>          </p>
9751  <blockquote class="text">  <blockquote class="text">
9752  <p>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list  <p>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
9753                                    
9754  </p>  </p>
9755  <p>/ DB_INSTRUMENTS SP pathname SP query_val_list  <p>/ DB_INSTRUMENTS SP db_path SP query_val_list
9756                                    
9757  </p>  </p>
9758  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
9759                                    
9760  </p>  </p>
9761  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
9762                                    
9763  </p>  </p>
9764  </blockquote><p>  </blockquote><p>
# Line 9378  Command Syntax</h3> Line 9767  Command Syntax</h3>
9767  <p>move_instruction =  <p>move_instruction =
9768          </p>          </p>
9769  <blockquote class="text">  <blockquote class="text">
9770  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
9771                                    
9772  </p>  </p>
9773  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
9774                                    
9775  </p>  </p>
9776  </blockquote><p>  </blockquote><p>
# Line 9390  Command Syntax</h3> Line 9779  Command Syntax</h3>
9779  <p>copy_instruction =  <p>copy_instruction =
9780          </p>          </p>
9781  <blockquote class="text">  <blockquote class="text">
9782  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
9783                                    
9784  </p>  </p>
9785  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
9786                                    
9787  </p>  </p>
9788  </blockquote><p>  </blockquote><p>
# Line 9474  Command Syntax</h3> Line 9863  Command Syntax</h3>
9863  </blockquote><p>  </blockquote><p>
9864    
9865  </p>  </p>
9866    <p>edit_instruction =
9867            </p>
9868    <blockquote class="text">
9869    <p>INSTRUMENT SP sampler_channel
9870                    
9871    </p>
9872    </blockquote><p>
9873    
9874    </p>
9875    <p>format_instruction =
9876            </p>
9877    <blockquote class="text">
9878    <p>INSTRUMENTS_DB
9879                    
9880    </p>
9881    </blockquote><p>
9882    
9883    </p>
9884  <p>modal_arg =  <p>modal_arg =
9885          </p>          </p>
9886  <blockquote class="text">  <blockquote class="text">
# Line 9543  Command Syntax</h3> Line 9950  Command Syntax</h3>
9950  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
9951                                    
9952  </p>  </p>
9953  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9954                                    
9955  </p>  </p>
9956  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9957                                    
9958  </p>  </p>
9959  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9960                                    
9961  </p>  </p>
9962  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9963                                    
9964  </p>  </p>
9965  </blockquote><p>  </blockquote><p>
# Line 9735  Command Syntax</h3> Line 10142  Command Syntax</h3>
10142  </blockquote><p>  </blockquote><p>
10143    
10144  </p>  </p>
10145  <p>pathname =  <p>filename =
         </p>  
 <blockquote class="text">  
 <p>stringval  
                   
 </p>  
 </blockquote><p>  
   
 </p>  
 <p>dirname =  
10146          </p>          </p>
10147  <blockquote class="text">  <blockquote class="text">
10148  <p>stringval  <p>path
10149                                    
10150  </p>  </p>
10151  </blockquote><p>  </blockquote><p>
10152    
10153  </p>  </p>
10154  <p>filename =  <p>db_path =
10155          </p>          </p>
10156  <blockquote class="text">  <blockquote class="text">
10157  <p>stringval  <p>path
10158                                    
10159  </p>  </p>
10160  </blockquote><p>  </blockquote><p>
# Line 9765  Command Syntax</h3> Line 10163  Command Syntax</h3>
10163  <p>map_name =  <p>map_name =
10164          </p>          </p>
10165  <blockquote class="text">  <blockquote class="text">
10166  <p>stringval  <p>stringval_escaped
10167                                    
10168  </p>  </p>
10169  </blockquote><p>  </blockquote><p>
# Line 9774  Command Syntax</h3> Line 10172  Command Syntax</h3>
10172  <p>entry_name =  <p>entry_name =
10173          </p>          </p>
10174  <blockquote class="text">  <blockquote class="text">
10175  <p>stringval  <p>stringval_escaped
10176                                    
10177  </p>  </p>
10178  </blockquote><p>  </blockquote><p>
# Line 9783  Command Syntax</h3> Line 10181  Command Syntax</h3>
10181  <p>fx_send_name =  <p>fx_send_name =
10182          </p>          </p>
10183  <blockquote class="text">  <blockquote class="text">
10184  <p>stringval  <p>stringval_escaped
10185                                    
10186  </p>  </p>
10187  </blockquote><p>  </blockquote><p>
# Line 9834  Command Syntax</h3> Line 10232  Command Syntax</h3>
10232  <p>query_val =  <p>query_val =
10233          </p>          </p>
10234  <blockquote class="text">  <blockquote class="text">
10235  <p>string  <p>text_escaped
10236                                    
10237  </p>  </p>
10238  <p>/ stringval  <p>/ stringval_escaped
10239                    
10240    </p>
10241    </blockquote><p>
10242    
10243    </p>
10244    <p>scan_mode =
10245            </p>
10246    <blockquote class="text">
10247    <p>RECURSIVE
10248                    
10249    </p>
10250    <p>/ NON_RECURSIVE
10251                    
10252    </p>
10253    <p>/ FLAT
10254                                    
10255  </p>  </p>
10256  </blockquote><p>  </blockquote><p>
10257    
10258  </p>  </p>
10259    <a name="character_set"></a><br /><hr />
10260    <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>
10261    <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
10262    Character Set and Escape Sequences</h3>
10263    
10264    <p>Older versions of this protocol up to and including v1.1 only
10265                    supported the standard ASCII character set (ASCII code 0 - 127)
10266                    <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
10267                    however support the Extended ASCII character set (ASCII code
10268                    0 - 255). The same group of younger protocols also support
10269                    escape sequences, but only for certain, explicitly declared
10270                    parts of the protocol. The supported escape sequences are
10271                    defined as follows:
10272    </p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
10273    <col align="left"><col align="left">
10274    <tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
10275    <tr>
10276    <td align="left">\n</td>
10277    <td align="left">new line</td>
10278    </tr>
10279    <tr>
10280    <td align="left">\r</td>
10281    <td align="left">carriage return</td>
10282    </tr>
10283    <tr>
10284    <td align="left">\f</td>
10285    <td align="left">form feed</td>
10286    </tr>
10287    <tr>
10288    <td align="left">\t</td>
10289    <td align="left">horizontal tab</td>
10290    </tr>
10291    <tr>
10292    <td align="left">\v</td>
10293    <td align="left">vertical tab</td>
10294    </tr>
10295    <tr>
10296    <td align="left">\'</td>
10297    <td align="left">apostrophe</td>
10298    </tr>
10299    <tr>
10300    <td align="left">\"</td>
10301    <td align="left">quotation mark</td>
10302    </tr>
10303    <tr>
10304    <td align="left">\\</td>
10305    <td align="left">backslash</td>
10306    </tr>
10307    <tr>
10308    <td align="left">\OOO</td>
10309    <td align="left">three digit octal ASCII code of the character</td>
10310    </tr>
10311    <tr>
10312    <td align="left">\xHH</td>
10313    <td align="left">two digit hex ASCII code of the character</td>
10314    </tr>
10315    </table>
10316    
10317    <p>Notice: due to the transition of certain parts of the
10318                    protocol which now support escape sequences, a slight backward
10319                    incompatibility to protocols version v1.1 and younger has been
10320                    introduced. The only difference is that in parts of the protocol
10321                    where escape characters are now supported, a backslash characters
10322                    MUST be escaped as well (that is as double backslash), whereas
10323                    in the old versions a single backslash was sufficient.
10324    </p>
10325    <p>The following LSCP commands support escape sequences as part
10326                    of their filename / path based arguments and / or may contain
10327                    a filename / path with escape sequences in their response:
10328                    </p>
10329    <blockquote class="text">
10330    <p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a>
10331    </p>
10332    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
10333    </p>
10334    <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>
10335    </p>
10336    <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>
10337    </p>
10338    <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>
10339    </p>
10340    <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>
10341    </p>
10342    <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>
10343    </p>
10344    <p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a>
10345    </p>
10346    <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>
10347    </p>
10348    <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>
10349    </p>
10350    <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>
10351    </p>
10352    <p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a>
10353    </p>
10354    <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>
10355    </p>
10356    <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>
10357    </p>
10358    <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>
10359    </p>
10360    <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>
10361    </p>
10362    <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>
10363    </p>
10364    <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>
10365    </p>
10366    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10367    </p>
10368    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10369    </p>
10370    <p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a>
10371    </p>
10372    <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>
10373    </p>
10374    <p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a>
10375    </p>
10376    <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>
10377    </p>
10378    </blockquote><p>
10379                    Note that the forward slash character ('/') has a special meaning in
10380                    filename / path based arguments: it acts as separator of the nodes in
10381                    the path, thus if a directory- or filename includes a forward slash
10382                    (not intended as path node separator), you MUST escape that slash
10383                    either with the respective hex escape sequence ("\x2f") or with the
10384                    respective octal escape sequence ("\057").
10385                    
10386    </p>
10387    <p>
10388                    The following LSCP commands even support escape sequences as
10389                    part of at least one of their text-based arguments (i.e. entity name,
10390                    description) and / or may contain escape sequences in at least one of
10391                    their text-based fields in their response:
10392                    </p>
10393    <blockquote class="text">
10394    <p><a class='info' href='#GET SERVER INFO'>"GET SERVER INFO"<span> (</span><span class='info'>General sampler informations</span><span>)</span></a>
10395    </p>
10396    <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>
10397    </p>
10398    <p><a class='info' href='#GET CHANNEL INFO'>"GET CHANNEL INFO"<span> (</span><span class='info'>Getting sampler channel information</span><span>)</span></a>
10399    </p>
10400    <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>
10401    </p>
10402    <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>
10403    </p>
10404    <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>
10405    </p>
10406    <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>
10407    </p>
10408    <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>
10409    </p>
10410    <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>
10411    </p>
10412    <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>
10413    </p>
10414    <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>
10415    </p>
10416    <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>
10417    </p>
10418    <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>
10419    </p>
10420    <p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a>
10421    </p>
10422    <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>
10423    </p>
10424    <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>
10425    </p>
10426    <p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a>
10427    </p>
10428    </blockquote><p>
10429                    Please note that these lists are manually maintained. If you
10430                    find a command that also supports escape sequences we forgot to
10431                    mention here, please report it!
10432                    
10433    </p>
10434  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
10435  <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>  <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>
10436  <a name="rfc.section.8"></a><h3>8.&nbsp;  <a name="rfc.section.8"></a><h3>8.&nbsp;
# Line 10132  Channel information changed</h3> Line 10720  Channel information changed</h3>
10720  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
10721  Number of effect sends changed</h3>  Number of effect sends changed</h3>
10722    
10723  <p>Client may want to be notified when the number of effect sends on  <p>Client may want to be notified when the number of effect sends on
10724                  a particular sampler channel is changed by issuing the following command:                  a particular sampler channel is changed by issuing the following command:
10725  </p>  </p>
10726  <p>  <p>
# Line 10529  Database instrument information changed< Line 11117  Database instrument information changed<
11117                  (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is                  (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
11118                  the new name of the instrument, encapsulated into apostrophes.                  the new name of the instrument, encapsulated into apostrophes.
11119  </p>  </p>
11120  <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />  <a name="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"></a><br /><hr />
11121  <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>  <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>
11122  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;  <a name="rfc.section.8.22"></a><h3>8.22.&nbsp;
11123    Database job status information changed</h3>
11124    
11125    <p>Client may want to be notified when the status of particular database
11126                    instruments job is changed by issuing the following command:
11127    </p>
11128    <p>
11129                        </p>
11130    <blockquote class="text">
11131    <p>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
11132    </p>
11133    </blockquote><p>
11134                    
11135    </p>
11136    <p>Server will start sending the following notification messages:
11137    </p>
11138    <p>
11139                        </p>
11140    <blockquote class="text">
11141    <p>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"
11142    </p>
11143    </blockquote><p>
11144                    
11145    </p>
11146    <p>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
11147                    which status is changed. The front-end will have to send the respective
11148                    command to actually get the status info. Because these messages
11149                    will be triggered by LSCP commands issued by other clients rather than real
11150                    time events happening on the server, it is believed that an empty notification
11151                    message is sufficient here.
11152    </p>
11153    <a name="SUBSCRIBE MISCELLANEOUS"></a><br /><hr />
11154    <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>
11155    <a name="rfc.section.8.23"></a><h3>8.23.&nbsp;
11156  Miscellaneous and debugging events</h3>  Miscellaneous and debugging events</h3>
11157    
11158  <p>Client may want to be notified of miscellaneous and debugging events occurring at  <p>Client may want to be notified of miscellaneous and debugging events occurring at
# Line 10596  Acknowledgments</h3> Line 11217  Acknowledgments</h3>
11217  <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>  <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>
11218  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
11219  <table width="99%" border="0">  <table width="99%" border="0">
11220    <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
11221    <td class="author-text">UCLA, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
11222  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
11223  <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="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>
11224  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC2234">[RFC2234]</a></td>
# Line 10673  Please address the information to the IE Line 11296  Please address the information to the IE
11296  Funding for the RFC Editor function is provided by  Funding for the RFC Editor function is provided by
11297  the IETF Administrative Support Activity (IASA).</p>  the IETF Administrative Support Activity (IASA).</p>
11298  </body></html>  </body></html>
11299    
Legend:
Removed from v.1189  
changed lines
  Added in v.1400
  ViewVC Help
Powered by ViewVC