34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="December" year="2006"/> |
<date month="March" year="2007"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
2555 |
<t>VOLUME - |
<t>VOLUME - |
2556 |
<list> |
<list> |
2557 |
<t>optionally dotted number for the channel volume factor |
<t>optionally dotted number for the channel volume factor |
2558 |
(where a value < 1.0 means attenuation and a value > |
(where a value < 1.0 means attenuation and a value > |
2559 |
1.0 means amplification)</t> |
1.0 means amplification)</t> |
2560 |
</list> |
</list> |
2561 |
</t> |
</t> |
3227 |
</t> |
</t> |
3228 |
</section> |
</section> |
3229 |
|
|
3230 |
|
<section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND"> |
3231 |
|
<t>The front-end can create an additional effect send on a specific sampler channel |
3232 |
|
by sending the following command:</t> |
3233 |
|
<t> |
3234 |
|
<list> |
3235 |
|
<t>CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]</t> |
3236 |
|
</list> |
3237 |
|
</t> |
3238 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3239 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3240 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
3241 |
|
sampler channel on which the effect send should be created on, <midi-ctrl> |
3242 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
3243 |
|
effect send level and <name> is an optional argument defining a name |
3244 |
|
for the effect send entity. The name does not have to be unique.</t> |
3245 |
|
|
3246 |
|
<t>By default, that is as initial routing, the effect send's audio channels |
3247 |
|
are automatically routed to the last audio channels of the sampler channel's |
3248 |
|
audio output device, that way you can i.e. first increase the amount of audio |
3249 |
|
channels on the audio output device for having dedicated effect send output |
3250 |
|
channels and when "CREATE FX_SEND" is called, those channels will automatically |
3251 |
|
be picked. You can alter the destination channels however with |
3252 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>. |
3253 |
|
</t> |
3254 |
|
|
3255 |
|
<t>Note: Create effect sends on a sampler channel only when needed, because having effect |
3256 |
|
sends on a sampler channel will decrease runtime performance, because for implementing channel |
3257 |
|
effect sends, separate (sampler channel local) audio buffers are needed to render and mix |
3258 |
|
the voices and route the audio signal afterwards to the master outputs and effect send |
3259 |
|
outputs (along with their respective effect send levels). A sampler channel without effect |
3260 |
|
sends however can mix its voices directly into the audio output devices's audio buffers |
3261 |
|
and is thus faster. |
3262 |
|
</t> |
3263 |
|
|
3264 |
|
<t>Possible Answers:</t> |
3265 |
|
<t> |
3266 |
|
<list> |
3267 |
|
<t>"OK[<fx-send-id>]" - |
3268 |
|
<list> |
3269 |
|
<t>in case a new effect send could be added to the |
3270 |
|
sampler channel, where <fx-send-id> reflects the |
3271 |
|
unique ID of the newly created effect send entity</t> |
3272 |
|
</list> |
3273 |
|
</t> |
3274 |
|
<t>"ERR:<error-code>:<error-message>" - |
3275 |
|
<list> |
3276 |
|
<t>when a new effect send could not be added, i.e. |
3277 |
|
due to invalid parameters</t> |
3278 |
|
</list> |
3279 |
|
</t> |
3280 |
|
</list> |
3281 |
|
</t> |
3282 |
|
|
3283 |
|
<t>Examples:</t> |
3284 |
|
<t> |
3285 |
|
<list> |
3286 |
|
<t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t> |
3287 |
|
<t>S: "OK[0]"</t> |
3288 |
|
</list> |
3289 |
|
</t> |
3290 |
|
<t> |
3291 |
|
<list> |
3292 |
|
<t>C: "CREATE FX_SEND 0 93"</t> |
3293 |
|
<t>S: "OK[1]"</t> |
3294 |
|
</list> |
3295 |
|
</t> |
3296 |
|
</section> |
3297 |
|
|
3298 |
|
<section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND"> |
3299 |
|
<t>The front-end can remove an existing effect send on a specific sampler channel |
3300 |
|
by sending the following command:</t> |
3301 |
|
<t> |
3302 |
|
<list> |
3303 |
|
<t>DESTROY FX_SEND <sampler-channel> <fx-send-id></t> |
3304 |
|
</list> |
3305 |
|
</t> |
3306 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3307 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3308 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the |
3309 |
|
sampler channel from which the effect send should be removed from and |
3310 |
|
<fx-send-id> is the respective effect send number as returned by the |
3311 |
|
<xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3312 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
3313 |
|
|
3314 |
|
<t>Possible Answers:</t> |
3315 |
|
<t> |
3316 |
|
<list> |
3317 |
|
<t>"OK" - |
3318 |
|
<list> |
3319 |
|
<t>on success</t> |
3320 |
|
</list> |
3321 |
|
</t> |
3322 |
|
<t>"ERR:<error-code>:<error-message>" - |
3323 |
|
<list> |
3324 |
|
<t>in case it failed, providing an appropriate error code and |
3325 |
|
error message</t> |
3326 |
|
</list> |
3327 |
|
</t> |
3328 |
|
</list> |
3329 |
|
</t> |
3330 |
|
|
3331 |
|
<t>Example:</t> |
3332 |
|
<t> |
3333 |
|
<list> |
3334 |
|
<t>C: "DESTROY FX_SEND 0 0"</t> |
3335 |
|
<t>S: "OK"</t> |
3336 |
|
</list> |
3337 |
|
</t> |
3338 |
|
</section> |
3339 |
|
|
3340 |
|
<section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS"> |
3341 |
|
<t>The front-end can ask for the amount of effect sends on a specific sampler channel |
3342 |
|
by sending the following command:</t> |
3343 |
|
<t> |
3344 |
|
<list> |
3345 |
|
<t>GET FX_SENDS <sampler-channel></t> |
3346 |
|
</list> |
3347 |
|
</t> |
3348 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3349 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3350 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
3351 |
|
|
3352 |
|
<t>Possible Answers:</t> |
3353 |
|
<t> |
3354 |
|
<list> |
3355 |
|
<t>The sampler will answer by returning the number of effect |
3356 |
|
sends on the given sampler channel.</t> |
3357 |
|
</list> |
3358 |
|
</t> |
3359 |
|
|
3360 |
|
<t>Example:</t> |
3361 |
|
<t> |
3362 |
|
<list> |
3363 |
|
<t>C: "GET FX_SENDS 0"</t> |
3364 |
|
<t>S: "2"</t> |
3365 |
|
</list> |
3366 |
|
</t> |
3367 |
|
</section> |
3368 |
|
|
3369 |
|
<section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS"> |
3370 |
|
<t>The front-end can ask for a list of effect sends on a specific sampler channel |
3371 |
|
by sending the following command:</t> |
3372 |
|
<t> |
3373 |
|
<list> |
3374 |
|
<t>LIST FX_SENDS <sampler-channel></t> |
3375 |
|
</list> |
3376 |
|
</t> |
3377 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3378 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3379 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t> |
3380 |
|
|
3381 |
|
<t>Possible Answers:</t> |
3382 |
|
<t> |
3383 |
|
<list> |
3384 |
|
<t>The sampler will answer by returning a comma separated list |
3385 |
|
with all effect sends' numerical IDs on the given sampler |
3386 |
|
channel.</t> |
3387 |
|
</list> |
3388 |
|
</t> |
3389 |
|
|
3390 |
|
<t>Examples:</t> |
3391 |
|
<t> |
3392 |
|
<list> |
3393 |
|
<t>C: "LIST FX_SENDS 0"</t> |
3394 |
|
<t>S: "0,1"</t> |
3395 |
|
</list> |
3396 |
|
</t> |
3397 |
|
<t> |
3398 |
|
<list> |
3399 |
|
<t>C: "LIST FX_SENDS 1"</t> |
3400 |
|
<t>S: ""</t> |
3401 |
|
</list> |
3402 |
|
</t> |
3403 |
|
</section> |
3404 |
|
|
3405 |
|
<section title="Getting effect send information" anchor="GET FX_SEND INFO"> |
3406 |
|
<t>The front-end can ask for the current settings of an effect send entity |
3407 |
|
by sending the following command:</t> |
3408 |
|
<t> |
3409 |
|
<list> |
3410 |
|
<t>GET FX_SEND INFO <sampler-channel> <fx-send-id></t> |
3411 |
|
</list> |
3412 |
|
</t> |
3413 |
|
<t>Where <sampler-channel> is the sampler channel number |
3414 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3415 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3416 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3417 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3418 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command. |
3419 |
|
</t> |
3420 |
|
|
3421 |
|
<t>Possible Answers:</t> |
3422 |
|
<t> |
3423 |
|
<list> |
3424 |
|
<t>The sampler will answer by sending a <CRLF> separated list. |
3425 |
|
Each answer line begins with the settings category name |
3426 |
|
followed by a colon and then a space character <SP> and finally |
3427 |
|
the info character string to that setting category. At the |
3428 |
|
moment the following categories are defined:</t> |
3429 |
|
|
3430 |
|
<t> |
3431 |
|
<list> |
3432 |
|
<t>NAME - |
3433 |
|
<list> |
3434 |
|
<t>name of the effect send entity</t> |
3435 |
|
</list> |
3436 |
|
</t> |
3437 |
|
<t>MIDI_CONTROLLER - |
3438 |
|
<list> |
3439 |
|
<t>a value between 0 and 127 reflecting the MIDI controller |
3440 |
|
which is able to modify the effect send's send level</t> |
3441 |
|
</list> |
3442 |
|
</t> |
3443 |
|
<t>LEVEL - |
3444 |
|
<list> |
3445 |
|
<t>optionally dotted number reflecting the effect send's |
3446 |
|
current send level (where a value < 1.0 means attenuation |
3447 |
|
and a value > 1.0 means amplification)</t> |
3448 |
|
</list> |
3449 |
|
</t> |
3450 |
|
<t>AUDIO_OUTPUT_ROUTING - |
3451 |
|
<list> |
3452 |
|
<t>comma separated list which reflects to which audio |
3453 |
|
channel of the selected audio output device each |
3454 |
|
effect send output channel is routed to, e.g. "0,3" would |
3455 |
|
mean the effect send's output channel 0 is routed to channel |
3456 |
|
0 of the audio output device and the effect send's output |
3457 |
|
channel 1 is routed to the channel 3 of the audio |
3458 |
|
output device (see |
3459 |
|
<xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref> |
3460 |
|
for details)</t> |
3461 |
|
</list> |
3462 |
|
</t> |
3463 |
|
</list> |
3464 |
|
</t> |
3465 |
|
</list> |
3466 |
|
</t> |
3467 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
3468 |
|
|
3469 |
|
<t>Example:</t> |
3470 |
|
<t> |
3471 |
|
<list> |
3472 |
|
<t>C: "GET FX_SEND INFO 0 0"</t> |
3473 |
|
<t>S: "NAME: Reverb Send"</t> |
3474 |
|
<t> "MIDI_CONTROLLER: 91"</t> |
3475 |
|
<t> "LEVEL: 0.3"</t> |
3476 |
|
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
3477 |
|
<t> "."</t> |
3478 |
|
</list> |
3479 |
|
</t> |
3480 |
|
</section> |
3481 |
|
|
3482 |
|
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
3483 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
3484 |
|
sampler channel by sending the following command:</t> |
3485 |
|
<t> |
3486 |
|
<list> |
3487 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></t> |
3488 |
|
</list> |
3489 |
|
</t> |
3490 |
|
<t>Where <sampler-chan> is the sampler channel number |
3491 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3492 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3493 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3494 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3495 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3496 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
3497 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
3498 |
|
the audio channel of the selected audio output device where <audio-src> |
3499 |
|
should be routed to.</t> |
3500 |
|
|
3501 |
|
<t>Note that effect sends can only route audio to the same audio output |
3502 |
|
device as assigned to the effect send's sampler channel. Also note that an |
3503 |
|
effect send entity does always have exactly as much audio channels as its |
3504 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
3505 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
3506 |
|
channels on a sampler channel might be dependant not only to the deployed |
3507 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
3508 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
3509 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
3510 |
|
|
3511 |
|
<t>Possible Answers:</t> |
3512 |
|
<t> |
3513 |
|
<list> |
3514 |
|
<t>"OK" - |
3515 |
|
<list> |
3516 |
|
<t>on success</t> |
3517 |
|
</list> |
3518 |
|
</t> |
3519 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3520 |
|
<list> |
3521 |
|
<t>if audio output channel was set, but there are noteworthy |
3522 |
|
issue(s) related, providing an appropriate warning code and |
3523 |
|
warning message</t> |
3524 |
|
</list> |
3525 |
|
</t> |
3526 |
|
<t>"ERR:<error-code>:<error-message>" - |
3527 |
|
<list> |
3528 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3529 |
|
</list> |
3530 |
|
</t> |
3531 |
|
</list> |
3532 |
|
</t> |
3533 |
|
<t>Example:</t> |
3534 |
|
<t> |
3535 |
|
<list> |
3536 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
3537 |
|
<t>S: "OK"</t> |
3538 |
|
</list> |
3539 |
|
</t> |
3540 |
|
</section> |
3541 |
|
|
3542 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
3543 |
|
<t>The front-end can alter the MIDI controller of an effect |
3544 |
|
send entity by sending the following command:</t> |
3545 |
|
<t> |
3546 |
|
<list> |
3547 |
|
<t>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl></t> |
3548 |
|
</list> |
3549 |
|
</t> |
3550 |
|
<t>Where <sampler-chan> is the sampler channel number |
3551 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3552 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3553 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3554 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3555 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3556 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
3557 |
|
able to modify the effect send's send level.</t> |
3558 |
|
|
3559 |
|
<t>Possible Answers:</t> |
3560 |
|
<t> |
3561 |
|
<list> |
3562 |
|
<t>"OK" - |
3563 |
|
<list> |
3564 |
|
<t>on success</t> |
3565 |
|
</list> |
3566 |
|
</t> |
3567 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3568 |
|
<list> |
3569 |
|
<t>if MIDI controller was set, but there are noteworthy |
3570 |
|
issue(s) related, providing an appropriate warning code and |
3571 |
|
warning message</t> |
3572 |
|
</list> |
3573 |
|
</t> |
3574 |
|
<t>"ERR:<error-code>:<error-message>" - |
3575 |
|
<list> |
3576 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3577 |
|
</list> |
3578 |
|
</t> |
3579 |
|
</list> |
3580 |
|
</t> |
3581 |
|
<t>Example:</t> |
3582 |
|
<t> |
3583 |
|
<list> |
3584 |
|
<t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t> |
3585 |
|
<t>S: "OK"</t> |
3586 |
|
</list> |
3587 |
|
</t> |
3588 |
|
</section> |
3589 |
|
|
3590 |
|
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
3591 |
|
<t>The front-end can alter the current send level of an effect |
3592 |
|
send entity by sending the following command:</t> |
3593 |
|
<t> |
3594 |
|
<list> |
3595 |
|
<t>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume></t> |
3596 |
|
</list> |
3597 |
|
</t> |
3598 |
|
<t>Where <sampler-chan> is the sampler channel number |
3599 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3600 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3601 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3602 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3603 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3604 |
|
<volume> is an optionally dotted positive number (a value |
3605 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
3606 |
|
1.0 means amplification) reflecting the new send level.</t> |
3607 |
|
|
3608 |
|
<t>Possible Answers:</t> |
3609 |
|
<t> |
3610 |
|
<list> |
3611 |
|
<t>"OK" - |
3612 |
|
<list> |
3613 |
|
<t>on success</t> |
3614 |
|
</list> |
3615 |
|
</t> |
3616 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3617 |
|
<list> |
3618 |
|
<t>if new send level was set, but there are noteworthy |
3619 |
|
issue(s) related, providing an appropriate warning code and |
3620 |
|
warning message</t> |
3621 |
|
</list> |
3622 |
|
</t> |
3623 |
|
<t>"ERR:<error-code>:<error-message>" - |
3624 |
|
<list> |
3625 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3626 |
|
</list> |
3627 |
|
</t> |
3628 |
|
</list> |
3629 |
|
</t> |
3630 |
|
<t>Example:</t> |
3631 |
|
<t> |
3632 |
|
<list> |
3633 |
|
<t>C: "SET FX_SEND LEVEL 0 0 0.15"</t> |
3634 |
|
<t>S: "OK"</t> |
3635 |
|
</list> |
3636 |
|
</t> |
3637 |
|
</section> |
3638 |
|
|
3639 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3640 |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
3641 |
<t> |
<t> |
3925 |
<t>The mentioned fields above don't have to be in particular order. |
<t>The mentioned fields above don't have to be in particular order. |
3926 |
Other fields might be added in future.</t> |
Other fields might be added in future.</t> |
3927 |
</section> |
</section> |
3928 |
|
|
3929 |
|
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
3930 |
|
<t>The client can ask for the current global sampler-wide volume |
3931 |
|
attenuation by sending the following command:</t> |
3932 |
|
<t> |
3933 |
|
<list> |
3934 |
|
<t>GET VOLUME</t> |
3935 |
|
</list> |
3936 |
|
</t> |
3937 |
|
<t>Possible Answers:</t> |
3938 |
|
<t> |
3939 |
|
<list> |
3940 |
|
<t>The sampler will always answer by returning the optional |
3941 |
|
dotted floating point coefficient, reflecting the current |
3942 |
|
global volume attenuation. |
3943 |
|
</t> |
3944 |
|
</list> |
3945 |
|
</t> |
3946 |
|
<t>Note: it is up to the respective sampler engine whether to obey |
3947 |
|
that global volume parameter or not, but in general all engines SHOULD |
3948 |
|
use this parameter.</t> |
3949 |
|
</section> |
3950 |
|
|
3951 |
|
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
3952 |
|
<t>The client can alter the current global sampler-wide volume |
3953 |
|
attenuation by sending the following command:</t> |
3954 |
|
<t> |
3955 |
|
<list> |
3956 |
|
<t>SET VOLUME <volume></t> |
3957 |
|
</list> |
3958 |
|
</t> |
3959 |
|
<t>Where <volume> should be replaced by the optional dotted |
3960 |
|
floating point value, reflecting the new global volume parameter. |
3961 |
|
This value might usually be in the range between 0.0 and 1.0, that |
3962 |
|
is for attenuating the overall volume.</t> |
3963 |
|
|
3964 |
|
<t>Possible Answers:</t> |
3965 |
|
<t> |
3966 |
|
<list> |
3967 |
|
<t>"OK" - |
3968 |
|
<list> |
3969 |
|
<t>on success</t> |
3970 |
|
</list> |
3971 |
|
</t> |
3972 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3973 |
|
<list> |
3974 |
|
<t>if the global volume was set, but there are noteworthy |
3975 |
|
issue(s) related, providing an appropriate warning code and |
3976 |
|
warning message</t> |
3977 |
|
</list> |
3978 |
|
</t> |
3979 |
|
<t>"ERR:<error-code>:<error-message>" - |
3980 |
|
<list> |
3981 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3982 |
|
</list> |
3983 |
|
</t> |
3984 |
|
</list> |
3985 |
|
</t> |
3986 |
|
</section> |
3987 |
</section> |
</section> |
3988 |
|
|
3989 |
|
|
4257 |
command:</t> |
command:</t> |
4258 |
<t> |
<t> |
4259 |
<list> |
<list> |
4260 |
<t>MAP MIDI_INSTRUMENT <map> |
<t>MAP MIDI_INSTRUMENT [NON_MODAL] <map> |
4261 |
<midi_bank> <midi_prog> <engine_name> |
<midi_bank> <midi_prog> <engine_name> |
4262 |
<filename> <instrument_index> <volume_value> |
<filename> <instrument_index> <volume_value> |
4263 |
[<instr_load_mode>] [<name>]</t> |
[<instr_load_mode>] [<name>]</t> |
4275 |
<instrument_index> the index (integer value) of the instrument |
<instrument_index> the index (integer value) of the instrument |
4276 |
within the given file, <volume_value> reflects the master |
within the given file, <volume_value> reflects the master |
4277 |
volume of the instrument as optionally dotted number (where a |
volume of the instrument as optionally dotted number (where a |
4278 |
value < 1.0 means attenuation and a value > 1.0 means |
value < 1.0 means attenuation and a value > 1.0 means |
4279 |
amplification). This parameter easily allows to adjust the |
amplification). This parameter easily allows to adjust the |
4280 |
volume of all intruments within a custom instrument map |
volume of all intruments within a custom instrument map |
4281 |
without having to adjust their instrument files. The |
without having to adjust their instrument files. The |
4310 |
<t>"PERSISTENT" - |
<t>"PERSISTENT" - |
4311 |
<list> |
<list> |
4312 |
<t>The instrument will immediately be loaded |
<t>The instrument will immediately be loaded |
4313 |
into memory in the background when this mapping |
into memory when this mapping |
4314 |
command is sent and the instrument is kept all |
command is sent and the instrument is kept all |
4315 |
the time. Instruments with this mode are |
the time. Instruments with this mode are |
4316 |
only freed when the sampler is reset or all |
only freed when the sampler is reset or all |
4360 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4361 |
</t> |
</t> |
4362 |
<t> |
<t> |
4363 |
The "MAP MIDI_INSTRUMENT" command |
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
4364 |
will immediately return, thus it will not block when an |
completely established in the sampler. The OPTIONAL "NON_MODAL" argument |
4365 |
instrument is to be loaded due to a "PERSISTENT" type |
however causes the respective "MAP MIDI_INSTRUMENT" command to return |
4366 |
entry as instruments are loaded in the background. As a |
immediately, that is to let the sampler establish the mapping in the |
4367 |
consequence this command may not necessarily return an error |
background. So this argument might be especially useful for mappings with |
4368 |
i.e. when the given instrument file does not exist or may |
a "PERSISTENT" type, because these have to load the respective instruments |
4369 |
turn out to be corrupt. |
immediately and might thus block for a very long time. It is recommended |
4370 |
|
however to use the OPTIONAL "NON_MODAL" argument only if really necessary, |
4371 |
|
because it has the following drawbacks: as "NON_MODAL" instructions return |
4372 |
|
immediately, they may not necessarily return an error i.e. when the given |
4373 |
|
instrument file turns out to be corrupt, beside that subsequent commands |
4374 |
|
in a LSCP instruction sequence might fail, because mandatory mappings are |
4375 |
|
not yet completed. |
4376 |
</t> |
</t> |
4377 |
|
|
4378 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4415 |
</t> |
</t> |
4416 |
<t> |
<t> |
4417 |
<list> |
<list> |
4418 |
<t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
<t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
4419 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4420 |
</list> |
</list> |
4421 |
</t> |
</t> |
4614 |
<t>"VOLUME" - |
<t>"VOLUME" - |
4615 |
<list> |
<list> |
4616 |
<t>master volume of the instrument as optionally |
<t>master volume of the instrument as optionally |
4617 |
dotted number (where a value < 1.0 means attenuation |
dotted number (where a value < 1.0 means attenuation |
4618 |
and a value > 1.0 means amplification)</t> |
and a value > 1.0 means amplification)</t> |
4619 |
</list> |
</list> |
4620 |
</t> |
</t> |
4785 |
</t> |
</t> |
4786 |
<t>subscribe_event = |
<t>subscribe_event = |
4787 |
<list> |
<list> |
4788 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4789 |
|
</t> |
4790 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4791 |
|
</t> |
4792 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4793 |
|
</t> |
4794 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4795 |
|
</t> |
4796 |
|
<t>/ CHANNEL_COUNT |
4797 |
</t> |
</t> |
4798 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
4799 |
</t> |
</t> |
4803 |
</t> |
</t> |
4804 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
4805 |
</t> |
</t> |
4806 |
|
<t>/ FX_SEND_COUNT |
4807 |
|
</t> |
4808 |
|
<t>/ FX_SEND_INFO |
4809 |
|
</t> |
4810 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4811 |
|
</t> |
4812 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4813 |
|
</t> |
4814 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4815 |
|
</t> |
4816 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4817 |
|
</t> |
4818 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
4819 |
</t> |
</t> |
4820 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
4821 |
</t> |
</t> |
4822 |
|
<t>/ GLOBAL_INFO |
4823 |
|
</t> |
4824 |
</list> |
</list> |
4825 |
</t> |
</t> |
4826 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
4827 |
<list> |
<list> |
4828 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4829 |
|
</t> |
4830 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4831 |
|
</t> |
4832 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4833 |
|
</t> |
4834 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4835 |
|
</t> |
4836 |
|
<t>/ CHANNEL_COUNT |
4837 |
</t> |
</t> |
4838 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
4839 |
</t> |
</t> |
4843 |
</t> |
</t> |
4844 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
4845 |
</t> |
</t> |
4846 |
|
<t>/ FX_SEND_COUNT |
4847 |
|
</t> |
4848 |
|
<t>/ FX_SEND_INFO |
4849 |
|
</t> |
4850 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4851 |
|
</t> |
4852 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4853 |
|
</t> |
4854 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4855 |
|
</t> |
4856 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4857 |
|
</t> |
4858 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
4859 |
</t> |
</t> |
4860 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
4861 |
</t> |
</t> |
4862 |
|
<t>/ GLOBAL_INFO |
4863 |
|
</t> |
4864 |
</list> |
</list> |
4865 |
</t> |
</t> |
4866 |
<t>map_instruction = |
<t>map_instruction = |
4867 |
<list> |
<list> |
4868 |
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
<t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
4869 |
</t> |
</t> |
4870 |
<t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
4871 |
</t> |
</t> |
4872 |
<t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
4873 |
</t> |
</t> |
4874 |
<t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name |
<t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name |
4875 |
</t> |
</t> |
4876 |
</list> |
</list> |
4877 |
</t> |
</t> |
4955 |
</t> |
</t> |
4956 |
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
4957 |
</t> |
</t> |
4958 |
|
<t>/ FX_SENDS SP sampler_channel |
4959 |
|
</t> |
4960 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
4961 |
|
</t> |
4962 |
|
<t>/ VOLUME |
4963 |
|
</t> |
4964 |
</list> |
</list> |
4965 |
</t> |
</t> |
4966 |
<t>set_instruction = |
<t>set_instruction = |
4977 |
</t> |
</t> |
4978 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
4979 |
</t> |
</t> |
4980 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
4981 |
|
</t> |
4982 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
4983 |
|
</t> |
4984 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
4985 |
|
</t> |
4986 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
4987 |
</t> |
</t> |
4988 |
|
<t>/ VOLUME SP volume_value |
4989 |
|
</t> |
4990 |
</list> |
</list> |
4991 |
</t> |
</t> |
4992 |
<t>create_instruction = |
<t>create_instruction = |
4999 |
</t> |
</t> |
5000 |
<t>/ MIDI_INPUT_DEVICE SP string |
<t>/ MIDI_INPUT_DEVICE SP string |
5001 |
</t> |
</t> |
5002 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
5003 |
|
</t> |
5004 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
5005 |
|
</t> |
5006 |
</list> |
</list> |
5007 |
</t> |
</t> |
5008 |
<t>reset_instruction = |
<t>reset_instruction = |
5025 |
</t> |
</t> |
5026 |
<t>/ MIDI_INPUT_DEVICE SP number |
<t>/ MIDI_INPUT_DEVICE SP number |
5027 |
</t> |
</t> |
5028 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
5029 |
|
</t> |
5030 |
</list> |
</list> |
5031 |
</t> |
</t> |
5032 |
<t>load_instruction = |
<t>load_instruction = |
5069 |
</t> |
</t> |
5070 |
</list> |
</list> |
5071 |
</t> |
</t> |
5072 |
|
<t>modal_arg = |
5073 |
|
<list> |
5074 |
|
<t>/* epsilon (empty argument) */ |
5075 |
|
</t> |
5076 |
|
<t>/ NON_MODAL SP |
5077 |
|
</t> |
5078 |
|
</list> |
5079 |
|
</t> |
5080 |
<t>key_val_list = |
<t>key_val_list = |
5081 |
<list> |
<list> |
5082 |
<t>string '=' param_val_list |
<t>string '=' param_val_list |
5113 |
</t> |
</t> |
5114 |
<t>/ MIDI_INSTRUMENT_MAPS |
<t>/ MIDI_INSTRUMENT_MAPS |
5115 |
</t> |
</t> |
5116 |
|
<t>/ FX_SENDS SP sampler_channel |
5117 |
|
</t> |
5118 |
</list> |
</list> |
5119 |
</t> |
</t> |
5120 |
<t>load_instr_args = |
<t>load_instr_args = |
5197 |
</t> |
</t> |
5198 |
</list> |
</list> |
5199 |
</t> |
</t> |
5200 |
|
<t>midi_ctrl = |
5201 |
|
<list> |
5202 |
|
<t>number |
5203 |
|
</t> |
5204 |
|
</list> |
5205 |
|
</t> |
5206 |
<t>volume_value = |
<t>volume_value = |
5207 |
<list> |
<list> |
5208 |
<t>dotnum |
<t>dotnum |
5223 |
</t> |
</t> |
5224 |
</list> |
</list> |
5225 |
</t> |
</t> |
5226 |
|
<t>fx_send_id = |
5227 |
|
<list> |
5228 |
|
<t>number |
5229 |
|
</t> |
5230 |
|
</list> |
5231 |
|
</t> |
5232 |
<t>engine_name = |
<t>engine_name = |
5233 |
<list> |
<list> |
5234 |
<t>string |
<t>string |
5253 |
</t> |
</t> |
5254 |
</list> |
</list> |
5255 |
</t> |
</t> |
5256 |
|
<t>fx_send_name = |
5257 |
|
<list> |
5258 |
|
<t>stringval |
5259 |
|
</t> |
5260 |
|
</list> |
5261 |
|
</t> |
5262 |
<t>param_val_list = |
<t>param_val_list = |
5263 |
<list> |
<list> |
5264 |
<t>param_val |
<t>param_val |
5395 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
5396 |
<t> |
<t> |
5397 |
<list> |
<list> |
5398 |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices></t> |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"</t> |
5399 |
</list> |
</list> |
5400 |
</t> |
</t> |
5401 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
5465 |
message is sufficient here.</t> |
message is sufficient here.</t> |
5466 |
</section> |
</section> |
5467 |
|
|
5468 |
|
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
5469 |
|
<t>Client may want to be notified when the number of effect sends on |
5470 |
|
a particular sampler channel is changed by issuing the following command:</t> |
5471 |
|
<t> |
5472 |
|
<list> |
5473 |
|
<t>SUBSCRIBE FX_SEND_COUNT</t> |
5474 |
|
</list> |
5475 |
|
</t> |
5476 |
|
<t>Server will start sending the following notification messages:</t> |
5477 |
|
<t> |
5478 |
|
<list> |
5479 |
|
<t>"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"</t> |
5480 |
|
</list> |
5481 |
|
</t> |
5482 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
5483 |
|
channel, on which the effect sends number is changed and <fx-sends> will |
5484 |
|
be replaced by the new number of effect sends on that channel.</t> |
5485 |
|
</section> |
5486 |
|
|
5487 |
|
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO"> |
5488 |
|
<t>Client may want to be notified when changes were made to effect sends on a |
5489 |
|
a particular sampler channel by issuing the following command:</t> |
5490 |
|
<t> |
5491 |
|
<list> |
5492 |
|
<t>SUBSCRIBE FX_SEND_INFO</t> |
5493 |
|
</list> |
5494 |
|
</t> |
5495 |
|
<t>Server will start sending the following notification messages:</t> |
5496 |
|
<t> |
5497 |
|
<list> |
5498 |
|
<t>"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"</t> |
5499 |
|
</list> |
5500 |
|
</t> |
5501 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
5502 |
|
channel, on which an effect send entity is changed and <fx-send-id> will |
5503 |
|
be replaced by the numerical ID of the changed effect send.</t> |
5504 |
|
</section> |
5505 |
|
|
5506 |
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
5507 |
<t>Client may want to be notified when the total number of voices on the |
<t>Client may want to be notified when the total number of voices on the |
5508 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
5514 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
5515 |
<t> |
<t> |
5516 |
<list> |
<list> |
5517 |
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices></t> |
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices>"</t> |
5518 |
</list> |
</list> |
5519 |
</t> |
</t> |
5520 |
<t>where <voices> will be replaced by the new number of |
<t>where <voices> will be replaced by the new number of |
5575 |
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
5576 |
</list> |
</list> |
5577 |
</t> |
</t> |
5578 |
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
5579 |
the nuber of instruments has changed and <instruments> will be replaced by |
the nuber of instruments has changed and <instruments> will be replaced by |
5580 |
the new number of MIDI instruments in the specified map.</t> |
the new number of MIDI instruments in the specified map.</t> |
5581 |
</section> |
</section> |
5595 |
</list> |
</list> |
5596 |
</t> |
</t> |
5597 |
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5598 |
in which a MIDI instrument is changed. <bank> and <program> specifies |
in which a MIDI instrument is changed. <bank> and <program> specifies |
5599 |
the location of the changed MIDI instrument in the map. The front-end will have to send |
the location of the changed MIDI instrument in the map. The front-end will have to send |
5600 |
the respective command to actually get the MIDI instrument info. Because these messages |
the respective command to actually get the MIDI instrument info. Because these messages |
5601 |
will be triggered by LSCP commands issued by other clients rather than real |
will be triggered by LSCP commands issued by other clients rather than real |
5603 |
message is sufficient here.</t> |
message is sufficient here.</t> |
5604 |
</section> |
</section> |
5605 |
|
|
5606 |
<<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO"> |
5607 |
|
<t>Client may want to be notified when changes to the global settings |
5608 |
|
of the sampler were made by issuing the following command:</t> |
5609 |
|
<t> |
5610 |
|
<list> |
5611 |
|
<t>SUBSCRIBE GLOBAL_INFO</t> |
5612 |
|
</list> |
5613 |
|
</t> |
5614 |
|
<t>Server will start sending the following types of notification messages:</t> |
5615 |
|
<t> |
5616 |
|
<list> |
5617 |
|
<t>"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the |
5618 |
|
golbal volume of the sampler is changed, where <volume> will be |
5619 |
|
replaced by the optional dotted floating point value, reflecting the |
5620 |
|
new global volume parameter.</t> |
5621 |
|
</list> |
5622 |
|
</t> |
5623 |
|
</section> |
5624 |
|
|
5625 |
|
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
5626 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
5627 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
5628 |
<t> |
<t> |