/[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 1731 by iliev, Fri May 2 13:03:00 2008 UTC revision 1773 by iliev, Wed Sep 10 15:14:31 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.33 (http://xml.resource.org/)">  <meta name="generator" content="xml2rfc v1.32 (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: October 3, 2008</td><td class="header">April 2008</td></tr>  <tr><td class="header">Expires: March 14, 2009</td><td class="header">September 10, 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 October 3, 2008.</p>  This Internet-Draft will expire on March 14, 2009.</p>
177    
178    <h3>Copyright Notice</h3>
179    <p>
180    Copyright &copy; The IETF Trust (2008).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 332  Altering effect send's audio routing<br Line 336  Altering effect send's audio routing<br
336  Altering effect send's MIDI controller<br />  Altering effect send's MIDI controller<br />
337  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
338  Altering effect send's send level<br />  Altering effect send's send level<br />
339  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SEND CHANNEL MIDI_DATA">6.4.34.</a>&nbsp;
340    Sending MIDI messages to sampler channel<br />
341    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.35.</a>&nbsp;
342  Resetting a sampler channel<br />  Resetting a sampler channel<br />
343  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
344  Controlling connection<br />  Controlling connection<br />
# Line 5745  Altering effect send's send level</h3> Line 5751  Altering effect send's send level</h3>
5751  </blockquote><p>  </blockquote><p>
5752                                            
5753  </p>  </p>
5754  <a name="RESET CHANNEL"></a><br /><hr />  <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />
5755  <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>
5756  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5757    Sending MIDI messages to sampler channel</h3>
5758    
5759    <p>The front-end can send MIDI events to specific sampler channel
5760                        by sending the following command:
5761    </p>
5762    <p>
5763                            </p>
5764    <blockquote class="text">
5765    <p>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;
5766    </p>
5767    </blockquote><p>
5768                        
5769    </p>
5770    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5771                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5772                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5773                        &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
5774                        specifies the MIDI message type. Currently, the following MIDI messages are supported:
5775    </p>
5776    <p>
5777                            </p>
5778    <blockquote class="text">
5779    <p>"NOTE_ON" -
5780                                    </p>
5781    <blockquote class="text">
5782    <p>For turning on MIDI notes, where &lt;arg1&gt;
5783                                        specifies the key number and &lt;arg2&gt; the velocity
5784                                        as described in the MIDI specification.
5785    </p>
5786    </blockquote>
5787                                
5788    
5789    <p>"NOTE_OFF" -
5790                                    </p>
5791    <blockquote class="text">
5792    <p>For turning a currently playing MIDI note off, where &lt;arg1&gt;
5793                                        specifies the key number and &lt;arg2&gt; the velocity
5794                                        as described in the MIDI specification.
5795    </p>
5796    </blockquote>
5797                                
5798    
5799    </blockquote><p>
5800                        
5801    </p>
5802    <p>CAUTION: This command is provided for implementations of virtual MIDI keyboards
5803                        and no realtime guarantee whatsoever will be made!
5804    </p>
5805    <p>Possible Answers:
5806    </p>
5807    <p>
5808                            </p>
5809    <blockquote class="text">
5810    <p>"OK" -
5811                                    </p>
5812    <blockquote class="text">
5813    <p>on success
5814    </p>
5815    </blockquote>
5816                                
5817    
5818    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5819                                    </p>
5820    <blockquote class="text">
5821    <p>in case it failed, providing an appropriate error code and error message
5822    </p>
5823    </blockquote>
5824                                
5825    
5826    </blockquote><p>
5827                        
5828    </p>
5829    <p>Example:
5830    </p>
5831    <p>
5832                            </p>
5833    <blockquote class="text">
5834    <p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
5835    </p>
5836    <p>S: "OK"
5837    </p>
5838    </blockquote><p>
5839                        
5840    </p>
5841    <a name="RESET CHANNEL"></a><br /><hr />
5842    <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>
5843    <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
5844  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
5845    
5846  <p>The front-end can reset a particular sampler channel by sending the following command:  <p>The front-end can reset a particular sampler channel by sending the following command:
# Line 9529  Retrieving informations about one instru Line 9622  Retrieving informations about one instru
9622  </blockquote>  </blockquote>
9623                                                                            
9624    
9625    <p>KEY_BINDINGS -
9626                                            </p>
9627    <blockquote class="text">
9628    <p>comma separated list of integer values representing
9629                                                   the instrument's key mapping in the range between 0 .. 127,
9630                                                   reflecting the analog meaning of the MIDI specification.
9631    </p>
9632    </blockquote>
9633                                        
9634    
9635    <p>KEYSWITCH_BINDINGS -
9636                                            </p>
9637    <blockquote class="text">
9638    <p>comma separated list of integer values representing
9639                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
9640                                                   reflecting the analog meaning of the MIDI specification.
9641    </p>
9642    </blockquote>
9643                                        
9644    
9645  </blockquote>  </blockquote>
9646                                                            
9647    
# Line 9678  Command Syntax</h3> Line 9791  Command Syntax</h3>
9791                                    
9792  </p>  </p>
9793  <p>/ FORMAT SP format_instruction  <p>/ FORMAT SP format_instruction
9794                    
9795    </p>
9796    <p>SEND SP send_instruction
9797                                    
9798  </p>  </p>
9799  <p>/ RESET  <p>/ RESET
# Line 10412  Command Syntax</h3> Line 10528  Command Syntax</h3>
10528  </blockquote><p>  </blockquote><p>
10529    
10530  </p>  </p>
10531    <p>send_instruction =
10532            </p>
10533    <blockquote class="text">
10534    <p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
10535                    
10536    </p>
10537    </blockquote><p>
10538    
10539    </p>
10540  <p>load_instr_args =  <p>load_instr_args =
10541          </p>          </p>
10542  <blockquote class="text">  <blockquote class="text">
# Line 10760  Character Set and Escape Sequences</h3> Line 10885  Character Set and Escape Sequences</h3>
10885  <td align="left">two digit hex ASCII code of the character</td>  <td align="left">two digit hex ASCII code of the character</td>
10886  </tr>  </tr>
10887  </table>  </table>
 <br clear="all" />  
10888    
10889  <p>Notice: due to the transition of certain parts of the  <p>Notice: due to the transition of certain parts of the
10890                  protocol which now support escape sequences, a slight backward                  protocol which now support escape sequences, a slight backward
# Line 11795  Acknowledgments</h3> Line 11919  Acknowledgments</h3>
11919  <h3>11.&nbsp;References</h3>  <h3>11.&nbsp;References</h3>
11920  <table width="99%" border="0">  <table width="99%" border="0">
11921  <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>
11922  <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>  <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>
11923  <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>
11924  <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>  <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>
11925  <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>
11926  <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>  <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>
11927  <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>
11928  <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>  <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>
11929  </table>  </table>
11930    
11931  <a name="rfc.authors"></a><br /><hr />  <a name="rfc.authors"></a><br /><hr />
# Line 11868  or other Line 11992  or other
11992  proprietary rights that may cover technology that may be required  proprietary rights that may cover technology that may be required
11993  to implement this standard.  to implement this standard.
11994  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>
11995    <h3>Acknowledgment</h3>
11996    <p class='copyright'>
11997    Funding for the RFC Editor function is provided by
11998    the IETF Administrative Support Activity (IASA).</p>
11999  </body></html>  </body></html>

Legend:
Removed from v.1731  
changed lines
  Added in v.1773

  ViewVC Help
Powered by ViewVC