/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Diff of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 944 by schoenebeck, Sun Nov 26 16:29:57 2006 UTC revision 1109 by iliev, Thu Mar 22 20:55:17 2007 UTC
# Line 11  Line 11 
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.
# Line 31  Schoenebeck'> Line 34  Schoenebeck'>
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="March" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 2552  Schoenebeck'> Line 2555  Schoenebeck'>
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 &lt; 1.0 means attenuation and a value >
2559                                              1.0 means amplification)</t>                                              1.0 means amplification)</t>
2560                                          </list>                                          </list>
2561                                      </t>                                      </t>
# Line 2571  Schoenebeck'> Line 2574  Schoenebeck'>
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>
# Line 2593  Schoenebeck'> Line 2604  Schoenebeck'>
2604                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
2605                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
2606                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
2607                                <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2608                                <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
2609                                <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
2610                                <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
2611                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
2612                          </list>                          </list>
2613                      </t>                      </t>
# Line 2753  Schoenebeck'> Line 2768  Schoenebeck'>
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
# Line 3144  Schoenebeck'> Line 3159  Schoenebeck'>
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 &lt;sampler-channel&gt; &lt;map&gt;</t>
3168                            </list>
3169                        </t>
3170                        <t>Where &lt;sampler-channel&gt; 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                        &lt;map&gt; 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 &lt;map&gt; 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:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3236                            </list>
3237                        </t>
3238                        <t>Where &lt;sampler-channel&gt; 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, &lt;midi-ctrl&gt;
3242                        is a number between 0..127 defining the MIDI controller which can alter the
3243                        effect send level and &lt;name&gt; 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[&lt;fx-send-id&gt;]" -
3268                                    <list>
3269                                        <t>in case a new effect send could be added to the
3270                                        sampler channel, where &lt;fx-send-id&gt; reflects the
3271                                        unique ID of the newly created effect send entity</t>
3272                                    </list>
3273                                </t>
3274                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3304                            </list>
3305                        </t>
3306                        <t>Where &lt;sampler-channel&gt; 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                        &lt;fx-send-id&gt; 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:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;sampler-channel&gt;</t>
3346                            </list>
3347                        </t>
3348                        <t>Where &lt;sampler-channel&gt; 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 &lt;sampler-channel&gt;</t>
3375                            </list>
3376                        </t>
3377                        <t>Where &lt;sampler-channel&gt; 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 &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3411                            </list>
3412                        </t>
3413                        <t>Where &lt;sampler-channel&gt; 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                        &lt;fx-send-id&gt; 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 &lt;CRLF&gt; separated list.
3425                                Each answer line begins with the settings category name
3426                                followed by a colon and then a space character &lt;SP&gt; 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 &lt; 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>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3475                                <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3476                                <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3477                                <t>&nbsp;&nbsp;&nbsp;"."</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 &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;</t>
3488                            </list>
3489                        </t>
3490                        <t>Where &lt;sampler-chan&gt; 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                        &lt;fx-send-id&gt; 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                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3497                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3498                        the audio channel of the selected audio output device where &lt;audio-src&gt;
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:&lt;warning-code&gt;:&lt;warning-message&gt;" -
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:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3548                            </list>
3549                        </t>
3550                        <t>Where &lt;sampler-chan&gt; 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                        &lt;fx-send-id&gt; 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                        &lt;midi-ctrl&gt; 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:&lt;warning-code&gt;:&lt;warning-message&gt;" -
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:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3596                            </list>
3597                        </t>
3598                        <t>Where &lt;sampler-chan&gt; 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                        &lt;fx-send-id&gt; 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                        &lt;volume&gt; 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:&lt;warning-code&gt;:&lt;warning-message&gt;" -
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:&lt;error-code&gt;:&lt;error-message&gt;" -
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>
# Line 3433  Schoenebeck'> Line 3925  Schoenebeck'>
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 &lt;volume&gt;</t>
3957                            </list>
3958                        </t>
3959                       <t>Where &lt;volume&gt; 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:&lt;warning-code&gt;:&lt;warning-message&gt;" -
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:&lt;error-code&gt;:&lt;error-message&gt;" -
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
# Line 3455  Schoenebeck'> Line 4014  Schoenebeck'>
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 [&lt;name&gt;]</t>
4023                            </list>
4024                        </t>
4025                        <t>Where &lt;name&gt; 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[&lt;map&gt;]" -
4033                                    <list>
4034                                        <t>in case a new MIDI instrument map could
4035                                        be added, where &lt;map&gt; reflects the
4036                                        unique ID of the newly created MIDI
4037                                        instrument map</t>
4038                                    </list>
4039                                </t>
4040                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;map&gt;</t>
4076                            </list>
4077                        </t>
4078                        <t>Where &lt;map&gt; 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:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;map&gt;</t>
4177                            </list>
4178                        </t>
4179                        <t>Where &lt;map&gt; 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 &lt;CRLF&gt; separated list.
4188                                Each answer line begins with the settings category name
4189                                followed by a colon and then a space character &lt;SP&gt; 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>&nbsp;&nbsp;&nbsp;"."</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 &lt;map&gt; &lt;name&gt;</t>
4223                            </list>
4224                        </t>
4225                        <t>Where &lt;map&gt; is the numerical ID of the map and
4226                        &lt;name&gt; 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:&lt;error-code&gt;:&lt;error-message&gt;" -
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 &lt;midi_bank_msb&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4261                              &lt;midi_bank_lsb&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4262                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4263                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
4264                          </list>                          </list>
4265                      </t>                      </t>
4266                      <t>Where &lt;midi_bank_msb&gt; is an integer value between                      <t>Where &lt;map&gt; is the numeric ID of the map to alter,
4267                      0..127 reflecting the MIDI bank select MSB (coarse) index,                      &lt;midi_bank&gt; is an integer value between
4268                      &lt;midi_bank_lsb&gt; an integer value between 0..127 reflecting                      0..16383 reflecting the MIDI bank select index,
4269                      the MIDI bank select LSB (fine) index, &lt;midi_prog&gt; an                      &lt;midi_prog&gt; an
4270                      integer value between 0..127 reflecting the MIDI program change                      integer value between 0..127 reflecting the MIDI program change
4271                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; 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), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4274                      of the instrument's file to be deployed (encapsulated into apostrophes), &lt;instrument_index&gt; the index (integer value) of the instrument                      of the instrument's file to be deployed (encapsulated into apostrophes),
4275                        &lt;instrument_index&gt; the index (integer value) of the instrument
4276                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; 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 &lt; 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
# Line 3513  Schoenebeck'> Line 4310  Schoenebeck'>
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
# Line 3563  Schoenebeck'> Line 4360  Schoenebeck'>
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>
# Line 3582  Schoenebeck'> Line 4385  Schoenebeck'>
4385                              </t>                              </t>
4386                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4387                                  <list>                                  <list>
4388                                      <t>when the given engine does not exist or a value                                      <t>when the given map or engine does not exist or a value
4389                                      is out of range</t>                                      is out of range</t>
4390                                  </list>                                  </list>
4391                              </t>                              </t>
# Line 3592  Schoenebeck'> Line 4395  Schoenebeck'>
4395                      <t>Examples:</t>                      <t>Examples:</t>
4396                      <t>                      <t>
4397                          <list>                          <list>
4398                              <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>
4399                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4400                          </list>                          </list>
4401                      </t>                      </t>
4402                      <t>                      <t>
4403                          <list>                          <list>
4404                              <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>
4405                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4406                          </list>                          </list>
4407                      </t>                      </t>
# Line 3606  Schoenebeck'> Line 4409  Schoenebeck'>
4409                          <list>                          <list>
4410                              <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>
4411                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4412                              <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>
4413                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4414                          </list>                          </list>
4415                      </t>                      </t>
4416                      <t>                      <t>
4417                          <list>                          <list>
4418                              <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 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>
4422                  </section>                  </section>
4423    
4424                  <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">
4425                      <t>The front-end can query the amount of currently existing MIDI                      <t>The front-end can query the amount of currently existing
4426                      instrument map entries by sending the following                      entries in a MIDI instrument map by sending the following
4427                        command:</t>
4428                        <t>
4429                            <list>
4430                                <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
4431                            </list>
4432                        </t>
4433                        <t>The front-end can query the amount of currently existing
4434                        entries in all MIDI instrument maps by sending the following
4435                      command:</t>                      command:</t>
4436                      <t>                      <t>
4437                          <list>                          <list>
4438                              <t>GET MIDI_INSTRUMENTS</t>                              <t>GET MIDI_INSTRUMENTS ALL</t>
4439                          </list>                          </list>
4440                      </t>                      </t>
4441                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4442                      <t>                      <t>
4443                          <list>                          <list>
4444                              <t>LinuxSampler will answer by sending the current number of                              <t>The sampler will answer by sending the current number of
4445                              entries in the sampler's MIDI instrument map.</t>                              entries in the MIDI instrument map(s).</t>
4446                          </list>                          </list>
4447                      </t>                      </t>
4448    
4449                      <t>Example:</t>                      <t>Example:</t>
4450                      <t>                      <t>
4451                          <list>                          <list>
4452                              <t>C: "GET MIDI_INSTRUMENTS"</t>                              <t>C: "GET MIDI_INSTRUMENTS 0"</t>
4453                              <t>S: "634"</t>                              <t>S: "234"</t>
4454                            </list>
4455                        </t>
4456                        <t>
4457                            <list>
4458                                <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
4459                                <t>S: "954"</t>
4460                          </list>                          </list>
4461                      </t>                      </t>
4462                  </section>                  </section>
4463    
4464                  <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">
4465                      <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
4466                      instrument map entries by sending the following command:</t>                      entries in a certain MIDI instrument map by sending the following
4467                        command:</t>
4468                      <t>                      <t>
4469                          <list>                          <list>
4470                              <t>LIST MIDI_INSTRUMENTS</t>                              <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
4471                          </list>                          </list>
4472                      </t>                      </t>
4473                        <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
4474                        <t>The front-end can query a list of all currently existing
4475                        entries of all MIDI instrument maps by sending the following
4476                        command:</t>
4477                        <t>
4478                            <list>
4479                                <t>LIST MIDI_INSTRUMENTS ALL</t>
4480                            </list>
4481                        </t>
4482    
4483                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4484                      <t>                      <t>
4485                          <list>                          <list>
4486                              <t>LinuxSampler will answer by sending a comma separated                              <t>The sampler will answer by sending a comma separated
4487                              list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) -                              list of map ID - MIDI bank - MIDI program triples, where
4488                              MIDI program triples, where each triple is encapsulated                              each triple is encapsulated into curly braces. The
4489                              into curly braces. The list is returned in one single                              list is returned in one single line. Each triple
4490                              line. Each triple just reflects the key of the respective                              just reflects the key of the respective map entry,
4491                              map entry, thus subsequent                              thus subsequent
4492                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4493                              command(s) are necessary to retrieve detailed informations                              command(s) are necessary to retrieve detailed informations
4494                              about each entry.</t>                              about each entry.</t>
# Line 3670  Schoenebeck'> Line 4498  Schoenebeck'>
4498                      <t>Example:</t>                      <t>Example:</t>
4499                      <t>                      <t>
4500                          <list>                          <list>
4501                              <t>C: "LIST MIDI_INSTRUMENTS"</t>                              <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
4502                              <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>
4503                          </list>                          </list>
4504                      </t>                      </t>
4505                  </section>                  </section>
4506    
4507                  <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">
4508                      <t>The front-end can delete an entry from the MIDI instrument                      <t>The front-end can delete an entry from a MIDI instrument
4509                      map by sending the following command:</t>                      map by sending the following command:</t>
4510                      <t>                      <t>
4511                          <list>                          <list>
4512                              <t>UNMAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>                              <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4513                          </list>                          </list>
4514                      </t>                      </t>
4515                      <t>                      <t>
4516                      Where &lt;midi_bank_msb&gt; is an integer value between 0..127                      Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4517                      reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;                      &lt;midi_bank&gt; is an integer value between 0..16383
4518                      an integer value between 0..127 reflecting the MIDI bank LSB                      reflecting the MIDI bank value and
4519                      (fine) value and &lt;midi_prog&gt; an integer value between                      &lt;midi_prog&gt; an integer value between
4520                      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
4521                      index triple.                      index triple.
4522                      </t>                      </t>
4523    
# Line 3712  Schoenebeck'> Line 4540  Schoenebeck'>
4540                      <t>Example:</t>                      <t>Example:</t>
4541                      <t>                      <t>
4542                          <list>                          <list>
4543                              <t>C: "UNMAP MIDI_INSTRUMENT 2 40 127"</t>                              <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
4544                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4545                          </list>                          </list>
4546                      </t>                      </t>
# Line 3723  Schoenebeck'> Line 4551  Schoenebeck'>
4551                      instrument map entry by sending the following command:</t>                      instrument map entry by sending the following command:</t>
4552                      <t>                      <t>
4553                          <list>                          <list>
4554                              <t>GET MIDI_INSTRUMENT INFO &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>                              <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4555                          </list>                          </list>
4556                      </t>                      </t>
4557                      <t>                      <t>
4558                      Where &lt;midi_bank_msb&gt; is an integer value between 0..127                      Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4559                      reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;                      &lt;midi_bank&gt; is an integer value between 0..16383
4560                      an integer value between 0..127 reflecting the MIDI bank LSB                      reflecting the MIDI bank value, &lt;midi_bank&gt;
4561                      (fine) value and &lt;midi_prog&gt; an integer value between                      and &lt;midi_prog&gt; an integer value between
4562                      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
4563                      index triple.                      index triple.
4564                      </t>                      </t>
4565    
# Line 3786  Schoenebeck'> Line 4614  Schoenebeck'>
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 &lt; 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>
# Line 3797  Schoenebeck'> Line 4625  Schoenebeck'>
4625                      <t>Example:</t>                      <t>Example:</t>
4626                      <t>                      <t>
4627                          <list>                          <list>
4628                              <t>C: "GET MIDI_INSTRUMENT INFO 3 45 120"</t>                              <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
4629                              <t>S: "NAME: Drums for Foo Song"</t>                              <t>S: "NAME: Drums for Foo Song"</t>
4630                              <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>                              <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
4631                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
# Line 3811  Schoenebeck'> Line 4639  Schoenebeck'>
4639                  </section>                  </section>
4640    
4641                  <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">                  <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
4642                      <t>The front-end can clear the whole MIDI instrument map, that                      <t>The front-end can clear a whole MIDI instrument map, that
4643                      is delete all entries by sending the following command:</t>                      is delete all its entries by sending the following command:</t>
4644                        <t>
4645                            <list>
4646                                <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
4647                            </list>
4648                        </t>
4649                        <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
4650                        <t>The front-end can clear all MIDI instrument maps, that
4651                        is delete all entries of all maps by sending the following
4652                        command:</t>
4653                      <t>                      <t>
4654                          <list>                          <list>
4655                              <t>CLEAR MIDI_INSTRUMENTS</t>                              <t>CLEAR MIDI_INSTRUMENTS ALL</t>
4656                          </list>                          </list>
4657                      </t>                      </t>
4658                        <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
4659                        maps, only their entries, thus the map's settings like
4660                        custom name will be preservevd.</t>
4661    
4662                     <t>Possible Answers:</t>                     <t>Possible Answers:</t>
4663                      <t>                      <t>
# Line 3830  Schoenebeck'> Line 4670  Schoenebeck'>
4670                          </list>                          </list>
4671                      </t>                      </t>
4672    
4673                      <t>Example:</t>                      <t>Examples:</t>
4674                      <t>                      <t>
4675                         <list>                         <list>
4676                              <t>C: "CLEAR MIDI_INSTRUMENTS"</t>                              <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
4677                                <t>S: "OK"</t>
4678                            </list>
4679                        </t>
4680                        <t>
4681                           <list>
4682                                <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
4683                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4684                          </list>                          </list>
4685                      </t>                      </t>
# Line 3891  Schoenebeck'> Line 4737  Schoenebeck'>
4737  </t>  </t>
4738  <t>command =  <t>command =
4739          <list>          <list>
4740                  <t>ADD SP CHANNEL                  <t>ADD SP add_instruction
4741                  </t>                  </t>
4742                  <t>/ MAP SP map_instruction                  <t>/ MAP SP map_instruction
4743                  </t>                  </t>
# Line 3908  Schoenebeck'> Line 4754  Schoenebeck'>
4754                  <t>/ LOAD SP load_instruction                  <t>/ LOAD SP load_instruction
4755                  </t>                  </t>
4756                  <t>/ REMOVE SP remove_instruction                  <t>/ REMOVE SP remove_instruction
   
