/[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 1201 by iliev, Thu May 24 14:22:39 2007 UTC revision 1363 by schoenebeck, Sun Sep 30 21:51:14 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 25, 2007</td><td class="header">May 24, 2007</td></tr>  <tr><td class="header">Expires: March 4, 2008</td><td class="header">September 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 25, 2007.</p>  This Internet-Draft will expire on March 4, 2008.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
# Line 432  Changing the description of instrument<b Line 432  Changing the description of instrument<b
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;  &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 />  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 512  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 3299  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 3340  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 3375  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 6647  Create or replace a MIDI instrument map Line 6674  Create or replace a MIDI instrument map
6674                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
6675                      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>
6676                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
6677                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
6678                        supporting escape sequences as described in chapter
6679                        "<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>"),
6680                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
6681                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
6682                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 7237  Managing Instruments Database</h3> Line 7266  Managing Instruments Database</h3>
7266  <p>The following commands describe how to use and manage  <p>The following commands describe how to use and manage
7267                  the instruments database.                  the instruments database.
7268  </p>  </p>
7269    <p>Notice:
7270    </p>
7271    <p>
7272                            </p>
7273    <blockquote class="text">
7274    <p>All command arguments representing a path or
7275                                instrument/directory name support escape sequences as described in chapter
7276                                "<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>".
7277                                
7278    </p>
7279    <p>All occurrences of a forward slash in instrument and directory
7280                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
7281                                
7282    </p>
7283    </blockquote><p>
7284                        
7285    </p>
7286  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />  <a name="ADD DB_INSTRUMENT_DIRECTORY"></a><br /><hr />
7287  <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>
7288  <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 7502  Getting instrument directory information Line 7548  Getting instrument directory information
7548  <p>DESCRIPTION -  <p>DESCRIPTION -
7549                                          </p>                                          </p>
7550  <blockquote class="text">  <blockquote class="text">
7551  <p>A brief description of the directory content  <p>A brief description of the directory content.
7552                                                Note that the character string may contain
7553                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
7554  </p>  </p>
7555  </blockquote>  </blockquote>
7556                                                                            
# Line 7747  Changing the description of directory</h Line 7795  Changing the description of directory</h
7795                                            
7796  </p>  </p>
7797  <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
7798                      &lt;desc&gt; is the new description for the directory.                      &lt;desc&gt; is the new description for the directory
7799                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
7800                        "<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>").
7801  </p>  </p>
7802  <p>Possible Answers:  <p>Possible Answers:
7803  </p>  </p>
# Line 7814  Finding directories</h3> Line 7864  Finding directories</h3>
7864                            </p>                            </p>
7865  <blockquote class="text">  <blockquote class="text">
7866  <p>Restricts the search to directories, which names  <p>Restricts the search to directories, which names
7867                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
7868                                  supporting escape sequences as described in chapter
7869                                  "<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>").
7870  </p>  </p>
7871  </blockquote><p>  </blockquote><p>
7872                                                
# Line 7857  Finding directories</h3> Line 7909  Finding directories</h3>
7909                            </p>                            </p>
7910  <blockquote class="text">  <blockquote class="text">
7911  <p>Restricts the search to directories with description  <p>Restricts the search to directories with description
7912                                that satisfies the supplied search string.                                that satisfies the supplied search string
7913                                  (encapsulated into apostrophes, supporting escape
7914                                  sequences as described in chapter
7915                                  "<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>").
7916  </p>  </p>
7917  </blockquote><p>  </blockquote><p>
7918                                                
# Line 8238  Getting instrument information</h3> Line 8293  Getting instrument information</h3>
8293                                          </p>                                          </p>
8294  <blockquote class="text">  <blockquote class="text">
8295  <p>File name of the instrument.  <p>File name of the instrument.
8296                                                Note that the character string may contain
8297                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8298  </p>  </p>
8299  </blockquote>  </blockquote>
8300                                                                            
# Line 8297  Getting instrument information</h3> Line 8354  Getting instrument information</h3>
8354  <p>DESCRIPTION -  <p>DESCRIPTION -
8355                                          </p>                                          </p>
8356  <blockquote class="text">  <blockquote class="text">
8357  <p>A brief description of the instrument  <p>A brief description of the instrument.
8358                                                Note that the character string may contain
8359                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8360  </p>  </p>
8361  </blockquote>  </blockquote>
8362                                                                            
# Line 8314  Getting instrument information</h3> Line 8373  Getting instrument information</h3>
8373  <p>PRODUCT -  <p>PRODUCT -
8374                                          </p>                                          </p>
8375  <blockquote class="text">  <blockquote class="text">
8376  <p>The product title of the instrument  <p>The product title of the instrument.
8377                                                Note that the character string may contain
8378                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8379  </p>  </p>
8380  </blockquote>  </blockquote>
8381                                                                            
# Line 8322  Getting instrument information</h3> Line 8383  Getting instrument information</h3>
8383  <p>ARTISTS -  <p>ARTISTS -
8384                                          </p>                                          </p>
8385  <blockquote class="text">  <blockquote class="text">
8386  <p>Lists the artist names  <p>Lists the artist names.
8387                                                Note that the character string may contain
8388                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8389  </p>  </p>
8390  </blockquote>  </blockquote>
8391                                                                            
# Line 8332  Getting instrument information</h3> Line 8395  Getting instrument information</h3>
8395  <blockquote class="text">  <blockquote class="text">
8396  <p>Provides a list of keywords that refer to the instrument.  <p>Provides a list of keywords that refer to the instrument.
8397                                              Keywords are separated with semicolon and blank.                                              Keywords are separated with semicolon and blank.
8398                                                Note that the character string may contain
8399                                                <a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>.
8400  </p>  </p>
8401  </blockquote>  </blockquote>
8402                                                                            
# Line 8572  Changing the description of instrument</ Line 8637  Changing the description of instrument</
8637                                            
8638  </p>  </p>
8639  <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
8640                      &lt;desc&gt; is the new description for the instrument.                      &lt;desc&gt; is the new description for the instrument
8641                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
8642                        "<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>").
8643  </p>  </p>
8644  <p>Possible Answers:  <p>Possible Answers:
8645  </p>  </p>
# Line 8639  Finding instruments</h3> Line 8706  Finding instruments</h3>
8706                            </p>                            </p>
8707  <blockquote class="text">  <blockquote class="text">
8708  <p>Restricts the search to instruments, which names  <p>Restricts the search to instruments, which names
8709                                satisfy the supplied search string.                                satisfy the supplied search string (encapsulated into apostrophes,
8710                                  supporting escape sequences as described in chapter
8711                                  "<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>").
8712  </p>  </p>
8713  </blockquote><p>  </blockquote><p>
8714                                                
# Line 8649  Finding instruments</h3> Line 8718  Finding instruments</h3>
8718  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]  <p>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
8719                            </p>                            </p>
8720  <blockquote class="text">  <blockquote class="text">
8721  <p>Restricts the search to instruments, which  <p>Restricts the search to instruments, which
8722                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
8723                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
8724                                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 8697  Finding instruments</h3> Line 8766  Finding instruments</h3>
8766                            </p>                            </p>
8767  <blockquote class="text">  <blockquote class="text">
8768  <p>Restricts the search to instruments with description  <p>Restricts the search to instruments with description
8769                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8770                                  supporting escape sequences as described in chapter
8771                                  "<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>").
8772  </p>  </p>
8773  </blockquote><p>  </blockquote><p>
8774                                                
# Line 8708  Finding instruments</h3> Line 8779  Finding instruments</h3>
8779                            </p>                            </p>
8780  <blockquote class="text">  <blockquote class="text">
8781  <p>Restricts the search to instruments with product info  <p>Restricts the search to instruments with product info
8782                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8783                                  supporting escape sequences as described in chapter
8784                                  "<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>").
8785  </p>  </p>
8786  </blockquote><p>  </blockquote><p>
8787                                                
# Line 8719  Finding instruments</h3> Line 8792  Finding instruments</h3>
8792                            </p>                            </p>
8793  <blockquote class="text">  <blockquote class="text">
8794  <p>Restricts the search to instruments with artists info  <p>Restricts the search to instruments with artists info
8795                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8796                                  supporting escape sequences as described in chapter
8797                                  "<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>").
8798  </p>  </p>
8799  </blockquote><p>  </blockquote><p>
8800                                                
# Line 8730  Finding instruments</h3> Line 8805  Finding instruments</h3>
8805                            </p>                            </p>
8806  <blockquote class="text">  <blockquote class="text">
8807  <p>Restricts the search to instruments with keyword list  <p>Restricts the search to instruments with keyword list
8808                                that satisfies the supplied search string.                                that satisfies the supplied search string (encapsulated into apostrophes,
8809                                  supporting escape sequences as described in chapter
8810                                  "<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>").
8811  </p>  </p>
8812  </blockquote><p>  </blockquote><p>
8813                                                
# Line 8740  Finding instruments</h3> Line 8817  Finding instruments</h3>
8817  <p>IS_DRUM=true | false  <p>IS_DRUM=true | false
8818                            </p>                            </p>
8819  <blockquote class="text">  <blockquote class="text">
8820  <p>Either true or false. Restricts the search to  <p>Either true or false. Restricts the search to
8821                                drum kits or chromatic instruments.                                drum kits or chromatic instruments.
8822  </p>  </p>
8823  </blockquote><p>  </blockquote><p>
# Line 8900  Getting job status information</h3> Line 8977  Getting job status information</h3>
8977  </blockquote><p>  </blockquote><p>
8978                                            
8979  </p>  </p>
8980    <a name="FORMAT INSTRUMENTS_DB"></a><br /><hr />
8981    <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>
8982    <a name="rfc.section.6.8.22"></a><h3>6.8.22.&nbsp;
8983    Formatting the instruments database</h3>
8984    
8985    <p>The front-end can remove all instruments and directories and re-create
8986                        the instruments database structure (e.g., in case of a database corruption)
8987                        by sending the following command:
8988    </p>
8989    <p>
8990                            </p>
8991    <blockquote class="text">
8992    <p>FORMAT INSTRUMENTS_DB
8993    </p>
8994    </blockquote><p>
8995                        
8996    </p>
8997    <p>Possible Answers:
8998    </p>
8999    <p>
9000                            </p>
9001    <blockquote class="text">
9002    <p>"OK" -
9003                                    </p>
9004    <blockquote class="text">
9005    <p>on success
9006    </p>
9007    </blockquote>
9008                                
9009    
9010    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9011                                    </p>
9012    <blockquote class="text">
9013    <p>If the formatting of the instruments database
9014                                        failed.
9015    </p>
9016    </blockquote>
9017                                
9018    
9019    </blockquote><p>
9020                        
9021    </p>
9022    <a name="editing_instruments"></a><br /><hr />
9023    <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>
9024    <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
9025    Editing Instruments</h3>
9026    
9027    <p>The sampler allows to edit instruments while playing with the
9028                    sampler by spawning an external (3rd party) instrument editor
9029                    application for a given instrument. The 3rd party instrument
9030                    editor applications have to place a respective plugin DLL file
9031                    into the sampler's plugins directory. The sampler will
9032                    automatically try to load all plugin DLLs in that directory on
9033                    startup and only on startup!
9034    </p>
9035    <p>At the moment there is only one command for this feature set,
9036                    but this will most probably change in future.
9037    </p>
9038    <a name="EDIT INSTRUMENT"></a><br /><hr />
9039    <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>
9040    <a name="rfc.section.6.9.1"></a><h3>6.9.1.&nbsp;
9041    Opening an appropriate instrument editor application</h3>
9042    
9043    <p>The front-end can request to open an appropriate instrument
9044                        editor application by sending the following command:
9045    </p>
9046    <p>
9047                            </p>
9048    <blockquote class="text">
9049    <p>EDIT INSTRUMENT &lt;sampler-channel&gt;
9050    </p>
9051    </blockquote><p>
9052                        
9053    </p>
9054    <p>Where &lt;sampler-channel&gt; should be replaced by the
9055                        number of the sampler channel as given by the
9056                        <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
9057                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a>
9058                        command.
9059    </p>
9060    <p>The sampler will try to ask all registered instrument
9061                        editors (or to be more specific: their sampler plugins)
9062                        whether they are capable to handle the instrument on the
9063                        given sampler channel. The sampler will simply use the first
9064                        instrument editor application which replied with a positive
9065                        answer and spawn that instrument editor application within
9066                        the sampler's process and provide that application access
9067                        to the instrument's data structures, so both applications
9068                        can share and access the same instruments data at the same
9069                        time, thus allowing to immediately hear changes with the
9070                        sampler made by the instrument editor.
9071    </p>
9072    <p>Note: consequently instrument editors are always spawned
9073                        locally on the same machine where the sampler is running
9074                        on!
9075    </p>
9076    <p>Possible Answers:
9077    </p>
9078    <p>
9079                            </p>
9080    <blockquote class="text">
9081    <p>"OK" -
9082                                    </p>
9083    <blockquote class="text">
9084    <p>when an appropriate instrument editor was
9085                                        launched
9086    </p>
9087    </blockquote>
9088                                
9089    
9090    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
9091                                    </p>
9092    <blockquote class="text">
9093    <p>when an appropriate instrument editor was
9094                                        launched, but there are noteworthy issues
9095    </p>
9096    </blockquote>
9097                                
9098    
9099    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9100                                    </p>
9101    <blockquote class="text">
9102    <p>when an appropriate instrument editor
9103                                        could not be launched
9104    </p>
9105    </blockquote>
9106                                
9107    
9108    </blockquote><p>
9109                        
9110    </p>
9111    <p>Examples:
9112    </p>
9113    <p>
9114                            </p>
9115    <blockquote class="text">
9116    <p>C: "EDIT INSTRUMENT 0"
9117    </p>
9118    <p>S: "OK"
9119    </p>
9120    </blockquote><p>
9121                        
9122    </p>
9123  <a name="command_syntax"></a><br /><hr />  <a name="command_syntax"></a><br /><hr />
9124  <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>
9125  <a name="rfc.section.7"></a><h3>7.&nbsp;  <a name="rfc.section.7"></a><h3>7.&nbsp;
# Line 9015  Command Syntax</h3> Line 9235  Command Syntax</h3>
9235  <p>/ COPY SP copy_instruction  <p>/ COPY SP copy_instruction
9236                                    
9237  </p>  </p>
9238    <p>/ EDIT SP edit_instruction
9239                    
9240    </p>
9241    <p>/ FORMAT SP format_instruction
9242                    
9243    </p>
9244  <p>/ RESET  <p>/ RESET
9245                                    
9246  </p>  </p>
# Line 9030  Command Syntax</h3> Line 9256  Command Syntax</h3>
9256  <p>CHANNEL  <p>CHANNEL
9257                                    
9258  </p>  </p>
9259  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9260                                    
9261  </p>  </p>
9262  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
9263                                    
9264  </p>  </p>
9265  <p>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
9266                                    
9267  </p>  </p>
9268  <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
9269                                    
9270  </p>  </p>
9271  <p>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
9272                                    
9273  </p>  </p>
9274  <p>/ DB_INSTRUMENTS SP pathname SP pathname  <p>/ DB_INSTRUMENTS SP db_path SP filename
9275                                    
9276  </p>  </p>
9277  <p>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index  <p>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
9278                                    
9279  </p>  </p>
9280  <p>/ MIDI_INSTRUMENT_MAP  <p>/ MIDI_INSTRUMENT_MAP
# Line 9249  Command Syntax</h3> Line 9475  Command Syntax</h3>
9475  <p>/ MIDI_INSTRUMENT_MAP SP ALL  <p>/ MIDI_INSTRUMENT_MAP SP ALL
9476                                    
9477  </p>  </p>
9478  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
9479                                    
9480  </p>  </p>
9481  <p>/ DB_INSTRUMENT_DIRECTORY SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP db_path
9482                                    
9483  </p>  </p>
9484  <p>/ DB_INSTRUMENT SP pathname  <p>/ DB_INSTRUMENT SP db_path
9485                                    
9486  </p>  </p>
9487  </blockquote><p>  </blockquote><p>
# Line 9363  Command Syntax</h3> Line 9589  Command Syntax</h3>
9589  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
9590                                    
9591  </p>  </p>
9592  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9593                                    
9594  </p>  </p>
9595  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9596                                    
9597  </p>  </p>
9598  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname  <p>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
9599                                    
9600  </p>  </p>
9601  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9602                                    
9603  </p>  </p>
9604  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9605                                    
9606  </p>  </p>
9607  <p>/ DB_INSTRUMENT SP INFO SP pathname  <p>/ DB_INSTRUMENT SP INFO SP db_path
9608                                    
9609  </p>  </p>
9610  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number  <p>/ DB_INSTRUMENTS_JOB SP INFO SP number
# Line 9402  Command Syntax</h3> Line 9628  Command Syntax</h3>
9628  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list  <p>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
9629                                    
9630  </p>  </p>
9631    <p>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
9632                    
9633    </p>
9634  <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
9635                                    
9636  </p>  </p>
# Line 9423  Command Syntax</h3> Line 9652  Command Syntax</h3>
9652  <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
9653                                    
9654  </p>  </p>
9655  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
9656                                    
9657  </p>  </p>
9658  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
9659                                    
9660  </p>  </p>
9661  <p>/ DB_INSTRUMENT SP NAME SP pathname SP dirname  <p>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
9662                                    
9663  </p>  </p>
9664  <p>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
9665                                    
9666  </p>  </p>
9667  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
# Line 9492  Command Syntax</h3> Line 9721  Command Syntax</h3>
9721  <p>find_instruction =  <p>find_instruction =
9722          </p>          </p>
9723  <blockquote class="text">  <blockquote class="text">
9724  <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
9725                                    
9726  </p>  </p>
9727  <p>/ DB_INSTRUMENTS SP pathname SP query_val_list  <p>/ DB_INSTRUMENTS SP db_path SP query_val_list
9728                                    
9729  </p>  </p>
9730  <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
9731                                    
9732  </p>  </p>
9733  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
9734                                    
9735  </p>  </p>
9736  </blockquote><p>  </blockquote><p>
# Line 9510  Command Syntax</h3> Line 9739  Command Syntax</h3>
9739  <p>move_instruction =  <p>move_instruction =
9740          </p>          </p>
9741  <blockquote class="text">  <blockquote class="text">
9742  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
9743                                    
9744  </p>  </p>
9745  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
9746                                    
9747  </p>  </p>
9748  </blockquote><p>  </blockquote><p>
# Line 9522  Command Syntax</h3> Line 9751  Command Syntax</h3>
9751  <p>copy_instruction =  <p>copy_instruction =
9752          </p>          </p>
9753  <blockquote class="text">  <blockquote class="text">
9754  <p>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname  <p>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
9755                                    
9756  </p>  </p>
9757  <p>/ DB_INSTRUMENT SP pathname SP pathname  <p>/ DB_INSTRUMENT SP db_path SP db_path
9758                                    
9759  </p>  </p>
9760  </blockquote><p>  </blockquote><p>
# Line 9606  Command Syntax</h3> Line 9835  Command Syntax</h3>
9835  </blockquote><p>  </blockquote><p>
9836    
9837  </p>  </p>
9838    <p>edit_instruction =
9839            </p>
9840    <blockquote class="text">
9841    <p>INSTRUMENT SP sampler_channel
9842                    
9843    </p>
9844    </blockquote><p>
9845    
9846    </p>
9847    <p>format_instruction =
9848            </p>
9849    <blockquote class="text">
9850    <p>INSTRUMENTS_DB
9851                    
9852    </p>
9853    </blockquote><p>
9854    
9855    </p>
9856  <p>modal_arg =  <p>modal_arg =
9857          </p>          </p>
9858  <blockquote class="text">  <blockquote class="text">
# Line 9675  Command Syntax</h3> Line 9922  Command Syntax</h3>
9922  <p>/ FX_SENDS SP sampler_channel  <p>/ FX_SENDS SP sampler_channel
9923                                    
9924  </p>  </p>
9925  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
9926                                    
9927  </p>  </p>
9928  <p>/ DB_INSTRUMENT_DIRECTORIES SP pathname  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path
9929                                    
9930  </p>  </p>
9931  <p>/ DB_INSTRUMENTS SP RECURSIVE SP pathname  <p>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
9932                                    
9933  </p>  </p>
9934  <p>/ DB_INSTRUMENTS SP pathname  <p>/ DB_INSTRUMENTS SP db_path
9935                                    
9936  </p>  </p>
9937  </blockquote><p>  </blockquote><p>
# Line 9867  Command Syntax</h3> Line 10114  Command Syntax</h3>
10114  </blockquote><p>  </blockquote><p>
10115    
10116  </p>  </p>
10117  <p>pathname =  <p>filename =
         </p>  
 <blockquote class="text">  
 <p>stringval  
                   
 </p>  
 </blockquote><p>  
   
 </p>  
 <p>dirname =  
