/[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 1002 by schoenebeck, Wed Dec 27 16:23:46 2006 UTC revision 1028 by schoenebeck, Sun Jan 14 17:33:03 2007 UTC
# 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: June 30, 2007</td><td class="header">December 27, 2006</td></tr>  <tr><td class="header">Expires: July 18, 2007</td><td class="header">January 14, 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<br />LSCP 1.2</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 June 30, 2007.</p>  This Internet-Draft will expire on July 18, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
180  Copyright &copy; The Internet Society (2006).</p>  Copyright &copy; The Internet Society (2007).</p>
181    
182  <h3>Abstract</h3>  <h3>Abstract</h3>
183    
# Line 330  Listing all effect sends on a sampler ch Line 330  Listing all effect sends on a sampler ch
330  Getting effect send information<br />  Getting effect send information<br />
331  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.30.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.30.</a>&nbsp;
332  Altering effect send's audio routing<br />  Altering effect send's audio routing<br />
333  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.31.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.31.</a>&nbsp;
334    Altering effect send's MIDI controller<br />
335    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.32.</a>&nbsp;
336    Altering effect send's send level<br />
337    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.33.</a>&nbsp;
338  Resetting a sampler channel<br />  Resetting a sampler channel<br />
339  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
340  Controlling connection<br />  Controlling connection<br />
# Line 352  Maximum amount of active voices<br /> Line 356  Maximum amount of active voices<br />
356  Reset sampler<br />  Reset sampler<br />
357  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET SERVER INFO">6.6.4.</a>&nbsp;
358  General sampler informations<br />  General sampler informations<br />
359    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOLUME">6.6.5.</a>&nbsp;
360    Getting global volume attenuation<br />
361    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.6.</a>&nbsp;
362    Setting global volume attenuation<br />
363  &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;
364  MIDI Instrument Mapping<br />  MIDI Instrument Mapping<br />
365  &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;
# Line 3954  Getting sampler channel information</h3> Line 3962  Getting sampler channel information</h3>
3962                                          </p>                                          </p>
3963  <blockquote class="text">  <blockquote class="text">
3964  <p>optionally dotted number for the channel volume factor  <p>optionally dotted number for the channel volume factor
3965                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
3966                                              1.0 means amplification)                                              1.0 means amplification)
3967  </p>  </p>
3968  </blockquote>  </blockquote>
# Line 5256  Getting effect send information</h3> Line 5264  Getting effect send information</h3>
5264  </blockquote>  </blockquote>
5265                                                                            
5266    
5267    <p>MIDI_CONTROLLER -
5268                                            </p>
5269    <blockquote class="text">
5270    <p>a value between 0 and 127 reflecting the MIDI controller
5271                                                which is able to modify the effect send's send level
5272    </p>
5273    </blockquote>
5274                                        
5275    
5276    <p>LEVEL -
5277                                            </p>
5278    <blockquote class="text">
5279    <p>optionally dotted number reflecting the effect send's
5280                                                current send level (where a value &lt; 1.0 means attenuation
5281                                                and a value > 1.0 means amplification)
5282    </p>
5283    </blockquote>
5284                                        
5285    
5286  <p>AUDIO_OUTPUT_ROUTING -  <p>AUDIO_OUTPUT_ROUTING -
5287                                          </p>                                          </p>
5288  <blockquote class="text">  <blockquote class="text">
# Line 5289  Getting effect send information</h3> Line 5316  Getting effect send information</h3>
5316  </p>  </p>
5317  <p>S: "NAME: Reverb Send"  <p>S: "NAME: Reverb Send"
5318  </p>  </p>
5319    <p>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"
5320    </p>
5321    <p>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"
5322    </p>
5323  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"  <p>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"
5324  </p>  </p>
5325  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
# Line 5379  Altering effect send's audio routing</h3 Line 5410  Altering effect send's audio routing</h3
5410  </blockquote><p>  </blockquote><p>
5411                                            
5412  </p>  </p>
5413  <a name="RESET CHANNEL"></a><br /><hr />  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5414  <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>
5415  <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;  <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5416    Altering effect send's MIDI controller</h3>
5417    
5418    <p>The front-end can alter the MIDI controller of an effect
5419                        send entity by sending the following command:
5420    </p>
5421    <p>
5422                            </p>
5423    <blockquote class="text">
5424    <p>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;
5425    </p>
5426    </blockquote><p>
5427                        
5428    </p>
5429    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5430                        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>
5431                        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,
5432                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5433                        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>
5434                        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
5435                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
5436                        able to modify the effect send's send level.
5437    </p>
5438    <p>Possible Answers:
5439    </p>
5440    <p>
5441                            </p>
5442    <blockquote class="text">
5443    <p>"OK" -
5444                                    </p>
5445    <blockquote class="text">
5446    <p>on success
5447    </p>
5448    </blockquote>
5449                                
5450    
5451    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5452                                    </p>
5453    <blockquote class="text">
5454    <p>if MIDI controller was set, but there are noteworthy
5455                                        issue(s) related, providing an appropriate warning code and
5456                                        warning message
5457    </p>
5458    </blockquote>
5459                                
5460    
5461    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5462                                    </p>
5463    <blockquote class="text">
5464    <p>in case it failed, providing an appropriate error code and error message
5465    </p>
5466    </blockquote>
5467                                
5468    
5469    </blockquote><p>
5470                        
5471    </p>
5472    <p>Example:
5473    </p>
5474    <p>
5475                            </p>
5476    <blockquote class="text">
5477    <p>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
5478    </p>
5479    <p>S: "OK"
5480    </p>
5481    </blockquote><p>
5482                        
5483    </p>
5484    <a name="SET FX_SEND LEVEL"></a><br /><hr />
5485    <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>
5486    <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5487    Altering effect send's send level</h3>
5488    
5489    <p>The front-end can alter the current send level of an effect
5490                        send entity by sending the following command:
5491    </p>
5492    <p>
5493                            </p>
5494    <blockquote class="text">
5495    <p>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;
5496    </p>
5497    </blockquote><p>
5498                        
5499    </p>
5500    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5501                        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>
5502                        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,
5503                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5504                        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>
5505                        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
5506                        &lt;volume&gt; is an optionally dotted positive number (a value
5507                        smaller than 1.0 means attenuation, whereas a value greater than
5508                        1.0 means amplification) reflecting the new send level.
5509    </p>
5510    <p>Possible Answers:
5511    </p>
5512    <p>
5513                            </p>
5514    <blockquote class="text">
5515    <p>"OK" -
5516                                    </p>
5517    <blockquote class="text">
5518    <p>on success
5519    </p>
5520    </blockquote>
5521                                
5522    
5523    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
5524                                    </p>
5525    <blockquote class="text">
5526    <p>if new send level was set, but there are noteworthy
5527                                        issue(s) related, providing an appropriate warning code and
5528                                        warning message
5529    </p>
5530    </blockquote>
5531                                
5532    
5533    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5534                                    </p>
5535    <blockquote class="text">
5536    <p>in case it failed, providing an appropriate error code and error message
5537    </p>
5538    </blockquote>
5539                                
5540    
5541    </blockquote><p>
5542                        
5543    </p>
5544    <p>Example:
5545    </p>
5546    <p>
5547                            </p>
5548    <blockquote class="text">
5549    <p>C: "SET FX_SEND LEVEL 0 0 0.15"
5550    </p>
5551    <p>S: "OK"
5552    </p>
5553    </blockquote><p>
5554                        
5555    </p>
5556    <a name="RESET CHANNEL"></a><br /><hr />
5557    <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>
5558    <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5559  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
5560    
5561  <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 5822  General sampler informations</h3> Line 5996  General sampler informations</h3>
5996  <p>The mentioned fields above don't have to be in particular order.  <p>The mentioned fields above don't have to be in particular order.
5997                      Other fields might be added in future.                      Other fields might be added in future.
5998  </p>  </p>
5999    <a name="GET VOLUME"></a><br /><hr />
6000    <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>
6001    <a name="rfc.section.6.6.5"></a><h3>6.6.5.&nbsp;
6002    Getting global volume attenuation</h3>
6003    
6004    <p>The client can ask for the current global sampler-wide volume
6005                        attenuation by sending the following command:
6006    </p>
6007    <p>
6008                            </p>
6009    <blockquote class="text">
6010    <p>GET VOLUME
6011    </p>
6012    </blockquote><p>
6013                        
6014    </p>
6015    <p>Possible Answers:
6016    </p>
6017    <p>
6018                            </p>
6019    <blockquote class="text">
6020    <p>The sampler will always answer by returning the optional
6021                                dotted floating point coefficient, reflecting the current
6022                                global volume attenuation.
6023                                
6024    </p>
6025    </blockquote><p>
6026                        
6027    </p>
6028    <p>Note: it is up to the respective sampler engine whether to obey
6029                        that global volume parameter or not, but in general all engines SHOULD
6030                        use this parameter.
6031    </p>
6032    <a name="SET VOLUME"></a><br /><hr />
6033    <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>
6034    <a name="rfc.section.6.6.6"></a><h3>6.6.6.&nbsp;
6035    Setting global volume attenuation</h3>
6036    
6037    <p>The client can alter the current global sampler-wide volume
6038                        attenuation by sending the following command:
6039    </p>
6040    <p>
6041                            </p>
6042    <blockquote class="text">
6043    <p>SET VOLUME &lt;volume&gt;
6044    </p>
6045    </blockquote><p>
6046                        
6047    </p>
6048    <p>Where &lt;volume&gt; should be replaced by the optional dotted
6049                       floating point value, reflecting the new global volume parameter.
6050                       This value might usually be in the range between 0.0 and 1.0, that
6051                       is for attenuating the overall volume.
6052    </p>
6053    <p>Possible Answers:
6054    </p>
6055    <p>
6056                            </p>
6057    <blockquote class="text">
6058    <p>"OK" -
6059                                    </p>
6060    <blockquote class="text">
6061    <p>on success
6062    </p>
6063    </blockquote>
6064                                
6065    
6066    <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6067                                    </p>
6068    <blockquote class="text">
6069    <p>if the global volume was set, but there are noteworthy
6070                                        issue(s) related, providing an appropriate warning code and
6071                                        warning message
6072    </p>
6073    </blockquote>
6074                                
6075    
6076    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6077                                    </p>
6078    <blockquote class="text">
6079    <p>in case it failed, providing an appropriate error code and error message
6080    </p>
6081    </blockquote>
6082                                
6083    
6084    </blockquote><p>
6085                        
6086    </p>
6087  <a name="MIDI Instrument Mapping"></a><br /><hr />  <a name="MIDI Instrument Mapping"></a><br /><hr />
6088  <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>
6089  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
# Line 6246  Create or replace a MIDI instrument map Line 6508  Create or replace a MIDI instrument map
6508                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
6509                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
6510                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
6511                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
6512                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
6513                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
6514                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 6709  Get current settings of MIDI instrument Line 6971  Get current settings of MIDI instrument
6971                                  </p>                                  </p>
6972  <blockquote class="text">  <blockquote class="text">
6973  <p>master volume of the instrument as optionally  <p>master volume of the instrument as optionally
6974                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
6975                                      and a value > 1.0 means amplification)                                      and a value > 1.0 means amplification)
6976  </p>  </p>
6977  </blockquote>  </blockquote>
# Line 7197  Command Syntax</h3> Line 7459  Command Syntax</h3>
7459  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id  <p>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
7460                                    
7461  </p>  </p>
7462    <p>/ VOLUME
7463                    
7464    </p>
7465  </blockquote><p>  </blockquote><p>
7466    
7467  </p>  </p>
# Line 7224  Command Syntax</h3> Line 7489  Command Syntax</h3>
7489  <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index  <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
7490                                    
7491  </p>  </p>
7492    <p>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
7493                    
7494    </p>
7495    <p>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
7496                    
7497    </p>
7498  <p>/ ECHO SP boolean  <p>/ ECHO SP boolean
7499                                    
7500  </p>  </p>
7501    <p>/ VOLUME SP volume_value
7502                    
7503    </p>
7504  </blockquote><p>  </blockquote><p>
7505    
7506  </p>  </p>
# Line 8189  Schoenebeck</td></tr> Line 8463  Schoenebeck</td></tr>
8463  <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>
8464  <h3>Full Copyright Statement</h3>  <h3>Full Copyright Statement</h3>
8465  <p class='copyright'>  <p class='copyright'>
8466  Copyright &copy; The Internet Society (2006).</p>  Copyright &copy; The Internet Society (2007).</p>
8467  <p class='copyright'>  <p class='copyright'>
8468  This document is subject to the rights,  This document is subject to the rights,
8469  licenses and restrictions contained in BCP&nbsp;78,  licenses and restrictions contained in BCP&nbsp;78,
Legend:
Removed from v.1002  
changed lines
  Added in v.1028
  ViewVC Help
Powered by ViewVC