4757                  </t>                  </t>
4758                  <t>/ SET SP set_instruction                  <t>/ SET SP set_instruction
4759                  </t>                  </t>
# Line 3928  Schoenebeck'> Line 4773  Schoenebeck'>
4773                  </t>                  </t>
4774          </list>          </list>
4775  </t>  </t>
4776    <t>add_instruction =
4777            <list>
4778                    <t>CHANNEL
4779                    </t>
4780                    <t>/ MIDI_INSTRUMENT_MAP
4781                    </t>
4782                    <t>/ MIDI_INSTRUMENT_MAP SP map_name
4783                    </t>
4784            </list>
4785    </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>
# Line 3940  Schoenebeck'> Line 4803  Schoenebeck'>
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>
# Line 3958  Schoenebeck'> Line 4843  Schoenebeck'>
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_bank_msb SP midi_bank_lsb 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_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 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_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 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_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 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>
4878  <t>unmap_instruction =  <t>unmap_instruction =
4879          <list>          <list>
4880                  <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
4881                  </t>                  </t>
4882          </list>          </list>
4883  </t>  </t>
# Line 3986  Schoenebeck'> Line 4885  Schoenebeck'>
4885          <list>          <list>
4886                  <t>CHANNEL SP sampler_channel                  <t>CHANNEL SP sampler_channel
4887                  </t>                  </t>
4888                    <t>/ MIDI_INSTRUMENT_MAP SP midi_map
4889                    </t>
4890                    <t>/ MIDI_INSTRUMENT_MAP SP ALL
4891                    </t>
4892          </list>          </list>
4893  </t>  </t>
4894  <t>get_instruction =  <t>get_instruction =
# Line 4042  Schoenebeck'> Line 4945  Schoenebeck'>
4945                  </t>                  </t>
4946                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
4947                  </t>                  </t>
4948                  <t>/ MIDI_INSTRUMENTS                  <t>/ MIDI_INSTRUMENTS SP midi_map
4949                    </t>
4950                    <t>/ MIDI_INSTRUMENTS SP ALL
4951                  </t>                  </t>
4952                  <t>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog                  <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4953                    </t>
4954                    <t>/ MIDI_INSTRUMENT_MAPS
4955                    </t>
4956                    <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4957                    </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>                  </t>
4964          </list>          </list>
4965  </t>  </t>
# Line 4060  Schoenebeck'> Line 4975  Schoenebeck'>
4975                  </t>                  </t>
4976                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
4977                  </t>                  </t>
4978                    <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
4979                    </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 =
# Line 4074  Schoenebeck'> Line 4999  Schoenebeck'>
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 =
# Line 4084  Schoenebeck'> Line 5013  Schoenebeck'>
5013  </t>  </t>
5014  <t>clear_instruction =  <t>clear_instruction =
5015          <list>          <list>
5016                  <t>MIDI_INSTRUMENTS                  <t>MIDI_INSTRUMENTS SP midi_map
5017                    </t>
5018                    <t>/ MIDI_INSTRUMENTS SP ALL
5019                  </t>                  </t>
5020          </list>          </list>
5021  </t>  </t>
# Line 4094  Schoenebeck'> Line 5025  Schoenebeck'>
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 =
# Line 4128  Schoenebeck'> Line 5061  Schoenebeck'>
5061                  </t>                  </t>
5062                  <t>/ SOLO SP sampler_channel SP boolean                  <t>/ SOLO SP sampler_channel SP boolean
5063                  </t>                  </t>
5064                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
5065                    </t>
5066                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
5067                    </t>
5068                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
5069                    </t>
5070            </list>
5071    </t>
5072    <t>modal_arg =
5073            <list>
5074                    <t>/* epsilon (empty argument) */
5075                    </t>
5076                    <t>/ NON_MODAL SP
5077                    </t>
5078          </list>          </list>
5079  </t>  </t>
5080  <t>key_val_list =  <t>key_val_list =
# Line 4160  Schoenebeck'> Line 5107  Schoenebeck'>
5107                  </t>                  </t>
5108                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
5109                  </t>                  </t>
5110                  <t>/ MIDI_INSTRUMENTS                  <t>/ MIDI_INSTRUMENTS SP midi_map
5111                    </t>
5112                    <t>/ MIDI_INSTRUMENTS SP ALL
5113                    </t>
5114                    <t>/ MIDI_INSTRUMENT_MAPS
5115                    </t>
5116                    <t>/ FX_SENDS SP sampler_channel
5117                  </t>                  </t>
5118          </list>          </list>
5119  </t>  </t>
# Line 4226  Schoenebeck'> Line 5179  Schoenebeck'>
5179                  </t>                  </t>
5180          </list>          </list>
5181  </t>  </t>
5182  <t>midi_bank_msb =  <t>midi_map =
5183          <list>          <list>
5184                  <t>number                  <t>number
5185                  </t>                  </t>
5186          </list>          </list>
5187  </t>  </t>
5188  <t>midi_bank_lsb =  <t>midi_bank =
5189          <list>          <list>
5190                  <t>number                  <t>number
5191                  </t>                  </t>
# Line 4244  Schoenebeck'> Line 5197  Schoenebeck'>
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
# Line 4264  Schoenebeck'> Line 5223  Schoenebeck'>
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
# Line 4276  Schoenebeck'> Line 5241  Schoenebeck'>
5241                  </t>                  </t>
5242          </list>          </list>
5243  </t>  </t>
5244    <t>map_name =
5245            <list>
5246                    <t>stringval
5247                    </t>
5248            </list>
5249    </t>
5250  <t>entry_name =  <t>entry_name =
5251          <list>          <list>
5252                  <t>stringval                  <t>stringval
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
# Line 4309  Schoenebeck'> Line 5286  Schoenebeck'>
5286          <section title="Events" anchor="events">          <section title="Events" anchor="events">
5287              <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>
5288    
5289              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
5290                    <t>Client may want to be notified when the total number of audio output devices on the
5291                    back-end changes by issuing the following command:</t>
5292                    <t>
5293                        <list>
5294                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
5295                        </list>
5296                    </t>
5297                    <t>Server will start sending the following notification messages:</t>
5298                    <t>
5299                        <list>
5300                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
5301                        </list>
5302                    </t>
5303                    <t>where &lt;devices&gt; will be replaced by the new number
5304                    of audio output devices.</t>
5305                </section>
5306    
5307                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
5308                    <t>Client may want to be notified when changes were made to audio output devices on the
5309                    back-end by issuing the following command:</t>
5310                    <t>
5311                        <list>
5312                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
5313                        </list>
5314                    </t>
5315                    <t>Server will start sending the following notification messages:</t>
5316                    <t>
5317                        <list>
5318                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
5319                        </list>
5320                    </t>
5321                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
5322                    which settings has been changed. The front-end will have to send
5323                    the respective command to actually get the audio output device info. Because these messages
5324                    will be triggered by LSCP commands issued by other clients rather than real
5325                    time events happening on the server, it is believed that an empty notification
5326                    message is sufficient here.</t>
5327                </section>
5328    
5329                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
5330                    <t>Client may want to be notified when the total number of MIDI input devices on the
5331                    back-end changes by issuing the following command:</t>
5332                    <t>
5333                        <list>
5334                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
5335                        </list>
5336                    </t>
5337                    <t>Server will start sending the following notification messages:</t>
5338                    <t>
5339                        <list>
5340                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
5341                        </list>
5342                    </t>
5343                    <t>where &lt;devices&gt; will be replaced by the new number
5344                    of MIDI input devices.</t>
5345                </section>
5346    
5347                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
5348                    <t>Client may want to be notified when changes were made to MIDI input devices on the
5349                    back-end by issuing the following command:</t>
5350                    <t>
5351                        <list>
5352                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
5353                        </list>
5354                    </t>
5355                    <t>Server will start sending the following notification messages:</t>
5356                    <t>
5357                        <list>
5358                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
5359                        </list>
5360                    </t>
5361                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
5362                    which settings has been changed. The front-end will have to send
5363                    the respective command to actually get the MIDI input device info. Because these messages
5364                    will be triggered by LSCP commands issued by other clients rather than real
5365                    time events happening on the server, it is believed that an empty notification
5366                    message is sufficient here.</t>
5367                </section>
5368    
5369                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
5370                  <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
5371                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
5372                  <t>                  <t>
# Line 4338  Schoenebeck'> Line 5395  Schoenebeck'>
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:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
5399                      </list>                      </list>
5400                  </t>                  </t>
5401                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
# Line 4386  Schoenebeck'> Line 5443  Schoenebeck'>
5443                  "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>
5444              </section>              </section>
5445    
5446              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
5447                  <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
5448                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
5449                  <t>                  <t>
# Line 4408  Schoenebeck'> Line 5465  Schoenebeck'>
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:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
5480                        </list>
5481                    </t>
5482                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5483                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; 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:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
5499                        </list>
5500                    </t>
5501                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5502                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; 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>
# Line 4419  Schoenebeck'> Line 5514  Schoenebeck'>
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:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
5518                      </list>                      </list>
5519                  </t>                  </t>
5520                  <t>where &lt;voices&gt; will be replaced by the new number of                  <t>where &lt;voices&gt; will be replaced by the new number of
5521                  all currently active voices.</t>                  all currently active voices.</t>
5522              </section>              </section>
5523    
5524                <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
5525                    <t>Client may want to be notified when the number of MIDI instrument maps on the
5526                    back-end changes by issuing the following command:</t>
5527                    <t>
5528                        <list>
5529                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
5530                        </list>
5531                    </t>
5532                    <t>Server will start sending the following notification messages:</t>
5533                    <t>
5534                        <list>
5535                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
5536                        </list>
5537                    </t>
5538                    <t>where &lt;maps&gt; will be replaced by the new number
5539                    of MIDI instrument maps.</t>
5540                </section>
5541    
5542                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
5543                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
5544                    back-end by issuing the following command:</t>
5545                    <t>
5546                        <list>
5547                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
5548                        </list>
5549                    </t>
5550                    <t>Server will start sending the following notification messages:</t>
5551                    <t>
5552                        <list>
5553                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
5554                        </list>
5555                    </t>
5556                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5557                    for which information changes occurred. The front-end will have to send
5558                    the respective command to actually get the MIDI instrument map info. Because these messages
5559                    will be triggered by LSCP commands issued by other clients rather than real
5560                    time events happening on the server, it is believed that an empty notification
5561                    message is sufficient here.</t>
5562                </section>
5563    
5564                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
5565                    <t>Client may want to be notified when the number of MIDI instrument maps on the
5566                    back-end changes by issuing the following command:</t>
5567                    <t>
5568                        <list>
5569                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
5570                        </list>
5571                    </t>
5572                    <t>Server will start sending the following notification messages:</t>
5573                    <t>
5574                        <list>
5575                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
5576                        </list>
5577                    </t>
5578                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
5579                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
5580                    the new number of MIDI instruments in the specified map.</t>
5581                </section>
5582    
5583                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
5584                    <t>Client may want to be notified when changes were made to MIDI instruments on the
5585                    back-end by issuing the following command:</t>
5586                    <t>
5587                        <list>
5588                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
5589                        </list>
5590                    </t>
5591                    <t>Server will start sending the following notification messages:</t>
5592                    <t>
5593                        <list>
5594                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
5595                        </list>
5596                    </t>
5597                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5598                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
5599                    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
5601                    will be triggered by LSCP commands issued by other clients rather than real
5602                    time events happening on the server, it is believed that an empty notification
5603                    message is sufficient here.</t>
5604                </section>
5605    
5606                <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 &lt;volume&gt;" - Notifies that the
5618                            golbal volume of the sampler is changed, where &lt;volume&gt; 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">              <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>
Legend:
Removed from v.944  
changed lines
  Added in v.1109
  ViewVC Help
Powered by ViewVC