13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
14 |
<?rfc strict="yes" ?> |
<?rfc strict="yes" ?> |
15 |
|
|
16 |
<rfc category="std" ipr="full2026" docName="lscp.txt"> |
<rfc category="std" ipr="full2026" docName="LSCP 1.0"> |
17 |
<front> |
<front> |
18 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
19 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
130 |
group of backward compatible versions. That means a frontend is |
group of backward compatible versions. That means a frontend is |
131 |
compatible to the connected sampler if and only if the LSCP versions |
compatible to the connected sampler if and only if the LSCP versions |
132 |
to which each of the two parties complies to, match both of the |
to which each of the two parties complies to, match both of the |
133 |
following rule: |
following rules: |
134 |
</t> |
</t> |
135 |
<t>Compatibility:</t> |
<t>Compatibility:</t> |
136 |
<t> |
<t> |
463 |
</section> |
</section> |
464 |
</section> |
</section> |
465 |
|
|
466 |
<section title="Description for control commands"> |
<section title="Description for control commands" anchor="control_commands"> |
467 |
<t>This chapter will describe the available control commands |
<t>This chapter will describe the available control commands |
468 |
that can be sent on the TCP connection in detail. Some certain |
that can be sent on the TCP connection in detail. Some certain |
469 |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
3264 |
<t> |
<t> |
3265 |
<list> |
<list> |
3266 |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
3267 |
Each answer line begins with the settings category name |
Each answer line begins with the information category name |
3268 |
followed by a colon and then a space character <SP> and finally |
followed by a colon and then a space character <SP> and finally |
3269 |
the info character string to that information category. At the |
the info character string to that information category. At the |
3270 |
moment the following categories are defined: |
moment the following categories are defined: |
3298 |
</section> |
</section> |
3299 |
|
|
3300 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
3301 |
<t>TODO: will soon automatically included from src/network/lscp.y, |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
3302 |
meanwhile have a look at that file to get the exact definition of |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
3303 |
the command syntax.</t> |
where applicable. |
3304 |
|
</t> |
3305 |
|
<!-- |
3306 |
|
This section is automatically generated by scripts/update_grammar.pl |
3307 |
|
from src/network/lscp.y (yacc input file). Do not modify this section |
3308 |
|
manually ! |
3309 |
|
--> |
3310 |
|
<!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! --> |
3311 |
|
|
3312 |
|
<t>input = |
3313 |
|
<list> |
3314 |
|
<t>line LF |
3315 |
|
</t> |
3316 |
|
<t>/ line CR LF |
3317 |
|
</t> |
3318 |
|
</list> |
3319 |
|
</t> |
3320 |
|
<t>line = |
3321 |
|
<list> |
3322 |
|
<t>/* epsilon (empty line ignored) */ |
3323 |
|
</t> |
3324 |
|
<t>/ comment |
3325 |
|
</t> |
3326 |
|
<t>/ command |
3327 |
|
</t> |
3328 |
|
<t>/ error |
3329 |
|
</t> |
3330 |
|
</list> |
3331 |
|
</t> |
3332 |
|
<t>comment = |
3333 |
|
<list> |
3334 |
|
<t>'#' |
3335 |
|
</t> |
3336 |
|
<t>/ comment '#' |
3337 |
|
</t> |
3338 |
|
<t>/ comment SP |
3339 |
|
</t> |
3340 |
|
<t>/ comment number |
3341 |
|
</t> |
3342 |
|
<t>/ comment string |
3343 |
|
</t> |
3344 |
|
</list> |
3345 |
|
</t> |
3346 |
|
<t>command = |
3347 |
|
<list> |
3348 |
|
<t>ADD SP CHANNEL |
3349 |
|
</t> |
3350 |
|
<t>/ GET SP get_instruction |
3351 |
|
</t> |
3352 |
|
<t>/ CREATE SP create_instruction |
3353 |
|
</t> |
3354 |
|
<t>/ DESTROY SP destroy_instruction |
3355 |
|
</t> |
3356 |
|
<t>/ LIST SP list_instruction |
3357 |
|
</t> |
3358 |
|
<t>/ LOAD SP load_instruction |
3359 |
|
</t> |
3360 |
|
<t>/ REMOVE SP CHANNEL SP sampler_channel |
3361 |
|
</t> |
3362 |
|
<t>/ SET SP set_instruction |
3363 |
|
</t> |
3364 |
|
<t>/ SUBSCRIBE SP subscribe_event |
3365 |
|
</t> |
3366 |
|
<t>/ UNSUBSCRIBE SP unsubscribe_event |
3367 |
|
</t> |
3368 |
|
<t>/ SELECT SP text |
3369 |
|
</t> |
3370 |
|
<t>/ RESET SP CHANNEL SP sampler_channel |
3371 |
|
</t> |
3372 |
|
<t>/ RESET |
3373 |
|
</t> |
3374 |
|
<t>/ QUIT |
3375 |
|
</t> |
3376 |
|
</list> |
3377 |
|
</t> |
3378 |
|
<t>subscribe_event = |
3379 |
|
<list> |
3380 |
|
<t>CHANNEL_COUNT |
3381 |
|
</t> |
3382 |
|
<t>/ VOICE_COUNT |
3383 |
|
</t> |
3384 |
|
<t>/ STREAM_COUNT |
3385 |
|
</t> |
3386 |
|
<t>/ BUFFER_FILL |
3387 |
|
</t> |
3388 |
|
<t>/ CHANNEL_INFO |
3389 |
|
</t> |
3390 |
|
<t>/ MISCELLANEOUS |
3391 |
|
</t> |
3392 |
|
</list> |
3393 |
|
</t> |
3394 |
|
<t>unsubscribe_event = |
3395 |
|
<list> |
3396 |
|
<t>CHANNEL_COUNT |
3397 |
|
</t> |
3398 |
|
<t>/ VOICE_COUNT |
3399 |
|
</t> |
3400 |
|
<t>/ STREAM_COUNT |
3401 |
|
</t> |
3402 |
|
<t>/ BUFFER_FILL |
3403 |
|
</t> |
3404 |
|
<t>/ CHANNEL_INFO |
3405 |
|
</t> |
3406 |
|
<t>/ MISCELLANEOUS |
3407 |
|
</t> |
3408 |
|
</list> |
3409 |
|
</t> |
3410 |
|
<t>get_instruction = |
3411 |
|
<list> |
3412 |
|
<t>AVAILABLE_ENGINES |
3413 |
|
</t> |
3414 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
3415 |
|
</t> |
3416 |
|
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
3417 |
|
</t> |
3418 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
3419 |
|
</t> |
3420 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
3421 |
|
</t> |
3422 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
3423 |
|
</t> |
3424 |
|
<t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string |
3425 |
|
</t> |
3426 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string |
3427 |
|
</t> |
3428 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
3429 |
|
</t> |
3430 |
|
<t>/ AUDIO_OUTPUT_DEVICES |
3431 |
|
</t> |
3432 |
|
<t>/ MIDI_INPUT_DEVICES |
3433 |
|
</t> |
3434 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number |
3435 |
|
</t> |
3436 |
|
<t>/ MIDI_INPUT_DEVICE SP INFO SP number |
3437 |
|
</t> |
3438 |
|
<t>/ MIDI_INPUT_PORT SP INFO SP number SP number |
3439 |
|
</t> |
3440 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string |
3441 |
|
</t> |
3442 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
3443 |
|
</t> |
3444 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string |
3445 |
|
</t> |
3446 |
|
<t>/ CHANNELS |
3447 |
|
</t> |
3448 |
|
<t>/ CHANNEL SP INFO SP sampler_channel |
3449 |
|
</t> |
3450 |
|
<t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
3451 |
|
</t> |
3452 |
|
<t>/ CHANNEL SP STREAM_COUNT SP sampler_channel |
3453 |
|
</t> |
3454 |
|
<t>/ CHANNEL SP VOICE_COUNT SP sampler_channel |
3455 |
|
</t> |
3456 |
|
<t>/ ENGINE SP INFO SP engine_name |
3457 |
|
</t> |
3458 |
|
<t>/ SERVER SP INFO |
3459 |
|
</t> |
3460 |
|
</list> |
3461 |
|
</t> |
3462 |
|
<t>set_instruction = |
3463 |
|
<list> |
3464 |
|
<t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
3465 |
|
</t> |
3466 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list |
3467 |
|
</t> |
3468 |
|
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
3469 |
|
</t> |
3470 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
3471 |
|
</t> |
3472 |
|
<t>/ CHANNEL SP set_chan_instruction |
3473 |
|
</t> |
3474 |
|
<t>/ ECHO SP boolean |
3475 |
|
</t> |
3476 |
|
</list> |
3477 |
|
</t> |
3478 |
|
<t>create_instruction = |
3479 |
|
<list> |
3480 |
|
<t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
3481 |
|
</t> |
3482 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP string |
3483 |
|
</t> |
3484 |
|
<t>/ MIDI_INPUT_DEVICE SP string SP key_val_list |
3485 |
|
</t> |
3486 |
|
<t>/ MIDI_INPUT_DEVICE SP string |
3487 |
|
</t> |
3488 |
|
</list> |
3489 |
|
</t> |
3490 |
|
<t>destroy_instruction = |
3491 |
|
<list> |
3492 |
|
<t>AUDIO_OUTPUT_DEVICE SP number |
3493 |
|
</t> |
3494 |
|
<t>/ MIDI_INPUT_DEVICE SP number |
3495 |
|
</t> |
3496 |
|
</list> |
3497 |
|
</t> |
3498 |
|
<t>load_instruction = |
3499 |
|
<list> |
3500 |
|
<t>INSTRUMENT SP load_instr_args |
3501 |
|
</t> |
3502 |
|
<t>/ ENGINE SP load_engine_args |
3503 |
|
</t> |
3504 |
|
</list> |
3505 |
|
</t> |
3506 |
|
<t>set_chan_instruction = |
3507 |
|
<list> |
3508 |
|
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
3509 |
|
</t> |
3510 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index |
3511 |
|
</t> |
3512 |
|
<t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
3513 |
|
</t> |
3514 |
|
<t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index |
3515 |
|
</t> |
3516 |
|
<t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
3517 |
|
</t> |
3518 |
|
<t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
3519 |
|
</t> |
3520 |
|
<t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index |
3521 |
|
</t> |
3522 |
|
<t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name |
3523 |
|
</t> |
3524 |
|
<t>/ VOLUME SP sampler_channel SP volume_value |
3525 |
|
</t> |
3526 |
|
</list> |
3527 |
|
</t> |
3528 |
|
<t>key_val_list = |
3529 |
|
<list> |
3530 |
|
<t>string '=' param_val_list |
3531 |
|
</t> |
3532 |
|
<t>/ key_val_list SP string '=' param_val_list |
3533 |
|
</t> |
3534 |
|
</list> |
3535 |
|
</t> |
3536 |
|
<t>buffer_size_type = |
3537 |
|
<list> |
3538 |
|
<t>BYTES |
3539 |
|
</t> |
3540 |
|
<t>/ PERCENTAGE |
3541 |
|
</t> |
3542 |
|
</list> |
3543 |
|
</t> |
3544 |
|
<t>list_instruction = |
3545 |
|
<list> |
3546 |
|
<t>AUDIO_OUTPUT_DEVICES |
3547 |
|
</t> |
3548 |
|
<t>/ MIDI_INPUT_DEVICES |
3549 |
|
</t> |
3550 |
|
<t>/ CHANNELS |
3551 |
|
</t> |
3552 |
|
<t>/ AVAILABLE_ENGINES |
3553 |
|
</t> |
3554 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
3555 |
|
</t> |
3556 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
3557 |
|
</t> |
3558 |
|
</list> |
3559 |
|
</t> |
3560 |
|
<t>load_instr_args = |
3561 |
|
<list> |
3562 |
|
<t>filename SP instrument_index SP sampler_channel |
3563 |
|
</t> |
3564 |
|
<t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel |
3565 |
|
</t> |
3566 |
|
</list> |
3567 |
|
</t> |
3568 |
|
<t>load_engine_args = |
3569 |
|
<list> |
3570 |
|
<t>engine_name SP sampler_channel |
3571 |
|
</t> |
3572 |
|
</list> |
3573 |
|
</t> |
3574 |
|
<t>device_index = |
3575 |
|
<list> |
3576 |
|
<t>number |
3577 |
|
</t> |
3578 |
|
</list> |
3579 |
|
</t> |
3580 |
|
<t>audio_channel_index = |
3581 |
|
<list> |
3582 |
|
<t>number |
3583 |
|
</t> |
3584 |
|
</list> |
3585 |
|
</t> |
3586 |
|
<t>audio_output_type_name = |
3587 |
|
<list> |
3588 |
|
<t>string |
3589 |
|
</t> |
3590 |
|
</list> |
3591 |
|
</t> |
3592 |
|
<t>midi_input_port_index = |
3593 |
|
<list> |
3594 |
|
<t>number |
3595 |
|
</t> |
3596 |
|
</list> |
3597 |
|
</t> |
3598 |
|
<t>midi_input_channel_index = |
3599 |
|
<list> |
3600 |
|
<t>number |
3601 |
|
</t> |
3602 |
|
<t>/ ALL |
3603 |
|
</t> |
3604 |
|
</list> |
3605 |
|
</t> |
3606 |
|
<t>midi_input_type_name = |
3607 |
|
<list> |
3608 |
|
<t>string |
3609 |
|
</t> |
3610 |
|
</list> |
3611 |
|
</t> |
3612 |
|
<t>volume_value = |
3613 |
|
<list> |
3614 |
|
<t>dotnum |
3615 |
|
</t> |
3616 |
|
<t>/ number |
3617 |
|
</t> |
3618 |
|
</list> |
3619 |
|
</t> |
3620 |
|
<t>sampler_channel = |
3621 |
|
<list> |
3622 |
|
<t>number |
3623 |
|
</t> |
3624 |
|
</list> |
3625 |
|
</t> |
3626 |
|
<t>instrument_index = |
3627 |
|
<list> |
3628 |
|
<t>number |
3629 |
|
</t> |
3630 |
|
</list> |
3631 |
|
</t> |
3632 |
|
<t>engine_name = |
3633 |
|
<list> |
3634 |
|
<t>string |
3635 |
|
</t> |
3636 |
|
</list> |
3637 |
|
</t> |
3638 |
|
<t>filename = |
3639 |
|
<list> |
3640 |
|
<t>stringval |
3641 |
|
</t> |
3642 |
|
</list> |
3643 |
|
</t> |
3644 |
|
<t>param_val_list = |
3645 |
|
<list> |
3646 |
|
<t>param_val |
3647 |
|
</t> |
3648 |
|
<t>/ param_val_list','param_val |
3649 |
|
</t> |
3650 |
|
</list> |
3651 |
|
</t> |
3652 |
|
<t>param_val = |
3653 |
|
<list> |
3654 |
|
<t>string |
3655 |
|
</t> |
3656 |
|
<t>/ '\'' string '\'' |
3657 |
|
</t> |
3658 |
|
<t>/ '\"' string '\"' |
3659 |
|
</t> |
3660 |
|
<t>/ number |
3661 |
|
</t> |
3662 |
|
<t>/ dotnum |
3663 |
|
</t> |
3664 |
|
</list> |
3665 |
|
</t> |
3666 |
|
|
3667 |
|
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
3668 |
</section> |
</section> |
3669 |
|
|
3670 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
3823 |
<date year="1997"></date> |
<date year="1997"></date> |
3824 |
</front> |
</front> |
3825 |
<seriesInfo name="RFC" value="2119" /> |
<seriesInfo name="RFC" value="2119" /> |
|
<seriesInfo name="STD" value="1" /> |
|
3826 |
</reference> |
</reference> |
3827 |
<reference anchor="RFC793"> |
<reference anchor="RFC793"> |
3828 |
<front> |
<front> |
3833 |
<date year="1981"></date> |
<date year="1981"></date> |
3834 |
</front> |
</front> |
3835 |
<seriesInfo name="RFC" value="793" /> |
<seriesInfo name="RFC" value="793" /> |
3836 |
<seriesInfo name="STD" value="1" /> |
</reference> |
3837 |
|
<reference anchor="RFC2234"> |
3838 |
|
<front> |
3839 |
|
<title>Augmented BNF for Syntax Specifications</title> |
3840 |
|
<author initials="D.H." surname="Crocker" fullname="David H. Crocker"> |
3841 |
|
<organization>Internet Mail Consortium</organization> |
3842 |
|
</author> |
3843 |
|
<author initials="P." surname="Overell" fullname="Paul Overell"> |
3844 |
|
<organization>Demon Internet Ltd</organization> |
3845 |
|
</author> |
3846 |
|
<date year="1997"></date> |
3847 |
|
</front> |
3848 |
|
<seriesInfo name="RFC" value="2234" /> |
3849 |
</reference> |
</reference> |
3850 |
</references> |
</references> |
3851 |
</back> |
</back> |