10118          </p>          </p>
10119  <blockquote class="text">  <blockquote class="text">
10120  <p>stringval  <p>path
10121                                    
10122  </p>  </p>
10123  </blockquote><p>  </blockquote><p>
10124    
10125  </p>  </p>
10126  <p>filename =  <p>db_path =
10127          </p>          </p>
10128  <blockquote class="text">  <blockquote class="text">
10129  <p>stringval  <p>path
10130                                    
10131  </p>  </p>
10132  </blockquote><p>  </blockquote><p>
# Line 9966  Command Syntax</h3> Line 10204  Command Syntax</h3>
10204  <p>query_val =  <p>query_val =
10205          </p>          </p>
10206  <blockquote class="text">  <blockquote class="text">
10207  <p>string  <p>textval_escaped
10208                                    
10209  </p>  </p>
10210  <p>/ stringval  <p>/ stringval_escaped
10211                                    
10212  </p>  </p>
10213  </blockquote><p>  </blockquote><p>
# Line 9990  Command Syntax</h3> Line 10228  Command Syntax</h3>
10228  </blockquote><p>  </blockquote><p>
10229    
10230  </p>  </p>
10231    <a name="character_set"></a><br /><hr />
10232    <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>
10233    <a name="rfc.section.7.1"></a><h3>7.1.&nbsp;
10234    Character Set and Escape Sequences</h3>
10235    
10236    <p>Older versions of this protocol up to and including v1.1 only
10237                    supported the standard ASCII character set (ASCII code 0 - 127)
10238                    <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
10239                    however support the Extended ASCII character set (ASCII code
10240                    0 - 255). The same group of younger protocols also support
10241                    escape sequences, but only for certain, explicitly declared
10242                    parts of the protocol. The supported escape sequences are
10243                    defined as follows:
10244    </p><table class="full" align="center" border="0" cellpadding="2" cellspacing="2">
10245    <col align="left"><col align="left">
10246    <tr><th align="left">ASCII Character Sequence</th><th align="left">Translated into (Name)</th></tr>
10247    <tr>
10248    <td align="left">\n</td>
10249    <td align="left">new line</td>
10250    </tr>
10251    <tr>
10252    <td align="left">\r</td>
10253    <td align="left">carriage return</td>
10254    </tr>
10255    <tr>
10256    <td align="left">\f</td>
10257    <td align="left">form feed</td>
10258    </tr>
10259    <tr>
10260    <td align="left">\t</td>
10261    <td align="left">horizontal tab</td>
10262    </tr>
10263    <tr>
10264    <td align="left">\v</td>
10265    <td align="left">vertical tab</td>
10266    </tr>
10267    <tr>
10268    <td align="left">\'</td>
10269    <td align="left">apostrophe</td>
10270    </tr>
10271    <tr>
10272    <td align="left">\"</td>
10273    <td align="left">quotation mark</td>
10274    </tr>
10275    <tr>
10276    <td align="left">\\</td>
10277    <td align="left">backslash</td>
10278    </tr>
10279    <tr>
10280    <td align="left">\OOO</td>
10281    <td align="left">three digit octal ASCII code of the character</td>
10282    </tr>
10283    <tr>
10284    <td align="left">\xHH</td>
10285    <td align="left">two digit hex ASCII code of the character</td>
10286    </tr>
10287    </table>
10288    
10289    <p>Notice: due to the transition of certain parts of the
10290                    protocol which now support escape sequences, a slight backward
10291                    incompatibility to protocols version v1.1 and younger has been
10292                    introduced. The only difference is that in parts of the protocol
10293                    where escape characters are now supported, a backslash characters
10294                    MUST be escaped as well (that is as double backslash), whereas
10295                    in the old versions a single backslash was sufficient.
10296    </p>
10297  <a name="events"></a><br /><hr />  <a name="events"></a><br /><hr />
10298  <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>
10299  <a name="rfc.section.8"></a><h3>8.&nbsp;  <a name="rfc.section.8"></a><h3>8.&nbsp;
# Line 10279  Channel information changed</h3> Line 10583  Channel information changed</h3>
10583  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;  <a name="rfc.section.8.10"></a><h3>8.10.&nbsp;
10584  Number of effect sends changed</h3>  Number of effect sends changed</h3>
10585    
10586  <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
10587                  a particular sampler channel is changed by issuing the following command:                  a particular sampler channel is changed by issuing the following command:
10588  </p>  </p>
10589  <p>  <p>
# Line 10776  Acknowledgments</h3> Line 11080  Acknowledgments</h3>
11080  <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>
11081  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
11082  <table width="99%" border="0">  <table width="99%" border="0">
11083    <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
11084    <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>
11085  <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>
11086  <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>
11087  <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 10853  Please address the information to the IE Line 11159  Please address the information to the IE
11159  Funding for the RFC Editor function is provided by  Funding for the RFC Editor function is provided by
11160  the IETF Administrative Support Activity (IASA).</p>  the IETF Administrative Support Activity (IASA).</p>
11161  </body></html>  </body></html>
11162    
Legend:
Removed from v.1201  
changed lines
  Added in v.1363
  ViewVC Help
Powered by ViewVC