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

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

Parent Directory | Revision Log | View Patch Patch

-revision 1731 by iliev,
Fri May  2 13:03:00 2008 UTC
+revision 1801 by schoenebeck,
Sun Dec  7 01:31:29 2008 UTC
 Line 145
  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
- <tr><td class="header">Expires: October 3, 2008</td><td class="header">April 2008</td></tr>
+ <tr><td class="header">Expires: June 9, 2009</td><td class="header">December 6, 2008</td></tr>
  </table></td></tr></table>
  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.4</h1>
 Line 173 
 The list of current Internet-Drafts can
  The list of Internet-Draft Shadow Directories can be accessed at
  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
  <p>
- This Internet-Draft will expire on October 3, 2008.</p>
+ This Internet-Draft will expire on June 9, 2009.</p>
  <h3>Abstract</h3>
 Line 332 
 Altering effect send's audio routing<br
  Altering effect send's MIDI controller<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
  Altering effect send's send level<br />
- &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;
+ Sending MIDI messages to sampler channel<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.35.</a>&nbsp;
  Resetting a sampler channel<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
  Controlling connection<br />
-Line 360 
 General sampler informations<br />
+Line 362 
 General sampler informations<br />
  Getting global volume attenuation<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOLUME">6.6.7.</a>&nbsp;
  Setting global volume attenuation<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET VOICES">6.6.8.</a>&nbsp;
+ Getting global voice limit<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET VOICES">6.6.9.</a>&nbsp;
+ Setting global voice limit<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET STREAMS">6.6.10.</a>&nbsp;
+ Getting global disk stream limit<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET STREAMS">6.6.11.</a>&nbsp;
+ Setting global disk stream limit<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#MIDI Instrument Mapping">6.7.</a>&nbsp;
  MIDI Instrument Mapping<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a>&nbsp;
-Line 5745 
 Altering effect send's send level</h3>
+Line 5755 
 Altering effect send's send level</h3>
  </blockquote><p>
  </p>
- <a name="RESET CHANNEL"></a><br /><hr />
+ <a name="SEND CHANNEL MIDI_DATA"></a><br /><hr />
  <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>
  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
+ Sending MIDI messages to sampler channel</h3>
+ <p>The front-end can send MIDI events to specific sampler channel
+                     by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;sampler-chan&gt; is the sampler channel number
+                     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>
+                     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,
+                     &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
+                     specifies the MIDI message type. Currently, the following MIDI messages are supported:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"NOTE_ON" -
+                                 </p>
+ <blockquote class="text">
+ <p>For turning on MIDI notes, where &lt;arg1&gt;
+                                     specifies the key number and &lt;arg2&gt; the velocity
+                                     as described in the MIDI specification.
+ </p>
+ </blockquote>
+ <p>"NOTE_OFF" -
+                                 </p>
+ <blockquote class="text">
+ <p>For turning a currently playing MIDI note off, where &lt;arg1&gt;
+                                     specifies the key number and &lt;arg2&gt; the velocity
+                                     as described in the MIDI specification.
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>CAUTION: This command is provided for implementations of virtual MIDI keyboards
+                     and no realtime guarantee whatsoever will be made!
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case it failed, providing an appropriate error code and error message
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Example:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="RESET CHANNEL"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.4.35"></a><h3>6.4.35.&nbsp;
  Resetting a sampler channel</h3>
  <p>The front-end can reset a particular sampler channel by sending the following command:
-Line 6314 
 Setting global volume attenuation</h3>
+Line 6411 
 Setting global volume attenuation</h3>
  </blockquote><p>
  </p>
+ <a name="GET VOICES"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.6.8"></a><h3>6.6.8.&nbsp;
+ Getting global voice limit</h3>
+ <p>The client can ask for the current global sampler-wide limit
+                        for maximum voices by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET VOICES
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by returning the number for
+                                the current limit of maximum voices.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>The voice limit setting defines how many voices should maximum
+                        be processed by the sampler at the same time. If the user
+                        triggers new notes which would exceed that voice limit, the
+                        sampler engine will react by stealing old voices for those
+                        newly triggered notes. Note that the amount of voices triggered
+                        by a new note can be larger than one and is dependent to the
+                        respective instrument and probably further criterias.
+ </p>
+ <a name="SET VOICES"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.6.9"></a><h3>6.6.9.&nbsp;
+ Setting global voice limit</h3>
+ <p>The client can alter the current global sampler-wide limit
+                     for maximum voices by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET VOICES &lt;max-voices&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;max-voices&gt; should be replaced by the integer
+                    value, reflecting the new global amount limit of maximum voices.
+                    This value has to be larger than 0.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the voice limit was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case it failed, providing an appropriate error code and error message
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Note: the given value will be passed to all sampler engine instances.
+                        The total amount of maximum voices on the running system might thus
+                        be as big as the given value multiplied by the current amount of engine
+                        instances.
+ </p>
+ <p>Caution: when adjusting the voice limit, you SHOULD also
+                         adjust the disk stream limit respectively and vice versa.
+ </p>
+ <a name="GET STREAMS"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.6.10"></a><h3>6.6.10.&nbsp;
+ Getting global disk stream limit</h3>
+ <p>The client can ask for the current global sampler-wide limit
+                        for maximum disk streams by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>GET STREAMS
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>LinuxSampler will answer by returning the number for
+                                the current limit of maximum disk streams.
+ </p>
+ </blockquote><p>
+ </p>
+ <p>The disk stream limit setting defines how many disk streams should
+                        maximum be processed by a sampler engine at the same time. The
+                        higher this value, the more memory (RAM) will be occupied, since
+                        every disk streams allocates a certain buffer size for being able
+                        to perform its streaming operations.
+ </p>
+ <a name="SET STREAMS"></a><br /><hr />
+ <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>
+ <a name="rfc.section.6.6.11"></a><h3>6.6.11.&nbsp;
+ Setting global disk stream limit</h3>
+ <p>The client can alter the current global sampler-wide limit
+                     for maximum disk streams by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET STREAMS &lt;max-streams&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;max-streams&gt; should be replaced by the integer
+                    value, reflecting the new global amount limit of maximum disk streams.
+                    This value has to be positive.
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>"OK" -
+                                 </p>
+ <blockquote class="text">
+ <p>on success
+ </p>
+ </blockquote>
+ <p>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>if the disk stream limit was set, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message
+ </p>
+ </blockquote>
+ <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 </p>
+ <blockquote class="text">
+ <p>in case it failed, providing an appropriate error code and error message
+ </p>
+ </blockquote>
+ </blockquote><p>
+ </p>
+ <p>Note: the given value will be passed to all sampler engine instances.
+                        The total amount of maximum disk streams on the running system might
+                        thus be as big as the given value multiplied by the current amount of
+                        engine instances.
+ </p>
+ <p>Caution: when adjusting the disk stream limit, you SHOULD also
+                         adjust the voice limit respectively and vice versa.
+ </p>
  <a name="MIDI Instrument Mapping"></a><br /><hr />
  <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>
  <a name="rfc.section.6.7"></a><h3>6.7.&nbsp;
