11 |
<?rfc symrefs="yes" ?> |
<?rfc symrefs="yes" ?> |
12 |
<?rfc sortrefs="yes"?> |
<?rfc sortrefs="yes"?> |
13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
|
<?rfc strict="yes" ?> |
|
14 |
|
|
15 |
<rfc category="std" ipr="full2026" docName="LSCP 1.2"> |
<!-- FIXME: next attribute should actually be "yes", temporarily disbled due |
16 |
|
to an annoying "missing Normative/Informative References" error message --> |
17 |
|
<?rfc strict="no" ?> |
18 |
|
|
19 |
|
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
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="November" year="2006"/> |
<date month="December" year="2006"/> |
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> |
2574 |
the channel is a solo channel; "false" otherwise</t> |
the channel is a solo channel; "false" otherwise</t> |
2575 |
</list> |
</list> |
2576 |
</t> |
</t> |
2577 |
|
<t>MIDI_INSTRUMENT_MAP - |
2578 |
|
<list> |
2579 |
|
<t>Determines to which MIDI instrument map this sampler |
2580 |
|
channel is assigned to. Read chapter |
2581 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
2582 |
|
for a list of possible values.</t> |
2583 |
|
</list> |
2584 |
|
</t> |
2585 |
</list> |
</list> |
2586 |
</t> |
</t> |
2587 |
</list> |
</list> |
2604 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
2605 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
2606 |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
2607 |
|
<t> "VOLUME: 1.0"</t> |
2608 |
|
<t> "MUTE: false"</t> |
2609 |
|
<t> "SOLO: false"</t> |
2610 |
|
<t> "MIDI_INSTRUMENT_MAP: NONE"</t> |
2611 |
<t> "."</t> |
<t> "."</t> |
2612 |
</list> |
</list> |
2613 |
</t> |
</t> |
2768 |
</t> |
</t> |
2769 |
</section> |
</section> |
2770 |
|
|
2771 |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
2772 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2773 |
|
|
2774 |
<t>The front-end can alter the audio output type on a specific sampler |
<t>The front-end can alter the audio output type on a specific sampler |
3159 |
</t> |
</t> |
3160 |
</section> |
</section> |
3161 |
|
|
3162 |
|
<section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP"> |
3163 |
|
<t>The front-end can assign a MIDI instrument map to a specific sampler channel |
3164 |
|
by sending the following command:</t> |
3165 |
|
<t> |
3166 |
|
<list> |
3167 |
|
<t>SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map></t> |
3168 |
|
</list> |
3169 |
|
</t> |
3170 |
|
<t>Where <sampler-channel> is the respective sampler channel |
3171 |
|
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3172 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
3173 |
|
<map> can have the following possibilites:</t> |
3174 |
|
<t> |
3175 |
|
<list> |
3176 |
|
<t>"NONE" - |
3177 |
|
<list> |
3178 |
|
<t>This is the default setting. In this case |
3179 |
|
the sampler channel is not assigned any MIDI |
3180 |
|
instrument map and thus will ignore all MIDI |
3181 |
|
program change messages.</t> |
3182 |
|
</list> |
3183 |
|
</t> |
3184 |
|
<t>"DEFAULT" - |
3185 |
|
<list> |
3186 |
|
<t>The sampler channel will always use the |
3187 |
|
default MIDI instrument map to handle MIDI |
3188 |
|
program change messages.</t> |
3189 |
|
</list> |
3190 |
|
</t> |
3191 |
|
<t>numeric ID - |
3192 |
|
<list> |
3193 |
|
<t>You can assign a specific MIDI instrument map |
3194 |
|
by replacing <map> with the respective numeric |
3195 |
|
ID of the MIDI instrument map as returned by the |
3196 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
3197 |
|
command. Once that map will be deleted, the sampler |
3198 |
|
channel would fall back to "NONE".</t> |
3199 |
|
</list> |
3200 |
|
</t> |
3201 |
|
</list> |
3202 |
|
</t> |
3203 |
|
<t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref> |
3204 |
|
for details regarding MIDI instrument mapping.</t> |
3205 |
|
|
3206 |
|
<t>Possible Answers:</t> |
3207 |
|
<t> |
3208 |
|
<list> |
3209 |
|
<t>"OK" - |
3210 |
|
<list> |
3211 |
|
<t>on success</t> |
3212 |
|
</list> |
3213 |
|
</t> |
3214 |
|
<t>"ERR:<error-code>:<error-message>" - |
3215 |
|
<list> |
3216 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3217 |
|
</list> |
3218 |
|
</t> |
3219 |
|
</list> |
3220 |
|
</t> |
3221 |
|
|
3222 |
|
<t>Examples:</t> |
3223 |
|
<t> |
3224 |
|
<list> |
3225 |
|
<t></t> |
3226 |
|
</list> |
3227 |
|
</t> |
3228 |
|
</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 |
|
|
3990 |
<section title="MIDI Instrument Mapping"> |
<section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping"> |
3991 |
<t>The MIDI protocol provides a way to switch between instruments |
<t>The MIDI protocol provides a way to switch between instruments |
3992 |
by sending so called MIDI bank select and MIDI program change |
by sending so called MIDI bank select and MIDI program change |
3993 |
messages which are essentially just numbers. The following commands |
messages which are essentially just numbers. The following commands |
3994 |
allow to actually map arbitrary MIDI bank select / program change |
allow to actually map arbitrary MIDI bank select / program change |
3995 |
numbers with real instruments.</t> |
numbers with real instruments.</t> |
3996 |
<t>By default, that is when the sampler is launched, this map will |
<t>The sampler allows to manage an arbitrary amount of MIDI |
3997 |
be empty, thus the sampler will simply ignore all program change |
instrument maps which define which instrument to load on |
3998 |
messages. The front-end has to explicitly add entries to the map |
which MIDI program change message.</t> |
3999 |
so the sampler knows how to react on a given program change |
<t>By default, that is when the sampler is launched, there is no |
4000 |
message, that is by switching to the respectively defined engine |
map, thus the sampler will simply ignore all program change |
4001 |
type and loading the respective instrument.</t> |
messages. The front-end has to explicitly create at least one |
4002 |
|
map, add entries to the map and tell the respective sampler |
4003 |
|
channel(s) which MIDI instrument map to use, so the sampler |
4004 |
|
knows how to react on a given program change message on the |
4005 |
|
respective sampler channel, that is by switching to the |
4006 |
|
respectively defined engine type and loading the respective |
4007 |
|
instrument. See command |
4008 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
4009 |
|
for how to assign a MIDI instrument map to a sampler channel.</t> |
4010 |
<t>Also note per MIDI specification a bank select message does not |
<t>Also note per MIDI specification a bank select message does not |
4011 |
cause to switch to another instrument. Instead when receiving a |
cause to switch to another instrument. Instead when receiving a |
4012 |
bank select message the bank value will be stored and a subsequent |
bank select message the bank value will be stored and a subsequent |
4014 |
cause the sampler to switch to the respective instrument as |
cause the sampler to switch to the respective instrument as |
4015 |
reflected by the current MIDI instrument map.</t> |
reflected by the current MIDI instrument map.</t> |
4016 |
|
|
4017 |
|
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP"> |
4018 |
|
<t>The front-end can add a new MIDI instrument map by sending |
4019 |
|
the following command:</t> |
4020 |
|
<t> |
4021 |
|
<list> |
4022 |
|
<t>ADD MIDI_INSTRUMENT_MAP [<name>]</t> |
4023 |
|
</list> |
4024 |
|
</t> |
4025 |
|
<t>Where <name> is an optional argument allowing to |
4026 |
|
assign a custom name to the new map. MIDI instrument Map |
4027 |
|
names do not have to be unique.</t> |
4028 |
|
|
4029 |
|
<t>Possible Answers:</t> |
4030 |
|
<t> |
4031 |
|
<list> |
4032 |
|
<t>"OK[<map>]" - |
4033 |
|
<list> |
4034 |
|
<t>in case a new MIDI instrument map could |
4035 |
|
be added, where <map> reflects the |
4036 |
|
unique ID of the newly created MIDI |
4037 |
|
instrument map</t> |
4038 |
|
</list> |
4039 |
|
</t> |
4040 |
|
<t>"ERR:<error-code>:<error-message>" - |
4041 |
|
<list> |
4042 |
|
<t>when a new map could not be created, which |
4043 |
|
might never occur in practice</t> |
4044 |
|
</list> |
4045 |
|
</t> |
4046 |
|
</list> |
4047 |
|
</t> |
4048 |
|
|
4049 |
|
<t>Examples:</t> |
4050 |
|
<t> |
4051 |
|
<list> |
4052 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t> |
4053 |
|
<t>S: "OK[0]"</t> |
4054 |
|
</list> |
4055 |
|
</t> |
4056 |
|
<t> |
4057 |
|
<list> |
4058 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t> |
4059 |
|
<t>S: "OK[1]"</t> |
4060 |
|
</list> |
4061 |
|
</t> |
4062 |
|
<t> |
4063 |
|
<list> |
4064 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP"</t> |
4065 |
|
<t>S: "OK[5]"</t> |
4066 |
|
</list> |
4067 |
|
</t> |
4068 |
|
</section> |
4069 |
|
|
4070 |
|
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP"> |
4071 |
|
<t>The front-end can delete a particular MIDI instrument map |
4072 |
|
by sending the following command:</t> |
4073 |
|
<t> |
4074 |
|
<list> |
4075 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP <map></t> |
4076 |
|
</list> |
4077 |
|
</t> |
4078 |
|
<t>Where <map> reflects the unique ID of the map to delete |
4079 |
|
as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
4080 |
|
command.</t> |
4081 |
|
<t>The front-end can delete all MIDI instrument maps by |
4082 |
|
sending the following command:</t> |
4083 |
|
<t> |
4084 |
|
<list> |
4085 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP ALL</t> |
4086 |
|
</list> |
4087 |
|
</t> |
4088 |
|
|
4089 |
|
<t>Possible Answers:</t> |
4090 |
|
<t> |
4091 |
|
<list> |
4092 |
|
<t>"OK" - |
4093 |
|
<list> |
4094 |
|
<t>in case the map(s) could be deleted</t> |
4095 |
|
</list> |
4096 |
|
</t> |
4097 |
|
<t>"ERR:<error-code>:<error-message>" - |
4098 |
|
<list> |
4099 |
|
<t>when the given map does not exist</t> |
4100 |
|
</list> |
4101 |
|
</t> |
4102 |
|
</list> |
4103 |
|
</t> |
4104 |
|
|
4105 |
|
<t>Examples:</t> |
4106 |
|
<t> |
4107 |
|
<list> |
4108 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t> |
4109 |
|
<t>S: "OK"</t> |
4110 |
|
</list> |
4111 |
|
</t> |
4112 |
|
<t> |
4113 |
|
<list> |
4114 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t> |
4115 |
|
<t>S: "OK"</t> |
4116 |
|
</list> |
4117 |
|
</t> |
4118 |
|
</section> |
4119 |
|
|
4120 |
|
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS"> |
4121 |
|
<t>The front-end can retrieve the current amount of MIDI |
4122 |
|
instrument maps by sending the following command:</t> |
4123 |
|
<t> |
4124 |
|
<list> |
4125 |
|
<t>GET MIDI_INSTRUMENT_MAPS</t> |
4126 |
|
</list> |
4127 |
|
</t> |
4128 |
|
|
4129 |
|
<t>Possible Answers:</t> |
4130 |
|
<t> |
4131 |
|
<list> |
4132 |
|
<t>The sampler will answer by returning the current |
4133 |
|
number of MIDI instrument maps.</t> |
4134 |
|
</list> |
4135 |
|
</t> |
4136 |
|
|
4137 |
|
<t>Example:</t> |
4138 |
|
<t> |
4139 |
|
<list> |
4140 |
|
<t>C: "GET MIDI_INSTRUMENT_MAPS"</t> |
4141 |
|
<t>S: "2"</t> |
4142 |
|
</list> |
4143 |
|
</t> |
4144 |
|
</section> |
4145 |
|
|
4146 |
|
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS"> |
4147 |
|
<t>The number of MIDI instrument maps can change on runtime. To get the |
4148 |
|
current list of MIDI instrument maps, the front-end can send the |
4149 |
|
following command:</t> |
4150 |
|
<t> |
4151 |
|
<list> |
4152 |
|
<t>LIST MIDI_INSTRUMENT_MAPS</t> |
4153 |
|
</list> |
4154 |
|
</t> |
4155 |
|
<t>Possible Answers:</t> |
4156 |
|
<t> |
4157 |
|
<list> |
4158 |
|
<t>The sampler will answer by returning a comma separated list |
4159 |
|
with all MIDI instrument maps' numerical IDs.</t> |
4160 |
|
</list> |
4161 |
|
</t> |
4162 |
|
<t>Example:</t> |
4163 |
|
<t> |
4164 |
|
<list> |
4165 |
|
<t>C: "LIST MIDI_INSTRUMENT_MAPS"</t> |
4166 |
|
<t>S: "0,1,5,12"</t> |
4167 |
|
</list> |
4168 |
|
</t> |
4169 |
|
</section> |
4170 |
|
|
4171 |
|
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO"> |
4172 |
|
<t>The front-end can ask for the current settings of a MIDI |
4173 |
|
instrument map by sending the following command:</t> |
4174 |
|
<t> |
4175 |
|
<list> |
4176 |
|
<t>GET MIDI_INSTRUMENT_MAP INFO <map></t> |
4177 |
|
</list> |
4178 |
|
</t> |
4179 |
|
<t>Where <map> is the numerical ID of the map the |
4180 |
|
front-end is interested in as returned by the |
4181 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
4182 |
|
command.</t> |
4183 |
|
|
4184 |
|
<t>Possible Answers:</t> |
4185 |
|
<t> |
4186 |
|
<list> |
4187 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
4188 |
|
Each answer line begins with the settings category name |
4189 |
|
followed by a colon and then a space character <SP> and finally |
4190 |
|
the info character string to that setting category. At the |
4191 |
|
moment the following categories are defined:</t> |
4192 |
|
|
4193 |
|
<t> |
4194 |
|
<list> |
4195 |
|
<t>NAME - |
4196 |
|
<list> |
4197 |
|
<t>custom name of the given map, |
4198 |
|
which does not have to be unique</t> |
4199 |
|
</list> |
4200 |
|
</t> |
4201 |
|
</list> |
4202 |
|
</t> |
4203 |
|
</list> |
4204 |
|
</t> |
4205 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
4206 |
|
|
4207 |
|
<t>Example:</t> |
4208 |
|
<t> |
4209 |
|
<list> |
4210 |
|
<t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t> |
4211 |
|
<t>S: "NAME: Standard Map"</t> |
4212 |
|
<t> "."</t> |
4213 |
|
</list> |
4214 |
|
</t> |
4215 |
|
</section> |
4216 |
|
|
4217 |
|
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME"> |
4218 |
|
<t>The front-end can alter the custom name of a MIDI |
4219 |
|
instrument map by sending the following command:</t> |
4220 |
|
<t> |
4221 |
|
<list> |
4222 |
|
<t>SET MIDI_INSTRUMENT_MAP NAME <map> <name></t> |
4223 |
|
</list> |
4224 |
|
</t> |
4225 |
|
<t>Where <map> is the numerical ID of the map and |
4226 |
|
<name> the new custom name of the map, which does not |
4227 |
|
have to be unique.</t> |
4228 |
|
|
4229 |
|
<t>Possible Answers:</t> |
4230 |
|
<t> |
4231 |
|
<list> |
4232 |
|
<t>"OK" - |
4233 |
|
<list> |
4234 |
|
<t>on success</t> |
4235 |
|
</list> |
4236 |
|
</t> |
4237 |
|
<t>"ERR:<error-code>:<error-message>" - |
4238 |
|
<list> |
4239 |
|
<t>in case the given map does not exist</t> |
4240 |
|
</list> |
4241 |
|
</t> |
4242 |
|
</list> |
4243 |
|
</t> |
4244 |
|
|
4245 |
|
<t>Example:</t> |
4246 |
|
<t> |
4247 |
|
<list> |
4248 |
|
<t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t> |
4249 |
|
<t>S: "OK"</t> |
4250 |
|
</list> |
4251 |
|
</t> |
4252 |
|
</section> |
4253 |
|
|
4254 |
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
4255 |
<t>The front-end can create a new or replace an existing entry |
<t>The front-end can create a new or replace an existing entry |
4256 |
in the sampler's MIDI instrument map by sending the following |
in a sampler's MIDI instrument map by sending the following |
4257 |
command:</t> |
command:</t> |
4258 |
<t> |
<t> |
4259 |
<list> |
<list> |
4260 |
<t>MAP MIDI_INSTRUMENT <midi_bank_msb> |
<t>MAP MIDI_INSTRUMENT <map> |
4261 |
<midi_bank_lsb> <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> |
4264 |
</list> |
</list> |
4265 |
</t> |
</t> |
4266 |
<t>Where <midi_bank_msb> is an integer value between |
<t>Where <map> is the numeric ID of the map to alter, |
4267 |
0..127 reflecting the MIDI bank select MSB (coarse) index, |
<midi_bank> is an integer value between |
4268 |
<midi_bank_lsb> an integer value between 0..127 reflecting |
0..16383 reflecting the MIDI bank select index, |
4269 |
the MIDI bank select LSB (fine) index, <midi_prog> an |
<midi_prog> an |
4270 |
integer value between 0..127 reflecting the MIDI program change |
integer value between 0..127 reflecting the MIDI program change |
4271 |
index, <engine_name> a sampler engine name as returned by |
index, <engine_name> a sampler engine name as returned by |
4272 |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4273 |
command (not encapsulated into apostrophes), <filename> the name |
command (not encapsulated into apostrophes), <filename> the name |
4274 |
of the instrument's file to be deployed (encapsulated into apostrophes), <instrument_index> the index (integer value) of the instrument |
of the instrument's file to be deployed (encapsulated into apostrophes), |
4275 |
|
<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 |
4379 |
</t> |
</t> |
4380 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
4381 |
<list> |
<list> |
4382 |
<t>when the given engine does not exist or a value |
<t>when the given map or engine does not exist or a value |
4383 |
is out of range</t> |
is out of range</t> |
4384 |
</list> |
</list> |
4385 |
</t> |
</t> |
4389 |
<t>Examples:</t> |
<t>Examples:</t> |
4390 |
<t> |
<t> |
4391 |
<list> |
<list> |
4392 |
<t>C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t> |
<t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t> |
4393 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4394 |
</list> |
</list> |
4395 |
</t> |
</t> |
4396 |
<t> |
<t> |
4397 |
<list> |
<list> |
4398 |
<t>C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t> |
<t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t> |
4399 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4400 |
</list> |
</list> |
4401 |
</t> |
</t> |
4403 |
<list> |
<list> |
4404 |
<t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t> |
<t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t> |
4405 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4406 |
<t>C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t> |
<t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t> |
4407 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4408 |
</list> |
</list> |
4409 |
</t> |
</t> |
4410 |
<t> |
<t> |
4411 |
<list> |
<list> |
4412 |
<t>C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
<t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
4413 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4414 |
</list> |
</list> |
4415 |
</t> |
</t> |
4416 |
</section> |
</section> |
4417 |
|
|
4418 |
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
4419 |
<t>The front-end can query the amount of currently existing MIDI |
<t>The front-end can query the amount of currently existing |
4420 |
instrument map entries by sending the following |
entries in a MIDI instrument map by sending the following |
4421 |
command:</t> |
command:</t> |
4422 |
<t> |
<t> |
4423 |
<list> |
<list> |
4424 |
<t>GET MIDI_INSTRUMENTS</t> |
<t>GET MIDI_INSTRUMENTS <map></t> |
4425 |
|
</list> |
4426 |
|
</t> |
4427 |
|
<t>The front-end can query the amount of currently existing |
4428 |
|
entries in all MIDI instrument maps by sending the following |
4429 |
|
command:</t> |
4430 |
|
<t> |
4431 |
|
<list> |
4432 |
|
<t>GET MIDI_INSTRUMENTS ALL</t> |
4433 |
</list> |
</list> |
4434 |
</t> |
</t> |
4435 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4436 |
<t> |
<t> |
4437 |
<list> |
<list> |
4438 |
<t>LinuxSampler will answer by sending the current number of |
<t>The sampler will answer by sending the current number of |
4439 |
entries in the sampler's MIDI instrument map.</t> |
entries in the MIDI instrument map(s).</t> |
4440 |
</list> |
</list> |
4441 |
</t> |
</t> |
4442 |
|
|
4443 |
<t>Example:</t> |
<t>Example:</t> |
4444 |
<t> |
<t> |
4445 |
<list> |
<list> |
4446 |
<t>C: "GET MIDI_INSTRUMENTS"</t> |
<t>C: "GET MIDI_INSTRUMENTS 0"</t> |
4447 |
<t>S: "634"</t> |
<t>S: "234"</t> |
4448 |
|
</list> |
4449 |
|
</t> |
4450 |
|
<t> |
4451 |
|
<list> |
4452 |
|
<t>C: "GET MIDI_INSTRUMENTS ALL"</t> |
4453 |
|
<t>S: "954"</t> |
4454 |
</list> |
</list> |
4455 |
</t> |
</t> |
4456 |
</section> |
</section> |
4457 |
|
|
4458 |
<section title="Getting indeces of all MIDI instrument map entries" anchor="LIST MIDI_INSTRUMENTS"> |
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS"> |
4459 |
<t>The front-end can query a list of all currently existing MIDI |
<t>The front-end can query a list of all currently existing |
4460 |
instrument map entries by sending the following command:</t> |
entries in a certain MIDI instrument map by sending the following |
4461 |
|
command:</t> |
4462 |
|
<t> |
4463 |
|
<list> |
4464 |
|
<t>LIST MIDI_INSTRUMENTS <map></t> |
4465 |
|
</list> |
4466 |
|
</t> |
4467 |
|
<t>Where <map> is the numeric ID of the MIDI instrument map.</t> |
4468 |
|
<t>The front-end can query a list of all currently existing |
4469 |
|
entries of all MIDI instrument maps by sending the following |
4470 |
|
command:</t> |
4471 |
<t> |
<t> |
4472 |
<list> |
<list> |
4473 |
<t>LIST MIDI_INSTRUMENTS</t> |
<t>LIST MIDI_INSTRUMENTS ALL</t> |
4474 |
</list> |
</list> |
4475 |
</t> |
</t> |
4476 |
|
|
4477 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4478 |
<t> |
<t> |
4479 |
<list> |
<list> |
4480 |
<t>LinuxSampler will answer by sending a comma separated |
<t>The sampler will answer by sending a comma separated |
4481 |
list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) - |
list of map ID - MIDI bank - MIDI program triples, where |
4482 |
MIDI program triples, where each triple is encapsulated |
each triple is encapsulated into curly braces. The |
4483 |
into curly braces. The list is returned in one single |
list is returned in one single line. Each triple |
4484 |
line. Each triple just reflects the key of the respective |
just reflects the key of the respective map entry, |
4485 |
map entry, thus subsequent |
thus subsequent |
4486 |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4487 |
command(s) are necessary to retrieve detailed informations |
command(s) are necessary to retrieve detailed informations |
4488 |
about each entry.</t> |
about each entry.</t> |
4492 |
<t>Example:</t> |
<t>Example:</t> |
4493 |
<t> |
<t> |
4494 |
<list> |
<list> |
4495 |
<t>C: "LIST MIDI_INSTRUMENTS"</t> |
<t>C: "LIST MIDI_INSTRUMENTS 0"</t> |
4496 |
<t>S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"</t> |
<t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t> |
4497 |
</list> |
</list> |
4498 |
</t> |
</t> |
4499 |
</section> |
</section> |
4500 |
|
|
4501 |
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
4502 |
<t>The front-end can delete an entry from the MIDI instrument |
<t>The front-end can delete an entry from a MIDI instrument |
4503 |
map by sending the following command:</t> |
map by sending the following command:</t> |
4504 |
<t> |
<t> |
4505 |
<list> |
<list> |
4506 |
<t>UNMAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog></t> |
<t>UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog></t> |
4507 |
</list> |
</list> |
4508 |
</t> |
</t> |
4509 |
<t> |
<t> |
4510 |
Where <midi_bank_msb> is an integer value between 0..127 |
Where <map> is the numeric ID of the MIDI instrument map, |
4511 |
reflecting the MIDI bank MSB (coarse) value, <midi_bank_lsb> |
<midi_bank> is an integer value between 0..16383 |
4512 |
an integer value between 0..127 reflecting the MIDI bank LSB |
reflecting the MIDI bank value and |
4513 |
(fine) value and <midi_prog> an integer value between |
<midi_prog> an integer value between |
4514 |
0..127 reflecting the MIDI program value of the map entrie's key |
0..127 reflecting the MIDI program value of the map's entrie's key |
4515 |
index triple. |
index triple. |
4516 |
</t> |
</t> |
4517 |
|
|
4534 |
<t>Example:</t> |
<t>Example:</t> |
4535 |
<t> |
<t> |
4536 |
<list> |
<list> |
4537 |
<t>C: "UNMAP MIDI_INSTRUMENT 2 40 127"</t> |
<t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t> |
4538 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4539 |
</list> |
</list> |
4540 |
</t> |
</t> |
4545 |
instrument map entry by sending the following command:</t> |
instrument map entry by sending the following command:</t> |
4546 |
<t> |
<t> |
4547 |
<list> |
<list> |
4548 |
<t>GET MIDI_INSTRUMENT INFO <midi_bank_msb> <midi_bank_lsb> <midi_prog></t> |
<t>GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog></t> |
4549 |
</list> |
</list> |
4550 |
</t> |
</t> |
4551 |
<t> |
<t> |
4552 |
Where <midi_bank_msb> is an integer value between 0..127 |
Where <map> is the numeric ID of the MIDI instrument map, |
4553 |
reflecting the MIDI bank MSB (coarse) value, <midi_bank_lsb> |
<midi_bank> is an integer value between 0..16383 |
4554 |
an integer value between 0..127 reflecting the MIDI bank LSB |
reflecting the MIDI bank value, <midi_bank> |
4555 |
(fine) value and <midi_prog> an integer value between |
and <midi_prog> an integer value between |
4556 |
0..127 reflecting the MIDI program value of the map entrie's key |
0..127 reflecting the MIDI program value of the map's entrie's key |
4557 |
index triple. |
index triple. |
4558 |
</t> |
</t> |
4559 |
|
|
4608 |
<t>"VOLUME" - |
<t>"VOLUME" - |
4609 |
<list> |
<list> |
4610 |
<t>master volume of the instrument as optionally |
<t>master volume of the instrument as optionally |
4611 |
dotted number (where a value < 1.0 means attenuation |
dotted number (where a value < 1.0 means attenuation |
4612 |
and a value > 1.0 means amplification)</t> |
and a value > 1.0 means amplification)</t> |
4613 |
</list> |
</list> |
4614 |
</t> |
</t> |
4619 |
<t>Example:</t> |
<t>Example:</t> |
4620 |
<t> |
<t> |
4621 |
<list> |
<list> |
4622 |
<t>C: "GET MIDI_INSTRUMENT INFO 3 45 120"</t> |
<t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t> |
4623 |
<t>S: "NAME: Drums for Foo Song"</t> |
<t>S: "NAME: Drums for Foo Song"</t> |
4624 |
<t> "ENGINE_NAME: GigEngine"</t> |
<t> "ENGINE_NAME: GigEngine"</t> |
4625 |
<t> "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t> |
<t> "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t> |
4633 |
</section> |
</section> |
4634 |
|
|
4635 |
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
4636 |
<t>The front-end can clear the whole MIDI instrument map, that |
<t>The front-end can clear a whole MIDI instrument map, that |
4637 |
is delete all entries by sending the following command:</t> |
is delete all its entries by sending the following command:</t> |
4638 |
|
<t> |
4639 |
|
<list> |
4640 |
|
<t>CLEAR MIDI_INSTRUMENTS <map></t> |
4641 |
|
</list> |
4642 |
|
</t> |
4643 |
|
<t>Where <map> is the numeric ID of the map to clear.</t> |
4644 |
|
<t>The front-end can clear all MIDI instrument maps, that |
4645 |
|
is delete all entries of all maps by sending the following |
4646 |
|
command:</t> |
4647 |
<t> |
<t> |
4648 |
<list> |
<list> |
4649 |
<t>CLEAR MIDI_INSTRUMENTS</t> |
<t>CLEAR MIDI_INSTRUMENTS ALL</t> |
4650 |
</list> |
</list> |
4651 |
</t> |
</t> |
4652 |
|
<t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the |
4653 |
|
maps, only their entries, thus the map's settings like |
4654 |
|
custom name will be preservevd.</t> |
4655 |
|
|
4656 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
4657 |
<t> |
<t> |
4664 |
</list> |
</list> |
4665 |
</t> |
</t> |
4666 |
|
|
4667 |
<t>Example:</t> |
<t>Examples:</t> |
4668 |
|
<t> |
4669 |
|
<list> |
4670 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS 0"</t> |
4671 |
|
<t>S: "OK"</t> |
4672 |
|
</list> |
4673 |
|
</t> |
4674 |
<t> |
<t> |
4675 |
<list> |
<list> |
4676 |
<t>C: "CLEAR MIDI_INSTRUMENTS"</t> |
<t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t> |
4677 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
4678 |
</list> |
</list> |
4679 |
</t> |
</t> |
4731 |
</t> |
</t> |
4732 |
<t>command = |
<t>command = |
4733 |
<list> |
<list> |
4734 |
<t>ADD SP CHANNEL |
<t>ADD SP add_instruction |
4735 |
</t> |
</t> |
4736 |
<t>/ MAP SP map_instruction |
<t>/ MAP SP map_instruction |
4737 |
</t> |
</t> |
4748 |
<t>/ LOAD SP load_instruction |
<t>/ LOAD SP load_instruction |
4749 |
</t> |
</t> |
4750 |
<t>/ REMOVE SP remove_instruction |
<t>/ REMOVE SP remove_instruction |
|
|
|
4751 |
</t> |
</t> |
4752 |
<t>/ SET SP set_instruction |
<t>/ SET SP set_instruction |
4753 |
</t> |
</t> |
4767 |
</t> |
</t> |
4768 |
</list> |
</list> |
4769 |
</t> |
</t> |
4770 |
|
<t>add_instruction = |
4771 |
|
<list> |
4772 |
|
<t>CHANNEL |
4773 |
|
</t> |
4774 |
|
<t>/ MIDI_INSTRUMENT_MAP |
4775 |
|
</t> |
4776 |
|
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
4777 |
|
</t> |
4778 |
|
</list> |
4779 |
|
</t> |
4780 |
<t>subscribe_event = |
<t>subscribe_event = |
4781 |
<list> |
<list> |
4782 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4783 |
|
</t> |
4784 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4785 |
|
</t> |
4786 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4787 |
|
</t> |
4788 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4789 |
|
</t> |
4790 |
|
<t>/ CHANNEL_COUNT |
4791 |
</t> |
</t> |
4792 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
4793 |
</t> |
</t> |
4797 |
</t> |
</t> |
4798 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
4799 |
</t> |
</t> |
4800 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4801 |
|
</t> |
4802 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4803 |
|
</t> |
4804 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4805 |
|
</t> |
4806 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4807 |
|
</t> |
4808 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
4809 |
</t> |
</t> |
4810 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
4813 |
</t> |
</t> |
4814 |
<t>unsubscribe_event = |
<t>unsubscribe_event = |
4815 |
<list> |
<list> |
4816 |
<t>CHANNEL_COUNT |
<t>AUDIO_OUTPUT_DEVICE_COUNT |
4817 |
|
</t> |
4818 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
4819 |
|
</t> |
4820 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
4821 |
|
</t> |
4822 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
4823 |
|
</t> |
4824 |
|
<t>/ CHANNEL_COUNT |
4825 |
</t> |
</t> |
4826 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
4827 |
</t> |
</t> |
4831 |
</t> |
</t> |
4832 |
<t>/ CHANNEL_INFO |
<t>/ CHANNEL_INFO |
4833 |
</t> |
</t> |
4834 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
4835 |
|
</t> |
4836 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
4837 |
|
</t> |
4838 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
4839 |
|
</t> |
4840 |
|
<t>/ MIDI_INSTRUMENT_INFO |
4841 |
|
</t> |
4842 |
<t>/ MISCELLANEOUS |
<t>/ MISCELLANEOUS |
4843 |
</t> |
</t> |
4844 |
<t>/ TOTAL_VOICE_COUNT |
<t>/ TOTAL_VOICE_COUNT |
4847 |
</t> |
</t> |
4848 |
<t>map_instruction = |
<t>map_instruction = |
4849 |
<list> |
<list> |
4850 |
<t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value |
4851 |
</t> |
</t> |
4852 |
<t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode |
<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 |
4853 |
</t> |
</t> |
4854 |
<t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name |
<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 |
4855 |
</t> |
</t> |
4856 |
<t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb 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 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 |
4857 |
</t> |
</t> |
4858 |
</list> |
</list> |
4859 |
</t> |
</t> |
4860 |
<t>unmap_instruction = |
<t>unmap_instruction = |
4861 |
<list> |
<list> |
4862 |
<t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog |
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog |
4863 |
</t> |
</t> |
4864 |
</list> |
</list> |
4865 |
</t> |
</t> |
4867 |
<list> |
<list> |
4868 |
<t>CHANNEL SP sampler_channel |
<t>CHANNEL SP sampler_channel |
4869 |
</t> |
</t> |
4870 |
|
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
4871 |
|
</t> |
4872 |
|
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
4873 |
|
</t> |
4874 |
</list> |
</list> |
4875 |
</t> |
</t> |
4876 |
<t>get_instruction = |
<t>get_instruction = |
4927 |
</t> |
</t> |
4928 |
<t>/ TOTAL_VOICE_COUNT_MAX |
<t>/ TOTAL_VOICE_COUNT_MAX |
4929 |
</t> |
</t> |
4930 |
<t>/ MIDI_INSTRUMENTS |
<t>/ MIDI_INSTRUMENTS SP midi_map |
4931 |
|
</t> |
4932 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
4933 |
|
</t> |
4934 |
|
<t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog |
4935 |
|
</t> |
4936 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
4937 |
|
</t> |
4938 |
|
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
4939 |
</t> |
</t> |
4940 |
<t>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog |
<t>/ FX_SENDS SP sampler_channel |
4941 |
|
</t> |
4942 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
4943 |
|
</t> |
4944 |
|
<t>/ VOLUME |
4945 |
</t> |
</t> |
4946 |
</list> |
</list> |
4947 |
</t> |
</t> |
4957 |
</t> |
</t> |
4958 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
4959 |
</t> |
</t> |
4960 |
|
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
4961 |
|
</t> |
4962 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
4963 |
|
</t> |
4964 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
4965 |
|
</t> |
4966 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
4967 |
|
</t> |
4968 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
4969 |
</t> |
</t> |
4970 |
|
<t>/ VOLUME SP volume_value |
4971 |
|
</t> |
4972 |
</list> |
</list> |
4973 |
</t> |
</t> |
4974 |
<t>create_instruction = |
<t>create_instruction = |
4981 |
</t> |
</t> |
4982 |
<t>/ MIDI_INPUT_DEVICE SP string |
<t>/ MIDI_INPUT_DEVICE SP string |
4983 |
</t> |
</t> |
4984 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
4985 |
|
</t> |
4986 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
4987 |
|
</t> |
4988 |
</list> |
</list> |
4989 |
</t> |
</t> |
4990 |
<t>reset_instruction = |
<t>reset_instruction = |
4995 |
</t> |
</t> |
4996 |
<t>clear_instruction = |
<t>clear_instruction = |
4997 |
<list> |
<list> |
4998 |
<t>MIDI_INSTRUMENTS |
<t>MIDI_INSTRUMENTS SP midi_map |
4999 |
|
</t> |
5000 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
5001 |
</t> |
</t> |
5002 |
</list> |
</list> |
5003 |
</t> |
</t> |
5007 |
</t> |
</t> |
5008 |
<t>/ MIDI_INPUT_DEVICE SP number |
<t>/ MIDI_INPUT_DEVICE SP number |
5009 |
</t> |
</t> |
5010 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
5011 |
|
</t> |
5012 |
</list> |
</list> |
5013 |
</t> |
</t> |
5014 |
<t>load_instruction = |
<t>load_instruction = |
5043 |
</t> |
</t> |
5044 |
<t>/ SOLO SP sampler_channel SP boolean |
<t>/ SOLO SP sampler_channel SP boolean |
5045 |
</t> |
</t> |
5046 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
5047 |
|
</t> |
5048 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
5049 |
|
</t> |
5050 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
5051 |
|
</t> |
5052 |
</list> |
</list> |
5053 |
</t> |
</t> |
5054 |
<t>key_val_list = |
<t>key_val_list = |
5081 |
</t> |
</t> |
5082 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
5083 |
</t> |
</t> |
5084 |
<t>/ MIDI_INSTRUMENTS |
<t>/ MIDI_INSTRUMENTS SP midi_map |
5085 |
|
</t> |
5086 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
5087 |
|
</t> |
5088 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
5089 |
|
</t> |
5090 |
|
<t>/ FX_SENDS SP sampler_channel |
5091 |
</t> |
</t> |
5092 |
</list> |
</list> |
5093 |
</t> |
</t> |
5153 |
</t> |
</t> |
5154 |
</list> |
</list> |
5155 |
</t> |
</t> |
5156 |
<t>midi_bank_msb = |
<t>midi_map = |
5157 |
<list> |
<list> |
5158 |
<t>number |
<t>number |
5159 |
</t> |
</t> |
5160 |
</list> |
</list> |
5161 |
</t> |
</t> |
5162 |
<t>midi_bank_lsb = |
<t>midi_bank = |
5163 |
<list> |
<list> |
5164 |
<t>number |
<t>number |
5165 |
</t> |
</t> |
5171 |
</t> |
</t> |
5172 |
</list> |
</list> |
5173 |
</t> |
</t> |
5174 |
|
<t>midi_ctrl = |
5175 |
|
<list> |
5176 |
|
<t>number |
5177 |
|
</t> |
5178 |
|
</list> |
5179 |
|
</t> |
5180 |
<t>volume_value = |
<t>volume_value = |
5181 |
<list> |
<list> |
5182 |
<t>dotnum |
<t>dotnum |
5197 |
</t> |
</t> |
5198 |
</list> |
</list> |
5199 |
</t> |
</t> |
5200 |
|
<t>fx_send_id = |
5201 |
|
<list> |
5202 |
|
<t>number |
5203 |
|
</t> |
5204 |
|
</list> |
5205 |
|
</t> |
5206 |
<t>engine_name = |
<t>engine_name = |
5207 |
<list> |
<list> |
5208 |
<t>string |
<t>string |
5215 |
</t> |
</t> |
5216 |
</list> |
</list> |
5217 |
</t> |
</t> |
5218 |
|
<t>map_name = |
5219 |
|
<list> |
5220 |
|
<t>stringval |
5221 |
|
</t> |
5222 |
|
</list> |
5223 |
|
</t> |
5224 |
<t>entry_name = |
<t>entry_name = |
5225 |
<list> |
<list> |
5226 |
<t>stringval |
<t>stringval |
5227 |
</t> |
</t> |
5228 |
</list> |
</list> |
5229 |
</t> |
</t> |
5230 |
|
<t>fx_send_name = |
5231 |
|
<list> |
5232 |
|
<t>stringval |
5233 |
|
</t> |
5234 |
|
</list> |
5235 |
|
</t> |
5236 |
<t>param_val_list = |
<t>param_val_list = |
5237 |
<list> |
<list> |
5238 |
<t>param_val |
<t>param_val |
5260 |
<section title="Events" anchor="events"> |
<section title="Events" anchor="events"> |
5261 |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
5262 |
|
|
5263 |
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
5264 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
5265 |
|
back-end changes by issuing the following command:</t> |
5266 |
|
<t> |
5267 |
|
<list> |
5268 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
5269 |
|
</list> |
5270 |
|
</t> |
5271 |
|
<t>Server will start sending the following notification messages:</t> |
5272 |
|
<t> |
5273 |
|
<list> |
5274 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
5275 |
|
</list> |
5276 |
|
</t> |
5277 |
|
<t>where <devices> will be replaced by the new number |
5278 |
|
of audio output devices.</t> |
5279 |
|
</section> |
5280 |
|
|
5281 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
5282 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
5283 |
|
back-end by issuing the following command:</t> |
5284 |
|
<t> |
5285 |
|
<list> |
5286 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
5287 |
|
</list> |
5288 |
|
</t> |
5289 |
|
<t>Server will start sending the following notification messages:</t> |
5290 |
|
<t> |
5291 |
|
<list> |
5292 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
5293 |
|
</list> |
5294 |
|
</t> |
5295 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
5296 |
|
which settings has been changed. The front-end will have to send |
5297 |
|
the respective command to actually get the audio output device info. Because these messages |
5298 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5299 |
|
time events happening on the server, it is believed that an empty notification |
5300 |
|
message is sufficient here.</t> |
5301 |
|
</section> |
5302 |
|
|
5303 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
5304 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
5305 |
|
back-end changes by issuing the following command:</t> |
5306 |
|
<t> |
5307 |
|
<list> |
5308 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
5309 |
|
</list> |
5310 |
|
</t> |
5311 |
|
<t>Server will start sending the following notification messages:</t> |
5312 |
|
<t> |
5313 |
|
<list> |
5314 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
5315 |
|
</list> |
5316 |
|
</t> |
5317 |
|
<t>where <devices> will be replaced by the new number |
5318 |
|
of MIDI input devices.</t> |
5319 |
|
</section> |
5320 |
|
|
5321 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
5322 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
5323 |
|
back-end by issuing the following command:</t> |
5324 |
|
<t> |
5325 |
|
<list> |
5326 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
5327 |
|
</list> |
5328 |
|
</t> |
5329 |
|
<t>Server will start sending the following notification messages:</t> |
5330 |
|
<t> |
5331 |
|
<list> |
5332 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
5333 |
|
</list> |
5334 |
|
</t> |
5335 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
5336 |
|
which settings has been changed. The front-end will have to send |
5337 |
|
the respective command to actually get the MIDI input device info. Because these messages |
5338 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5339 |
|
time events happening on the server, it is believed that an empty notification |
5340 |
|
message is sufficient here.</t> |
5341 |
|
</section> |
5342 |
|
|
5343 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
5344 |
<t>Client may want to be notified when the total number of channels on the |
<t>Client may want to be notified when the total number of channels on the |
5345 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
5346 |
<t> |
<t> |
5417 |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
5418 |
</section> |
</section> |
5419 |
|
|
5420 |
<section title="Channel information changed" anchor="SUBSCRIBE INFO"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
5421 |
<t>Client may want to be notified when changes were made to sampler channels on the |
<t>Client may want to be notified when changes were made to sampler channels on the |
5422 |
back-end by issuing the following command:</t> |
back-end by issuing the following command:</t> |
5423 |
<t> |
<t> |
5457 |
all currently active voices.</t> |
all currently active voices.</t> |
5458 |
</section> |
</section> |
5459 |
|
|
5460 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
5461 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
5462 |
|
back-end changes by issuing the following command:</t> |
5463 |
|
<t> |
5464 |
|
<list> |
5465 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
5466 |
|
</list> |
5467 |
|
</t> |
5468 |
|
<t>Server will start sending the following notification messages:</t> |
5469 |
|
<t> |
5470 |
|
<list> |
5471 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
5472 |
|
</list> |
5473 |
|
</t> |
5474 |
|
<t>where <maps> will be replaced by the new number |
5475 |
|
of MIDI instrument maps.</t> |
5476 |
|
</section> |
5477 |
|
|
5478 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
5479 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
5480 |
|
back-end by issuing the following command:</t> |
5481 |
|
<t> |
5482 |
|
<list> |
5483 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
5484 |
|
</list> |
5485 |
|
</t> |
5486 |
|
<t>Server will start sending the following notification messages:</t> |
5487 |
|
<t> |
5488 |
|
<list> |
5489 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
5490 |
|
</list> |
5491 |
|
</t> |
5492 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5493 |
|
for which information changes occurred. The front-end will have to send |
5494 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
5495 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5496 |
|
time events happening on the server, it is believed that an empty notification |
5497 |
|
message is sufficient here.</t> |
5498 |
|
</section> |
5499 |
|
|
5500 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
5501 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
5502 |
|
back-end changes by issuing the following command:</t> |
5503 |
|
<t> |
5504 |
|
<list> |
5505 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
5506 |
|
</list> |
5507 |
|
</t> |
5508 |
|
<t>Server will start sending the following notification messages:</t> |
5509 |
|
<t> |
5510 |
|
<list> |
5511 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
5512 |
|
</list> |
5513 |
|
</t> |
5514 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
5515 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
5516 |
|
the new number of MIDI instruments in the specified map.</t> |
5517 |
|
</section> |
5518 |
|
|
5519 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
5520 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
5521 |
|
back-end by issuing the following command:</t> |
5522 |
|
<t> |
5523 |
|
<list> |
5524 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
5525 |
|
</list> |
5526 |
|
</t> |
5527 |
|
<t>Server will start sending the following notification messages:</t> |
5528 |
|
<t> |
5529 |
|
<list> |
5530 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
5531 |
|
</list> |
5532 |
|
</t> |
5533 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
5534 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
5535 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
5536 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
5537 |
|
will be triggered by LSCP commands issued by other clients rather than real |
5538 |
|
time events happening on the server, it is believed that an empty notification |
5539 |
|
message is sufficient here.</t> |
5540 |
|
</section> |
5541 |
|
|
5542 |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
5543 |
<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 |
5544 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |