/[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 1696 by schoenebeck,
Sat Feb 16 01:16:39 2008 UTC
+revision 1773 by iliev,
Wed Sep 10 15:14:31 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: August 19, 2008</td><td class="header">February 16, 2008</td></tr>
+ <tr><td class="header">Expires: March 14, 2009</td><td class="header">September 10, 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 August 19, 2008.</p>
+ This Internet-Draft will expire on March 14, 2009.</p>
  <h3>Copyright Notice</h3>
  <p>
 Line 336 
 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 436 
 Finding instruments<br />
+Line 438 
 Finding instruments<br />
  Getting job status information<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FORMAT INSTRUMENTS_DB">6.8.22.</a>&nbsp;
  Formatting the instruments database<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#FIND LOST DB_INSTRUMENT_FILES">6.8.23.</a>&nbsp;
+ Checking for lost instrument files<br />
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET DB_INSTRUMENT FILE_PATH">6.8.24.</a>&nbsp;
+ Replacing an instrument file<br />
  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#editing_instruments">6.9.</a>&nbsp;
  Editing Instruments<br />
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#EDIT INSTRUMENT">6.9.1.</a>&nbsp;
-Line 5745 
 Altering effect send's send level</h3>
+Line 5751 
 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 9104 
 Formatting the instruments database</h3>
+Line 9197 
 Formatting the instruments database</h3>
  </blockquote><p>
  </p>
+ <a name="FIND LOST DB_INSTRUMENT_FILES"></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.8.23"></a><h3>6.8.23.&nbsp;
+ Checking for lost instrument files</h3>
+ <p>The front-end can retrieve the list of all instrument files in the instruments database
+                     that don't exist in the filesystem by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>FIND LOST DB_INSTRUMENT_FILES
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Possible Answers:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>A comma separated list with the absolute path names
+                             (encapsulated into apostrophes) of all lost instrument files.
+ </p>
+ <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: "FIND LOST DB_INSTRUMENT_FILES"
+ </p>
+ <p>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"
+ </p>
+ </blockquote><p>
+ </p>
+ <a name="SET DB_INSTRUMENT FILE_PATH"></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.8.24"></a><h3>6.8.24.&nbsp;
+ Replacing an instrument file</h3>
+ <p>The front-end can substitute all occurrences of an instrument file
+                     in the instruments database with a new one by sending the following command:
+ </p>
+ <p>
+                         </p>
+ <blockquote class="text">
+ <p>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;
+ </p>
+ </blockquote><p>
+ </p>
+ <p>Where &lt;old_path&gt; is the absolute path name of the instrument file
+                     to substitute with &lt;new_path&gt;.
+ </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: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"
+ </p>
+ <p>S: "OK"
+ </p>
+ </blockquote><p>
+ </p>
  <a name="editing_instruments"></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.9"></a><h3>6.9.&nbsp;
-Line 9427 
 Retrieving informations about one instru
+Line 9622 
 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 9576 
 Command Syntax</h3>
+Line 9791 
 Command Syntax</h3>
  </p>
  <p>/ FORMAT SP format_instruction
+ </p>
+ <p>SEND SP send_instruction
  </p>
  <p>/ RESET
-Line 10028 
 Command Syntax</h3>
+Line 10246 
 Command Syntax</h3>
  <p>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
  </p>
+ <p>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
+ </p>
  <p>/ ECHO SP boolean
  </p>
-Line 10097 
 Command Syntax</h3>
+Line 10318 
 Command Syntax</h3>
  <p>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
  </p>
+ <p>/ LOST SP DB_INSTRUMENT_FILES
+ </p>
  </blockquote><p>
  </p>
-Line 10304 
 Command Syntax</h3>
+Line 10528 
 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 10714 
 Character Set and Escape Sequences</h3>
+Line 10947 
 Character Set and Escape Sequences</h3>
  </p>
  <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>
+ <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>
+ </p>
+ <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>
+ </p>
  <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>
  <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 11245 
 MIDI data on a MIDI input device arrived
  <p>
                              </p>
  <blockquote class="text">
- <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;"
  </p>
- <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;"
  </p>
  </blockquote><p>
-Line 11760 
 Please address the information to the IE
+Line 11997 
 Please address the information to the IE
  Funding for the RFC Editor function is provided by
  the IETF Administrative Support Activity (IASA).</p>
  </body></html>

 Legend:



Removed from v.1696
 


changed lines


 
Added in v.1773
 Legend:



Removed from v.1696
 


changed lines


 
Added in v.1773
-Removed from v.1696
+Added in v.1773

	ViewVC Help
Powered by ViewVC