-Line 8060 
 Adding instruments to the instruments da
+Line 8349 
 Adding instruments to the instruments da
  <p>
                          </p>
  <blockquote class="text">
- <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
+ <p>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]
  </p>
  </blockquote><p>
-Line 8118 
 Adding instruments to the instruments da
+Line 8407 
 Adding instruments to the instruments da
  </blockquote><p>
  </p>
+ <p> If FILE_AS_DIR argument is supplied, all instruments in an instrument
+                  file will be added to a separate directory in the instruments database, which
+                  name will be the name of the instrument file with the file extension stripped off.
+ </p>
  <p>The difference between regular and NON_MODAL versions of the command
                      is that the regular command returns when the scanning is finished
                      while NON_MODAL version returns immediately and a background process is launched.
-Line 9529 
 Retrieving informations about one instru
+Line 9823 
 Retrieving informations about one instru
  </blockquote>
+ <p>KEY_BINDINGS -
+                                         </p>
+ <blockquote class="text">
+ <p>comma separated list of integer values representing
+                                                the instrument's key mapping in the range between 0 .. 127,
+                                                reflecting the analog meaning of the MIDI specification.
+ </p>
+ </blockquote>
+ <p>KEYSWITCH_BINDINGS -
+                                         </p>
+ <blockquote class="text">
+ <p>comma separated list of integer values representing
+                                                the instrument's keyswitch mapping in the range between 0 .. 127,
+                                                reflecting the analog meaning of the MIDI specification.
+ </p>
+ </blockquote>
  </blockquote>
-Line 9680 
 Command Syntax</h3>
+Line 9994 
 Command Syntax</h3>
  <p>/ FORMAT SP format_instruction
  </p>
+ <p>/ SEND SP send_instruction
+ </p>
  <p>/ RESET
  </p>
-Line 9701 
 Command Syntax</h3>
+Line 10018 
 Command Syntax</h3>
  <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
  </p>
+ <p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
+ </p>
  <p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
  </p>
+ <p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
+ </p>
  <p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
  </p>
-Line 10073 
 Command Syntax</h3>
+Line 10396 
 Command Syntax</h3>
  <p>/ VOLUME
  </p>
+ <p>/ VOICES
+ </p>
+ <p>/ STREAMS
+ </p>
  <p>/ FILE SP INSTRUMENTS SP filename
  </p>
-Line 10139 
 Command Syntax</h3>
+Line 10468 
 Command Syntax</h3>
  <p>/ VOLUME SP volume_value
  </p>
+ <p>/ VOICES SP number
+ </p>
+ <p>/ STREAMS SP number
+ </p>
  </blockquote><p>
  </p>
-Line 10412 
 Command Syntax</h3>
+Line 10747 
 Command Syntax</h3>
  </blockquote><p>
  </p>
+ <p>send_instruction =
+         </p>
+ <blockquote class="text">
+ <p>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
+ </p>
+ </blockquote><p>
+ </p>
  <p>load_instr_args =
          </p>
  <blockquote class="text">
-Line 11534 
 Global settings changed</h3>
+Line 11878 
 Global settings changed</h3>
                          new global volume parameter.
  </p>
  </blockquote><p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
+                         golbal limit of the sampler for maximum voices is changed, where
+                         &lt;max-voices&gt; will be an integer value, reflecting the
+                         new global voice limit parameter.
+ </p>
+ </blockquote><p>
+                     </p>
+ <blockquote class="text">
+ <p>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
+                         golbal limit of the sampler for maximum disk streams is changed, where
+                         &lt;max-streams&gt; will be an integer value, reflecting the
+                         new global disk streams limit parameter.
+ </p>
+ </blockquote><p>
  </p>
  <a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr />
-Line 11869 
 proprietary rights that may cover techno
+Line 12229 
 proprietary rights that may cover techno
  to implement this standard.
  Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
  </body></html>

 Legend:



Removed from v.1731
 


changed lines


 
Added in v.1801
 Legend:



Removed from v.1731
 


changed lines


 
Added in v.1801
-Removed from v.1731
+Added in v.1801

	ViewVC Help
Powered by ViewVC