/[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 1696 by schoenebeck, Sat Feb 16 01:16:39 2008 UTC revision 1731 by iliev, Fri May 2 13:03:00 2008 UTC
# Line 3  Line 3 
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">
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.33 (http://xml.resource.org/)">
7  <style type='text/css'><!--  <style type='text/css'><!--
8          body {          body {
9                  font-family: verdana, charcoal, helvetica, arial, sans-serif;                  font-family: verdana, charcoal, helvetica, arial, sans-serif;
# 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: August 19, 2008</td><td class="header">February 16, 2008</td></tr>  <tr><td class="header">Expires: October 3, 2008</td><td class="header">April 2008</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>
151    
# 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 August 19, 2008.</p>  This Internet-Draft will expire on October 3, 2008.</p>
   
 <h3>Copyright Notice</h3>  
 <p>  
 Copyright &copy; The IETF Trust (2008).</p>  
177    
178  <h3>Abstract</h3>  <h3>Abstract</h3>
179    
# Line 436  Finding instruments<br /> Line 432  Finding instruments<br />
432  Getting job status information<br />  Getting job status information<br />
433  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
434  Formatting the instruments database<br />  Formatting the instruments database<br />
435    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a>&nbsp;
436    Checking for lost instrument files<br />
437    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a>&nbsp;
438    Replacing an instrument file<br />
439  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
440  Editing Instruments<br />  Editing Instruments<br />
441  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
# Line 9104  Formatting the instruments database</h3> Line 9104  Formatting the instruments database</h3>
9104  </blockquote><p>  </blockquote><p>
9105                                            
9106  </p>  </p>
9107    <a name="FIND LOST DB_INSTRUMENT_FILES"></a><br /><hr />
9108    <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>
9109    <a name="rfc.section.6.8.23"></a><h3>6.8.23.&nbsp;
9110    Checking for lost instrument files</h3>
9111    
9112    <p>The front-end can retrieve the list of all instrument files in the instruments database
9113                        that don't exist in the filesystem by sending the following command:
9114    </p>
9115    <p>
9116                            </p>
9117    <blockquote class="text">
9118    <p>FIND LOST DB_INSTRUMENT_FILES
9119    </p>
9120    </blockquote><p>
9121                        
9122    </p>
9123    <p>Possible Answers:
9124    </p>
9125    <p>
9126                            </p>
9127    <blockquote class="text">
9128    <p>A comma separated list with the absolute path names
9129                                (encapsulated into apostrophes) of all lost instrument files.
9130    </p>
9131    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9132                                    </p>
9133    <blockquote class="text">
9134    <p>in case it failed, providing an appropriate error code and error message.
9135    </p>
9136    </blockquote>
9137                                
9138    
9139    </blockquote><p>
9140                        
9141    </p>
9142    <p>Example:
9143    </p>
9144    <p>
9145                            </p>
9146    <blockquote class="text">
9147    <p>C: "FIND LOST DB_INSTRUMENT_FILES"
9148    </p>
9149    <p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"
9150    </p>
9151    </blockquote><p>
9152                        
9153    </p>
9154    <a name="SET DB_INSTRUMENT FILE_PATH"></a><br /><hr />
9155    <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>
9156    <a name="rfc.section.6.8.24"></a><h3>6.8.24.&nbsp;
9157    Replacing an instrument file</h3>
9158    
9159    <p>The front-end can substitute all occurrences of an instrument file
9160                        in the instruments database with a new one by sending the following command:
9161    </p>
9162    <p>
9163                            </p>
9164    <blockquote class="text">
9165    <p>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;
9166    </p>
9167    </blockquote><p>
9168                        
9169    </p>
9170    <p>Where &lt;old_path&gt; is the absolute path name of the instrument file
9171                        to substitute with &lt;new_path&gt;.
9172    </p>
9173    <p>Possible Answers:
9174    </p>
9175    <p>
9176                            </p>
9177    <blockquote class="text">
9178    <p>"OK" -
9179                                    </p>
9180    <blockquote class="text">
9181    <p>on success
9182    </p>
9183    </blockquote>
9184                                
9185    
9186    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
9187                                    </p>
9188    <blockquote class="text">
9189    <p>in case it failed, providing an appropriate error code and error message.
9190    </p>
9191    </blockquote>
9192                                
9193    
9194    </blockquote><p>
9195                        
9196    </p>
9197    <p>Example:
9198    </p>
9199    <p>
9200                            </p>
9201    <blockquote class="text">
9202    <p>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"
9203    </p>
9204    <p>S: "OK"
9205    </p>
9206    </blockquote><p>
9207                        
9208    </p>
9209  <a name="editing_instruments"></a><br /><hr />  <a name="editing_instruments"></a><br /><hr />
9210  <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>
9211  <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;  <a name="rfc.section.6.9"></a><h3>6.9.&nbsp;
# Line 10028  Command Syntax</h3> Line 10130  Command Syntax</h3>
10130  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
10131                                    
10132  </p>  </p>
10133    <p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
10134                    
10135    </p>
10136  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
10137                                    
10138  </p>  </p>
# Line 10097  Command Syntax</h3> Line 10202  Command Syntax</h3>
10202  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
10203                                    
10204  </p>  </p>
10205    <p>/ LOST SP DB_INSTRUMENT_FILES
10206                    
10207    </p>
10208  </blockquote><p>  </blockquote><p>
10209    
10210  </p>  </p>
# Line 10652  Character Set and Escape Sequences</h3> Line 10760  Character Set and Escape Sequences</h3>
10760  <td align="left">two digit hex ASCII code of the character</td>  <td align="left">two digit hex ASCII code of the character</td>
10761  </tr>  </tr>
10762  </table>  </table>
10763    <br clear="all" />
10764    
10765  <p>Notice: due to the transition of certain parts of the  <p>Notice: due to the transition of certain parts of the
10766                  protocol which now support escape sequences, a slight backward                  protocol which now support escape sequences, a slight backward
# Line 10714  Character Set and Escape Sequences</h3> Line 10823  Character Set and Escape Sequences</h3>
10823  </p>  </p>
10824  <p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a>  <p><a class='info' href='#COPY DB_INSTRUMENT_DIRECTORY'>"COPY DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Copying instrument directories</span><span>)</span></a>
10825  </p>  </p>
10826    <p><a class='info' href='#FIND LOST DB_INSTRUMENT_FILES'>"FIND LOST DB_INSTRUMENT_FILES"<span> (</span><span class='info'>Checking for lost instrument files</span><span>)</span></a>
10827    </p>
10828    <p><a class='info' href='#SET DB_INSTRUMENT FILE_PATH'>"SET DB_INSTRUMENT FILE_PATH"<span> (</span><span class='info'>Replacing an instrument file</span><span>)</span></a>
10829    </p>
10830  <p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a>  <p><a class='info' href='#GET FILE INSTRUMENTS'>"GET FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving amount of instruments of a file</span><span>)</span></a>
10831  </p>  </p>
10832  <p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a>  <p><a class='info' href='#LIST FILE INSTRUMENTS'>"LIST FILE INSTRUMENTS"<span> (</span><span class='info'>Retrieving all instruments of a file</span><span>)</span></a>
# Line 11008  MIDI data on a MIDI input device arrived Line 11121  MIDI data on a MIDI input device arrived
11121  <p>  <p>
11122                              </p>                              </p>
11123  <blockquote class="text">  <blockquote class="text">
11124  <p>"NOTIFY:CHANNEL_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"  <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"
11125  </p>  </p>
11126  <p>"NOTIFY:CHANNEL_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"  <p>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"
11127  </p>  </p>
11128  </blockquote><p>  </blockquote><p>
11129                                            
# Line 11682  Acknowledgments</h3> Line 11795  Acknowledgments</h3>
11795  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
11796  <table width="99%" border="0">  <table width="99%" border="0">
11797  <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC20">[RFC20]</a></td>
11798  <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>  <td class="author-text">UCLA, &ldquo;<a href="http://tools.ietf.org/html/rfc20">ASCII format for Network Interchange</a>,&rdquo; RFC&nbsp;20, 1969.</td></tr>
11799  <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>
11800  <td class="author-text">Bradner, S., &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>  <td class="author-text">Bradner, S., &ldquo;<a href="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; RFC&nbsp;2119, 1997.</td></tr>
11801  <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>
11802  <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>  <td class="author-text">Crocker, D. and P. Overell, &ldquo;<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications</a>,&rdquo; RFC&nbsp;2234, 1997.</td></tr>
11803  <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>  <tr><td class="author-text" valign="top"><a name="RFC793">[RFC793]</a></td>
11804  <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>  <td class="author-text">Defense Advanced Research Projects Agency, &ldquo;<a href="http://tools.ietf.org/html/rfc793">TRANSMISSION CONTROL PROTOCOL</a>,&rdquo; RFC&nbsp;793, 1981.</td></tr>
11805  </table>  </table>
11806    
11807  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 11755  or other Line 11868  or other
11868  proprietary rights that may cover technology that may be required  proprietary rights that may cover technology that may be required
11869  to implement this standard.  to implement this standard.
11870  Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>  Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
 <h3>Acknowledgment</h3>  
 <p class='copyright'>  
 Funding for the RFC Editor function is provided by  
 the IETF Administrative Support Activity (IASA).</p>  
11871  </body></html>  </body></html>
   
Legend:
Removed from v.1696  
changed lines
  Added in v.1731
  ViewVC Help
Powered by ViewVC