/[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 706 by iliev, Thu Jul 21 08:34:46 2005 UTC revision 944 by schoenebeck, Sun Nov 26 16:29:57 2006 UTC
# Line 13  Line 13 
13  <?rfc iprnotified="no" ?>  <?rfc iprnotified="no" ?>
14  <?rfc strict="yes" ?>  <?rfc strict="yes" ?>
15    
16  <rfc category="std" ipr="full2026" docName="LSCP 1.1">  <rfc category="std" ipr="full2026" docName="LSCP 1.2">
17      <front>      <front>
18          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
19          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 31  Schoenebeck'> Line 31  Schoenebeck'>
31                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
32              </address>              </address>
33          </author>          </author>
34          <date month="May" year="2005"/>          <date month="November" year="2006"/>
35          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
36          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
37          <abstract>          <abstract>
# Line 2559  Schoenebeck'> Line 2559  Schoenebeck'>
2559                                      <t>MUTE -                                      <t>MUTE -
2560                                          <list>                                          <list>
2561                                              <t>Determines whether the channel is muted, "true" if the                                              <t>Determines whether the channel is muted, "true" if the
2562                                              channel is muted, "false" if the channel is not muted, and                                              channel is muted, "false" if the channel is not muted, and
2563                                              "MUTED_BY_SOLO" if the channel is muted because of the                                              "MUTED_BY_SOLO" if the channel is muted because of the
2564                                              presence of a solo channel and will be unmuted when                                              presence of a solo channel and will be unmuted when
2565                                              there are no solo channels left</t>                                              there are no solo channels left</t>
2566                                          </list>                                          </list>
2567                                      </t>                                      </t>
# Line 3329  Schoenebeck'> Line 3329  Schoenebeck'>
3329              <section title="Global commands">              <section title="Global commands">
3330                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
3331    
3332                    <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3333                        <t>The front-end can ask for the current number of active voices on
3334                        the sampler by sending the following command:</t>
3335                        <t>
3336                            <list>
3337                                <t>GET TOTAL_VOICE_COUNT</t>
3338                            </list>
3339                        </t>
3340    
3341                        <t>Possible Answers:</t>
3342                        <t>
3343                            <list>
3344                                <t>LinuxSampler will answer by returning the number of all active
3345                                voices on the sampler.</t>
3346                            </list>
3347                        </t>
3348                    </section>
3349    
3350                    <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3351                        <t>The front-end can ask for the maximum number of active voices
3352                        by sending the following command:</t>
3353                        <t>
3354                            <list>
3355                                <t>GET TOTAL_VOICE_COUNT_MAX</t>
3356                            </list>
3357                        </t>
3358    
3359                        <t>Possible Answers:</t>
3360                        <t>
3361                            <list>
3362                                <t>LinuxSampler will answer by returning the maximum number
3363                                of active voices.</t>
3364                            </list>
3365                        </t>
3366                    </section>
3367    
3368                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
3369                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
3370                      <t>                      <t>
# Line 3398  Schoenebeck'> Line 3434  Schoenebeck'>
3434                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
3435                  </section>                  </section>
3436              </section>              </section>
3437    
3438    
3439                <section title="MIDI Instrument Mapping">
3440                    <t>The MIDI protocol provides a way to switch between instruments
3441                    by sending so called MIDI bank select and MIDI program change
3442                    messages which are essentially just numbers. The following commands
3443                    allow to actually map arbitrary MIDI bank select / program change
3444                    numbers with real instruments.</t>
3445                    <t>By default, that is when the sampler is launched, this map will
3446                    be empty, thus the sampler will simply ignore all program change
3447                    messages. The front-end has to explicitly add entries to the map
3448                    so the sampler knows how to react on a given program change
3449                    message, that is by switching to the respectively defined engine
3450                    type and loading the respective instrument.</t>
3451                    <t>Also note per MIDI specification a bank select message does not
3452                    cause to switch to another instrument. Instead when receiving a
3453                    bank select message the bank value will be stored and a subsequent
3454                    program change message (which may occur at any time) will finally
3455                    cause the sampler to switch to the respective instrument as
3456                    reflected by the current MIDI instrument map.</t>
3457    
3458                    <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
3459                        <t>The front-end can create a new or replace an existing entry
3460                        in the sampler's MIDI instrument map by sending the following
3461                        command:</t>
3462                        <t>
3463                            <list>
3464                                <t>MAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt;
3465                                &lt;midi_bank_lsb&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
3466                                &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
3467                                [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
3468                            </list>
3469                        </t>
3470                        <t>Where &lt;midi_bank_msb&gt; is an integer value between
3471                        0..127 reflecting the MIDI bank select MSB (coarse) index,
3472                        &lt;midi_bank_lsb&gt; an integer value between 0..127 reflecting
3473                        the MIDI bank select LSB (fine) index, &lt;midi_prog&gt; an
3474                        integer value between 0..127 reflecting the MIDI program change
3475                        index, &lt;engine_name&gt; a sampler engine name as returned by
3476                        the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
3477                        command (not encapsulated into apostrophes), &lt;filename&gt; the name
3478                        of the instrument's file to be deployed (encapsulated into apostrophes), &lt;instrument_index&gt; the index (integer value) of the instrument
3479                        within the given file, &lt;volume_value&gt; reflects the master
3480                        volume of the instrument as optionally dotted number (where a
3481                        value < 1.0 means attenuation and a value > 1.0 means
3482                        amplification). This parameter easily allows to adjust the
3483                        volume of all intruments within a custom instrument map
3484                        without having to adjust their instrument files. The
3485                        OPTIONAL &lt;instr_load_mode&gt; argument defines the life
3486                        time of the instrument, that is when the instrument should
3487                        be loaded, when freed and has exactly the following
3488                        possibilities:</t>
3489                        <t>
3490                            <list>
3491                                <t>"ON_DEMAND" -
3492                                    <list>
3493                                        <t>The instrument will be loaded when needed,
3494                                        that is when demanded by at least one sampler
3495                                        channel. It will immediately be freed from memory
3496                                        when not needed by any sampler channel anymore.</t>
3497                                    </list>
3498                                </t>
3499                                <t>"ON_DEMAND_HOLD" -
3500                                    <list>
3501                                        <t>The instrument will be loaded when needed,
3502                                        that is when demanded by at least one sampler
3503                                        channel. It will be kept in memory even when
3504                                        not needed by any sampler channel anymore.
3505                                        Instruments with this mode are only freed
3506                                        when the sampler is reset or all mapping
3507                                        entries with this mode (and respective
3508                                        instrument) are explicitly changed to
3509                                        "ON_DEMAND" and no sampler channel is using
3510                                        the instrument anymore.</t>
3511                                    </list>
3512                                </t>
3513                                <t>"PERSISTENT" -
3514                                    <list>
3515                                        <t>The instrument will immediately be loaded
3516                                        into memory in the background when this mapping
3517                                        command is sent and the instrument is kept all
3518                                        the time. Instruments with this mode are
3519                                        only freed when the sampler is reset or all
3520                                        mapping entries with this mode (and
3521                                        respective instrument) are explicitly
3522                                        changed to "ON_DEMAND" and no sampler
3523                                        channel is using the instrument anymore.</t>
3524                                    </list>
3525                                </t>
3526                                <t>not supplied -
3527                                    <list>
3528                                        <t>In case there is no &lt;instr_load_mode&gt;
3529                                        argument given, it will be up to the
3530                                        InstrumentManager to decide which mode to use.
3531                                        Usually it will use "ON_DEMAND" if an entry
3532                                        for the given instrument does not exist in
3533                                        the InstrumentManager's list yet, otherwise
3534                                        if an entry already exists, it will simply
3535                                        stick with the mode currently reflected by
3536                                        the already existing entry, that is it will
3537                                        not change the mode.</t>
3538                                    </list>
3539                                </t>
3540                            </list>
3541                        </t>
3542                        <t>
3543                        The &lt;instr_load_mode&gt; argument thus allows to define an
3544                        appropriate strategy (low memory consumption vs. fast
3545                        instrument switching) for each instrument individually. Note, the
3546                        following restrictions apply to this argument: "ON_DEMAND_HOLD" and
3547                        "PERSISTENT" have to be supported by the respective sampler engine
3548                        (which is technically the case when the engine provides an
3549                        InstrumentManager for its format). If this is not the case the
3550                        argument will automatically fall back to the default value
3551                        "ON_DEMAND". Also the load mode of one instrument may
3552                        automatically change the laod mode of other instrument(s), i.e.
3553                        because the instruments are part of the same file and the
3554                        engine does not allow a way to manage load modes for them
3555                        individually. Due to this, in case the frontend shows the
3556                        load modes of entries, the frontend should retrieve the actual
3557                        mode by i.e. sending
3558                        <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
3559                        command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
3560                        set a custom name (encapsulated into apostrophes) for the mapping
3561                        entry, useful for frontends for displaying an appropriate name for
3562                        mapped instruments (using
3563                        <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
3564                        </t>
3565                        <t>
3566                        The "MAP MIDI_INSTRUMENT" command
3567                        will immediately return, thus it will not block when an
3568                        instrument is to be loaded due to a "PERSISTENT" type
3569                        entry as instruments are loaded in the background. As a
3570                        consequence this command may not necessarily return an error
3571                        i.e. when the given instrument file does not exist or may
3572                        turn out to be corrupt.
3573                        </t>
3574    
3575                        <t>Possible Answers:</t>
3576                        <t>
3577                            <list>
3578                                <t>"OK" -
3579                                    <list>
3580                                        <t>usually</t>
3581                                    </list>
3582                                </t>
3583                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3584                                    <list>
3585                                        <t>when the given engine does not exist or a value
3586                                        is out of range</t>
3587                                    </list>
3588                                </t>
3589                            </list>
3590                        </t>
3591    
3592                        <t>Examples:</t>
3593                        <t>
3594                            <list>
3595                                <t>C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
3596                                <t>S: "OK"</t>
3597                            </list>
3598                        </t>
3599                        <t>
3600                            <list>
3601                                <t>C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
3602                                <t>S: "OK"</t>
3603                            </list>
3604                        </t>
3605                        <t>
3606                            <list>
3607                                <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
3608                                <t>S: "OK"</t>
3609                                <t>C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
3610                                <t>S: "OK"</t>
3611                            </list>
3612                        </t>
3613                        <t>
3614                            <list>
3615                                <t>C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
3616                                <t>S: "OK"</t>
3617                            </list>
3618                        </t>
3619                    </section>
3620    
3621                    <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
3622                        <t>The front-end can query the amount of currently existing MIDI
3623                        instrument map entries by sending the following
3624                        command:</t>
3625                        <t>
3626                            <list>
3627                                <t>GET MIDI_INSTRUMENTS</t>
3628                            </list>
3629                        </t>
3630                        <t>Possible Answers:</t>
3631                        <t>
3632                            <list>
3633                                <t>LinuxSampler will answer by sending the current number of
3634                                entries in the sampler's MIDI instrument map.</t>
3635                            </list>
3636                        </t>
3637    
3638                        <t>Example:</t>
3639                        <t>
3640                            <list>
3641                                <t>C: "GET MIDI_INSTRUMENTS"</t>
3642                                <t>S: "634"</t>
3643                            </list>
3644                        </t>
3645                    </section>
3646    
3647                    <section title="Getting indeces of all MIDI instrument map entries" anchor="LIST MIDI_INSTRUMENTS">
3648                        <t>The front-end can query a list of all currently existing MIDI
3649                        instrument map entries by sending the following command:</t>
3650                        <t>
3651                            <list>
3652                                <t>LIST MIDI_INSTRUMENTS</t>
3653                            </list>
3654                        </t>
3655                        <t>Possible Answers:</t>
3656                        <t>
3657                            <list>
3658                                <t>LinuxSampler will answer by sending a comma separated
3659                                list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) -
3660                                MIDI program triples, where each triple is encapsulated
3661                                into curly braces. The list is returned in one single
3662                                line. Each triple just reflects the key of the respective
3663                                map entry, thus subsequent
3664                                <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
3665                                command(s) are necessary to retrieve detailed informations
3666                                about each entry.</t>
3667                            </list>
3668                        </t>
3669    
3670                        <t>Example:</t>
3671                        <t>
3672                            <list>
3673                                <t>C: "LIST MIDI_INSTRUMENTS"</t>
3674                                <t>S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"</t>
3675                            </list>
3676                        </t>
3677                    </section>
3678    
3679                    <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
3680                        <t>The front-end can delete an entry from the MIDI instrument
3681                        map by sending the following command:</t>
3682                        <t>
3683                            <list>
3684                                <t>UNMAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>
3685                            </list>
3686                        </t>
3687                        <t>
3688                        Where &lt;midi_bank_msb&gt; is an integer value between 0..127
3689                        reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;
3690                        an integer value between 0..127 reflecting the MIDI bank LSB
3691                        (fine) value and &lt;midi_prog&gt; an integer value between
3692                        0..127 reflecting the MIDI program value of the map entrie's key
3693                        index triple.
3694                        </t>
3695    
3696                        <t>Possible Answers:</t>
3697                        <t>
3698                            <list>
3699                                <t>"OK" -
3700                                    <list>
3701                                        <t>usually</t>
3702                                    </list>
3703                                </t>
3704                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3705                                    <list>
3706                                        <t>when index out of bounds</t>
3707                                    </list>
3708                                </t>
3709                            </list>
3710                        </t>
3711    
3712                        <t>Example:</t>
3713                        <t>
3714                            <list>
3715                                <t>C: "UNMAP MIDI_INSTRUMENT 2 40 127"</t>
3716                                <t>S: "OK"</t>
3717                            </list>
3718                        </t>
3719                    </section>
3720    
3721                    <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
3722                        <t>The front-end can retrieve the current settings of a certain
3723                        instrument map entry by sending the following command:</t>
3724                        <t>
3725                            <list>
3726                                <t>GET MIDI_INSTRUMENT INFO &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>
3727                            </list>
3728                        </t>
3729                        <t>
3730                        Where &lt;midi_bank_msb&gt; is an integer value between 0..127
3731                        reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;
3732                        an integer value between 0..127 reflecting the MIDI bank LSB
3733                        (fine) value and &lt;midi_prog&gt; an integer value between
3734                        0..127 reflecting the MIDI program value of the map entrie's key
3735                        index triple.
3736                        </t>
3737    
3738                        <t>Possible Answers:</t>
3739                        <t>
3740                            <list>
3741                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
3742                                separated list. Each answer line begins with the
3743                                information category name followed by a colon and then
3744                                a space character &lt;SP&gt; and finally the info
3745                                character string to that info category. At the moment
3746                                the following categories are defined:</t>
3747                                <t>"NAME" -
3748                                    <list>
3749                                        <t>Name for this MIDI instrument map entry (if defined).
3750                                        This name shall be used by frontends for displaying a
3751                                        name for this mapped instrument. It can be set and
3752                                        changed with the
3753                                        <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
3754                                        command and does not have to be unique.</t>
3755                                    </list>
3756                                </t>
3757                                <t>"ENGINE_NAME" -
3758                                    <list>
3759                                        <t>Name of the engine to be deployed for this
3760                                        instrument.</t>
3761                                    </list>
3762                                </t>
3763                                <t>"INSTRUMENT_FILE" -
3764                                    <list>
3765                                        <t>File name of the instrument.</t>
3766                                    </list>
3767                                </t>
3768                                <t>"INSTRUMENT_NR" -
3769                                    <list>
3770                                        <t>Index of the instrument within the file.</t>
3771                                    </list>
3772                                </t>
3773                                <t>"INSTRUMENT_NAME" -
3774                                    <list>
3775                                        <t>Name of the loaded instrument as reflected by its file.
3776                                        In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
3777                                        cannot be changed.</t>
3778                                    </list>
3779                                </t>
3780                                <t>"LOAD_MODE" -
3781                                    <list>
3782                                        <t>Life time of instrument
3783                                        (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
3784                                    </list>
3785                                </t>
3786                                <t>"VOLUME" -
3787                                    <list>
3788                                        <t>master volume of the instrument as optionally
3789                                        dotted number (where a value < 1.0 means attenuation
3790                                        and a value > 1.0 means amplification)</t>
3791                                    </list>
3792                                </t>
3793                                <t>The mentioned fields above don't have to be in particular order.</t>
3794                            </list>
3795                        </t>
3796    
3797                        <t>Example:</t>
3798                        <t>
3799                            <list>
3800                                <t>C: "GET MIDI_INSTRUMENT INFO 3 45 120"</t>
3801                                <t>S: "NAME: Drums for Foo Song"</t>
3802                                <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
3803                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
3804                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
3805                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
3806                                <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
3807                                <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
3808                                <t>&nbsp;&nbsp;&nbsp;"."</t>
3809                            </list>
3810                        </t>
3811                    </section>
3812    
3813                    <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
3814                        <t>The front-end can clear the whole MIDI instrument map, that
3815                        is delete all entries by sending the following command:</t>
3816                        <t>
3817                            <list>
3818                                <t>CLEAR MIDI_INSTRUMENTS</t>
3819                            </list>
3820                        </t>
3821    
3822                       <t>Possible Answers:</t>
3823                        <t>
3824                            <list>
3825                                <t>"OK" -
3826                                    <list>
3827                                        <t>always</t>
3828                                    </list>
3829                                </t>
3830                            </list>
3831                        </t>
3832    
3833                        <t>Example:</t>
3834                        <t>
3835                           <list>
3836                                <t>C: "CLEAR MIDI_INSTRUMENTS"</t>
3837                                <t>S: "OK"</t>
3838                            </list>
3839                        </t>
3840                    </section>
3841                </section>
3842    
3843          </section>          </section>
3844    
3845    
3846          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
3847              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
3848              is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)              is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
# Line 3422  Schoenebeck'> Line 3865  Schoenebeck'>
3865  </t>  </t>
3866  <t>line =  <t>line =
3867          <list>          <list>
3868                  <t>/* epsilon (empty line ignored) */                  <t>/* epsilon (empty line ignored) */
3869                  </t>                  </t>
3870                  <t>/ comment                    <t>/ comment
3871                  </t>                  </t>
3872                  <t>/ command                    <t>/ command
3873                  </t>                  </t>
3874                  <t>/ error                      <t>/ error
3875                  </t>                  </t>
3876          </list>          </list>
3877  </t>  </t>
# Line 3448  Schoenebeck'> Line 3891  Schoenebeck'>
3891  </t>  </t>
3892  <t>command =  <t>command =
3893          <list>          <list>
3894                  <t>ADD SP CHANNEL                                          <t>ADD SP CHANNEL
3895                    </t>
3896                    <t>/ MAP SP map_instruction
3897                    </t>
3898                    <t>/ UNMAP SP unmap_instruction
3899                    </t>
3900                    <t>/ GET SP get_instruction
3901                  </t>                  </t>
3902                  <t>/ GET SP get_instruction                                  <t>/ CREATE SP create_instruction
3903                  </t>                  </t>
3904                  <t>/ CREATE SP create_instruction                            <t>/ DESTROY SP destroy_instruction
3905                  </t>                  </t>
3906                  <t>/ DESTROY SP destroy_instruction                          <t>/ LIST SP list_instruction
3907                  </t>                  </t>
3908                  <t>/ LIST SP list_instruction                                <t>/ LOAD SP load_instruction
3909                  </t>                  </t>
3910                  <t>/ LOAD SP load_instruction                                <t>/ REMOVE SP remove_instruction
3911    
3912                  </t>                  </t>
3913                  <t>/ REMOVE SP CHANNEL SP sampler_channel                    <t>/ SET SP set_instruction
3914                  </t>                  </t>
3915                  <t>/ SET SP set_instruction                                  <t>/ SUBSCRIBE SP subscribe_event
3916                  </t>                  </t>
3917                  <t>/ SUBSCRIBE SP subscribe_event                            <t>/ UNSUBSCRIBE SP unsubscribe_event
3918                  </t>                  </t>
3919                  <t>/ UNSUBSCRIBE SP unsubscribe_event                        <t>/ SELECT SP text
3920                  </t>                  </t>
3921                  <t>/ SELECT SP text                                          <t>/ RESET SP reset_instruction
3922                  </t>                  </t>
3923                  <t>/ RESET SP CHANNEL SP sampler_channel                    <t>/ CLEAR SP clear_instruction
3924                  </t>                  </t>
3925                  <t>/ RESET                                                  <t>/ RESET
3926                  </t>                  </t>
3927                  <t>/ QUIT                                                    <t>/ QUIT
3928                  </t>                  </t>
3929          </list>          </list>
3930  </t>  </t>
3931  <t>subscribe_event =  <t>subscribe_event =
3932          <list>          <list>
3933                  <t>CHANNEL_COUNT                                          <t>CHANNEL_COUNT
3934                    </t>
3935                    <t>/ VOICE_COUNT
3936                  </t>                  </t>
3937                  <t>/ VOICE_COUNT                                            <t>/ STREAM_COUNT
3938                  </t>                  </t>
3939                  <t>/ STREAM_COUNT                                            <t>/ BUFFER_FILL
3940                  </t>                  </t>
3941                  <t>/ BUFFER_FILL                                            <t>/ CHANNEL_INFO
3942                  </t>                  </t>
3943                  <t>/ CHANNEL_INFO                                            <t>/ MISCELLANEOUS
3944                  </t>                  </t>
3945                  <t>/ MISCELLANEOUS                                          <t>/ TOTAL_VOICE_COUNT
3946                  </t>                  </t>
3947          </list>          </list>
3948  </t>  </t>
3949  <t>unsubscribe_event =  <t>unsubscribe_event =
3950          <list>          <list>
3951                  <t>CHANNEL_COUNT                                          <t>CHANNEL_COUNT
3952                    </t>
3953                    <t>/ VOICE_COUNT
3954                    </t>
3955                    <t>/ STREAM_COUNT
3956                    </t>
3957                    <t>/ BUFFER_FILL
3958                    </t>
3959                    <t>/ CHANNEL_INFO
3960                    </t>
3961                    <t>/ MISCELLANEOUS
3962                    </t>
3963                    <t>/ TOTAL_VOICE_COUNT
3964                    </t>
3965            </list>
3966    </t>
3967    <t>map_instruction =
3968            <list>
3969                    <t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
3970                  </t>                  </t>
3971                  <t>/ VOICE_COUNT                                            <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
3972                  </t>                  </t>
3973                  <t>/ STREAM_COUNT                                            <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
3974                  </t>                  </t>
3975                  <t>/ BUFFER_FILL                                            <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
3976                  </t>                  </t>
3977                  <t>/ CHANNEL_INFO                                    </list>
3978    </t>
3979    <t>unmap_instruction =
3980            <list>
3981                    <t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog
3982                  </t>                  </t>
3983                  <t>/ MISCELLANEOUS                                  </list>
3984    </t>
3985    <t>remove_instruction =
3986            <list>
3987                    <t>CHANNEL SP sampler_channel
3988                  </t>                  </t>
3989          </list>          </list>
3990  </t>  </t>
3991  <t>get_instruction =  <t>get_instruction =
3992          <list>          <list>
3993                  <t>AVAILABLE_ENGINES                                                                            <t>AVAILABLE_ENGINES
3994                  </t>                  </t>
3995                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS                                                                <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3996                  </t>                  </t>
3997                  <t>/ MIDI_INPUT_DRIVER SP INFO SP string                                                          <t>/ MIDI_INPUT_DRIVER SP INFO SP string
3998                  </t>                  </t>
3999                  <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string                                      <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
4000                  </t>                  </t>
4001                  <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list                      <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
4002                  </t>                  </t>
4003                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                                                              <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
4004                  </t>                  </t>
4005                  <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string                                                        <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
4006                  </t>                  </t>
4007                  <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string                                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
4008                  </t>                  </t>
4009                  <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
4010                  </t>                  </t>
4011                  <t>/ AUDIO_OUTPUT_DEVICES                                                                        <t>/ AUDIO_OUTPUT_DEVICES
4012                  </t>                  </t>
4013                  <t>/ MIDI_INPUT_DEVICES                                                                          <t>/ MIDI_INPUT_DEVICES
4014                  </t>                  </t>
4015                  <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number                                                        <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
4016                  </t>                  </t>
4017                  <t>/ MIDI_INPUT_DEVICE SP INFO SP number                                                          <t>/ MIDI_INPUT_DEVICE SP INFO SP number
4018                  </t>                  </t>
4019                  <t>/ MIDI_INPUT_PORT SP INFO SP number SP number                                                  <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
4020                  </t>                  </t>
4021                  <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string                              <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
4022                  </t>                  </t>
4023                  <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number                                            <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
4024                  </t>                  </t>
4025                  <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string                        <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
4026                  </t>                  </t>
4027                  <t>/ CHANNELS                                                                                    <t>/ CHANNELS
4028                  </t>                  </t>
4029                  <t>/ CHANNEL SP INFO SP sampler_channel                                                          <t>/ CHANNEL SP INFO SP sampler_channel
4030                  </t>                  </t>
4031                  <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel                                <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
4032                  </t>                  </t>
4033                  <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel                                                  <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
4034                  </t>                  </t>
4035                  <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel                                                    <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
4036                  </t>                  </t>
4037                  <t>/ ENGINE SP INFO SP engine_name                                                                <t>/ ENGINE SP INFO SP engine_name
4038                  </t>                  </t>
4039                  <t>/ SERVER SP INFO                                                                              <t>/ SERVER SP INFO
4040                    </t>
4041                    <t>/ TOTAL_VOICE_COUNT
4042                    </t>
4043                    <t>/ TOTAL_VOICE_COUNT_MAX
4044                    </t>
4045                    <t>/ MIDI_INSTRUMENTS
4046                    </t>
4047                    <t>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog
4048                  </t>                  </t>
4049          </list>          </list>
4050  </t>  </t>
4051  <t>set_instruction =  <t>set_instruction =
4052          <list>          <list>
4053                  <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                              <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
4054                  </t>                  </t>
4055                  <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
4056                  </t>                  </t>
4057                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                                <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
4058                  </t>                  </t>
4059                  <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
4060                  </t>                  </t>
4061                  <t>/ CHANNEL SP set_chan_instruction                                                                    <t>/ CHANNEL SP set_chan_instruction
4062                  </t>                  </t>
4063                  <t>/ ECHO SP boolean                                                                                    <t>/ ECHO SP boolean
4064                  </t>                  </t>
4065          </list>          </list>
4066  </t>  </t>
4067  <t>create_instruction =  <t>create_instruction =
4068          <list>          <list>
4069                  <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list                    <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
4070                  </t>                  </t>
4071                  <t>/ AUDIO_OUTPUT_DEVICE SP string                                    <t>/ AUDIO_OUTPUT_DEVICE SP string
4072                  </t>                  </t>
4073                  <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list                      <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
4074                  </t>                  </t>
4075                  <t>/ MIDI_INPUT_DEVICE SP string                                      <t>/ MIDI_INPUT_DEVICE SP string
4076                    </t>
4077            </list>
4078    </t>
4079    <t>reset_instruction =
4080            <list>
4081                    <t>CHANNEL SP sampler_channel
4082                    </t>
4083            </list>
4084    </t>
4085    <t>clear_instruction =
4086            <list>
4087                    <t>MIDI_INSTRUMENTS
4088                  </t>                  </t>
4089          </list>          </list>
4090  </t>  </t>
4091  <t>destroy_instruction =  <t>destroy_instruction =
4092          <list>          <list>
4093                  <t>AUDIO_OUTPUT_DEVICE SP number                    <t>AUDIO_OUTPUT_DEVICE SP number
4094                  </t>                  </t>
4095                  <t>/ MIDI_INPUT_DEVICE SP number                      <t>/ MIDI_INPUT_DEVICE SP number
4096                  </t>                  </t>
4097          </list>          </list>
4098  </t>  </t>
4099  <t>load_instruction =  <t>load_instruction =
4100          <list>          <list>
4101                  <t>INSTRUMENT SP load_instr_args                    <t>INSTRUMENT SP load_instr_args
4102                  </t>                  </t>
4103                  <t>/ ENGINE SP load_engine_args                      <t>/ ENGINE SP load_engine_args
4104                  </t>                  </t>
4105          </list>          </list>
4106  </t>  </t>
4107  <t>set_chan_instruction =  <t>set_chan_instruction =
4108          <list>          <list>
4109                  <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index                                                                <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
4110                  </t>                  </t>
4111                  <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index                                <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
4112                  </t>                  </t>
4113                  <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name                                                        <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
4114                  </t>                  </t>
4115                  <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index                    <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
4116                  </t>                  </t>
4117                  <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index                                                                  <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
4118                  </t>                  </t>
4119                  <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index                                                          <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
4120                  </t>                  </t>
4121                  <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index                                                    <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
4122                  </t>                  </t>
4123                  <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name                                                            <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
4124                  </t>                  </t>
4125                  <t>/ VOLUME SP sampler_channel SP volume_value                                                                            <t>/ VOLUME SP sampler_channel SP volume_value
4126                  </t>                  </t>
4127                  <t>/ MUTE SP sampler_channel SP boolean                                                                                    <t>/ MUTE SP sampler_channel SP boolean
4128                  </t>                  </t>
4129                  <t>/ SOLO SP sampler_channel SP boolean                                                                                    <t>/ SOLO SP sampler_channel SP boolean
4130                  </t>                  </t>
4131          </list>          </list>
4132  </t>  </t>
4133  <t>key_val_list =  <t>key_val_list =
4134          <list>          <list>
4135                  <t>string '=' param_val_list                                    <t>string '=' param_val_list
4136                  </t>                  </t>
4137                  <t>/ key_val_list SP string '=' param_val_list                    <t>/ key_val_list SP string '=' param_val_list
4138                  </t>                  </t>
4139          </list>          </list>
4140  </t>  </t>
4141  <t>buffer_size_type =  <t>buffer_size_type =
4142          <list>          <list>
4143                  <t>BYTES                        <t>BYTES
4144                  </t>                  </t>
4145                  <t>/ PERCENTAGE                    <t>/ PERCENTAGE
4146                  </t>                  </t>
4147          </list>          </list>
4148  </t>  </t>
4149  <t>list_instruction =  <t>list_instruction =
4150          <list>          <list>
4151                  <t>AUDIO_OUTPUT_DEVICES                              <t>AUDIO_OUTPUT_DEVICES
4152                    </t>
4153                    <t>/ MIDI_INPUT_DEVICES
4154                  </t>                  </t>
4155                  <t>/ MIDI_INPUT_DEVICES                                <t>/ CHANNELS
4156                  </t>                  </t>
4157                  <t>/ CHANNELS                                          <t>/ AVAILABLE_ENGINES
4158                  </t>                  </t>
4159                  <t>/ AVAILABLE_ENGINES                                <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
4160                  </t>                  </t>
4161                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS                      <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
4162                  </t>                  </t>
4163                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                    <t>/ MIDI_INSTRUMENTS
4164                  </t>                  </t>
4165          </list>          </list>
4166  </t>  </t>
4167  <t>load_instr_args =  <t>load_instr_args =
4168          <list>          <list>
4169                  <t>filename SP instrument_index SP sampler_channel                                <t>filename SP instrument_index SP sampler_channel
4170                  </t>                  </t>
4171                  <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel                    <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
4172                  </t>                  </t>
4173          </list>          </list>
4174  </t>  </t>
4175  <t>load_engine_args =  <t>load_engine_args =
4176          <list>          <list>
4177                  <t>engine_name SP sampler_channel                    <t>engine_name SP sampler_channel
4178                    </t>
4179            </list>
4180    </t>
4181    <t>instr_load_mode =
4182            <list>
4183                    <t>ON_DEMAND
4184                    </t>
4185                    <t>/ ON_DEMAND_HOLD
4186                    </t>
4187                    <t>/ PERSISTENT
4188                  </t>                  </t>
4189          </list>          </list>
4190  </t>  </t>
# Line 3706  Schoenebeck'> Line 4216  Schoenebeck'>
4216          <list>          <list>
4217                  <t>number                  <t>number
4218                  </t>                  </t>
4219                  <t>/ ALL                    <t>/ ALL
4220                  </t>                  </t>
4221          </list>          </list>
4222  </t>  </t>
# Line 3716  Schoenebeck'> Line 4226  Schoenebeck'>
4226                  </t>                  </t>
4227          </list>          </list>
4228  </t>  </t>
4229    <t>midi_bank_msb =
4230            <list>
4231                    <t>number
4232                    </t>
4233            </list>
4234    </t>
4235    <t>midi_bank_lsb =
4236            <list>
4237                    <t>number
4238                    </t>
4239            </list>
4240    </t>
4241    <t>midi_prog =
4242            <list>
4243                    <t>number
4244                    </t>
4245            </list>
4246    </t>
4247  <t>volume_value =  <t>volume_value =
4248          <list>          <list>
4249                  <t>dotnum                  <t>dotnum
4250                  </t>                  </t>
4251                  <t>/ number                    <t>/ number
4252                  </t>                  </t>
4253          </list>          </list>
4254  </t>  </t>
# Line 3748  Schoenebeck'> Line 4276  Schoenebeck'>
4276                  </t>                  </t>
4277          </list>          </list>
4278  </t>  </t>
4279    <t>entry_name =
4280            <list>
4281                    <t>stringval
4282                    </t>
4283            </list>
4284    </t>
4285  <t>param_val_list =  <t>param_val_list =
4286          <list>          <list>
4287                  <t>param_val                  <t>param_val
4288                  </t>                  </t>
4289                  <t>/ param_val_list','param_val                    <t>/ param_val_list','param_val
4290                  </t>                  </t>
4291          </list>          </list>
4292  </t>  </t>
# Line 3760  Schoenebeck'> Line 4294  Schoenebeck'>
4294          <list>          <list>
4295                  <t>string                  <t>string
4296                  </t>                  </t>
4297                  <t>/ '\'' string '\''                      <t>/ stringval
                 </t>  
                 <t>/ '\"' string '\"'      
4298                  </t>                  </t>
4299                  <t>/ number                              <t>/ number
4300                  </t>                  </t>
4301                  <t>/ dotnum                              <t>/ dotnum
4302                  </t>                  </t>
4303          </list>          </list>
4304  </t>  </t>
# Line 3876  Schoenebeck'> Line 4408  Schoenebeck'>
4408                  message is sufficient here.</t>                  message is sufficient here.</t>
4409              </section>              </section>
4410    
4411                <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
4412                    <t>Client may want to be notified when the total number of voices on the
4413                    back-end changes by issuing the following command:</t>
4414                    <t>
4415                        <list>
4416                            <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
4417                        </list>
4418                    </t>
4419                    <t>Server will start sending the following notification messages:</t>
4420                    <t>
4421                        <list>
4422                            <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>
4423                        </list>
4424                    </t>
4425                    <t>where &lt;voices&gt; will be replaced by the new number of
4426                    all currently active voices.</t>
4427                </section>
4428    
4429              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
4430                  <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
4431                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.706  
changed lines
  Added in v.944
  ViewVC Help
Powered by ViewVC