/[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 973 by schoenebeck, Fri Dec 15 21:40:27 2006 UTC revision 1362 by schoenebeck, Sun Sep 30 21:33:26 2007 UTC
# Line 16  Line 16 
16       to an annoying "missing Normative/Informative References" error message -->       to an annoying "missing Normative/Informative References" error message -->
17  <?rfc strict="no" ?>  <?rfc strict="no" ?>
18    
19  <rfc category="std" ipr="full3978" docName="LSCP 1.2">  <rfc category="std" ipr="full3978" docName="LSCP 1.2cvs">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol (draft)</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
23  Schoenebeck'>  Schoenebeck'>
24              <organization>              <organization>
# 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="September" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 61  Schoenebeck'> Line 61  Schoenebeck'>
61              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
62              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
63              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
64              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard <xref target="RFC20"/>),
65              example:</t>              thus the following example:</t>
66    
67              <t>              <t>
68                  <list>                  <list>
# Line 2061  Schoenebeck'> Line 2061  Schoenebeck'>
2061                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2063                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
2064                      parameter.</t>                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
2065                        for specifying no value for parameters allowing a list of values.</t>
2066    
2067                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2068                      <t>                      <t>
# Line 2088  Schoenebeck'> Line 2089  Schoenebeck'>
2089                      <t>Example:</t>                      <t>Example:</t>
2090                      <t>                      <t>
2091                          <list>                          <list>
2092                              <t></t>                              <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t>
2093                                <t>S: "OK"</t>
2094                            </list>
2095                        </t>
2096                        <t>
2097                            <list>
2098                                <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t>
2099                                <t>S: "OK"</t>
2100                          </list>                          </list>
2101                      </t>                      </t>
2102                  </section>                  </section>
# Line 2113  Schoenebeck'> Line 2121  Schoenebeck'>
2121                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
2122                      Each sampler channel can only have one instrument.</t>                      Each sampler channel can only have one instrument.</t>
2123    
2124                        <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125                        escape characters for special characters (see chapter
2126                        "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127                        for details) and accordingly backslash characters in the filename
2128                        MUST now be escaped as well!</t>
2129    
2130                      <t>The difference between regular and NON_MODAL versions of the command                      <t>The difference between regular and NON_MODAL versions of the command
2131                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
2132                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
# Line 2555  Schoenebeck'> Line 2569  Schoenebeck'>
2569                                      <t>VOLUME -                                      <t>VOLUME -
2570                                          <list>                                          <list>
2571                                              <t>optionally dotted number for the channel volume factor                                              <t>optionally dotted number for the channel volume factor
2572                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
2573                                              1.0 means amplification)</t>                                              1.0 means amplification)</t>
2574                                          </list>                                          </list>
2575                                      </t>                                      </t>
# Line 3227  Schoenebeck'> Line 3241  Schoenebeck'>
3241                      </t>                      </t>
3242                  </section>                  </section>
3243    
3244                    <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3245                        <t>The front-end can create an additional effect send on a specific sampler channel
3246                        by sending the following command:</t>
3247                        <t>
3248                            <list>
3249                                <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3250                            </list>
3251                        </t>
3252                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3253                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3254                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3255                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3256                        is a number between 0..127 defining the MIDI controller which can alter the
3257                        effect send level and &lt;name&gt; is an optional argument defining a name
3258                        for the effect send entity. The name does not have to be unique.</t>
3259    
3260                        <t>By default, that is as initial routing, the effect send's audio channels
3261                        are automatically routed to the last audio channels of the sampler channel's
3262                        audio output device, that way you can i.e. first increase the amount of audio
3263                        channels on the audio output device for having dedicated effect send output
3264                        channels and when "CREATE FX_SEND" is called, those channels will automatically
3265                        be picked. You can alter the destination channels however with
3266                        <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3267                        </t>
3268    
3269                        <t>Note: Create effect sends on a sampler channel only when needed, because having effect
3270                        sends on a sampler channel will decrease runtime performance, because for implementing channel
3271                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
3272                        the voices and route the audio signal afterwards to the master outputs and effect send
3273                        outputs (along with their respective effect send levels). A sampler channel without effect
3274                        sends however can mix its voices directly into the audio output devices's audio buffers
3275                        and is thus faster.
3276                        </t>
3277    
3278                        <t>Possible Answers:</t>
3279                        <t>
3280                            <list>
3281                                <t>"OK[&lt;fx-send-id&gt;]" -
3282                                    <list>
3283                                        <t>in case a new effect send could be added to the
3284                                        sampler channel, where &lt;fx-send-id&gt; reflects the
3285                                        unique ID of the newly created effect send entity</t>
3286                                    </list>
3287                                </t>
3288                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3289                                    <list>
3290                                        <t>when a new effect send could not be added, i.e.
3291                                        due to invalid parameters</t>
3292                                    </list>
3293                                </t>
3294                            </list>
3295                        </t>
3296    
3297                        <t>Examples:</t>
3298                        <t>
3299                            <list>
3300                                <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
3301                                <t>S: "OK[0]"</t>
3302                            </list>
3303                        </t>
3304                        <t>
3305                            <list>
3306                                <t>C: "CREATE FX_SEND 0 93"</t>
3307                                <t>S: "OK[1]"</t>
3308                            </list>
3309                        </t>
3310                    </section>
3311    
3312                    <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
3313                        <t>The front-end can remove an existing effect send on a specific sampler channel
3314                        by sending the following command:</t>
3315                        <t>
3316                            <list>
3317                                <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3318                            </list>
3319                        </t>
3320                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3321                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3322                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3323                        sampler channel from which the effect send should be removed from and
3324                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
3325                        <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3326                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3327    
3328                        <t>Possible Answers:</t>
3329                        <t>
3330                            <list>
3331                                <t>"OK" -
3332                                    <list>
3333                                        <t>on success</t>
3334                                    </list>
3335                                </t>
3336                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3337                                    <list>
3338                                        <t>in case it failed, providing an appropriate error code and
3339                                        error message</t>
3340                                    </list>
3341                                </t>
3342                            </list>
3343                        </t>
3344    
3345                        <t>Example:</t>
3346                        <t>
3347                            <list>
3348                                <t>C: "DESTROY FX_SEND 0 0"</t>
3349                                <t>S: "OK"</t>
3350                            </list>
3351                        </t>
3352                    </section>
3353    
3354                    <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
3355                        <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3356                        by sending the following command:</t>
3357                        <t>
3358                            <list>
3359                                <t>GET FX_SENDS &lt;sampler-channel&gt;</t>
3360                            </list>
3361                        </t>
3362                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3363                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3364                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3365    
3366                        <t>Possible Answers:</t>
3367                        <t>
3368                            <list>
3369                                <t>The sampler will answer by returning the number of effect
3370                                sends on the given sampler channel.</t>
3371                            </list>
3372                        </t>
3373    
3374                        <t>Example:</t>
3375                        <t>
3376                            <list>
3377                                <t>C: "GET FX_SENDS 0"</t>
3378                                <t>S: "2"</t>
3379                            </list>
3380                        </t>
3381                    </section>
3382    
3383                    <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
3384                        <t>The front-end can ask for a list of effect sends on a specific sampler channel
3385                        by sending the following command:</t>
3386                        <t>
3387                            <list>
3388                                <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
3389                            </list>
3390                        </t>
3391                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3392                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3393                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3394    
3395                        <t>Possible Answers:</t>
3396                        <t>
3397                            <list>
3398                                <t>The sampler will answer by returning a comma separated list
3399                                with all effect sends' numerical IDs on the given sampler
3400                                channel.</t>
3401                            </list>
3402                        </t>
3403    
3404                        <t>Examples:</t>
3405                        <t>
3406                            <list>
3407                                <t>C: "LIST FX_SENDS 0"</t>
3408                                <t>S: "0,1"</t>
3409                            </list>
3410                        </t>
3411                        <t>
3412                            <list>
3413                                <t>C: "LIST FX_SENDS 1"</t>
3414                                <t>S: ""</t>
3415                            </list>
3416                        </t>
3417                    </section>
3418    
3419                    <section title="Getting effect send information" anchor="GET FX_SEND INFO">
3420                        <t>The front-end can ask for the current settings of an effect send entity
3421                        by sending the following command:</t>
3422                        <t>
3423                            <list>
3424                                <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3425                            </list>
3426                        </t>
3427                        <t>Where &lt;sampler-channel&gt; is the sampler channel number
3428                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3429                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3430                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3431                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3432                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
3433                       </t>
3434    
3435                        <t>Possible Answers:</t>
3436                        <t>
3437                            <list>
3438                                <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
3439                                Each answer line begins with the settings category name
3440                                followed by a colon and then a space character &lt;SP&gt; and finally
3441                                the info character string to that setting category. At the
3442                                moment the following categories are defined:</t>
3443    
3444                                <t>
3445                                    <list>
3446                                        <t>NAME -
3447                                            <list>
3448                                                <t>name of the effect send entity</t>
3449                                            </list>
3450                                        </t>
3451                                        <t>MIDI_CONTROLLER -
3452                                            <list>
3453                                                <t>a value between 0 and 127 reflecting the MIDI controller
3454                                                which is able to modify the effect send's send level</t>
3455                                            </list>
3456                                        </t>
3457                                        <t>LEVEL -
3458                                            <list>
3459                                                <t>optionally dotted number reflecting the effect send's
3460                                                current send level (where a value &lt; 1.0 means attenuation
3461                                                and a value > 1.0 means amplification)</t>
3462                                            </list>
3463                                        </t>
3464                                        <t>AUDIO_OUTPUT_ROUTING -
3465                                            <list>
3466                                                <t>comma separated list which reflects to which audio
3467                                                channel of the selected audio output device each
3468                                                effect send output channel is routed to, e.g. "0,3" would
3469                                                mean the effect send's output channel 0 is routed to channel
3470                                                0 of the audio output device and the effect send's output
3471                                                channel 1 is routed to the channel 3 of the audio
3472                                                output device (see
3473                                                <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3474                                                for details)</t>
3475                                            </list>
3476                                        </t>
3477                                    </list>
3478                                </t>
3479                            </list>
3480                        </t>
3481                        <t>The mentioned fields above don't have to be in particular order.</t>
3482    
3483                        <t>Example:</t>
3484                        <t>
3485                            <list>
3486                                <t>C: "GET FX_SEND INFO 0 0"</t>
3487                                <t>S: "NAME: Reverb Send"</t>
3488                                <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3489                                <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3490                                <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3491                                <t>&nbsp;&nbsp;&nbsp;"."</t>
3492                            </list>
3493                        </t>
3494                    </section>
3495    
3496                    <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3497                        <t>The front-end can alter the current name of an effect
3498                        send entity by sending the following command:</t>
3499                        <t>
3500                            <list>
3501                                <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3502                            </list>
3503                        </t>
3504                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3505                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3506                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3507                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3508                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3509                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3510                        &lt;name&gt; is the new name of the effect send entity, which
3511                        does not have to be unique.</t>
3512    
3513                        <t>Possible Answers:</t>
3514                        <t>
3515                            <list>
3516                                <t>"OK" -
3517                                    <list>
3518                                        <t>on success</t>
3519                                    </list>
3520                                </t>
3521                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3522                                    <list>
3523                                        <t>in case it failed, providing an appropriate error code and error message</t>
3524                                    </list>
3525                                </t>
3526                            </list>
3527                        </t>
3528                        <t>Example:</t>
3529                        <t>
3530                            <list>
3531                                <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3532                                <t>S: "OK"</t>
3533                            </list>
3534                        </t>
3535                    </section>
3536    
3537                    <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3538                        <t>The front-end can alter the destination of an effect send's audio channel on a specific
3539                        sampler channel by sending the following command:</t>
3540                        <t>
3541                            <list>
3542                                <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>
3543                            </list>
3544                        </t>
3545                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3546                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3547                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3548                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3549                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3550                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3551                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3552                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3553                        the audio channel of the selected audio output device where &lt;audio-src&gt;
3554                        should be routed to.</t>
3555    
3556                        <t>Note that effect sends can only route audio to the same audio output
3557                        device as assigned to the effect send's sampler channel. Also note that an
3558                        effect send entity does always have exactly as much audio channels as its
3559                        sampler channel. So if the sampler channel is stereo, the effect send does
3560                        have two audio channels as well. Also keep in mind that the amount of audio
3561                        channels on a sampler channel might be dependant not only to the deployed
3562                        sampler engine on the sampler channel, but also dependant to the instrument
3563                        currently loaded. However you can (effectively) turn an i.e. stereo effect
3564                        send into a mono one by simply altering its audio routing appropriately.</t>
3565    
3566                        <t>Possible Answers:</t>
3567                        <t>
3568                            <list>
3569                                <t>"OK" -
3570                                    <list>
3571                                        <t>on success</t>
3572                                    </list>
3573                                </t>
3574                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3575                                    <list>
3576                                        <t>if audio output channel was set, but there are noteworthy
3577                                        issue(s) related, providing an appropriate warning code and
3578                                        warning message</t>
3579                                    </list>
3580                                </t>
3581                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3582                                    <list>
3583                                        <t>in case it failed, providing an appropriate error code and error message</t>
3584                                    </list>
3585                                </t>
3586                            </list>
3587                        </t>
3588                        <t>Example:</t>
3589                        <t>
3590                            <list>
3591                                <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3592                                <t>S: "OK"</t>
3593                            </list>
3594                        </t>
3595                    </section>
3596    
3597                    <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3598                        <t>The front-end can alter the MIDI controller of an effect
3599                        send entity by sending the following command:</t>
3600                        <t>
3601                            <list>
3602                                <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3603                            </list>
3604                        </t>
3605                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3606                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3607                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3608                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3609                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3610                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3611                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3612                        able to modify the effect send's send level.</t>
3613    
3614                        <t>Possible Answers:</t>
3615                        <t>
3616                            <list>
3617                                <t>"OK" -
3618                                    <list>
3619                                        <t>on success</t>
3620                                    </list>
3621                                </t>
3622                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3623                                    <list>
3624                                        <t>if MIDI controller was set, but there are noteworthy
3625                                        issue(s) related, providing an appropriate warning code and
3626                                        warning message</t>
3627                                    </list>
3628                                </t>
3629                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3630                                    <list>
3631                                        <t>in case it failed, providing an appropriate error code and error message</t>
3632                                    </list>
3633                                </t>
3634                            </list>
3635                        </t>
3636                        <t>Example:</t>
3637                        <t>
3638                            <list>
3639                                <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3640                                <t>S: "OK"</t>
3641                            </list>
3642                        </t>
3643                    </section>
3644    
3645                    <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3646                        <t>The front-end can alter the current send level of an effect
3647                        send entity by sending the following command:</t>
3648                        <t>
3649                            <list>
3650                                <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3651                            </list>
3652                        </t>
3653                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3654                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3655                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3656                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3657                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3658                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3659                        &lt;volume&gt; is an optionally dotted positive number (a value
3660                        smaller than 1.0 means attenuation, whereas a value greater than
3661                        1.0 means amplification) reflecting the new send level.</t>
3662    
3663                        <t>Possible Answers:</t>
3664                        <t>
3665                            <list>
3666                                <t>"OK" -
3667                                    <list>
3668                                        <t>on success</t>
3669                                    </list>
3670                                </t>
3671                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3672                                    <list>
3673                                        <t>if new send level was set, but there are noteworthy
3674                                        issue(s) related, providing an appropriate warning code and
3675                                        warning message</t>
3676                                    </list>
3677                                </t>
3678                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3679                                    <list>
3680                                        <t>in case it failed, providing an appropriate error code and error message</t>
3681                                    </list>
3682                                </t>
3683                            </list>
3684                        </t>
3685                        <t>Example:</t>
3686                        <t>
3687                            <list>
3688                                <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3689                                <t>S: "OK"</t>
3690                            </list>
3691                        </t>
3692                    </section>
3693    
3694                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3695                      <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>
3696                      <t>                      <t>
# Line 3509  Schoenebeck'> Line 3973  Schoenebeck'>
3973                                              complies with (see <xref target="LSCP versioning" /> for details)</t>                                              complies with (see <xref target="LSCP versioning" /> for details)</t>
3974                                          </list>                                          </list>
3975                                      </t>                                      </t>
3976                                        <t>INSTRUMENTS_DB_SUPPORT -
3977                                            <list>
3978                                                <t>either yes or no, specifies whether the
3979                                                sampler is build with instruments database support.</t>
3980                                            </list>
3981                                        </t>
3982                                  </list>                                  </list>
3983                              </t>                              </t>
3984                          </list>                          </list>
# Line 3516  Schoenebeck'> Line 3986  Schoenebeck'>
3986                      <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.
3987                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
3988                  </section>                  </section>
3989    
3990                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
3991                        <t>The client can ask for the current global sampler-wide volume
3992                        attenuation by sending the following command:</t>
3993                        <t>
3994                            <list>
3995                                <t>GET VOLUME</t>
3996                            </list>
3997                        </t>
3998                        <t>Possible Answers:</t>
3999                        <t>
4000                            <list>
4001                                <t>The sampler will always answer by returning the optional
4002                                dotted floating point coefficient, reflecting the current
4003                                global volume attenuation.
4004                                </t>
4005                            </list>
4006                        </t>
4007                        <t>Note: it is up to the respective sampler engine whether to obey
4008                        that global volume parameter or not, but in general all engines SHOULD
4009                        use this parameter.</t>
4010                    </section>
4011    
4012                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
4013                        <t>The client can alter the current global sampler-wide volume
4014                        attenuation by sending the following command:</t>
4015                        <t>
4016                            <list>
4017                                <t>SET VOLUME &lt;volume&gt;</t>
4018                            </list>
4019                        </t>
4020                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
4021                       floating point value, reflecting the new global volume parameter.
4022                       This value might usually be in the range between 0.0 and 1.0, that
4023                       is for attenuating the overall volume.</t>
4024    
4025                        <t>Possible Answers:</t>
4026                        <t>
4027                            <list>
4028                                <t>"OK" -
4029                                    <list>
4030                                        <t>on success</t>
4031                                    </list>
4032                                </t>
4033                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4034                                    <list>
4035                                        <t>if the global volume was set, but there are noteworthy
4036                                        issue(s) related, providing an appropriate warning code and
4037                                        warning message</t>
4038                                    </list>
4039                                </t>
4040                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4041                                    <list>
4042                                        <t>in case it failed, providing an appropriate error code and error message</t>
4043                                    </list>
4044                                </t>
4045                            </list>
4046                        </t>
4047                    </section>
4048              </section>              </section>
4049    
4050    
# Line 3730  Schoenebeck'> Line 4259  Schoenebeck'>
4259                                              which does not have to be unique</t>                                              which does not have to be unique</t>
4260                                          </list>                                          </list>
4261                                      </t>                                      </t>
4262                                        <t>DEFAULT -
4263                                            <list>
4264                                                <t>either true or false,
4265                                                defines whether this map is the default map</t>
4266                                            </list>
4267                                        </t>
4268                                  </list>                                  </list>
4269                              </t>                              </t>
4270                          </list>                          </list>
# Line 3741  Schoenebeck'> Line 4276  Schoenebeck'>
4276                          <list>                          <list>
4277                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4278                              <t>S: "NAME: Standard Map"</t>                              <t>S: "NAME: Standard Map"</t>
4279                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4280                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
4281                          </list>                          </list>
4282                      </t>                      </t>
# Line 3789  Schoenebeck'> Line 4325  Schoenebeck'>
4325                      command:</t>                      command:</t>
4326                      <t>                      <t>
4327                          <list>                          <list>
4328                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4329                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4330                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4331                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
# Line 3803  Schoenebeck'> Line 4339  Schoenebeck'>
4339                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4340                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4341                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4342                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
4343                        supporting escape sequences as described in chapter
4344                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4345                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4346                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4347                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
4348                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
4349                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
4350                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
4351                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 3842  Schoenebeck'> Line 4380  Schoenebeck'>
4380                              <t>"PERSISTENT" -                              <t>"PERSISTENT" -
4381                                  <list>                                  <list>
4382                                      <t>The instrument will immediately be loaded                                      <t>The instrument will immediately be loaded
4383                                      into memory in the background when this mapping                                      into memory when this mapping
4384                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
4385                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
4386                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 3892  Schoenebeck'> Line 4430  Schoenebeck'>
4430                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4431                      </t>                      </t>
4432                      <t>                      <t>
4433                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4434                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4435                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
4436                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
4437                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
4438                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
4439                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
4440                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4441                        because it has the following drawbacks: as "NON_MODAL" instructions return
4442                        immediately, they may not necessarily return an error i.e. when the given
4443                        instrument file turns out to be corrupt, beside that subsequent commands
4444                        in a LSCP instruction sequence might fail, because mandatory mappings are
4445                        not yet completed.
4446                      </t>                      </t>
4447    
4448                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 3941  Schoenebeck'> Line 4485  Schoenebeck'>
4485                      </t>                      </t>
4486                      <t>                      <t>
4487                          <list>                          <list>
4488                              <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>
4489                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4490                          </list>                          </list>
4491                      </t>                      </t>
# Line 4140  Schoenebeck'> Line 4684  Schoenebeck'>
4684                              <t>"VOLUME" -                              <t>"VOLUME" -
4685                                  <list>                                  <list>
4686                                      <t>master volume of the instrument as optionally                                      <t>master volume of the instrument as optionally
4687                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
4688                                      and a value > 1.0 means amplification)</t>                                      and a value > 1.0 means amplification)</t>
4689                                  </list>                                  </list>
4690                              </t>                              </t>
# Line 4212  Schoenebeck'> Line 4756  Schoenebeck'>
4756                  </section>                  </section>
4757              </section>              </section>
4758    
4759    
4760                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4761                    <t>The following commands describe how to use and manage
4762                    the instruments database.</t>
4763                    <t>Notice:</t>
4764                        <t>
4765                            <list>
4766                                <t>All command arguments representing a path or
4767                                instrument/directory name support escape sequences as described in chapter
4768                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4769                                </t>
4770                                <t>All occurrences of a forward slash in instrument and directory
4771                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4772                                </t>
4773                            </list>
4774                        </t>
4775    
4776                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4777                        <t>The front-end can add a new instrument directory to the
4778                        instruments database by sending the following command:</t>
4779                        <t>
4780                            <list>
4781                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4782                            </list>
4783                        </t>
4784                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4785                        to be created (encapsulated into apostrophes).</t>
4786    
4787                        <t>Possible Answers:</t>
4788                        <t>
4789                            <list>
4790                                <t>"OK" -
4791                                    <list>
4792                                        <t>on success</t>
4793                                    </list>
4794                                </t>
4795                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4796                                    <list>
4797                                        <t>when the directory could not be created, which
4798                                        can happen if the directory already exists or the
4799                                        name contains not allowed symbols</t>
4800                                    </list>
4801                                </t>
4802                            </list>
4803                        </t>
4804    
4805                        <t>Examples:</t>
4806                        <t>
4807                            <list>
4808                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4809                                <t>S: "OK"</t>
4810                            </list>
4811                        </t>
4812                    </section>
4813    
4814                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4815                        <t>The front-end can delete a particular instrument directory
4816                        from the instruments database by sending the following command:</t>
4817                        <t>
4818                            <list>
4819                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4820                            </list>
4821                        </t>
4822                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4823                        to delete. The optional FORCE argument can be used to
4824                        force the deletion of a non-empty directory and all its content.</t>
4825    
4826                        <t>Possible Answers:</t>
4827                        <t>
4828                            <list>
4829                                <t>"OK" -
4830                                    <list>
4831                                        <t>if the directory is deleted successfully</t>
4832                                    </list>
4833                                </t>
4834                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4835                                    <list>
4836                                        <t>if the given directory does not exist, or
4837                                        if trying to delete a non-empty directory,
4838                                        without using the FORCE argument.</t>
4839                                    </list>
4840                                </t>
4841                            </list>
4842                        </t>
4843    
4844                        <t>Examples:</t>
4845                        <t>
4846                            <list>
4847                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4848                                <t>S: "OK"</t>
4849                            </list>
4850                        </t>
4851                    </section>
4852    
4853                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4854                        <t>The front-end can retrieve the current amount of
4855                        directories in a specific directory by sending the following command:</t>
4856                        <t>
4857                            <list>
4858                                <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4859                            </list>
4860                        </t>
4861                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4862                        name of the directory. If RECURSIVE is specified, the number of
4863                        all directories, including those located in subdirectories of the
4864                        specified directory, will be returned.</t>
4865    
4866                        <t>Possible Answers:</t>
4867                        <t>
4868                            <list>
4869                                <t>The current number of instrument directories
4870                                in the specified directory.</t>
4871                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4872                                    <list>
4873                                        <t>if the given directory does not exist.</t>
4874                                    </list>
4875                                </t>
4876                            </list>
4877                        </t>
4878    
4879                        <t>Example:</t>
4880                        <t>
4881                            <list>
4882                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4883                                <t>S: "2"</t>
4884                            </list>
4885                        </t>
4886                    </section>
4887    
4888                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4889                        <t>The front-end can retrieve the current list of directories
4890                        in specific directory by sending the following command:</t>
4891                        <t>
4892                            <list>
4893                                <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4894                            </list>
4895                        </t>
4896                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4897                        name of the directory. If RECURSIVE is specified, the absolute path names
4898                        of all directories, including those located in subdirectories of the
4899                        specified directory, will be returned.</t>
4900    
4901                        <t>Possible Answers:</t>
4902                        <t>
4903                            <list>
4904                                <t>A comma separated list of all instrument directories
4905                                (encapsulated into apostrophes) in the specified directory.</t>
4906                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4907                                    <list>
4908                                        <t>if the given directory does not exist.</t>
4909                                    </list>
4910                                </t>
4911                            </list>
4912                        </t>
4913                        <t>Example:</t>
4914                        <t>
4915                            <list>
4916                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4917                                <t>S: "'Piano Collection','Percussion Collection'"</t>
4918                            </list>
4919                        </t>
4920                        <t>
4921                            <list>
4922                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4923                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4924                            </list>
4925                        </t>
4926                    </section>
4927    
4928                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4929                        <t>The front-end can ask for the current settings of an
4930                        instrument directory by sending the following command:</t>
4931                        <t>
4932                            <list>
4933                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4934                            </list>
4935                        </t>
4936                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4937                        name of the directory the front-end is interested in.</t>
4938    
4939                        <t>Possible Answers:</t>
4940                        <t>
4941                            <list>
4942                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4943                                Each answer line begins with the settings category name
4944                                followed by a colon and then a space character &lt;SP&gt; and finally
4945                                the info character string to that setting category. At the
4946                                moment the following categories are defined:</t>
4947    
4948                                <t>
4949                                    <list>
4950                                        <t>DESCRIPTION -
4951                                            <list>
4952                                                <t>A brief description of the directory content.
4953                                                Note that the character string may contain
4954                                                <xref target="character_set">escape sequences</xref>.</t>
4955                                            </list>
4956                                        </t>
4957                                        <t>CREATED -
4958                                            <list>
4959                                                <t>The creation date and time of the directory,
4960                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
4961                                            </list>
4962                                        </t>
4963                                        <t>MODIFIED -
4964                                            <list>
4965                                                <t>The date and time of the last modification of the
4966                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
4967                                            </list>
4968                                        </t>
4969                                    </list>
4970                                </t>
4971                            </list>
4972                        </t>
4973                        <t>The mentioned fields above don't have to be in particular order.</t>
4974    
4975                        <t>Example:</t>
4976                        <t>
4977                            <list>
4978                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
4979                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
4980                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
4981                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
4982                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4983                            </list>
4984                        </t>
4985                    </section>
4986    
4987                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
4988                        <t>The front-end can alter the name of a specific
4989                        instrument directory by sending the following command:</t>
4990                        <t>
4991                            <list>
4992                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
4993                            </list>
4994                        </t>
4995                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
4996                        &lt;name&gt; is the new name for that directory.</t>
4997    
4998                        <t>Possible Answers:</t>
4999                        <t>
5000                            <list>
5001                                <t>"OK" -
5002                                    <list>
5003                                        <t>on success</t>
5004                                    </list>
5005                                </t>
5006                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5007                                    <list>
5008                                        <t>in case the given directory does not exists,
5009                                        or if a directory with name equal to the new
5010                                        name already exists.</t>
5011                                    </list>
5012                                </t>
5013                            </list>
5014                        </t>
5015    
5016                        <t>Example:</t>
5017                        <t>
5018                            <list>
5019                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
5020                                <t>S: "OK"</t>
5021                            </list>
5022                        </t>
5023                    </section>
5024    
5025                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
5026                        <t>The front-end can move a specific
5027                        instrument directory by sending the following command:</t>
5028                        <t>
5029                            <list>
5030                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5031                            </list>
5032                        </t>
5033                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5034                        to move and &lt;dst&gt; is the location where the directory will
5035                        be moved to.</t>
5036    
5037                        <t>Possible Answers:</t>
5038                        <t>
5039                            <list>
5040                                <t>"OK" -
5041                                    <list>
5042                                        <t>on success</t>
5043                                    </list>
5044                                </t>
5045                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5046                                    <list>
5047                                        <t>in case a given directory does not exists,
5048                                        or if a directory with name equal to the name
5049                                        of the specified directory already exists in
5050                                        the destination directory. Error is also thrown
5051                                        when trying to move a directory to a subdirectory
5052                                        of itself.</t>
5053                                    </list>
5054                                </t>
5055                            </list>
5056                        </t>
5057    
5058                        <t>Example:</t>
5059                        <t>
5060                            <list>
5061                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5062                                <t>S: "OK"</t>
5063                            </list>
5064                        </t>
5065                    </section>
5066    
5067                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5068                        <t>The front-end can copy a specific
5069                        instrument directory by sending the following command:</t>
5070                        <t>
5071                            <list>
5072                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5073                            </list>
5074                        </t>
5075                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5076                        to copy and &lt;dst&gt; is the location where the directory will
5077                        be copied to.</t>
5078    
5079                        <t>Possible Answers:</t>
5080                        <t>
5081                            <list>
5082                                <t>"OK" -
5083                                    <list>
5084                                        <t>on success</t>
5085                                    </list>
5086                                </t>
5087                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5088                                    <list>
5089                                        <t>in case a given directory does not exists,
5090                                        or if a directory with name equal to the name
5091                                        of the specified directory already exists in
5092                                        the destination directory. Error is also thrown
5093                                        when trying to copy a directory to a subdirectory
5094                                        of itself.</t>
5095                                    </list>
5096                                </t>
5097                            </list>
5098                        </t>
5099    
5100                        <t>Example:</t>
5101                        <t>
5102                            <list>
5103                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5104                                <t>S: "OK"</t>
5105                            </list>
5106                        </t>
5107                    </section>
5108    
5109                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5110                        <t>The front-end can alter the description of a specific
5111                        instrument directory by sending the following command:</t>
5112                        <t>
5113                            <list>
5114                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5115                            </list>
5116                        </t>
5117                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5118                        &lt;desc&gt; is the new description for the directory
5119                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5120                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5121    
5122                        <t>Possible Answers:</t>
5123                        <t>
5124                            <list>
5125                                <t>"OK" -
5126                                    <list>
5127                                        <t>on success</t>
5128                                    </list>
5129                                </t>
5130                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5131                                    <list>
5132                                        <t>in case the given directory does not exists.</t>
5133                                    </list>
5134                                </t>
5135                            </list>
5136                        </t>
5137    
5138                        <t>Example:</t>
5139                        <t>
5140                            <list>
5141                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5142                                <t>S: "OK"</t>
5143                            </list>
5144                        </t>
5145                    </section>
5146    
5147                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5148                        <t>The front-end can search for directories
5149                        in specific directory by sending the following command:</t>
5150                        <t>
5151                            <list>
5152                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5153                            </list>
5154                        </t>
5155                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5156                        name of the directory to search in. If NON_RECURSIVE is specified, the
5157                        directories located in subdirectories of the specified directory will not
5158                        be searched. &lt;criteria-list&gt; is a list of search criterias
5159                        in form of "key1=val1 key2=val2 ...". The following criterias are
5160                        allowed:</t>
5161                        <t>
5162                          <t>NAME='&lt;search-string&gt;'
5163                              <list>
5164                                  <t>Restricts the search to directories, which names
5165                                  satisfy the supplied search string (encapsulated into apostrophes,
5166                                  supporting escape sequences as described in chapter
5167                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5168                              </list>
5169                          </t>
5170    
5171                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5172                              <list>
5173                                  <t>Restricts the search to directories, which creation
5174                                  date satisfies the specified period, where &lt;date-after&gt;
5175                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5176                                  If &lt;date-after&gt; is omitted the search is restricted to
5177                                  directories created before &lt;date-before&gt;. If
5178                                  &lt;date-before&gt; is omitted, the search is restricted
5179                                  to directories created after &lt;date-after&gt;.</t>
5180                              </list>
5181                          </t>
5182    
5183                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5184                              <list>
5185                                  <t>Restricts the search to directories, which
5186                                  date of last modification satisfies the specified period, where
5187                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5188                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5189                                  directories, which are last modified before &lt;date-before&gt;. If
5190                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5191                                  which are last modified after &lt;date-after&gt;.</t>
5192                              </list>
5193                          </t>
5194    
5195                          <t>DESCRIPTION='&lt;search-string&gt;'
5196                              <list>
5197                                  <t>Restricts the search to directories with description
5198                                  that satisfies the supplied search string
5199                                  (encapsulated into apostrophes, supporting escape
5200                                  sequences as described in chapter
5201                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5202                              </list>
5203                          </t>
5204                        </t>
5205    
5206                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5207                        word list separated with spaces for OR search and with '+' for AND search.</t>
5208    
5209                        <t>Possible Answers:</t>
5210                        <t>
5211                            <list>
5212                                <t>A comma separated list with the absolute path names (encapsulated into
5213                                apostrophes) of all directories in the specified directory that satisfy
5214                                the supplied search criterias.</t>
5215                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5216                                    <list>
5217                                        <t>if the given directory does not exist.</t>
5218                                    </list>
5219                                </t>
5220                            </list>
5221                        </t>
5222                        <t>Example:</t>
5223                        <t>
5224                            <list>
5225                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5226                                <t>S: "'/Piano Collection'"</t>
5227                            </list>
5228                        </t>
5229                        <t>
5230                            <list>
5231                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5232                                <t>S: "'/Piano Collection','/Percussions'"</t>
5233                            </list>
5234                        </t>
5235                    </section>
5236    
5237                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5238                        <t>The front-end can add one or more instruments
5239                        to the instruments database by sending the following command:</t>
5240                        <t>
5241                            <list>
5242                                <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5243                            </list>
5244                        </t>
5245                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5246                        (encapsulated into apostrophes) in the instruments database in which
5247                        only the new instruments (that are not already in the database) will
5248                        be added, &lt;file_path&gt; is the absolute path name of a file or
5249                        directory in the file system (encapsulated into apostrophes). In case
5250                        an instrument file is supplied, only the instruments in the specified
5251                        file will be added to the instruments database. If the optional
5252                        &lt;instr_index&gt; (the index of the instrument within the given file)
5253                        is supplied too, then only the specified instrument will be added.
5254                        In case a directory is supplied, the instruments in that directory
5255                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5256                        when a directory is provided as &lt;file_path&gt; and specifies how the
5257                        scanning will be done and has exactly the following possibilities:</t>
5258                        <t>
5259                            <list>
5260                                <t>"RECURSIVE" -
5261                                    <list>
5262                                        <t>All instruments will be processed, including those
5263                                        in the subdirectories, and the respective subdirectory
5264                                        tree structure will be recreated in the instruments
5265                                        database</t>
5266                                    </list>
5267                                </t>
5268                                <t>"NON_RECURSIVE" -
5269                                    <list>
5270                                        <t>Only the instruments in the specified directory
5271                                        will be added, the instruments in the subdirectories
5272                                        will not be processed.</t>
5273                                    </list>
5274                                </t>
5275                                <t>"FLAT" -
5276                                    <list>
5277                                        <t>All instruments will be processed, including those
5278                                        in the subdirectories, but the respective subdirectory
5279                                        structure will not be recreated in the instruments
5280                                        database. All instruments will be added directly in
5281                                        the specified database directory.</t>
5282                                    </list>
5283                                </t>
5284                            </list>
5285                        </t>
5286    
5287                     <t>The difference between regular and NON_MODAL versions of the command
5288                        is that the regular command returns when the scanning is finished
5289                        while NON_MODAL version returns immediately and a background process is launched.
5290                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5291                        command can be used to monitor the scanning progress.</t>
5292    
5293                        <t>Possible Answers:</t>
5294                        <t>
5295                            <list>
5296                                <t>"OK" -
5297                                    <list>
5298                                        <t>on success when NON_MODAL is not supplied</t>
5299                                    </list>
5300                                </t>
5301                                <t>"OK[&lt;job-id&gt;]" -
5302                                    <list>
5303                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5304                                        is a numerical ID used to obtain status information about the job progress.
5305                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5306                                        </t>
5307                                    </list>
5308                                </t>
5309                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5310                                    <list>
5311                                        <t>if an invalid path is specified.</t>
5312                                    </list>
5313                                </t>
5314                            </list>
5315                        </t>
5316    
5317                        <t>Examples:</t>
5318                        <t>
5319                            <list>
5320                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5321                                <t>S: "OK"</t>
5322                            </list>
5323                        </t>
5324                    </section>
5325    
5326                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5327                        <t>The front-end can remove a particular instrument
5328                        from the instruments database by sending the following command:</t>
5329                        <t>
5330                            <list>
5331                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5332                            </list>
5333                        </t>
5334                        <t>Where &lt;instr_path&gt; is the absolute path name
5335                        (in the instruments database) of the instrument to remove.</t>
5336    
5337                        <t>Possible Answers:</t>
5338                        <t>
5339                            <list>
5340                                <t>"OK" -
5341                                    <list>
5342                                        <t>if the instrument is removed successfully</t>
5343                                    </list>
5344                                </t>
5345                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5346                                    <list>
5347                                        <t>if the given path does not exist or
5348                                        is a directory.</t>
5349                                    </list>
5350                                </t>
5351                            </list>
5352                        </t>
5353    
5354                        <t>Examples:</t>
5355                        <t>
5356                            <list>
5357                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5358                                <t>S: "OK"</t>
5359                            </list>
5360                        </t>
5361                    </section>
5362    
5363                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5364                        <t>The front-end can retrieve the current amount of
5365                        instruments in a specific directory by sending the following command:</t>
5366                        <t>
5367                            <list>
5368                                <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5369                            </list>
5370                        </t>
5371                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5372                        of the directory. If RECURSIVE is specified, the number of all
5373                        instruments, including those located in subdirectories of the
5374                        specified directory, will be returned.</t>
5375    
5376                        <t>Possible Answers:</t>
5377                        <t>
5378                            <list>
5379                                <t>The current number of instruments
5380                                in the specified directory.</t>
5381                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5382                                    <list>
5383                                        <t>if the given directory does not exist.</t>
5384                                    </list>
5385                                </t>
5386                            </list>
5387                        </t>
5388    
5389                        <t>Example:</t>
5390                        <t>
5391                            <list>
5392                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5393                                <t>S: "2"</t>
5394                            </list>
5395                        </t>
5396                    </section>
5397    
5398                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5399                        <t>The front-end can retrieve the current list of instruments
5400                        in specific directory by sending the following command:</t>
5401                        <t>
5402                            <list>
5403                                <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5404                            </list>
5405                        </t>
5406                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5407                        name of the directory. If RECURSIVE is specified, the absolute path
5408                        names of all instruments, including those located in subdirectories
5409                        of the specified directory, will be returned.</t>
5410    
5411                        <t>Possible Answers:</t>
5412                        <t>
5413                            <list>
5414                                <t>A comma separated list of all instruments
5415                                (encapsulated into apostrophes) in the specified directory.</t>
5416                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5417                                    <list>
5418                                        <t>if the given directory does not exist.</t>
5419                                    </list>
5420                                </t>
5421                            </list>
5422                        </t>
5423                        <t>Example:</t>
5424                        <t>
5425                            <list>
5426                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5427                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5428                            </list>
5429                        </t>
5430                        <t>
5431                            <list>
5432                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5433                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5434                            </list>
5435                        </t>
5436                    </section>
5437    
5438                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5439                        <t>The front-end can ask for the current settings of an
5440                        instrument by sending the following command:</t>
5441                        <t>
5442                            <list>
5443                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5444                            </list>
5445                        </t>
5446                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5447                        name of the instrument the front-end is interested in.</t>
5448    
5449                        <t>Possible Answers:</t>
5450                        <t>
5451                            <list>
5452                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5453                                Each answer line begins with the settings category name
5454                                followed by a colon and then a space character &lt;SP&gt; and finally
5455                                the info character string to that setting category. At the
5456                                moment the following categories are defined:</t>
5457    
5458                                <t>
5459                                    <list>
5460                                        <t>INSTRUMENT_FILE -
5461                                            <list>
5462                                                <t>File name of the instrument.
5463                                                Note that the character string may contain
5464                                                <xref target="character_set">escape sequences</xref>.</t>
5465                                            </list>
5466                                        </t>
5467                                        <t>INSTRUMENT_NR -
5468                                            <list>
5469                                                <t>Index of the instrument within the file.</t>
5470                                            </list>
5471                                        </t>
5472                                        <t>FORMAT_FAMILY -
5473                                            <list>
5474                                                <t>The format family of the instrument.</t>
5475                                            </list>
5476                                        </t>
5477                                        <t>FORMAT_VERSION -
5478                                            <list>
5479                                                <t>The format version of the instrument.</t>
5480                                            </list>
5481                                        </t>
5482                                        <t>SIZE -
5483                                            <list>
5484                                                <t>The size of the instrument in bytes.</t>
5485                                            </list>
5486                                        </t>
5487                                        <t>CREATED -
5488                                            <list>
5489                                                <t>The date and time when the instrument is added
5490                                                in the instruments database, represented in
5491                                               "YYYY-MM-DD HH:MM:SS" format</t>
5492                                            </list>
5493                                        </t>
5494                                        <t>MODIFIED -
5495                                            <list>
5496                                                <t>The date and time of the last modification of the
5497                                                instrument's database settings, represented in
5498                                                "YYYY-MM-DD HH:MM:SS" format</t>
5499                                            </list>
5500                                        </t>
5501                                        <t>DESCRIPTION -
5502                                            <list>
5503                                                <t>A brief description of the instrument.
5504                                                Note that the character string may contain
5505                                                <xref target="character_set">escape sequences</xref>.</t>
5506                                            </list>
5507                                        </t>
5508                                        <t>IS_DRUM -
5509                                            <list>
5510                                                <t>either true or false, determines whether the
5511                                                instrument is a drumkit or a chromatic instrument</t>
5512                                            </list>
5513                                        </t>
5514                                        <t>PRODUCT -
5515                                            <list>
5516                                                <t>The product title of the instrument.
5517                                                Note that the character string may contain
5518                                                <xref target="character_set">escape sequences</xref>.</t>
5519                                            </list>
5520                                        </t>
5521                                        <t>ARTISTS -
5522                                            <list>
5523                                                <t>Lists the artist names.
5524                                                Note that the character string may contain
5525                                                <xref target="character_set">escape sequences</xref>.</t>
5526                                            </list>
5527                                        </t>
5528                                        <t>KEYWORDS -
5529                                            <list>
5530                                                <t>Provides a list of keywords that refer to the instrument.
5531                                                Keywords are separated with semicolon and blank.
5532                                                Note that the character string may contain
5533                                                <xref target="character_set">escape sequences</xref>.</t>
5534                                            </list>
5535                                        </t>
5536                                    </list>
5537                                </t>
5538                            </list>
5539                        </t>
5540                        <t>The mentioned fields above don't have to be in particular order.</t>
5541    
5542                        <t>Example:</t>
5543                        <t>
5544                            <list>
5545                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5546                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5547                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5548                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5549                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5550                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5551                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5552                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5553                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5554                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5555                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5556                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5557                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5558                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5559                            </list>
5560                        </t>
5561                    </section>
5562    
5563                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5564                        <t>The front-end can alter the name of a specific
5565                        instrument by sending the following command:</t>
5566                        <t>
5567                            <list>
5568                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5569                            </list>
5570                        </t>
5571                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5572                        &lt;name&gt; is the new name for that instrument.</t>
5573    
5574                        <t>Possible Answers:</t>
5575                        <t>
5576                            <list>
5577                                <t>"OK" -
5578                                    <list>
5579                                        <t>on success</t>
5580                                    </list>
5581                                </t>
5582                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5583                                    <list>
5584                                        <t>in case the given instrument does not exists,
5585                                        or if an instrument with name equal to the new
5586                                        name already exists.</t>
5587                                    </list>
5588                                </t>
5589                            </list>
5590                        </t>
5591    
5592                        <t>Example:</t>
5593                        <t>
5594                            <list>
5595                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5596                                <t>S: "OK"</t>
5597                            </list>
5598                        </t>
5599                    </section>
5600    
5601                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5602                        <t>The front-end can move a specific instrument to another directory by
5603                        sending the following command:</t>
5604                        <t>
5605                            <list>
5606                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5607                            </list>
5608                        </t>
5609                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5610                        to move and &lt;dst&gt; is the directory where the instrument will
5611                        be moved to.</t>
5612    
5613                        <t>Possible Answers:</t>
5614                        <t>
5615                            <list>
5616                                <t>"OK" -
5617                                    <list>
5618                                        <t>on success</t>
5619                                    </list>
5620                                </t>
5621                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5622                                    <list>
5623                                        <t>in case the given instrument does not exists,
5624                                        or if an instrument with name equal to the name of the
5625                                        specified instrument already exists in the destination
5626                                        directory.</t>
5627                                    </list>
5628                                </t>
5629                            </list>
5630                        </t>
5631    
5632                        <t>Example:</t>
5633                        <t>
5634                            <list>
5635                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5636                                <t>S: "OK"</t>
5637                            </list>
5638                        </t>
5639                    </section>
5640    
5641                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5642                        <t>The front-end can copy a specific instrument to another directory by
5643                        sending the following command:</t>
5644                        <t>
5645                            <list>
5646                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5647                            </list>
5648                        </t>
5649                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5650                        to copy and &lt;dst&gt; is the directory where the instrument will
5651                        be copied to.</t>
5652    
5653                        <t>Possible Answers:</t>
5654                        <t>
5655                            <list>
5656                                <t>"OK" -
5657                                    <list>
5658                                        <t>on success</t>
5659                                    </list>
5660                                </t>
5661                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5662                                    <list>
5663                                        <t>in case the given instrument does not exists,
5664                                        or if an instrument with name equal to the name of the
5665                                        specified instrument already exists in the destination
5666                                        directory.</t>
5667                                    </list>
5668                                </t>
5669                            </list>
5670                        </t>
5671    
5672                        <t>Example:</t>
5673                        <t>
5674                            <list>
5675                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5676                                <t>S: "OK"</t>
5677                            </list>
5678                        </t>
5679                    </section>
5680    
5681                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5682                        <t>The front-end can alter the description of a specific
5683                        instrument by sending the following command:</t>
5684                        <t>
5685                            <list>
5686                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5687                            </list>
5688                        </t>
5689                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5690                        &lt;desc&gt; is the new description for the instrument
5691                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5692                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5693    
5694                        <t>Possible Answers:</t>
5695                        <t>
5696                            <list>
5697                                <t>"OK" -
5698                                    <list>
5699                                        <t>on success</t>
5700                                    </list>
5701                                </t>
5702                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5703                                    <list>
5704                                        <t>in case the given instrument does not exists.</t>
5705                                    </list>
5706                                </t>
5707                            </list>
5708                        </t>
5709    
5710                        <t>Example:</t>
5711                        <t>
5712                            <list>
5713                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5714                                <t>S: "OK"</t>
5715                            </list>
5716                        </t>
5717                    </section>
5718    
5719                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5720                        <t>The front-end can search for instruments
5721                        in specific directory by sending the following command:</t>
5722                        <t>
5723                            <list>
5724                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5725                            </list>
5726                        </t>
5727                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5728                        name of the directory to search in. If NON_RECURSIVE is specified, the
5729                        directories located in subdirectories of the specified directory will not
5730                        be searched. &lt;criteria-list&gt; is a list of search criterias
5731                        in form of "key1=val1 key2=val2 ...". The following criterias are
5732                        allowed:</t>
5733                        <t>
5734                          <t>NAME='&lt;search-string&gt;'
5735                              <list>
5736                                  <t>Restricts the search to instruments, which names
5737                                  satisfy the supplied search string (encapsulated into apostrophes,
5738                                  supporting escape sequences as described in chapter
5739                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5740                              </list>
5741                          </t>
5742    
5743                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5744                              <list>
5745                                  <t>Restricts the search to instruments, which
5746                                  size is in the specified range. If &lt;min&gt; is omitted,
5747                                  the search results are restricted to instruments with size less then
5748                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5749                                  search is restricted to instruments with size greater then
5750                                  or equal to &lt;min&gt;.</t>
5751                              </list>
5752                          </t>
5753    
5754                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5755                              <list>
5756                                  <t>Restricts the search to instruments, which creation
5757                                  date satisfies the specified period, where &lt;date-after&gt;
5758                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5759                                  If &lt;date-after&gt; is omitted the search is restricted to
5760                                  instruments created before &lt;date-before&gt;. If
5761                                  &lt;date-before&gt; is omitted, the search is restricted
5762                                  to instruments created after &lt;date-after&gt;.</t>
5763                              </list>
5764                          </t>
5765    
5766                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5767                              <list>
5768                                  <t>Restricts the search to instruments, which
5769                                  date of last modification satisfies the specified period, where
5770                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5771                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5772                                  instruments, which are last modified before &lt;date-before&gt;. If
5773                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5774                                  which are last modified after &lt;date-after&gt;.</t>
5775                              </list>
5776                          </t>
5777    
5778                          <t>DESCRIPTION='&lt;search-string&gt;'
5779                              <list>
5780                                  <t>Restricts the search to instruments with description
5781                                  that satisfies the supplied search string (encapsulated into apostrophes,
5782                                  supporting escape sequences as described in chapter
5783                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5784                              </list>
5785                          </t>
5786    
5787                          <t>PRODUCT='&lt;search-string&gt;'
5788                              <list>
5789                                  <t>Restricts the search to instruments with product info
5790                                  that satisfies the supplied search string (encapsulated into apostrophes,
5791                                  supporting escape sequences as described in chapter
5792                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5793                              </list>
5794                          </t>
5795    
5796                          <t>ARTISTS='&lt;search-string&gt;'
5797                              <list>
5798                                  <t>Restricts the search to instruments with artists info
5799                                  that satisfies the supplied search string (encapsulated into apostrophes,
5800                                  supporting escape sequences as described in chapter
5801                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5802                              </list>
5803                          </t>
5804    
5805                          <t>KEYWORDS='&lt;search-string&gt;'
5806                              <list>
5807                                  <t>Restricts the search to instruments with keyword list
5808                                  that satisfies the supplied search string (encapsulated into apostrophes,
5809                                  supporting escape sequences as described in chapter
5810                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5811                              </list>
5812                          </t>
5813    
5814                          <t>IS_DRUM=true | false
5815                              <list>
5816                                  <t>Either true or false. Restricts the search to
5817                                  drum kits or chromatic instruments.</t>
5818                              </list>
5819                          </t>
5820    
5821                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5822                              <list>
5823                                  <t>Restricts the search to instruments of the supplied format families,
5824                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5825                              </list>
5826                          </t>
5827                        </t>
5828    
5829                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5830                        word list separated with spaces for OR search and with '+' for AND search.</t>
5831    
5832                        <t>Possible Answers:</t>
5833                        <t>
5834                            <list>
5835                                <t>A comma separated list with the absolute path names (encapsulated into
5836                                apostrophes) of all instruments in the specified directory that satisfy
5837                                the supplied search criterias.</t>
5838                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5839                                    <list>
5840                                        <t>if the given directory does not exist.</t>
5841                                    </list>
5842                                </t>
5843                            </list>
5844                        </t>
5845                        <t>Example:</t>
5846                        <t>
5847                            <list>
5848                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5849                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5850                            </list>
5851                        </t>
5852                        <t>
5853                            <list>
5854                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5855                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5856                            </list>
5857                        </t>
5858                    </section>
5859    
5860                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
5861                        <t>The front-end can ask for the current status of a
5862                        particular database instruments job by sending the following command:</t>
5863                        <t>
5864                            <list>
5865                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
5866                            </list>
5867                        </t>
5868                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
5869                        of the job the front-end is interested in.</t>
5870    
5871                        <t>Possible Answers:</t>
5872                        <t>
5873                            <list>
5874                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5875                                Each answer line begins with the settings category name
5876                                followed by a colon and then a space character &lt;SP&gt; and finally
5877                                the info character string to that setting category. At the
5878                                moment the following categories are defined:</t>
5879    
5880                                <t>
5881                                    <list>
5882                                        <t>FILES_TOTAL -
5883                                            <list>
5884                                                <t>The total number of files scheduled for scanning</t>
5885                                            </list>
5886                                        </t>
5887                                        <t>FILES_SCANNED -
5888                                            <list>
5889                                                <t>The current number of scanned files</t>
5890                                            </list>
5891                                        </t>
5892                                        <t>SCANNING -
5893                                            <list>
5894                                                <t>The absolute path name of the file which is currently
5895                                                being scanned</t>
5896                                            </list>
5897                                        </t>
5898                                        <t>STATUS -
5899                                            <list>
5900                                                <t>An integer value between 0 and 100 indicating the
5901                                                scanning progress percentage of the file which is
5902                                                currently being scanned</t>
5903                                            </list>
5904                                        </t>
5905                                    </list>
5906                                </t>
5907                            </list>
5908                        </t>
5909                        <t>The mentioned fields above don't have to be in particular order.</t>
5910    
5911                        <t>Example:</t>
5912                        <t>
5913                            <list>
5914                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
5915                                <t>S: "FILES_TOTAL: 12"</t>
5916                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
5917                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
5918                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
5919                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5920                            </list>
5921                        </t>
5922                    </section>
5923    
5924                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5925                        <t>The front-end can remove all instruments and directories and re-create
5926                        the instruments database structure (e.g., in case of a database corruption)
5927                        by sending the following command:</t>
5928                        <t>
5929                            <list>
5930                                <t>FORMAT INSTRUMENTS_DB</t>
5931                            </list>
5932                        </t>
5933                        
5934                        <t>Possible Answers:</t>
5935                        <t>
5936                            <list>
5937                                <t>"OK" -
5938                                    <list>
5939                                        <t>on success</t>
5940                                    </list>
5941                                </t>
5942                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5943                                    <list>
5944                                        <t>If the formatting of the instruments database
5945                                        failed.</t>
5946                                    </list>
5947                                </t>
5948                            </list>
5949                        </t>
5950                    </section>
5951    
5952                </section>
5953    
5954    
5955    
5956                <section title="Editing Instruments" anchor="editing_instruments">
5957                    <t>The sampler allows to edit instruments while playing with the
5958                    sampler by spawning an external (3rd party) instrument editor
5959                    application for a given instrument. The 3rd party instrument
5960                    editor applications have to place a respective plugin DLL file
5961                    into the sampler's plugins directory. The sampler will
5962                    automatically try to load all plugin DLLs in that directory on
5963                    startup and only on startup!</t>
5964                    <t>At the moment there is only one command for this feature set,
5965                    but this will most probably change in future.</t>
5966    
5967                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
5968                        <t>The front-end can request to open an appropriate instrument
5969                        editor application by sending the following command:</t>
5970                        <t>
5971                            <list>
5972                                <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>
5973                            </list>
5974                        </t>
5975                        <t>Where &lt;sampler-channel&gt; should be replaced by the
5976                        number of the sampler channel as given by the
5977                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
5978                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
5979                        command.</t>
5980    
5981                        <t>The sampler will try to ask all registered instrument
5982                        editors (or to be more specific: their sampler plugins)
5983                        whether they are capable to handle the instrument on the
5984                        given sampler channel. The sampler will simply use the first
5985                        instrument editor application which replied with a positive
5986                        answer and spawn that instrument editor application within
5987                        the sampler's process and provide that application access
5988                        to the instrument's data structures, so both applications
5989                        can share and access the same instruments data at the same
5990                        time, thus allowing to immediately hear changes with the
5991                        sampler made by the instrument editor.</t>
5992    
5993                        <t>Note: consequently instrument editors are always spawned
5994                        locally on the same machine where the sampler is running
5995                        on!</t>
5996    
5997                        <t>Possible Answers:</t>
5998                        <t>
5999                            <list>
6000                                <t>"OK" -
6001                                    <list>
6002                                        <t>when an appropriate instrument editor was
6003                                        launched</t>
6004                                    </list>
6005                                </t>
6006                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6007                                    <list>
6008                                        <t>when an appropriate instrument editor was
6009                                        launched, but there are noteworthy issues</t>
6010                                    </list>
6011                                </t>
6012                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6013                                    <list>
6014                                        <t>when an appropriate instrument editor
6015                                        could not be launched</t>
6016                                    </list>
6017                                </t>
6018                            </list>
6019                        </t>
6020    
6021                        <t>Examples:</t>
6022                        <t>
6023                            <list>
6024                                <t>C: "EDIT INSTRUMENT 0"</t>
6025                                <t>S: "OK"</t>
6026                            </list>
6027                        </t>
6028                    </section>
6029                </section>
6030          </section>          </section>
6031    
6032    
# Line 4287  Schoenebeck'> Line 6102  Schoenebeck'>
6102                  </t>                  </t>
6103                  <t>/ UNSUBSCRIBE SP unsubscribe_event                  <t>/ UNSUBSCRIBE SP unsubscribe_event
6104                  </t>                  </t>
                 <t>/ SELECT SP text  
                 </t>  
6105                  <t>/ RESET SP reset_instruction                  <t>/ RESET SP reset_instruction
6106                  </t>                  </t>
6107                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
6108                  </t>                  </t>
6109                    <t>/ FIND SP find_instruction
6110                    </t>
6111                    <t>/ MOVE SP move_instruction
6112                    </t>
6113                    <t>/ COPY SP copy_instruction
6114                    </t>
6115                    <t>/ EDIT SP edit_instruction
6116                    </t>
6117                    <t>/ FORMAT SP format_instruction
6118                    </t>
6119                  <t>/ RESET                  <t>/ RESET
6120                  </t>                  </t>
6121                  <t>/ QUIT                  <t>/ QUIT
# Line 4303  Schoenebeck'> Line 6126  Schoenebeck'>
6126          <list>          <list>
6127                  <t>CHANNEL                  <t>CHANNEL
6128                  </t>                  </t>
6129                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6130                    </t>
6131                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6132                    </t>
6133                    <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6134                    </t>
6135                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6136                    </t>
6137                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
6138                    </t>
6139                    <t>/ DB_INSTRUMENTS SP db_path SP filename
6140                    </t>
6141                    <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6142                    </t>
6143                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
6144                  </t>                  </t>
6145                  <t>/ MIDI_INSTRUMENT_MAP SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP map_name
# Line 4311  Schoenebeck'> Line 6148  Schoenebeck'>
6148  </t>  </t>
6149  <t>subscribe_event =  <t>subscribe_event =
6150          <list>          <list>
6151                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
6152                    </t>
6153                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
6154                    </t>
6155                    <t>/ MIDI_INPUT_DEVICE_COUNT
6156                    </t>
6157                    <t>/ MIDI_INPUT_DEVICE_INFO
6158                    </t>
6159                    <t>/ CHANNEL_COUNT
6160                  </t>                  </t>
6161                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6162                  </t>                  </t>
# Line 4321  Schoenebeck'> Line 6166  Schoenebeck'>
6166                  </t>                  </t>
6167                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
6168                  </t>                  </t>
6169                    <t>/ FX_SEND_COUNT
6170                    </t>
6171                    <t>/ FX_SEND_INFO
6172                    </t>
6173                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
6174                    </t>
6175                    <t>/ MIDI_INSTRUMENT_MAP_INFO
6176                    </t>
6177                    <t>/ MIDI_INSTRUMENT_COUNT
6178                    </t>
6179                    <t>/ MIDI_INSTRUMENT_INFO
6180                    </t>
6181                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6182                    </t>
6183                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6184                    </t>
6185                    <t>/ DB_INSTRUMENT_COUNT
6186                    </t>
6187                    <t>/ DB_INSTRUMENT_INFO
6188                    </t>
6189                    <t>/ DB_INSTRUMENTS_JOB_INFO
6190                    </t>
6191                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6192                  </t>                  </t>
6193                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6194                  </t>                  </t>
6195                    <t>/ GLOBAL_INFO
6196                    </t>
6197          </list>          </list>
6198  </t>  </t>
6199  <t>unsubscribe_event =  <t>unsubscribe_event =
6200          <list>          <list>
6201                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
6202                    </t>
6203                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
6204                    </t>
6205                    <t>/ MIDI_INPUT_DEVICE_COUNT
6206                    </t>
6207                    <t>/ MIDI_INPUT_DEVICE_INFO
6208                    </t>
6209                    <t>/ CHANNEL_COUNT
6210                  </t>                  </t>
6211                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6212                  </t>                  </t>
# Line 4339  Schoenebeck'> Line 6216  Schoenebeck'>
6216                  </t>                  </t>
6217                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
6218                  </t>                  </t>
6219                    <t>/ FX_SEND_COUNT
6220                    </t>
6221                    <t>/ FX_SEND_INFO
6222                    </t>
6223                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
6224                    </t>
6225                    <t>/ MIDI_INSTRUMENT_MAP_INFO
6226                    </t>
6227                    <t>/ MIDI_INSTRUMENT_COUNT
6228                    </t>
6229                    <t>/ MIDI_INSTRUMENT_INFO
6230                    </t>
6231                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6232                    </t>
6233                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6234                    </t>
6235                    <t>/ DB_INSTRUMENT_COUNT
6236                    </t>
6237                    <t>/ DB_INSTRUMENT_INFO
6238                    </t>
6239                    <t>/ DB_INSTRUMENTS_JOB_INFO
6240                    </t>
6241                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6242                  </t>                  </t>
6243                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6244                  </t>                  </t>
6245                    <t>/ GLOBAL_INFO
6246                    </t>
6247          </list>          </list>
6248  </t>  </t>
6249  <t>map_instruction =  <t>map_instruction =
6250          <list>          <list>
6251                  <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
6252                  </t>                  </t>
6253                  <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
6254                  </t>                  </t>
6255                  <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
6256                  </t>                  </t>
6257                  <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
6258                  </t>                  </t>
6259          </list>          </list>
6260  </t>  </t>
# Line 4371  Schoenebeck'> Line 6272  Schoenebeck'>
6272                  </t>                  </t>
6273                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6274                  </t>                  </t>
6275                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6276                    </t>
6277                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6278                    </t>
6279                    <t>/ DB_INSTRUMENT SP db_path
6280                    </t>
6281          </list>          </list>
6282  </t>  </t>
6283  <t>get_instruction =  <t>get_instruction =
# Line 4437  Schoenebeck'> Line 6344  Schoenebeck'>
6344                  </t>                  </t>
6345                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6346                  </t>                  </t>
6347                    <t>/ FX_SENDS SP sampler_channel
6348                    </t>
6349                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6350                    </t>
6351                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6352                    </t>
6353                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6354                    </t>
6355                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6356                    </t>
6357                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6358                    </t>
6359                    <t>/ DB_INSTRUMENTS SP db_path
6360                    </t>
6361                    <t>/ DB_INSTRUMENT SP INFO SP db_path
6362                    </t>
6363                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6364                    </t>
6365                    <t>/ VOLUME
6366                    </t>
6367          </list>          </list>
6368  </t>  </t>
6369  <t>set_instruction =  <t>set_instruction =
# Line 4447  Schoenebeck'> Line 6374  Schoenebeck'>
6374                  </t>                  </t>
6375                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6376                  </t>                  </t>
6377                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6378                    </t>
6379                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6380                  </t>                  </t>
6381                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
6382                  </t>                  </t>
6383                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6384                  </t>                  </t>
6385                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6386                    </t>
6387                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
6388                    </t>
6389                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
6390                    </t>
6391                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6392                    </t>
6393                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6394                    </t>
6395                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6396                    </t>
6397                    <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6398                    </t>
6399                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6400                    </t>
6401                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6402                  </t>                  </t>
6403                    <t>/ VOLUME SP volume_value
6404                    </t>
6405          </list>          </list>
6406  </t>  </t>
6407  <t>create_instruction =  <t>create_instruction =
# Line 4467  Schoenebeck'> Line 6414  Schoenebeck'>
6414                  </t>                  </t>
6415                  <t>/ MIDI_INPUT_DEVICE SP string                  <t>/ MIDI_INPUT_DEVICE SP string
6416                  </t>                  </t>
6417                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
6418                    </t>
6419                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6420                    </t>
6421          </list>          </list>
6422  </t>  </t>
6423  <t>reset_instruction =  <t>reset_instruction =
# Line 4483  Schoenebeck'> Line 6434  Schoenebeck'>
6434                  </t>                  </t>
6435          </list>          </list>
6436  </t>  </t>
6437    <t>find_instruction =
6438            <list>
6439                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6440                    </t>
6441                    <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6442                    </t>
6443                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
6444                    </t>
6445                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6446                    </t>
6447            </list>
6448    </t>
6449    <t>move_instruction =
6450            <list>
6451                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6452                    </t>
6453                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6454                    </t>
6455            </list>
6456    </t>
6457    <t>copy_instruction =
6458            <list>
6459                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6460                    </t>
6461                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6462                    </t>
6463            </list>
6464    </t>
6465  <t>destroy_instruction =  <t>destroy_instruction =
6466          <list>          <list>
6467                  <t>AUDIO_OUTPUT_DEVICE SP number                  <t>AUDIO_OUTPUT_DEVICE SP number
6468                  </t>                  </t>
6469                  <t>/ MIDI_INPUT_DEVICE SP number                  <t>/ MIDI_INPUT_DEVICE SP number
6470                  </t>                  </t>
6471                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
6472                    </t>
6473          </list>          </list>
6474  </t>  </t>
6475  <t>load_instruction =  <t>load_instruction =
# Line 4531  Schoenebeck'> Line 6512  Schoenebeck'>
6512                  </t>                  </t>
6513          </list>          </list>
6514  </t>  </t>
6515    <t>edit_instruction =
6516            <list>
6517                    <t>INSTRUMENT SP sampler_channel
6518                    </t>
6519            </list>
6520    </t>
6521    <t>format_instruction =
6522            <list>
6523                    <t>INSTRUMENTS_DB
6524                    </t>
6525            </list>
6526    </t>
6527    <t>modal_arg =
6528            <list>
6529                    <t>/* epsilon (empty argument) */
6530                    </t>
6531                    <t>/ NON_MODAL SP
6532                    </t>
6533            </list>
6534    </t>
6535  <t>key_val_list =  <t>key_val_list =
6536          <list>          <list>
6537                  <t>string '=' param_val_list                  <t>string '=' param_val_list
# Line 4567  Schoenebeck'> Line 6568  Schoenebeck'>
6568                  </t>                  </t>
6569                  <t>/ MIDI_INSTRUMENT_MAPS                  <t>/ MIDI_INSTRUMENT_MAPS
6570                  </t>                  </t>
6571                    <t>/ FX_SENDS SP sampler_channel
6572                    </t>
6573                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6574                    </t>
6575                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6576                    </t>
6577                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6578                    </t>
6579                    <t>/ DB_INSTRUMENTS SP db_path
6580                    </t>
6581          </list>          </list>
6582  </t>  </t>
6583  <t>load_instr_args =  <t>load_instr_args =
# Line 4649  Schoenebeck'> Line 6660  Schoenebeck'>
6660                  </t>                  </t>
6661          </list>          </list>
6662  </t>  </t>
6663    <t>midi_ctrl =
6664            <list>
6665                    <t>number
6666                    </t>
6667            </list>
6668    </t>
6669  <t>volume_value =  <t>volume_value =
6670          <list>          <list>
6671                  <t>dotnum                  <t>dotnum
# Line 4669  Schoenebeck'> Line 6686  Schoenebeck'>
6686                  </t>                  </t>
6687          </list>          </list>
6688  </t>  </t>
6689    <t>fx_send_id =
6690            <list>
6691                    <t>number
6692                    </t>
6693            </list>
6694    </t>
6695  <t>engine_name =  <t>engine_name =
6696          <list>          <list>
6697                  <t>string                  <t>string
# Line 4677  Schoenebeck'> Line 6700  Schoenebeck'>
6700  </t>  </t>
6701  <t>filename =  <t>filename =
6702          <list>          <list>
6703                  <t>stringval                  <t>path
6704                    </t>
6705            </list>
6706    </t>
6707    <t>db_path =
6708            <list>
6709                    <t>path
6710                  </t>                  </t>
6711          </list>          </list>
6712  </t>  </t>
# Line 4693  Schoenebeck'> Line 6722  Schoenebeck'>
6722                  </t>                  </t>
6723          </list>          </list>
6724  </t>  </t>
6725    <t>fx_send_name =
6726            <list>
6727                    <t>stringval
6728                    </t>
6729            </list>
6730    </t>
6731  <t>param_val_list =  <t>param_val_list =
6732          <list>          <list>
6733                  <t>param_val                  <t>param_val
# Line 4713  Schoenebeck'> Line 6748  Schoenebeck'>
6748                  </t>                  </t>
6749          </list>          </list>
6750  </t>  </t>
6751    <t>query_val_list =
6752            <list>
6753                    <t>string '=' query_val
6754                    </t>
6755                    <t>/ query_val_list SP string '=' query_val
6756                    </t>
6757            </list>
6758    </t>
6759    <t>query_val =
6760            <list>
6761                    <t>textval_escaped
6762                    </t>
6763                    <t>/ stringval_escaped
6764                    </t>
6765            </list>
6766    </t>
6767    <t>scan_mode =
6768            <list>
6769                    <t>RECURSIVE
6770                    </t>
6771                    <t>/ NON_RECURSIVE
6772                    </t>
6773                    <t>/ FLAT
6774                    </t>
6775            </list>
6776    </t>
6777    
6778              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6779    
6780                <section title="Character Set and Escape Sequences" anchor="character_set">
6781                    <t>Older versions of this protocol up to and including v1.1 only
6782                    supported the standard ASCII character set (ASCII code 0 - 127)
6783                    <xref target="RFC20"/>, all younger versions of this protocol
6784                    however support the Extended ASCII character set (ASCII code
6785                    0 - 255). The same group of younger protocols also support
6786                    escape sequences, but only for certain, explicitly declared
6787                    parts of the protocol. The supported escape sequences are
6788                    defined as follows:</t>
6789                    <texttable>
6790                        <ttcol>ASCII Character Sequence</ttcol>
6791                        <ttcol>Translated into (Name)</ttcol>
6792                        <c>\n</c> <c>new line</c>
6793                        <c>\r</c> <c>carriage return</c>
6794                        <c>\f</c> <c>form feed</c>
6795                        <c>\t</c> <c>horizontal tab</c>
6796                        <c>\v</c> <c>vertical tab</c>
6797                        <c>\'</c> <c>apostrophe</c>
6798                        <c>\"</c> <c>quotation mark</c>
6799                        <c>\\</c> <c>backslash</c>
6800                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
6801                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
6802                    </texttable>
6803                    <t>Notice: due to the transition of certain parts of the
6804                    protocol which now support escape sequences, a slight backward
6805                    incompatibility to protocols version v1.1 and younger has been
6806                    introduced. The only difference is that in parts of the protocol
6807                    where escape characters are now supported, a backslash characters
6808                    MUST be escaped as well (that is as double backslash), whereas
6809                    in the old versions a single backslash was sufficient.</t>
6810                </section>
6811          </section>          </section>
6812    
6813          <section title="Events" anchor="events">          <section title="Events" anchor="events">
6814              <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>
6815    
6816              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
6817                    <t>Client may want to be notified when the total number of audio output devices on the
6818                    back-end changes by issuing the following command:</t>
6819                    <t>
6820                        <list>
6821                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
6822                        </list>
6823                    </t>
6824                    <t>Server will start sending the following notification messages:</t>
6825                    <t>
6826                        <list>
6827                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
6828                        </list>
6829                    </t>
6830                    <t>where &lt;devices&gt; will be replaced by the new number
6831                    of audio output devices.</t>
6832                </section>
6833    
6834                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
6835                    <t>Client may want to be notified when changes were made to audio output devices on the
6836                    back-end by issuing the following command:</t>
6837                    <t>
6838                        <list>
6839                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
6840                        </list>
6841                    </t>
6842                    <t>Server will start sending the following notification messages:</t>
6843                    <t>
6844                        <list>
6845                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
6846                        </list>
6847                    </t>
6848                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
6849                    which settings has been changed. The front-end will have to send
6850                    the respective command to actually get the audio output device info. Because these messages
6851                    will be triggered by LSCP commands issued by other clients rather than real
6852                    time events happening on the server, it is believed that an empty notification
6853                    message is sufficient here.</t>
6854                </section>
6855    
6856                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
6857                    <t>Client may want to be notified when the total number of MIDI input devices on the
6858                    back-end changes by issuing the following command:</t>
6859                    <t>
6860                        <list>
6861                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
6862                        </list>
6863                    </t>
6864                    <t>Server will start sending the following notification messages:</t>
6865                    <t>
6866                        <list>
6867                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
6868                        </list>
6869                    </t>
6870                    <t>where &lt;devices&gt; will be replaced by the new number
6871                    of MIDI input devices.</t>
6872                </section>
6873    
6874                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
6875                    <t>Client may want to be notified when changes were made to MIDI input devices on the
6876                    back-end by issuing the following command:</t>
6877                    <t>
6878                        <list>
6879                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
6880                        </list>
6881                    </t>
6882                    <t>Server will start sending the following notification messages:</t>
6883                    <t>
6884                        <list>
6885                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
6886                        </list>
6887                    </t>
6888                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
6889                    which settings has been changed. The front-end will have to send
6890                    the respective command to actually get the MIDI input device info. Because these messages
6891                    will be triggered by LSCP commands issued by other clients rather than real
6892                    time events happening on the server, it is believed that an empty notification
6893                    message is sufficient here.</t>
6894                </section>
6895    
6896                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
6897                  <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
6898                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
6899                  <t>                  <t>
# Line 4749  Schoenebeck'> Line 6922  Schoenebeck'>
6922                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
6923                  <t>                  <t>
6924                      <list>                      <list>
6925                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
6926                      </list>                      </list>
6927                  </t>                  </t>
6928                  <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 4797  Schoenebeck'> Line 6970  Schoenebeck'>
6970                  "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>
6971              </section>              </section>
6972    
6973              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
6974                  <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
6975                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
6976                  <t>                  <t>
# Line 4819  Schoenebeck'> Line 6992  Schoenebeck'>
6992                  message is sufficient here.</t>                  message is sufficient here.</t>
6993              </section>              </section>
6994    
6995                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
6996                    <t>Client may want to be notified when the number of effect sends on
6997                    a particular sampler channel is changed by issuing the following command:</t>
6998                    <t>
6999                        <list>
7000                            <t>SUBSCRIBE FX_SEND_COUNT</t>
7001                        </list>
7002                    </t>
7003                    <t>Server will start sending the following notification messages:</t>
7004                    <t>
7005                        <list>
7006                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
7007                        </list>
7008                    </t>
7009                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
7010                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
7011                    be replaced by the new number of effect sends on that channel.</t>
7012                </section>
7013    
7014                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
7015                    <t>Client may want to be notified when changes were made to effect sends on a
7016                    a particular sampler channel by issuing the following command:</t>
7017                    <t>
7018                        <list>
7019                            <t>SUBSCRIBE FX_SEND_INFO</t>
7020                        </list>
7021                    </t>
7022                    <t>Server will start sending the following notification messages:</t>
7023                    <t>
7024                        <list>
7025                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
7026                        </list>
7027                    </t>
7028                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
7029                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
7030                    be replaced by the numerical ID of the changed effect send.</t>
7031                </section>
7032    
7033              <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">
7034                  <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
7035                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 4830  Schoenebeck'> Line 7041  Schoenebeck'>
7041                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
7042                  <t>                  <t>
7043                      <list>                      <list>
7044                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
7045                      </list>                      </list>
7046                  </t>                  </t>
7047                  <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
7048                  all currently active voices.</t>                  all currently active voices.</t>
7049              </section>              </section>
7050    
7051                <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
7052                    <t>Client may want to be notified when the number of MIDI instrument maps on the
7053                    back-end changes by issuing the following command:</t>
7054                    <t>
7055                        <list>
7056                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
7057                        </list>
7058                    </t>
7059                    <t>Server will start sending the following notification messages:</t>
7060                    <t>
7061                        <list>
7062                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
7063                        </list>
7064                    </t>
7065                    <t>where &lt;maps&gt; will be replaced by the new number
7066                    of MIDI instrument maps.</t>
7067                </section>
7068    
7069                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
7070                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
7071                    back-end by issuing the following command:</t>
7072                    <t>
7073                        <list>
7074                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
7075                        </list>
7076                    </t>
7077                    <t>Server will start sending the following notification messages:</t>
7078                    <t>
7079                        <list>
7080                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
7081                        </list>
7082                    </t>
7083                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
7084                    for which information changes occurred. The front-end will have to send
7085                    the respective command to actually get the MIDI instrument map info. Because these messages
7086                    will be triggered by LSCP commands issued by other clients rather than real
7087                    time events happening on the server, it is believed that an empty notification
7088                    message is sufficient here.</t>
7089                </section>
7090    
7091                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
7092                    <t>Client may want to be notified when the number of MIDI instrument maps on the
7093                    back-end changes by issuing the following command:</t>
7094                    <t>
7095                        <list>
7096                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
7097                        </list>
7098                    </t>
7099                    <t>Server will start sending the following notification messages:</t>
7100                    <t>
7101                        <list>
7102                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
7103                        </list>
7104                    </t>
7105                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
7106                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
7107                    the new number of MIDI instruments in the specified map.</t>
7108                </section>
7109    
7110                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
7111                    <t>Client may want to be notified when changes were made to MIDI instruments on the
7112                    back-end by issuing the following command:</t>
7113                    <t>
7114                        <list>
7115                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
7116                        </list>
7117                    </t>
7118                    <t>Server will start sending the following notification messages:</t>
7119                    <t>
7120                        <list>
7121                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
7122                        </list>
7123                    </t>
7124                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
7125                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
7126                    the location of the changed MIDI instrument in the map. The front-end will have to send
7127                    the respective command to actually get the MIDI instrument info. Because these messages
7128                    will be triggered by LSCP commands issued by other clients rather than real
7129                    time events happening on the server, it is believed that an empty notification
7130                    message is sufficient here.</t>
7131                </section>
7132    
7133                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
7134                    <t>Client may want to be notified when changes to the global settings
7135                    of the sampler were made by issuing the following command:</t>
7136                    <t>
7137                        <list>
7138                            <t>SUBSCRIBE GLOBAL_INFO</t>
7139                        </list>
7140                    </t>
7141                    <t>Server will start sending the following types of notification messages:</t>
7142                    <t>
7143                        <list>
7144                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
7145                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
7146                            replaced by the optional dotted floating point value, reflecting the
7147                            new global volume parameter.</t>
7148                        </list>
7149                    </t>
7150                </section>
7151    
7152                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
7153                    <t>Client may want to be notified when the number of instrument
7154                    directories in a particular directory in the instruments database
7155                    is changed by issuing the following command:</t>
7156                    <t>
7157                        <list>
7158                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
7159                        </list>
7160                    </t>
7161                    <t>Server will start sending the following notification messages:</t>
7162                    <t>
7163                        <list>
7164                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
7165                        </list>
7166                    </t>
7167                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7168                    name of the directory in the instruments database,
7169                    in which the number of directories is changed.</t>
7170                    <t>Note that when a non-empty directory is removed, this event
7171                    is not sent for the subdirectories in that directory.</t>
7172                </section>
7173    
7174                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
7175                    <t>Client may want to be notified when changes were made to directories
7176                    in the instruments database by issuing the following command:</t>
7177                    <t>
7178                        <list>
7179                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
7180                        </list>
7181                    </t>
7182                    <t>Server will start sending the following notification messages:</t>
7183                    <t>
7184                        <list>
7185                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
7186                        </list>
7187                    </t>
7188                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
7189                    of the directory, for which information changes occurred. The front-end will have to send
7190                    the respective command to actually get the updated directory info. Because these messages
7191                    will be triggered by LSCP commands issued by other clients rather than real
7192                    time events happening on the server, it is believed that an empty notification
7193                    message is sufficient here.</t>
7194                    <t>
7195                        <list>
7196                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
7197                        </list>
7198                    </t>
7199                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
7200                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7201                    the new name of the directory, encapsulated into apostrophes.</t>
7202                </section>
7203    
7204                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
7205                    <t>Client may want to be notified when the number of instruments
7206                    in a particular directory in the instruments database
7207                    is changed by issuing the following command:</t>
7208                    <t>
7209                        <list>
7210                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
7211                        </list>
7212                    </t>
7213                    <t>Server will start sending the following notification messages:</t>
7214                    <t>
7215                        <list>
7216                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
7217                        </list>
7218                    </t>
7219                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7220                    name of the directory in the instruments database,
7221                    in which the number of instruments is changed.</t>
7222                    <t>Note that when a non-empty directory is removed, this event
7223                    is not sent for the instruments in that directory.</t>
7224                </section>
7225    
7226                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
7227                    <t>Client may want to be notified when changes were made to instruments
7228                    in the instruments database by issuing the following command:</t>
7229                    <t>
7230                        <list>
7231                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
7232                        </list>
7233                    </t>
7234                    <t>Server will start sending the following notification messages:</t>
7235                    <t>
7236                        <list>
7237                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
7238                        </list>
7239                    </t>
7240                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
7241                    of the instrument, which settings are changed. The front-end will have to send
7242                    the respective command to actually get the updated directory info. Because these messages
7243                    will be triggered by LSCP commands issued by other clients rather than real
7244                    time events happening on the server, it is believed that an empty notification
7245                    message is sufficient here.</t>
7246                    <t>
7247                        <list>
7248                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
7249                        </list>
7250                    </t>
7251                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
7252                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7253                    the new name of the instrument, encapsulated into apostrophes.</t>
7254                </section>
7255    
7256                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7257                    <t>Client may want to be notified when the status of particular database
7258                    instruments job is changed by issuing the following command:</t>
7259                    <t>
7260                        <list>
7261                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7262                        </list>
7263                    </t>
7264                    <t>Server will start sending the following notification messages:</t>
7265                    <t>
7266                        <list>
7267                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7268                        </list>
7269                    </t>
7270                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7271                    which status is changed. The front-end will have to send the respective
7272                    command to actually get the status info. Because these messages
7273                    will be triggered by LSCP commands issued by other clients rather than real
7274                    time events happening on the server, it is believed that an empty notification
7275                    message is sufficient here.</t>
7276                </section>
7277    
7278              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7279                  <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
7280                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
# Line 4915  Schoenebeck'> Line 7353  Schoenebeck'>
7353                  </front>                  </front>
7354                  <seriesInfo name="RFC" value="2234" />                  <seriesInfo name="RFC" value="2234" />
7355              </reference>              </reference>
7356                <reference anchor="RFC20">
7357                    <front>
7358                        <title>ASCII format for Network Interchange</title>
7359                        <author>
7360                            <organization>UCLA</organization>
7361                        </author>
7362                        <date year="1969"></date>
7363                    </front>
7364                    <seriesInfo name="RFC" value="20" />
7365                </reference>
7366           </references>           </references>
7367      </back>      </back>
7368    
Legend:
Removed from v.973  
changed lines
  Added in v.1362
  ViewVC Help
Powered by ViewVC