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.32 (http://xml.resource.org/)"> |
<meta name="generator" content="xml2rfc v1.33 (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; |
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 14, 2009</td><td class="header">September 10, 2008</td></tr> |
<tr><td class="header">Expires: June 9, 2009</td><td class="header">December 6, 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 |
|
|
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 14, 2009.</p> |
This Internet-Draft will expire on June 9, 2009.</p> |
|
|
|
|
<h3>Copyright Notice</h3> |
|
|
<p> |
|
|
Copyright © The IETF Trust (2008).</p> |
|
177 |
|
|
178 |
<h3>Abstract</h3> |
<h3>Abstract</h3> |
179 |
|
|
362 |
Getting global volume attenuation<br /> |
Getting global volume attenuation<br /> |
363 |
<a href="#SET VOLUME">6.6.7.</a> |
<a href="#SET VOLUME">6.6.7.</a> |
364 |
Setting global volume attenuation<br /> |
Setting global volume attenuation<br /> |
365 |
|
<a href="#GET VOICES">6.6.8.</a> |
366 |
|
Getting global voice limit<br /> |
367 |
|
<a href="#SET VOICES">6.6.9.</a> |
368 |
|
Setting global voice limit<br /> |
369 |
|
<a href="#GET STREAMS">6.6.10.</a> |
370 |
|
Getting global disk stream limit<br /> |
371 |
|
<a href="#SET STREAMS">6.6.11.</a> |
372 |
|
Setting global disk stream limit<br /> |
373 |
<a href="#MIDI Instrument Mapping">6.7.</a> |
<a href="#MIDI Instrument Mapping">6.7.</a> |
374 |
MIDI Instrument Mapping<br /> |
MIDI Instrument Mapping<br /> |
375 |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
<a href="#ADD MIDI_INSTRUMENT_MAP">6.7.1.</a> |
6411 |
</blockquote><p> |
</blockquote><p> |
6412 |
|
|
6413 |
</p> |
</p> |
6414 |
|
<a name="GET VOICES"></a><br /><hr /> |
6415 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6416 |
|
<a name="rfc.section.6.6.8"></a><h3>6.6.8. |
6417 |
|
Getting global voice limit</h3> |
6418 |
|
|
6419 |
|
<p>The client can ask for the current global sampler-wide limit |
6420 |
|
for maximum voices by sending the following command: |
6421 |
|
</p> |
6422 |
|
<p> |
6423 |
|
</p> |
6424 |
|
<blockquote class="text"> |
6425 |
|
<p>GET VOICES |
6426 |
|
</p> |
6427 |
|
</blockquote><p> |
6428 |
|
|
6429 |
|
</p> |
6430 |
|
<p>Possible Answers: |
6431 |
|
</p> |
6432 |
|
<p> |
6433 |
|
</p> |
6434 |
|
<blockquote class="text"> |
6435 |
|
<p>LinuxSampler will answer by returning the number for |
6436 |
|
the current limit of maximum voices. |
6437 |
|
</p> |
6438 |
|
</blockquote><p> |
6439 |
|
|
6440 |
|
</p> |
6441 |
|
<p>The voice limit setting defines how many voices should maximum |
6442 |
|
be processed by the sampler at the same time. If the user |
6443 |
|
triggers new notes which would exceed that voice limit, the |
6444 |
|
sampler engine will react by stealing old voices for those |
6445 |
|
newly triggered notes. Note that the amount of voices triggered |
6446 |
|
by a new note can be larger than one and is dependent to the |
6447 |
|
respective instrument and probably further criterias. |
6448 |
|
</p> |
6449 |
|
<a name="SET VOICES"></a><br /><hr /> |
6450 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6451 |
|
<a name="rfc.section.6.6.9"></a><h3>6.6.9. |
6452 |
|
Setting global voice limit</h3> |
6453 |
|
|
6454 |
|
<p>The client can alter the current global sampler-wide limit |
6455 |
|
for maximum voices by sending the following command: |
6456 |
|
</p> |
6457 |
|
<p> |
6458 |
|
</p> |
6459 |
|
<blockquote class="text"> |
6460 |
|
<p>SET VOICES <max-voices> |
6461 |
|
</p> |
6462 |
|
</blockquote><p> |
6463 |
|
|
6464 |
|
</p> |
6465 |
|
<p>Where <max-voices> should be replaced by the integer |
6466 |
|
value, reflecting the new global amount limit of maximum voices. |
6467 |
|
This value has to be larger than 0. |
6468 |
|
</p> |
6469 |
|
<p>Possible Answers: |
6470 |
|
</p> |
6471 |
|
<p> |
6472 |
|
</p> |
6473 |
|
<blockquote class="text"> |
6474 |
|
<p>"OK" - |
6475 |
|
</p> |
6476 |
|
<blockquote class="text"> |
6477 |
|
<p>on success |
6478 |
|
</p> |
6479 |
|
</blockquote> |
6480 |
|
|
6481 |
|
|
6482 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6483 |
|
</p> |
6484 |
|
<blockquote class="text"> |
6485 |
|
<p>if the voice limit was set, but there are noteworthy |
6486 |
|
issue(s) related, providing an appropriate warning code and |
6487 |
|
warning message |
6488 |
|
</p> |
6489 |
|
</blockquote> |
6490 |
|
|
6491 |
|
|
6492 |
|
<p>"ERR:<error-code>:<error-message>" - |
6493 |
|
</p> |
6494 |
|
<blockquote class="text"> |
6495 |
|
<p>in case it failed, providing an appropriate error code and error message |
6496 |
|
</p> |
6497 |
|
</blockquote> |
6498 |
|
|
6499 |
|
|
6500 |
|
</blockquote><p> |
6501 |
|
|
6502 |
|
</p> |
6503 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6504 |
|
The total amount of maximum voices on the running system might thus |
6505 |
|
be as big as the given value multiplied by the current amount of engine |
6506 |
|
instances. |
6507 |
|
</p> |
6508 |
|
<p>Caution: when adjusting the voice limit, you SHOULD also |
6509 |
|
adjust the disk stream limit respectively and vice versa. |
6510 |
|
</p> |
6511 |
|
<a name="GET STREAMS"></a><br /><hr /> |
6512 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6513 |
|
<a name="rfc.section.6.6.10"></a><h3>6.6.10. |
6514 |
|
Getting global disk stream limit</h3> |
6515 |
|
|
6516 |
|
<p>The client can ask for the current global sampler-wide limit |
6517 |
|
for maximum disk streams by sending the following command: |
6518 |
|
</p> |
6519 |
|
<p> |
6520 |
|
</p> |
6521 |
|
<blockquote class="text"> |
6522 |
|
<p>GET STREAMS |
6523 |
|
</p> |
6524 |
|
</blockquote><p> |
6525 |
|
|
6526 |
|
</p> |
6527 |
|
<p>Possible Answers: |
6528 |
|
</p> |
6529 |
|
<p> |
6530 |
|
</p> |
6531 |
|
<blockquote class="text"> |
6532 |
|
<p>LinuxSampler will answer by returning the number for |
6533 |
|
the current limit of maximum disk streams. |
6534 |
|
</p> |
6535 |
|
</blockquote><p> |
6536 |
|
|
6537 |
|
</p> |
6538 |
|
<p>The disk stream limit setting defines how many disk streams should |
6539 |
|
maximum be processed by a sampler engine at the same time. The |
6540 |
|
higher this value, the more memory (RAM) will be occupied, since |
6541 |
|
every disk streams allocates a certain buffer size for being able |
6542 |
|
to perform its streaming operations. |
6543 |
|
</p> |
6544 |
|
<a name="SET STREAMS"></a><br /><hr /> |
6545 |
|
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table> |
6546 |
|
<a name="rfc.section.6.6.11"></a><h3>6.6.11. |
6547 |
|
Setting global disk stream limit</h3> |
6548 |
|
|
6549 |
|
<p>The client can alter the current global sampler-wide limit |
6550 |
|
for maximum disk streams by sending the following command: |
6551 |
|
</p> |
6552 |
|
<p> |
6553 |
|
</p> |
6554 |
|
<blockquote class="text"> |
6555 |
|
<p>SET STREAMS <max-streams> |
6556 |
|
</p> |
6557 |
|
</blockquote><p> |
6558 |
|
|
6559 |
|
</p> |
6560 |
|
<p>Where <max-streams> should be replaced by the integer |
6561 |
|
value, reflecting the new global amount limit of maximum disk streams. |
6562 |
|
This value has to be positive. |
6563 |
|
</p> |
6564 |
|
<p>Possible Answers: |
6565 |
|
</p> |
6566 |
|
<p> |
6567 |
|
</p> |
6568 |
|
<blockquote class="text"> |
6569 |
|
<p>"OK" - |
6570 |
|
</p> |
6571 |
|
<blockquote class="text"> |
6572 |
|
<p>on success |
6573 |
|
</p> |
6574 |
|
</blockquote> |
6575 |
|
|
6576 |
|
|
6577 |
|
<p>"WRN:<warning-code>:<warning-message>" - |
6578 |
|
</p> |
6579 |
|
<blockquote class="text"> |
6580 |
|
<p>if the disk stream limit was set, but there are noteworthy |
6581 |
|
issue(s) related, providing an appropriate warning code and |
6582 |
|
warning message |
6583 |
|
</p> |
6584 |
|
</blockquote> |
6585 |
|
|
6586 |
|
|
6587 |
|
<p>"ERR:<error-code>:<error-message>" - |
6588 |
|
</p> |
6589 |
|
<blockquote class="text"> |
6590 |
|
<p>in case it failed, providing an appropriate error code and error message |
6591 |
|
</p> |
6592 |
|
</blockquote> |
6593 |
|
|
6594 |
|
|
6595 |
|
</blockquote><p> |
6596 |
|
|
6597 |
|
</p> |
6598 |
|
<p>Note: the given value will be passed to all sampler engine instances. |
6599 |
|
The total amount of maximum disk streams on the running system might |
6600 |
|
thus be as big as the given value multiplied by the current amount of |
6601 |
|
engine instances. |
6602 |
|
</p> |
6603 |
|
<p>Caution: when adjusting the disk stream limit, you SHOULD also |
6604 |
|
adjust the voice limit respectively and vice versa. |
6605 |
|
</p> |
6606 |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
<a name="MIDI Instrument Mapping"></a><br /><hr /> |
6607 |
<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> |
6608 |
<a name="rfc.section.6.7"></a><h3>6.7. |
<a name="rfc.section.6.7"></a><h3>6.7. |
8349 |
<p> |
<p> |
8350 |
</p> |
</p> |
8351 |
<blockquote class="text"> |
<blockquote class="text"> |
8352 |
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>] |
<p>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>] |
8353 |
</p> |
</p> |
8354 |
</blockquote><p> |
</blockquote><p> |
8355 |
|
|
8407 |
</blockquote><p> |
</blockquote><p> |
8408 |
|
|
8409 |
</p> |
</p> |
8410 |
|
<p> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
8411 |
|
file will be added to a separate directory in the instruments database, which |
8412 |
|
name will be the name of the instrument file with the file extension stripped off. |
8413 |
|
|
8414 |
|
</p> |
8415 |
<p>The difference between regular and NON_MODAL versions of the command |
<p>The difference between regular and NON_MODAL versions of the command |
8416 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
8417 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
9992 |
|
|
9993 |
</p> |
</p> |
9994 |
<p>/ FORMAT SP format_instruction |
<p>/ FORMAT SP format_instruction |
9995 |
|
|
9996 |
</p> |
</p> |
9997 |
<p>SEND SP send_instruction |
<p>/ SEND SP send_instruction |
9998 |
|
|
9999 |
</p> |
</p> |
10000 |
<p>/ RESET |
<p>/ RESET |
10018 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
10019 |
|
|
10020 |
</p> |
</p> |
10021 |
|
<p>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
10022 |
|
|
10023 |
|
</p> |
10024 |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
10025 |
|
|
10026 |
</p> |
</p> |
10027 |
|
<p>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
10028 |
|
|
10029 |
|
</p> |
10030 |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<p>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
10031 |
|
|
10032 |
</p> |
</p> |
10396 |
<p>/ VOLUME |
<p>/ VOLUME |
10397 |
|
|
10398 |
</p> |
</p> |
10399 |
|
<p>/ VOICES |
10400 |
|
|
10401 |
|
</p> |
10402 |
|
<p>/ STREAMS |
10403 |
|
|
10404 |
|
</p> |
10405 |
<p>/ FILE SP INSTRUMENTS SP filename |
<p>/ FILE SP INSTRUMENTS SP filename |
10406 |
|
|
10407 |
</p> |
</p> |
10468 |
<p>/ VOLUME SP volume_value |
<p>/ VOLUME SP volume_value |
10469 |
|
|
10470 |
</p> |
</p> |
10471 |
|
<p>/ VOICES SP number |
10472 |
|
|
10473 |
|
</p> |
10474 |
|
<p>/ STREAMS SP number |
10475 |
|
|
10476 |
|
</p> |
10477 |
</blockquote><p> |
</blockquote><p> |
10478 |
|
|
10479 |
</p> |
</p> |
11104 |
<td align="left">two digit hex ASCII code of the character</td> |
<td align="left">two digit hex ASCII code of the character</td> |
11105 |
</tr> |
</tr> |
11106 |
</table> |
</table> |
11107 |
|
<br clear="all" /> |
11108 |
|
|
11109 |
<p>Notice: due to the transition of certain parts of the |
<p>Notice: due to the transition of certain parts of the |
11110 |
protocol which now support escape sequences, a slight backward |
protocol which now support escape sequences, a slight backward |
11878 |
new global volume parameter. |
new global volume parameter. |
11879 |
</p> |
</p> |
11880 |
</blockquote><p> |
</blockquote><p> |
11881 |
|
</p> |
11882 |
|
<blockquote class="text"> |
11883 |
|
<p>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
11884 |
|
golbal limit of the sampler for maximum voices is changed, where |
11885 |
|
<max-voices> will be an integer value, reflecting the |
11886 |
|
new global voice limit parameter. |
11887 |
|
</p> |
11888 |
|
</blockquote><p> |
11889 |
|
</p> |
11890 |
|
<blockquote class="text"> |
11891 |
|
<p>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
11892 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
11893 |
|
<max-streams> will be an integer value, reflecting the |
11894 |
|
new global disk streams limit parameter. |
11895 |
|
</p> |
11896 |
|
</blockquote><p> |
11897 |
|
|
11898 |
</p> |
</p> |
11899 |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
<a name="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"></a><br /><hr /> |
12155 |
<h3>11. References</h3> |
<h3>11. References</h3> |
12156 |
<table width="99%" border="0"> |
<table width="99%" border="0"> |
12157 |
<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> |
12158 |
<td class="author-text">UCLA, “<a href="ftp://ftp.isi.edu/in-notes/rfc20.txt">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
<td class="author-text">UCLA, “<a href="http://tools.ietf.org/html/rfc20">ASCII format for Network Interchange</a>,” RFC 20, 1969.</td></tr> |
12159 |
<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> |
12160 |
<td class="author-text">Bradner, S., “<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
<td class="author-text">Bradner, S., “<a href="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>,” RFC 2119, 1997.</td></tr> |
12161 |
<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> |
12162 |
<td class="author-text">Crocker, D. and P. Overell, “<a href="ftp://ftp.isi.edu/in-notes/rfc2234.txt">Augmented BNF for Syntax Specifications</a>,” RFC 2234, 1997.</td></tr> |
<td class="author-text">Crocker, D. and P. Overell, “<a href="http://tools.ietf.org/html/rfc2234">Augmented BNF for Syntax Specifications</a>,” RFC 2234, 1997.</td></tr> |
12163 |
<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> |
12164 |
<td class="author-text">Defense Advanced Research Projects Agency, “<a href="ftp://ftp.isi.edu/in-notes/rfc793.txt">TRANSMISSION CONTROL PROTOCOL</a>,” RFC 793, 1981.</td></tr> |
<td class="author-text">Defense Advanced Research Projects Agency, “<a href="http://tools.ietf.org/html/rfc793">TRANSMISSION CONTROL PROTOCOL</a>,” RFC 793, 1981.</td></tr> |
12165 |
</table> |
</table> |
12166 |
|
|
12167 |
<a name="rfc.authors"></a><br /><hr /> |
<a name="rfc.authors"></a><br /><hr /> |
12228 |
proprietary rights that may cover technology that may be required |
proprietary rights that may cover technology that may be required |
12229 |
to implement this standard. |
to implement this standard. |
12230 |
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> |
|
<h3>Acknowledgment</h3> |
|
|
<p class='copyright'> |
|
|
Funding for the RFC Editor function is provided by |
|
|
the IETF Administrative Support Activity (IASA).</p> |
|
12231 |
</body></html> |
</body></html> |
12232 |
|
|