/[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 981 by iliev, Sun Dec 17 22:35:01 2006 UTC revision 1135 by iliev, Thu Mar 29 09:40:45 2007 UTC
# Line 34  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="December" year="2006"/>          <date month="March" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 2555  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 3227  Schoenebeck'> Line 3227  Schoenebeck'>
3227                      </t>                      </t>
3228                  </section>                  </section>
3229    
3230                    <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3231                        <t>The front-end can create an additional effect send on a specific sampler channel
3232                        by sending the following command:</t>
3233                        <t>
3234                            <list>
3235                                <t>CREATE FX_SEND &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="Changing effect send's name" anchor="SET FX_SEND NAME">
3483                        <t>The front-end can alter the current name of an effect
3484                        send entity by sending the following command:</t>
3485                        <t>
3486                            <list>
3487                                <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&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 and
3496                        &lt;name&gt; is the new name of the effect send entity, which
3497                        does not have to be unique.</t>
3498    
3499                        <t>Possible Answers:</t>
3500                        <t>
3501                            <list>
3502                                <t>"OK" -
3503                                    <list>
3504                                        <t>on success</t>
3505                                    </list>
3506                                </t>
3507                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3508                                    <list>
3509                                        <t>in case it failed, providing an appropriate error code and error message</t>
3510                                    </list>
3511                                </t>
3512                            </list>
3513                        </t>
3514                        <t>Example:</t>
3515                        <t>
3516                            <list>
3517                                <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3518                                <t>S: "OK"</t>
3519                            </list>
3520                        </t>
3521                    </section>
3522    
3523                    <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3524                        <t>The front-end can alter the destination of an effect send's audio channel on a specific
3525                        sampler channel by sending the following command:</t>
3526                        <t>
3527                            <list>
3528                                <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>
3529                            </list>
3530                        </t>
3531                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3532                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3533                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3534                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3535                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3536                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3537                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3538                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3539                        the audio channel of the selected audio output device where &lt;audio-src&gt;
3540                        should be routed to.</t>
3541    
3542                        <t>Note that effect sends can only route audio to the same audio output
3543                        device as assigned to the effect send's sampler channel. Also note that an
3544                        effect send entity does always have exactly as much audio channels as its
3545                        sampler channel. So if the sampler channel is stereo, the effect send does
3546                        have two audio channels as well. Also keep in mind that the amount of audio
3547                        channels on a sampler channel might be dependant not only to the deployed
3548                        sampler engine on the sampler channel, but also dependant to the instrument
3549                        currently loaded. However you can (effectively) turn an i.e. stereo effect
3550                        send into a mono one by simply altering its audio routing appropriately.</t>
3551    
3552                        <t>Possible Answers:</t>
3553                        <t>
3554                            <list>
3555                                <t>"OK" -
3556                                    <list>
3557                                        <t>on success</t>
3558                                    </list>
3559                                </t>
3560                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3561                                    <list>
3562                                        <t>if audio output channel was set, but there are noteworthy
3563                                        issue(s) related, providing an appropriate warning code and
3564                                        warning message</t>
3565                                    </list>
3566                                </t>
3567                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3568                                    <list>
3569                                        <t>in case it failed, providing an appropriate error code and error message</t>
3570                                    </list>
3571                                </t>
3572                            </list>
3573                        </t>
3574                        <t>Example:</t>
3575                        <t>
3576                            <list>
3577                                <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3578                                <t>S: "OK"</t>
3579                            </list>
3580                        </t>
3581                    </section>
3582    
3583                    <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3584                        <t>The front-end can alter the MIDI controller of an effect
3585                        send entity by sending the following command:</t>
3586                        <t>
3587                            <list>
3588                                <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3589                            </list>
3590                        </t>
3591                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3592                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3593                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3594                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3595                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3596                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3597                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3598                        able to modify the effect send's send level.</t>
3599    
3600                        <t>Possible Answers:</t>
3601                        <t>
3602                            <list>
3603                                <t>"OK" -
3604                                    <list>
3605                                        <t>on success</t>
3606                                    </list>
3607                                </t>
3608                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3609                                    <list>
3610                                        <t>if MIDI controller was set, but there are noteworthy
3611                                        issue(s) related, providing an appropriate warning code and
3612                                        warning message</t>
3613                                    </list>
3614                                </t>
3615                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3616                                    <list>
3617                                        <t>in case it failed, providing an appropriate error code and error message</t>
3618                                    </list>
3619                                </t>
3620                            </list>
3621                        </t>
3622                        <t>Example:</t>
3623                        <t>
3624                            <list>
3625                                <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3626                                <t>S: "OK"</t>
3627                            </list>
3628                        </t>
3629                    </section>
3630    
3631                    <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3632                        <t>The front-end can alter the current send level of an effect
3633                        send entity by sending the following command:</t>
3634                        <t>
3635                            <list>
3636                                <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3637                            </list>
3638                        </t>
3639                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3640                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3641                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3642                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3643                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3644                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3645                        &lt;volume&gt; is an optionally dotted positive number (a value
3646                        smaller than 1.0 means attenuation, whereas a value greater than
3647                        1.0 means amplification) reflecting the new send level.</t>
3648    
3649                        <t>Possible Answers:</t>
3650                        <t>
3651                            <list>
3652                                <t>"OK" -
3653                                    <list>
3654                                        <t>on success</t>
3655                                    </list>
3656                                </t>
3657                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3658                                    <list>
3659                                        <t>if new send level was set, but there are noteworthy
3660                                        issue(s) related, providing an appropriate warning code and
3661                                        warning message</t>
3662                                    </list>
3663                                </t>
3664                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3665                                    <list>
3666                                        <t>in case it failed, providing an appropriate error code and error message</t>
3667                                    </list>
3668                                </t>
3669                            </list>
3670                        </t>
3671                        <t>Example:</t>
3672                        <t>
3673                            <list>
3674                                <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3675                                <t>S: "OK"</t>
3676                            </list>
3677                        </t>
3678                    </section>
3679    
3680                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3681                      <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>
3682                      <t>                      <t>
# Line 3516  Schoenebeck'> Line 3966  Schoenebeck'>
3966                      <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.
3967                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
3968                  </section>                  </section>
3969    
3970                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
3971                        <t>The client can ask for the current global sampler-wide volume
3972                        attenuation by sending the following command:</t>
3973                        <t>
3974                            <list>
3975                                <t>GET VOLUME</t>
3976                            </list>
3977                        </t>
3978                        <t>Possible Answers:</t>
3979                        <t>
3980                            <list>
3981                                <t>The sampler will always answer by returning the optional
3982                                dotted floating point coefficient, reflecting the current
3983                                global volume attenuation.
3984                                </t>
3985                            </list>
3986                        </t>
3987                        <t>Note: it is up to the respective sampler engine whether to obey
3988                        that global volume parameter or not, but in general all engines SHOULD
3989                        use this parameter.</t>
3990                    </section>
3991    
3992                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
3993                        <t>The client can alter the current global sampler-wide volume
3994                        attenuation by sending the following command:</t>
3995                        <t>
3996                            <list>
3997                                <t>SET VOLUME &lt;volume&gt;</t>
3998                            </list>
3999                        </t>
4000                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
4001                       floating point value, reflecting the new global volume parameter.
4002                       This value might usually be in the range between 0.0 and 1.0, that
4003                       is for attenuating the overall volume.</t>
4004    
4005                        <t>Possible Answers:</t>
4006                        <t>
4007                            <list>
4008                                <t>"OK" -
4009                                    <list>
4010                                        <t>on success</t>
4011                                    </list>
4012                                </t>
4013                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4014                                    <list>
4015                                        <t>if the global volume was set, but there are noteworthy
4016                                        issue(s) related, providing an appropriate warning code and
4017                                        warning message</t>
4018                                    </list>
4019                                </t>
4020                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4021                                    <list>
4022                                        <t>in case it failed, providing an appropriate error code and error message</t>
4023                                    </list>
4024                                </t>
4025                            </list>
4026                        </t>
4027                    </section>
4028              </section>              </section>
4029    
4030    
# Line 3730  Schoenebeck'> Line 4239  Schoenebeck'>
4239                                              which does not have to be unique</t>                                              which does not have to be unique</t>
4240                                          </list>                                          </list>
4241                                      </t>                                      </t>
4242                                        <t>DEFAULT -
4243                                            <list>
4244                                                <t>either true or false,
4245                                                defines whether this map is the default map</t>
4246                                            </list>
4247                                        </t>
4248                                  </list>                                  </list>
4249                              </t>                              </t>
4250                          </list>                          </list>
# Line 3789  Schoenebeck'> Line 4304  Schoenebeck'>
4304                      command:</t>                      command:</t>
4305                      <t>                      <t>
4306                          <list>                          <list>
4307                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4308                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4309                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4310                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
# Line 3807  Schoenebeck'> Line 4322  Schoenebeck'>
4322                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4323                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4324                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
4325                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
4326                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
4327                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
4328                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 3842  Schoenebeck'> Line 4357  Schoenebeck'>
4357                              <t>"PERSISTENT" -                              <t>"PERSISTENT" -
4358                                  <list>                                  <list>
4359                                      <t>The instrument will immediately be loaded                                      <t>The instrument will immediately be loaded
4360                                      into memory in the background when this mapping                                      into memory when this mapping
4361                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
4362                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
4363                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 3892  Schoenebeck'> Line 4407  Schoenebeck'>
4407                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4408                      </t>                      </t>
4409                      <t>                      <t>
4410                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4411                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4412                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
4413                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
4414                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
4415                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
4416                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
4417                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4418                        because it has the following drawbacks: as "NON_MODAL" instructions return
4419                        immediately, they may not necessarily return an error i.e. when the given
4420                        instrument file turns out to be corrupt, beside that subsequent commands
4421                        in a LSCP instruction sequence might fail, because mandatory mappings are
4422                        not yet completed.
4423                      </t>                      </t>
4424    
4425                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 3941  Schoenebeck'> Line 4462  Schoenebeck'>
4462                      </t>                      </t>
4463                      <t>                      <t>
4464                          <list>                          <list>
4465                              <t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>                              <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4466                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4467                          </list>                          </list>
4468                      </t>                      </t>
# Line 4140  Schoenebeck'> Line 4661  Schoenebeck'>
4661                              <t>"VOLUME" -                              <t>"VOLUME" -
4662                                  <list>                                  <list>
4663                                      <t>master volume of the instrument as optionally                                      <t>master volume of the instrument as optionally
4664                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
4665                                      and a value > 1.0 means amplification)</t>                                      and a value > 1.0 means amplification)</t>
4666                                  </list>                                  </list>
4667                              </t>                              </t>
# Line 4311  Schoenebeck'> Line 4832  Schoenebeck'>
4832  </t>  </t>
4833  <t>subscribe_event =  <t>subscribe_event =
4834          <list>          <list>
4835                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4836                    </t>
4837                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4838                    </t>
4839                    <t>/ MIDI_INPUT_DEVICE_COUNT
4840                    </t>
4841                    <t>/ MIDI_INPUT_DEVICE_INFO
4842                    </t>
4843                    <t>/ CHANNEL_COUNT
4844                  </t>                  </t>
4845                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4846                  </t>                  </t>
# Line 4321  Schoenebeck'> Line 4850  Schoenebeck'>
4850                  </t>                  </t>
4851                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4852                  </t>                  </t>
4853                    <t>/ FX_SEND_COUNT
4854                    </t>
4855                    <t>/ FX_SEND_INFO
4856                    </t>
4857                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4858                    </t>
4859                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4860                    </t>
4861                    <t>/ MIDI_INSTRUMENT_COUNT
4862                    </t>
4863                    <t>/ MIDI_INSTRUMENT_INFO
4864                    </t>
4865                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4866                  </t>                  </t>
4867                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4868                  </t>                  </t>
4869                    <t>/ GLOBAL_INFO
4870                    </t>
4871          </list>          </list>
4872  </t>  </t>
4873  <t>unsubscribe_event =  <t>unsubscribe_event =
4874          <list>          <list>
4875                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4876                    </t>
4877                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4878                    </t>
4879                    <t>/ MIDI_INPUT_DEVICE_COUNT
4880                    </t>
4881                    <t>/ MIDI_INPUT_DEVICE_INFO
4882                    </t>
4883                    <t>/ CHANNEL_COUNT
4884                  </t>                  </t>
4885                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4886                  </t>                  </t>
# Line 4339  Schoenebeck'> Line 4890  Schoenebeck'>
4890                  </t>                  </t>
4891                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4892                  </t>                  </t>
4893                    <t>/ FX_SEND_COUNT
4894                    </t>
4895                    <t>/ FX_SEND_INFO
4896                    </t>
4897                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4898                    </t>
4899                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4900                    </t>
4901                    <t>/ MIDI_INSTRUMENT_COUNT
4902                    </t>
4903                    <t>/ MIDI_INSTRUMENT_INFO
4904                    </t>
4905                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4906                  </t>                  </t>
4907                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4908                  </t>                  </t>
4909                    <t>/ GLOBAL_INFO
4910                    </t>
4911          </list>          </list>
4912  </t>  </t>
4913  <t>map_instruction =  <t>map_instruction =
4914          <list>          <list>
4915                  <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value                  <t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
4916                  </t>                  </t>
4917                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
4918                  </t>                  </t>
4919                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
4920                  </t>                  </t>
4921                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
4922                  </t>                  </t>
4923          </list>          </list>
4924  </t>  </t>
# Line 4437  Schoenebeck'> Line 5002  Schoenebeck'>
5002                  </t>                  </t>
5003                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
5004                  </t>                  </t>
5005                    <t>/ FX_SENDS SP sampler_channel
5006                    </t>
5007                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
5008                    </t>
5009                    <t>/ VOLUME
5010                    </t>
5011          </list>          </list>
5012  </t>  </t>
5013  <t>set_instruction =  <t>set_instruction =
# Line 4453  Schoenebeck'> Line 5024  Schoenebeck'>
5024                  </t>                  </t>
5025                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5026                  </t>                  </t>
5027                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5028                    </t>
5029                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
5030                    </t>
5031                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
5032                    </t>
5033                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
5034                    </t>
5035                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
5036                  </t>                  </t>
5037                    <t>/ VOLUME SP volume_value
5038                    </t>
5039          </list>          </list>
5040  </t>  </t>
5041  <t>create_instruction =  <t>create_instruction =
# Line 4467  Schoenebeck'> Line 5048  Schoenebeck'>
5048                  </t>                  </t>
5049                  <t>/ MIDI_INPUT_DEVICE SP string                  <t>/ MIDI_INPUT_DEVICE SP string
5050                  </t>                  </t>
5051                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
5052                    </t>
5053                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5054                    </t>
5055          </list>          </list>
5056  </t>  </t>
5057  <t>reset_instruction =  <t>reset_instruction =
# Line 4489  Schoenebeck'> Line 5074  Schoenebeck'>
5074                  </t>                  </t>
5075                  <t>/ MIDI_INPUT_DEVICE SP number                  <t>/ MIDI_INPUT_DEVICE SP number
5076                  </t>                  </t>
5077                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
5078                    </t>
5079          </list>          </list>
5080  </t>  </t>
5081  <t>load_instruction =  <t>load_instruction =
# Line 4531  Schoenebeck'> Line 5118  Schoenebeck'>
5118                  </t>                  </t>
5119          </list>          </list>
5120  </t>  </t>
5121    <t>modal_arg =
5122            <list>
5123                    <t>/* epsilon (empty argument) */
5124                    </t>
5125                    <t>/ NON_MODAL SP
5126                    </t>
5127            </list>
5128    </t>
5129  <t>key_val_list =  <t>key_val_list =
5130          <list>          <list>
5131                  <t>string '=' param_val_list                  <t>string '=' param_val_list
# Line 4567  Schoenebeck'> Line 5162  Schoenebeck'>
5162                  </t>                  </t>
5163                  <t>/ MIDI_INSTRUMENT_MAPS                  <t>/ MIDI_INSTRUMENT_MAPS
5164                  </t>                  </t>
5165                    <t>/ FX_SENDS SP sampler_channel
5166                    </t>
5167          </list>          </list>
5168  </t>  </t>
5169  <t>load_instr_args =  <t>load_instr_args =
# Line 4649  Schoenebeck'> Line 5246  Schoenebeck'>
5246                  </t>                  </t>
5247          </list>          </list>
5248  </t>  </t>
5249    <t>midi_ctrl =
5250            <list>
5251                    <t>number
5252                    </t>
5253            </list>
5254    </t>
5255  <t>volume_value =  <t>volume_value =
5256          <list>          <list>
5257                  <t>dotnum                  <t>dotnum
# Line 4669  Schoenebeck'> Line 5272  Schoenebeck'>
5272                  </t>                  </t>
5273          </list>          </list>
5274  </t>  </t>
5275    <t>fx_send_id =
5276            <list>
5277                    <t>number
5278                    </t>
5279            </list>
5280    </t>
5281  <t>engine_name =  <t>engine_name =
5282          <list>          <list>
5283                  <t>string                  <t>string
# Line 4693  Schoenebeck'> Line 5302  Schoenebeck'>
5302                  </t>                  </t>
5303          </list>          </list>
5304  </t>  </t>
5305    <t>fx_send_name =
5306            <list>
5307                    <t>stringval
5308                    </t>
5309            </list>
5310    </t>
5311  <t>param_val_list =  <t>param_val_list =
5312          <list>          <list>
5313                  <t>param_val                  <t>param_val
# Line 4829  Schoenebeck'> Line 5444  Schoenebeck'>
5444                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5445                  <t>                  <t>
5446                      <list>                      <list>
5447                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
5448                      </list>                      </list>
5449                  </t>                  </t>
5450                  <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 4899  Schoenebeck'> Line 5514  Schoenebeck'>
5514                  message is sufficient here.</t>                  message is sufficient here.</t>
5515              </section>              </section>
5516    
5517                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
5518                    <t>Client may want to be notified when the number of effect sends on
5519                    a particular sampler channel is changed by issuing the following command:</t>
5520                    <t>
5521                        <list>
5522                            <t>SUBSCRIBE FX_SEND_COUNT</t>
5523                        </list>
5524                    </t>
5525                    <t>Server will start sending the following notification messages:</t>
5526                    <t>
5527                        <list>
5528                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
5529                        </list>
5530                    </t>
5531                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5532                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
5533                    be replaced by the new number of effect sends on that channel.</t>
5534                </section>
5535    
5536                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
5537                    <t>Client may want to be notified when changes were made to effect sends on a
5538                    a particular sampler channel by issuing the following command:</t>
5539                    <t>
5540                        <list>
5541                            <t>SUBSCRIBE FX_SEND_INFO</t>
5542                        </list>
5543                    </t>
5544                    <t>Server will start sending the following notification messages:</t>
5545                    <t>
5546                        <list>
5547                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
5548                        </list>
5549                    </t>
5550                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5551                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
5552                    be replaced by the numerical ID of the changed effect send.</t>
5553                </section>
5554    
5555              <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">
5556                  <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
5557                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 4910  Schoenebeck'> Line 5563  Schoenebeck'>
5563                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5564                  <t>                  <t>
5565                      <list>                      <list>
5566                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
5567                      </list>                      </list>
5568                  </t>                  </t>
5569                  <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
# Line 4971  Schoenebeck'> Line 5624  Schoenebeck'>
5624                          <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>                          <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
5625                      </list>                      </list>
5626                  </t>                  </t>
5627                  <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which                  <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
5628                  the nuber of instruments has changed and &lt;instruments&gt; will be replaced by                  the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
5629                  the new number of MIDI instruments in the specified map.</t>                  the new number of MIDI instruments in the specified map.</t>
5630              </section>              </section>
# Line 4991  Schoenebeck'> Line 5644  Schoenebeck'>
5644                      </list>                      </list>
5645                  </t>                  </t>
5646                  <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,                  <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5647                  in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies                  in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
5648                  the location of the changed MIDI instrument in the map. The front-end will have to send                  the location of the changed MIDI instrument in the map. The front-end will have to send
5649                  the respective command to actually get the MIDI instrument info. Because these messages                  the respective command to actually get the MIDI instrument info. Because these messages
5650                  will be triggered by LSCP commands issued by other clients rather than real                  will be triggered by LSCP commands issued by other clients rather than real
# Line 4999  Schoenebeck'> Line 5652  Schoenebeck'>
5652                  message is sufficient here.</t>                  message is sufficient here.</t>
5653              </section>              </section>
5654    
5655              <<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
5656                    <t>Client may want to be notified when changes to the global settings
5657                    of the sampler were made by issuing the following command:</t>
5658                    <t>
5659                        <list>
5660                            <t>SUBSCRIBE GLOBAL_INFO</t>
5661                        </list>
5662                    </t>
5663                    <t>Server will start sending the following types of notification messages:</t>
5664                    <t>
5665                        <list>
5666                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
5667                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
5668                            replaced by the optional dotted floating point value, reflecting the
5669                            new global volume parameter.</t>
5670                        </list>
5671                    </t>
5672                </section>
5673    
5674                <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
5675                  <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
5676                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
5677                  <t>                  <t>
Legend:
Removed from v.981  
changed lines
  Added in v.1135
  ViewVC Help
Powered by ViewVC