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: March 4, 2008</td><td class="header">September 2007</td></tr> |
<tr><td class="header">Expires: April 9, 2008</td><td class="header">October 7, 2007</td></tr> |
149 |
</table></td></tr></table> |
</table></td></tr></table> |
150 |
<h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1> |
<h1><br />LinuxSampler Control Protocol (draft)<br />LSCP 1.2cvs</h1> |
151 |
|
|
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 March 4, 2008.</p> |
This Internet-Draft will expire on April 9, 2008.</p> |
177 |
|
|
178 |
<h3>Copyright Notice</h3> |
<h3>Copyright Notice</h3> |
179 |
<p> |
<p> |
364 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
365 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
366 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
367 |
<a href="#ADD MIDI_INSTRUMENT MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
368 |
Create a new MIDI instrument map<br /> |
Create a new MIDI instrument map<br /> |
369 |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
<a href="#REMOVE MIDI_INSTRUMENT_MAP">6.7.2.</a> |
370 |
Delete one particular or all MIDI instrument maps<br /> |
Delete one particular or all MIDI instrument maps<br /> |
5080 |
sampler channel on which the effect send should be created on, <midi-ctrl> |
sampler channel on which the effect send should be created on, <midi-ctrl> |
5081 |
is a number between 0..127 defining the MIDI controller which can alter the |
is a number between 0..127 defining the MIDI controller which can alter the |
5082 |
effect send level and <name> is an optional argument defining a name |
effect send level and <name> is an optional argument defining a name |
5083 |
for the effect send entity. The name does not have to be unique. |
for the effect send entity. The name does not have to be unique, but MUST be |
5084 |
|
encapsulated into apostrophes and supports escape sequences as described in chapter |
5085 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>". |
5086 |
</p> |
</p> |
5087 |
<p>By default, that is as initial routing, the effect send's audio channels |
<p>By default, that is as initial routing, the effect send's audio channels |
5088 |
are automatically routed to the last audio channels of the sampler channel's |
are automatically routed to the last audio channels of the sampler channel's |
5441 |
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> |
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> |
5442 |
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 |
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 |
5443 |
<name> is the new name of the effect send entity, which |
<name> is the new name of the effect send entity, which |
5444 |
does not have to be unique. |
does not have to be unique (name MUST be encapsulated into apostrophes |
5445 |
|
and supports escape sequences as described in chapter |
5446 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
5447 |
|
|
5448 |
</p> |
</p> |
5449 |
<p>Possible Answers: |
<p>Possible Answers: |
5450 |
</p> |
</p> |
6121 |
</p> |
</p> |
6122 |
<blockquote class="text"> |
<blockquote class="text"> |
6123 |
<p>arbitrary textual description about the sampler |
<p>arbitrary textual description about the sampler |
6124 |
|
(note that the character string may contain |
6125 |
|
<a class='info' href='#character_set'>escape sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>) |
6126 |
</p> |
</p> |
6127 |
</blockquote> |
</blockquote> |
6128 |
|
|
6284 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
6285 |
reflected by the current MIDI instrument map. |
reflected by the current MIDI instrument map. |
6286 |
</p> |
</p> |
6287 |
<a name="ADD MIDI_INSTRUMENT MAP"></a><br /><hr /> |
<a name="ADD MIDI_INSTRUMENT_MAP"></a><br /><hr /> |
6288 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6289 |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
<a name="rfc.section.6.7.1"></a><h3>6.7.1. |
6290 |
Create a new MIDI instrument map</h3> |
Create a new MIDI instrument map</h3> |
6302 |
</p> |
</p> |
6303 |
<p>Where <name> is an optional argument allowing to |
<p>Where <name> is an optional argument allowing to |
6304 |
assign a custom name to the new map. MIDI instrument Map |
assign a custom name to the new map. MIDI instrument Map |
6305 |
names do not have to be unique. |
names do not have to be unique, but MUST be encapsulated |
6306 |
|
into apostrophes and support escape sequences as described |
6307 |
|
in chapter "<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>". |
6308 |
|
|
6309 |
</p> |
</p> |
6310 |
<p>Possible Answers: |
<p>Possible Answers: |
6311 |
</p> |
</p> |
6618 |
</p> |
</p> |
6619 |
<p>Where <map> is the numerical ID of the map and |
<p>Where <map> is the numerical ID of the map and |
6620 |
<name> the new custom name of the map, which does not |
<name> the new custom name of the map, which does not |
6621 |
have to be unique. |
have to be unique (name MUST be encapsulated into apostrophes |
6622 |
|
and supports escape sequences as described in chapter |
6623 |
|
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>"). |
6624 |
|
|
6625 |
</p> |
</p> |
6626 |
<p>Possible Answers: |
<p>Possible Answers: |
6627 |
</p> |
</p> |
6786 |
load modes of entries, the frontend should retrieve the actual |
load modes of entries, the frontend should retrieve the actual |
6787 |
mode by i.e. sending |
mode by i.e. sending |
6788 |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a> |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a> |
6789 |
command(s). Finally the OPTIONAL <name> argument allows to |
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
6790 |
set a custom name (encapsulated into apostrophes) for the mapping |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6791 |
entry, useful for frontends for displaying an appropriate name for |
"<a class='info' href='#character_set'>Character Set and Escape Sequences<span> (</span><span class='info'>Character Set and Escape Sequences</span><span>)</span></a>") for the |
6792 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
6793 |
mapped instruments (using |
mapped instruments (using |
6794 |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>). |
<a class='info' href='#GET MIDI_INSTRUMENT INFO'>"GET MIDI_INSTRUMENT INFO"<span> (</span><span class='info'>Get current settings of MIDI instrument map entry</span><span>)</span></a>). |
6795 |
|
|
10149 |
<p>map_name = |
<p>map_name = |
10150 |
</p> |
</p> |
10151 |
<blockquote class="text"> |
<blockquote class="text"> |
10152 |
<p>stringval |
<p>stringval_escaped |
10153 |
|
|
10154 |
</p> |
</p> |
10155 |
</blockquote><p> |
</blockquote><p> |
10158 |
<p>entry_name = |
<p>entry_name = |
10159 |
</p> |
</p> |
10160 |
<blockquote class="text"> |
<blockquote class="text"> |
10161 |
<p>stringval |
<p>stringval_escaped |
10162 |
|
|
10163 |
</p> |
</p> |
10164 |
</blockquote><p> |
</blockquote><p> |
10167 |
<p>fx_send_name = |
<p>fx_send_name = |
10168 |
</p> |
</p> |
10169 |
<blockquote class="text"> |
<blockquote class="text"> |
10170 |
<p>stringval |
<p>stringval_escaped |
10171 |
|
|
10172 |
</p> |
</p> |
10173 |
</blockquote><p> |
</blockquote><p> |
10218 |
<p>query_val = |
<p>query_val = |
10219 |
</p> |
</p> |
10220 |
<blockquote class="text"> |
<blockquote class="text"> |
10221 |
<p>textval_escaped |
<p>text_escaped |
10222 |
|
|
10223 |
</p> |
</p> |
10224 |
<p>/ stringval_escaped |
<p>/ stringval_escaped |
10308 |
MUST be escaped as well (that is as double backslash), whereas |
MUST be escaped as well (that is as double backslash), whereas |
10309 |
in the old versions a single backslash was sufficient. |
in the old versions a single backslash was sufficient. |
10310 |
</p> |
</p> |
10311 |
|
<p>The following LSCP commands support escape sequences as part |
10312 |
|
of their filename / path based arguments: |
10313 |
|
</p> |
10314 |
|
<blockquote class="text"> |
10315 |
|
<p><a class='info' href='#LOAD INSTRUMENT'>"LOAD INSTRUMENT"<span> (</span><span class='info'>Loading an instrument</span><span>)</span></a> |
10316 |
|
</p> |
10317 |
|
<p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a> |
10318 |
|
</p> |
10319 |
|
<p><a class='info' href='#ADD DB_INSTRUMENT_DIRECTORY'>"ADD DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Creating a new instrument directory</span><span>)</span></a> |
10320 |
|
</p> |
10321 |
|
<p><a class='info' href='#ADD DB_INSTRUMENTS'>"ADD DB_INSTRUMENTS"<span> (</span><span class='info'>Adding instruments to the instruments database</span><span>)</span></a> |
10322 |
|
</p> |
10323 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT_DIRECTORY'>"REMOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Deleting an instrument directory</span><span>)</span></a> |
10324 |
|
</p> |
10325 |
|
<p><a class='info' href='#REMOVE DB_INSTRUMENT'>"REMOVE DB_INSTRUMENT"<span> (</span><span class='info'>Removing an instrument</span><span>)</span></a> |
10326 |
|
</p> |
10327 |
|
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORIES'>"GET DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Getting amount of instrument directories</span><span>)</span></a> |
10328 |
|
</p> |
10329 |
|
<p><a class='info' href='#LIST DB_INSTRUMENT_DIRECTORIES'>"LIST DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Listing all directories in specific directory</span><span>)</span></a> |
10330 |
|
</p> |
10331 |
|
<p><a class='info' href='#GET DB_INSTRUMENT_DIRECTORY INFO'>"GET DB_INSTRUMENT_DIRECTORY INFO"<span> (</span><span class='info'>Getting instrument directory information</span><span>)</span></a> |
10332 |
|
</p> |
10333 |
|
<p><a class='info' href='#GET DB_INSTRUMENTS'>"GET DB_INSTRUMENTS"<span> (</span><span class='info'>Getting amount of instruments</span><span>)</span></a> |
10334 |
|
</p> |
10335 |
|
<p><a class='info' href='#LIST DB_INSTRUMENTS'>"LIST DB_INSTRUMENTS"<span> (</span><span class='info'>Listing all instruments in specific directory</span><span>)</span></a> |
10336 |
|
</p> |
10337 |
|
<p><a class='info' href='#GET DB_INSTRUMENT INFO'>"GET DB_INSTRUMENT INFO"<span> (</span><span class='info'>Getting instrument information</span><span>)</span></a> |
10338 |
|
</p> |
10339 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a> |
10340 |
|
</p> |
10341 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a> |
10342 |
|
</p> |
10343 |
|
<p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a> |
10344 |
|
</p> |
10345 |
|
<p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a> |
10346 |
|
</p> |
10347 |
|
<p><a class='info' href='#FIND DB_INSTRUMENTS'>"FIND DB_INSTRUMENTS"<span> (</span><span class='info'>Finding instruments</span><span>)</span></a> |
10348 |
|
</p> |
10349 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10350 |
|
</p> |
10351 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT'>"MOVE DB_INSTRUMENT"<span> (</span><span class='info'>Moving an instrument</span><span>)</span></a> |
10352 |
|
</p> |
10353 |
|
<p><a class='info' href='#MOVE DB_INSTRUMENT_DIRECTORY'>"MOVE DB_INSTRUMENT_DIRECTORY"<span> (</span><span class='info'>Moving an instrument directory</span><span>)</span></a> |
10354 |
|
</p> |
10355 |
|
<p><a class='info' href='#COPY DB_INSTRUMENT'>"COPY DB_INSTRUMENT"<span> (</span><span class='info'>Copying instruments</span><span>)</span></a> |
10356 |
|
</p> |
10357 |
|
<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> |
10358 |
|
</p> |
10359 |
|
</blockquote><p> |
10360 |
|
Note that the forward slash character ('/') has a special meaning in |
10361 |
|
filename / path based arguments: it acts as separator of the nodes in |
10362 |
|
the path, thus if a directory- or filename includes a forward slash |
10363 |
|
(not intended as path node separator), you MUST escape that slash |
10364 |
|
either with the respective hex escape sequence ("\x2f") or with the |
10365 |
|
respective octal escape sequence ("\057"). |
10366 |
|
|
10367 |
|
</p> |
10368 |
|
<p> |
10369 |
|
The following LSCP commands even support escape sequences as |
10370 |
|
part of at least one of their text-based arguments (i.e. entity name, |
10371 |
|
description): |
10372 |
|
</p> |
10373 |
|
<blockquote class="text"> |
10374 |
|
<p><a class='info' href='#ADD MIDI_INSTRUMENT_MAP'>"ADD MIDI_INSTRUMENT_MAP"<span> (</span><span class='info'>Create a new MIDI instrument map</span><span>)</span></a> |
10375 |
|
</p> |
10376 |
|
<p><a class='info' href='#MAP MIDI_INSTRUMENT'>"MAP MIDI_INSTRUMENT"<span> (</span><span class='info'>Create or replace a MIDI instrument map entry</span><span>)</span></a> |
10377 |
|
</p> |
10378 |
|
<p><a class='info' href='#SET MIDI_INSTRUMENT_MAP NAME'>"SET MIDI_INSTRUMENT_MAP NAME"<span> (</span><span class='info'>Renaming a MIDI instrument map</span><span>)</span></a> |
10379 |
|
</p> |
10380 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY NAME'>"SET DB_INSTRUMENT_DIRECTORY NAME"<span> (</span><span class='info'>Renaming an instrument directory</span><span>)</span></a> |
10381 |
|
</p> |
10382 |
|
<p><a class='info' href='#SET DB_INSTRUMENT_DIRECTORY DESCRIPTION'>"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"<span> (</span><span class='info'>Changing the description of directory</span><span>)</span></a> |
10383 |
|
</p> |
10384 |
|
<p><a class='info' href='#SET DB_INSTRUMENT NAME'>"SET DB_INSTRUMENT NAME"<span> (</span><span class='info'>Renaming an instrument</span><span>)</span></a> |
10385 |
|
</p> |
10386 |
|
<p><a class='info' href='#SET DB_INSTRUMENT DESCRIPTION'>"SET DB_INSTRUMENT DESCRIPTION"<span> (</span><span class='info'>Changing the description of instrument</span><span>)</span></a> |
10387 |
|
</p> |
10388 |
|
<p><a class='info' href='#FIND DB_INSTRUMENT_DIRECTORIES'>"FIND DB_INSTRUMENT_DIRECTORIES"<span> (</span><span class='info'>Finding directories</span><span>)</span></a> |
10389 |
|
</p> |
10390 |
|
</blockquote><p> |
10391 |
|
Please note that these lists are manually maintained. If you |
10392 |
|
find a command that also supports escape sequences we forgot to |
10393 |
|
mention here, please report it! |
10394 |
|
|
10395 |
|
</p> |
10396 |
<a name="events"></a><br /><hr /> |
<a name="events"></a><br /><hr /> |
10397 |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
10398 |
<a name="rfc.section.8"></a><h3>8. |
<a name="rfc.section.8"></a><h3>8. |