/[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 1387 by iliev, Sun Oct 7 10:32:53 2007 UTC revision 1782 by iliev, Tue Sep 30 02:16:41 2008 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.2cvs">  <rfc category="std" ipr="full3978" docName="LSCP 1.4">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol (draft)</title>          <title>LinuxSampler Control Protocol</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="September" year="2007"/>          <date month="September" year="2008"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 2162  Schoenebeck'> Line 2162  Schoenebeck'>
2162                              </t>                              </t>
2163                          </list>                          </list>
2164                      </t>                      </t>
2165                      <t>Example:</t>                      <t>Example (Unix):</t>
2166                      <t>                      <t>
2167                          <list>                          <list>
2168                              <t></t>                              <t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t>
2169                                <t>S: OK</t>
2170                            </list>
2171                        </t>
2172                        <t>Example (Windows):</t>
2173                        <t>
2174                            <list>
2175                                <t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t>
2176                                <t>S: OK</t>
2177                          </list>                          </list>
2178                      </t>                      </t>
2179                  </section>                  </section>
# Line 2443  Schoenebeck'> Line 2451  Schoenebeck'>
2451                                  <list>                                  <list>
2452                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
2453                                          <list>                                          <list>
2454                                              <t>arbitrary description text about the engine</t>                                              <t>arbitrary description text about the engine
2455                                                (note that the character string may contain
2456                                                <xref target="character_set">escape sequences</xref>)</t>
2457                                          </list>                                          </list>
2458                                      </t>                                      </t>
2459                                       <t>VERSION -                                       <t>VERSION -
# Line 2527  Schoenebeck'> Line 2537  Schoenebeck'>
2537                                          <list>                                          <list>
2538                                              <t>the file name of the loaded instrument, "NONE" if                                              <t>the file name of the loaded instrument, "NONE" if
2539                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
2540                                              channel</t>                                              channel (note: since LSCP 1.2 this path may contain
2541                                                <xref target="character_set">escape sequences</xref>)</t>
2542                                          </list>                                          </list>
2543                                      </t>                                      </t>
2544                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 2537  Schoenebeck'> Line 2548  Schoenebeck'>
2548                                      </t>                                      </t>
2549                                      <t>INSTRUMENT_NAME -                                      <t>INSTRUMENT_NAME -
2550                                          <list>                                          <list>
2551                                              <t>the instrument name of the loaded instrument</t>                                              <t>the instrument name of the loaded instrument
2552                                                (note: since LSCP 1.2 this character string may contain
2553                                                <xref target="character_set">escape sequences</xref>)</t>
2554                                          </list>                                          </list>
2555                                      </t>                                      </t>
2556                                      <t>INSTRUMENT_STATUS -                                      <t>INSTRUMENT_STATUS -
# Line 3255  Schoenebeck'> Line 3268  Schoenebeck'>
3268                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3269                      is a number between 0..127 defining the MIDI controller which can alter the                      is a number between 0..127 defining the MIDI controller which can alter the
3270                      effect send level and &lt;name&gt; is an optional argument defining a name                      effect send level and &lt;name&gt; is an optional argument defining a name
3271                      for the effect send entity. The name does not have to be unique.</t>                      for the effect send entity. The name does not have to be unique, but MUST be
3272                        encapsulated into apostrophes and supports escape sequences as described in chapter
3273                        "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3274    
3275                      <t>By default, that is as initial routing, the effect send's audio channels                      <t>By default, that is as initial routing, the effect send's audio channels
3276                      are automatically routed to the last audio channels of the sampler channel's                      are automatically routed to the last audio channels of the sampler channel's
# Line 3445  Schoenebeck'> Line 3460  Schoenebeck'>
3460                                  <list>                                  <list>
3461                                      <t>NAME -                                      <t>NAME -
3462                                          <list>                                          <list>
3463                                              <t>name of the effect send entity</t>                                              <t>name of the effect send entity
3464                                                (note that this character string may contain
3465                                                 <xref target="character_set">escape sequences</xref>)</t>
3466                                          </list>                                          </list>
3467                                      </t>                                      </t>
3468                                      <t>MIDI_CONTROLLER -                                      <t>MIDI_CONTROLLER -
# Line 3508  Schoenebeck'> Line 3525  Schoenebeck'>
3525                      as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>                      as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3526                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3527                      &lt;name&gt; is the new name of the effect send entity, which                      &lt;name&gt; is the new name of the effect send entity, which
3528                      does not have to be unique.</t>                      does not have to be unique (name MUST be encapsulated into apostrophes
3529                        and supports escape sequences as described in chapter
3530                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
3531                        </t>
3532    
3533                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3534                      <t>                      <t>
# Line 3691  Schoenebeck'> Line 3711  Schoenebeck'>
3711                      </t>                      </t>
3712                  </section>                  </section>
3713    
3714                    <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3715                        <t>The front-end can send MIDI events to specific sampler channel
3716                        by sending the following command:</t>
3717                        <t>
3718                            <list>
3719                                <t>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;</t>
3720                            </list>
3721                        </t>
3722                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3723                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3724                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3725                        &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
3726                        specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3727                        <t>
3728                            <list>
3729                                <t>"NOTE_ON" -
3730                                    <list>
3731                                        <t>For turning on MIDI notes, where &lt;arg1&gt;
3732                                        specifies the key number and &lt;arg2&gt; the velocity
3733                                        as described in the MIDI specification.</t>
3734                                    </list>
3735                                </t>
3736                                <t>"NOTE_OFF" -
3737                                    <list>
3738                                        <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3739                                        specifies the key number and &lt;arg2&gt; the velocity
3740                                        as described in the MIDI specification.</t>
3741                                    </list>
3742                                </t>
3743                            </list>
3744                        </t>
3745                        <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3746                        and no realtime guarantee whatsoever will be made!</t>
3747                        <t>Possible Answers:</t>
3748                        <t>
3749                            <list>
3750                                <t>"OK" -
3751                                    <list>
3752                                        <t>on success</t>
3753                                    </list>
3754                                </t>
3755                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3756                                    <list>
3757                                        <t>in case it failed, providing an appropriate error code and error message</t>
3758                                    </list>
3759                                </t>
3760                            </list>
3761                        </t>
3762                        <t>Example:</t>
3763                        <t>
3764                            <list>
3765                                <t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t>
3766                                <t>S: "OK"</t>
3767                            </list>
3768                        </t>
3769                    </section>
3770    
3771                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3772                      <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>
3773                      <t>                      <t>
# Line 3912  Schoenebeck'> Line 3989  Schoenebeck'>
3989                      </t>                      </t>
3990                  </section>                  </section>
3991    
3992                    <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
3993                        <t>The front-end can ask for the current number of active disk streams on
3994                        the sampler by sending the following command:</t>
3995                        <t>
3996                            <list>
3997                                <t>GET TOTAL_STREAM_COUNT</t>
3998                            </list>
3999                        </t>
4000    
4001                        <t>Possible Answers:</t>
4002                        <t>
4003                            <list>
4004                                <t>LinuxSampler will answer by returning the number of all active
4005                                disk streams on the sampler.</t>
4006                            </list>
4007                        </t>
4008                    </section>
4009    
4010                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
4011                      <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>
4012                      <t>                      <t>
# Line 3959  Schoenebeck'> Line 4054  Schoenebeck'>
4054                                  <list>                                  <list>
4055                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
4056                                          <list>                                          <list>
4057                                              <t>arbitrary textual description about the sampler                                              <t>arbitrary textual description about the sampler
4058                                              (note that the character string may contain                                              (note that the character string may contain
4059                                              <xref target="character_set">escape sequences</xref>)</t>                                              <xref target="character_set">escape sequences</xref>)</t>
4060                                          </list>                                          </list>
4061                                      </t>                                      </t>
# Line 4077  Schoenebeck'> Line 4172  Schoenebeck'>
4172                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
4173                  reflected by the current MIDI instrument map.</t>                  reflected by the current MIDI instrument map.</t>
4174    
4175                  <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP">                  <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP">
4176                      <t>The front-end can add a new MIDI instrument map by sending                      <t>The front-end can add a new MIDI instrument map by sending
4177                      the following command:</t>                      the following command:</t>
4178                      <t>                      <t>
# Line 4087  Schoenebeck'> Line 4182  Schoenebeck'>
4182                      </t>                      </t>
4183                      <t>Where &lt;name&gt; is an optional argument allowing to                      <t>Where &lt;name&gt; is an optional argument allowing to
4184                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
4185                      names do not have to be unique.</t>                      names do not have to be unique, but MUST be encapsulated
4186                        into apostrophes and support escape sequences as described
4187                        in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4188                        </t>
4189    
4190                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4191                      <t>                      <t>
# Line 4258  Schoenebeck'> Line 4356  Schoenebeck'>
4356                                      <t>NAME -                                      <t>NAME -
4357                                          <list>                                          <list>
4358                                              <t>custom name of the given map,                                              <t>custom name of the given map,
4359                                              which does not have to be unique</t>                                              which does not have to be unique
4360                                                (note that this character string may contain
4361                                                 <xref target="character_set">escape sequences</xref>)</t>
4362                                          </list>                                          </list>
4363                                      </t>                                      </t>
4364                                      <t>DEFAULT -                                      <t>DEFAULT -
# Line 4294  Schoenebeck'> Line 4394  Schoenebeck'>
4394                      </t>                      </t>
4395                      <t>Where &lt;map&gt; is the numerical ID of the map and                      <t>Where &lt;map&gt; is the numerical ID of the map and
4396                      &lt;name&gt; the new custom name of the map, which does not                      &lt;name&gt; the new custom name of the map, which does not
4397                      have to be unique.</t>                      have to be unique (name MUST be encapsulated into apostrophes
4398                        and supports escape sequences as described in chapter
4399                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
4400                        </t>
4401    
4402                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4403                      <t>                      <t>
# Line 4652  Schoenebeck'> Line 4755  Schoenebeck'>
4755                                      name for this mapped instrument. It can be set and                                      name for this mapped instrument. It can be set and
4756                                      changed with the                                      changed with the
4757                                      <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>                                      <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
4758                                      command and does not have to be unique.</t>                                      command and does not have to be unique.
4759                                        (note that this character string may contain
4760                                        <xref target="character_set">escape sequences</xref>)</t>
4761                                  </list>                                  </list>
4762                              </t>                              </t>
4763                              <t>"ENGINE_NAME" -                              <t>"ENGINE_NAME" -
# Line 4663  Schoenebeck'> Line 4768  Schoenebeck'>
4768                              </t>                              </t>
4769                              <t>"INSTRUMENT_FILE" -                              <t>"INSTRUMENT_FILE" -
4770                                  <list>                                  <list>
4771                                      <t>File name of the instrument.</t>                                      <t>File name of the instrument
4772                                        (note that this path may contain
4773                                        <xref target="character_set">escape sequences</xref>).</t>
4774                                  </list>                                  </list>
4775                              </t>                              </t>
4776                              <t>"INSTRUMENT_NR" -                              <t>"INSTRUMENT_NR" -
# Line 4675  Schoenebeck'> Line 4782  Schoenebeck'>
4782                                  <list>                                  <list>
4783                                      <t>Name of the loaded instrument as reflected by its file.                                      <t>Name of the loaded instrument as reflected by its file.
4784                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4785                                      cannot be changed.</t>                                      cannot be changed (note that this character string may contain
4786                                        <xref target="character_set">escape sequences</xref>).</t>
4787                                  </list>                                  </list>
4788                              </t>                              </t>
4789                              <t>"LOAD_MODE" -                              <t>"LOAD_MODE" -
# Line 5242  Schoenebeck'> Line 5350  Schoenebeck'>
5350                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5351                      <t>                      <t>
5352                          <list>                          <list>
5353                              <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>                              <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5354                          </list>                          </list>
5355                      </t>                      </t>
5356                      <t>Where &lt;db_dir&gt; is the absolute path name of a directory                      <t>Where &lt;db_dir&gt; is the absolute path name of a directory
# Line 5287  Schoenebeck'> Line 5395  Schoenebeck'>
5395                          </list>                          </list>
5396                      </t>                      </t>
5397    
5398                     <t> If FILE_AS_DIR argument is supplied, all instruments in an instrument
5399                     file will be added to a separate directory in the instruments database, which
5400                     name will be the name of the instrument file with the file extension stripped off.
5401                     </t>
5402                   <t>The difference between regular and NON_MODAL versions of the command                   <t>The difference between regular and NON_MODAL versions of the command
5403                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
5404                      while NON_MODAL version returns immediately and a background process is launched.                      while NON_MODAL version returns immediately and a background process is launched.
# Line 5690  Schoenebeck'> Line 5802  Schoenebeck'>
5802                          </list>                          </list>
5803                      </t>                      </t>
5804                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5805                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
5806                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
5807                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5808    
# Line 5933  Schoenebeck'> Line 6045  Schoenebeck'>
6045                              <t>FORMAT INSTRUMENTS_DB</t>                              <t>FORMAT INSTRUMENTS_DB</t>
6046                          </list>                          </list>
6047                      </t>                      </t>
6048                        
6049                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
6050                      <t>                      <t>
6051                          <list>                          <list>
# Line 5952  Schoenebeck'> Line 6064  Schoenebeck'>
6064                      </t>                      </t>
6065                  </section>                  </section>
6066    
6067                    <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">
6068                        <t>The front-end can retrieve the list of all instrument files in the instruments database
6069                        that don't exist in the filesystem by sending the following command:</t>
6070                        <t>
6071                            <list>
6072                                <t>FIND LOST DB_INSTRUMENT_FILES</t>
6073                            </list>
6074                        </t>
6075    
6076                        <t>Possible Answers:</t>
6077                        <t>
6078                            <list>
6079                                <t>A comma separated list with the absolute path names
6080                                (encapsulated into apostrophes) of all lost instrument files.</t>
6081                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6082                                    <list>
6083                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6084                                    </list>
6085                                </t>
6086                            </list>
6087                        </t>
6088                        <t>Example:</t>
6089                        <t>
6090                            <list>
6091                                <t>C: "FIND LOST DB_INSTRUMENT_FILES"</t>
6092                                <t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t>
6093                            </list>
6094                        </t>
6095                    </section>
6096    
6097                    <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">
6098                        <t>The front-end can substitute all occurrences of an instrument file
6099                        in the instruments database with a new one by sending the following command:</t>
6100                        <t>
6101                            <list>
6102                                <t>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;</t>
6103                            </list>
6104                        </t>
6105                        <t>Where &lt;old_path&gt; is the absolute path name of the instrument file
6106                        to substitute with &lt;new_path&gt;.</t>
6107    
6108                        <t>Possible Answers:</t>
6109                        <t>
6110                            <list>
6111                                <t>"OK" -
6112                                    <list>
6113                                        <t>on success</t>
6114                                    </list>
6115                                </t>
6116                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6117                                    <list>
6118                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6119                                    </list>
6120                                </t>
6121                            </list>
6122                        </t>
6123    
6124                        <t>Example:</t>
6125                        <t>
6126                            <list>
6127                                <t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t>
6128                                <t>S: "OK"</t>
6129                            </list>
6130                        </t>
6131                    </section>
6132    
6133              </section>              </section>
6134    
6135    
# Line 5972  Schoenebeck'> Line 6150  Schoenebeck'>
6150                      editor application by sending the following command:</t>                      editor application by sending the following command:</t>
6151                      <t>                      <t>
6152                          <list>                          <list>
6153                              <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>                              <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6154                          </list>                          </list>
6155                      </t>                      </t>
6156                      <t>Where &lt;sampler-channel&gt; should be replaced by the                      <t>Where &lt;sampler-channel&gt; should be replaced by the
# Line 6024  Schoenebeck'> Line 6202  Schoenebeck'>
6202                      <t>Examples:</t>                      <t>Examples:</t>
6203                      <t>                      <t>
6204                          <list>                          <list>
6205                              <t>C: "EDIT INSTRUMENT 0"</t>                              <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6206                              <t>S: "OK"</t>                              <t>S: "OK"</t>
6207                          </list>                          </list>
6208                      </t>                      </t>
6209                  </section>                  </section>
6210              </section>              </section>
         </section>  
6211    
6212                <section title="Managing Files" anchor="file_management">
6213                    <t>You can query detailed informations about files located
6214                    at the same system where the sampler instance is running on.
6215                    Using this command set allows to retrieve file informations
6216                    even remotely from another machine.</t>
6217    
6218                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6219                        <t>The front-end can retrieve the amount of instruments
6220                        within a given instrument file by sending the
6221                        following command:</t>
6222                        <t>
6223                            <list>
6224                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6225                            </list>
6226                        </t>
6227                        <t>Where &lt;filename&gt; is the name of the instrument
6228                        file (encapsulated into apostrophes, supporting escape
6229                        sequences as described in chapter
6230                        "<xref target="character_set">Character Set and Escape
6231                            Sequences</xref>").</t>
6232    
6233                        <t>The sampler will try to ask all sampler engines,
6234                        whether they support the given file and ask the first
6235                        engine with a positive answer for the amount of
6236                        instruments.</t>
6237    
6238                        <t>Possible Answers:</t>
6239                        <t>
6240                            <list>
6241                                <t>On success, the sampler will answer by
6242                                   returning the amount of instruments.
6243                                </t>
6244                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6245                                    <list>
6246                                        <t>if the file could not be handled</t>
6247                                    </list>
6248                                </t>
6249                            </list>
6250                        </t>
6251    
6252                        <t>Examples:</t>
6253                        <t>
6254                            <list>
6255                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6256                                <t>S: "10"</t>
6257                            </list>
6258                        </t>
6259                    </section>
6260    
6261                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6262                        <t>The front-end can retrieve a list of all instruments
6263                        within a given instrument file by sending the
6264                        following command:</t>
6265                        <t>
6266                            <list>
6267                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6268                            </list>
6269                        </t>
6270                        <t>Where &lt;filename&gt; is the name of the instrument
6271                        file (encapsulated into apostrophes, supporting escape
6272                        sequences as described in chapter
6273                        "<xref target="character_set">Character Set and Escape
6274                            Sequences</xref>").</t>
6275    
6276                        <t>The sampler will try to ask all sampler engines,
6277                        whether they support the given file and ask the first
6278                        engine with a positive answer for a list of IDs for the
6279                        instruments in the given file.</t>
6280    
6281                        <t>Possible Answers:</t>
6282                        <t>
6283                            <list>
6284                                <t>On success, the sampler will answer by
6285                                   returning a comma separated list of
6286                                   instrument IDs.
6287                                </t>
6288                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6289                                    <list>
6290                                        <t>if the file could not be handled</t>
6291                                    </list>
6292                                </t>
6293                            </list>
6294                        </t>
6295    
6296                        <t>Examples:</t>
6297                        <t>
6298                            <list>
6299                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6300                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6301                            </list>
6302                        </t>
6303                    </section>
6304    
6305                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6306                        <t>The front-end can retrieve detailed informations
6307                        about a specific instrument within a given instrument
6308                        file by sending the following command:</t>
6309                        <t>
6310                            <list>
6311                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6312                                &lt;instr-id&gt;</t>
6313                            </list>
6314                        </t>
6315                        <t>Where &lt;filename&gt; is the name of the instrument
6316                        file (encapsulated into apostrophes, supporting escape
6317                        sequences as described in chapter
6318                        "<xref target="character_set">Character Set and Escape
6319                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6320                        instrument ID as returned by the
6321                        <xref target="LIST FILE INSTRUMENTS">
6322                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6323    
6324                        <t>The sampler will try to ask all sampler engines,
6325                        whether they support the given file and ask the first
6326                        engine with a positive answer for informations about the
6327                        specific instrument in the given file.</t>
6328    
6329                        <t>Possible Answers:</t>
6330                        <t>
6331                            <list>
6332                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6333                                Each answer line begins with the settings category name
6334                                followed by a colon and then a space character &lt;SP&gt; and finally
6335                                the info character string to that setting category. At the
6336                                moment the following categories are defined:</t>
6337    
6338                                <t>
6339                                    <list>
6340                                        <t>NAME -
6341                                            <list>
6342                                                <t>name of the instrument as
6343                                                stored in the instrument file</t>
6344                                            </list>
6345                                        </t>
6346                                        <t>FORMAT_FAMILY -
6347                                            <list>
6348                                                <t>name of the sampler format
6349                                                of the given instrument</t>
6350                                            </list>
6351                                        </t>
6352                                        <t>FORMAT_VERSION -
6353                                            <list>
6354                                                <t>version of the sampler format
6355                                                the instrumen is stored as</t>
6356                                            </list>
6357                                        </t>
6358                                        <t>PRODUCT -
6359                                            <list>
6360                                                <t>official product name of the
6361                                                instrument as stored in the file
6362                                                </t>
6363                                            </list>
6364                                        </t>
6365                                        <t>ARTISTS -
6366                                            <list>
6367                                                <t>artists / sample library
6368                                                vendor of the instrument</t>
6369                                            </list>
6370                                        </t>
6371                                        <t>KEY_BINDINGS -
6372                                            <list>
6373                                                <t>comma separated list of integer values representing
6374                                                   the instrument's key mapping in the range between 0 .. 127,
6375                                                   reflecting the analog meaning of the MIDI specification.</t>
6376                                            </list>
6377                                        </t>
6378                                        <t>KEYSWITCH_BINDINGS -
6379                                            <list>
6380                                                <t>comma separated list of integer values representing
6381                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
6382                                                   reflecting the analog meaning of the MIDI specification.</t>
6383                                            </list>
6384                                        </t>
6385                                    </list>
6386                                </t>
6387                            </list>
6388                        </t>
6389                        <t>The mentioned fields above don't have to be in particular order.</t>
6390    
6391                        <t>Example:</t>
6392                        <t>
6393                            <list>
6394                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6395                                <t>S: "NAME: Lunatic Loops"</t>
6396                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6397                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6398                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6399                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6400                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6401                            </list>
6402                        </t>
6403                    </section>
6404                </section>
6405            </section>
6406    
6407          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
6408              <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"/>
# Line 6119  Schoenebeck'> Line 6490  Schoenebeck'>
6490                  </t>                  </t>
6491                  <t>/ FORMAT SP format_instruction                  <t>/ FORMAT SP format_instruction
6492                  </t>                  </t>
6493                    <t>/ SEND SP send_instruction
6494                    </t>
6495                  <t>/ RESET                  <t>/ RESET
6496                  </t>                  </t>
6497                  <t>/ QUIT                  <t>/ QUIT
# Line 6133  Schoenebeck'> Line 6506  Schoenebeck'>
6506                  </t>                  </t>
6507                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6508                  </t>                  </t>
6509                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6510                    </t>
6511                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6512                  </t>                  </t>
6513                    <t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6514                    </t>
6515                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6516                  </t>                  </t>
6517                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
# Line 6161  Schoenebeck'> Line 6538  Schoenebeck'>
6538                  </t>                  </t>
6539                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6540                  </t>                  </t>
6541                    <t>/ CHANNEL_MIDI
6542                    </t>
6543                    <t>/ DEVICE_MIDI
6544                    </t>
6545                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6546                  </t>                  </t>
6547                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6193  Schoenebeck'> Line 6574  Schoenebeck'>
6574                  </t>                  </t>
6575                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6576                  </t>                  </t>
6577                    <t>/ TOTAL_STREAM_COUNT
6578                    </t>
6579                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6580                  </t>                  </t>
6581                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6211  Schoenebeck'> Line 6594  Schoenebeck'>
6594                  </t>                  </t>
6595                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6596                  </t>                  </t>
6597                    <t>/ CHANNEL_MIDI
6598                    </t>
6599                    <t>/ DEVICE_MIDI
6600                    </t>
6601                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6602                  </t>                  </t>
6603                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6243  Schoenebeck'> Line 6630  Schoenebeck'>
6630                  </t>                  </t>
6631                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6632                  </t>                  </t>
6633                    <t>/ TOTAL_STREAM_COUNT
6634                    </t>
6635                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6636                  </t>                  </t>
6637                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6333  Schoenebeck'> Line 6722  Schoenebeck'>
6722                  </t>                  </t>
6723                  <t>/ SERVER SP INFO                  <t>/ SERVER SP INFO
6724                  </t>                  </t>
6725                    <t>/ TOTAL_STREAM_COUNT
6726                    </t>
6727                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6728                  </t>                  </t>
6729                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
# Line 6367  Schoenebeck'> Line 6758  Schoenebeck'>
6758                  </t>                  </t>
6759                  <t>/ VOLUME                  <t>/ VOLUME
6760                  </t>                  </t>
6761                    <t>/ FILE SP INSTRUMENTS SP filename
6762                    </t>
6763                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6764                    </t>
6765          </list>          </list>
6766  </t>  </t>
6767  <t>set_instruction =  <t>set_instruction =
# Line 6393  Schoenebeck'> Line 6788  Schoenebeck'>
6788                  </t>                  </t>
6789                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6790                  </t>                  </t>
6791                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP raw_path                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6792                    </t>
6793                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6794                  </t>                  </t>
6795                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP raw_path                  <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6796                  </t>                  </t>
6797                  <t>/ DB_INSTRUMENT SP NAME SP db_path SP raw_path                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6798                  </t>                  </t>
6799                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP raw_path                  <t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6800                  </t>                  </t>
6801                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6802                  </t>                  </t>
# Line 6447  Schoenebeck'> Line 6844  Schoenebeck'>
6844                  </t>                  </t>
6845                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6846                  </t>                  </t>
6847                    <t>/ LOST SP DB_INSTRUMENT_FILES
6848                    </t>
6849          </list>          </list>
6850  </t>  </t>
6851  <t>move_instruction =  <t>move_instruction =
# Line 6517  Schoenebeck'> Line 6916  Schoenebeck'>
6916  </t>  </t>
6917  <t>edit_instruction =  <t>edit_instruction =
6918          <list>          <list>
6919                  <t>INSTRUMENT SP sampler_channel                  <t>CHANNEL SP INSTRUMENT SP sampler_channel
6920                  </t>                  </t>
6921          </list>          </list>
6922  </t>  </t>
# Line 6581  Schoenebeck'> Line 6980  Schoenebeck'>
6980                  </t>                  </t>
6981                  <t>/ DB_INSTRUMENTS SP db_path                  <t>/ DB_INSTRUMENTS SP db_path
6982                  </t>                  </t>
6983                    <t>/ FILE SP INSTRUMENTS SP filename
6984                    </t>
6985            </list>
6986    </t>
6987    <t>send_instruction =
6988            <list>
6989                    <t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
6990                    </t>
6991          </list>          </list>
6992  </t>  </t>
6993  <t>load_instr_args =  <t>load_instr_args =
# Line 6715  Schoenebeck'> Line 7122  Schoenebeck'>
7122  </t>  </t>
7123  <t>map_name =  <t>map_name =
7124          <list>          <list>
7125                  <t>stringval                  <t>stringval_escaped
7126                  </t>                  </t>
7127          </list>          </list>
7128  </t>  </t>
7129  <t>entry_name =  <t>entry_name =
7130          <list>          <list>
7131                  <t>stringval                  <t>stringval_escaped
7132                  </t>                  </t>
7133          </list>          </list>
7134  </t>  </t>
7135  <t>fx_send_name =  <t>fx_send_name =
7136          <list>          <list>
7137                  <t>stringval                  <t>stringval_escaped
7138                  </t>                  </t>
7139          </list>          </list>
7140  </t>  </t>
# Line 6762  Schoenebeck'> Line 7169  Schoenebeck'>
7169  </t>  </t>
7170  <t>query_val =  <t>query_val =
7171          <list>          <list>
7172                  <t>raw_path_base                  <t>text_escaped
7173                  </t>                  </t>
7174                  <t>/ raw_path                  <t>/ stringval_escaped
7175                  </t>                  </t>
7176          </list>          </list>
7177  </t>  </t>
# Line 6811  Schoenebeck'> Line 7218  Schoenebeck'>
7218                  where escape characters are now supported, a backslash characters                  where escape characters are now supported, a backslash characters
7219                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
7220                  in the old versions a single backslash was sufficient.</t>                  in the old versions a single backslash was sufficient.</t>
7221    
7222                    <t>The following LSCP commands support escape sequences as part
7223                    of their filename / path based arguments and / or may contain
7224                    a filename / path with escape sequences in their response:
7225                    <list>
7226                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
7227                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7228                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7229                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7230                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
7231                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
7232                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7233                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
7234                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
7235                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
7236                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7237                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
7238                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
7239                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7240                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7241                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7242                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7243                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7244                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7245                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7246                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
7247                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7248                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7249                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7250                        <t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t>
7251                        <t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t>
7252                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7253                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7254                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7255                    </list>
7256                    Note that the forward slash character ('/') has a special meaning in
7257                    filename / path based arguments: it acts as separator of the nodes in
7258                    the path, thus if a directory- or filename includes a forward slash
7259                    (not intended as path node separator), you MUST escape that slash
7260                    either with the respective hex escape sequence ("\x2f") or with the
7261                    respective octal escape sequence ("\057").
7262                    </t>
7263    
7264                    <t>
7265                    Note for Windows: file path arguments in LSCP are expected
7266                    to use forward slashes as directory node separator similar
7267                    to Unix based operating systems. In contrast to Unix however
7268                    a Windows typical drive character is expected to be
7269                    prefixed to the path. That is an original Windows file path
7270                    like "D:\Sounds\My.gig" would become in LSCP:
7271                    "D:/Sounds/My.gig".
7272                    </t>
7273    
7274                    <t>
7275                    The following LSCP commands even support escape sequences as
7276                    part of at least one of their text-based arguments (i.e. entity name,
7277                    description) and / or may contain escape sequences in at least one of
7278                    their text-based fields in their response:
7279                    <list>
7280                        <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
7281                        <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
7282                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7283                        <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
7284                        <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
7285                        <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
7286                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7287                        <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
7288                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
7289                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7290                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
7291                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7292                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7293                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7294                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7295                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7296                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7297                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7298                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7299                    </list>
7300                    Please note that these lists are manually maintained. If you
7301                    find a command that also supports escape sequences we forgot to
7302                    mention here, please report it!
7303                    </t>
7304              </section>              </section>
7305          </section>          </section>
7306    
# Line 6915  Schoenebeck'> Line 7405  Schoenebeck'>
7405                  of sampler channels.</t>                  of sampler channels.</t>
7406              </section>              </section>
7407    
7408                <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
7409                    <t>Client may want to be notified when MIDI data arrive on sampler channels on
7410                    back-end side, by issuing the following command:</t>
7411                    <t>
7412                        <list>
7413                            <t>SUBSCRIBE CHANNEL_MIDI</t>
7414                        </list>
7415                    </t>
7416                    <t>Server will start sending one of the the following notification messages:</t>
7417                    <t>
7418                        <list>
7419                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"</t>
7420                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7421                        </list>
7422                    </t>
7423                    <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
7424                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7425                    0 .. 127, reflecting the analog meaning of the MIDI specification.
7426                    </t>
7427                    <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7428                    delivered by this mechanism! With other words: events could be lost at any time!
7429                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7430                    thread unaffected by this feature.</t>
7431                </section>
7432    
7433                <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">
7434                        <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
7435                        <t>
7436                                <list>
7437                                        <t>SUBSCRIBE DEVICE_MIDI</t>
7438                                </list>
7439                        </t>
7440                        <t>Server will start sending one of the the following notification messages:</t>
7441                        <t>
7442                                <list>
7443                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
7444                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7445                                </list>
7446                        </t>
7447                        <t>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
7448                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
7449                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7450                           0 .. 127, reflecting the analog meaning of the MIDI specification.
7451                        </t>
7452                        <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7453                           delivered by this mechanism! With other words: events could be lost at any time!
7454                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7455                           thread unaffected by this feature.</t>
7456                </section>
7457    
7458              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7459                  <t>Client may want to be notified when the number of voices on the                  <t>Client may want to be notified when the number of voices on the
7460                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 7052  Schoenebeck'> Line 7592  Schoenebeck'>
7592                  all currently active voices.</t>                  all currently active voices.</t>
7593              </section>              </section>
7594    
7595                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7596                    <t>Client may want to be notified when the total number of disk streams on the
7597                    back-end changes by issuing the following command:</t>
7598                    <t>
7599                        <list>
7600                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7601                        </list>
7602                    </t>
7603                    <t>Server will start sending the following notification messages:</t>
7604                    <t>
7605                        <list>
7606                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7607                        </list>
7608                    </t>
7609                    <t>where &lt;streams&gt; will be replaced by the new number of
7610                    all currently active disk streams.</t>
7611                </section>
7612    
7613              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
7614                  <t>Client may want to be notified when the number of MIDI instrument maps on the                  <t>Client may want to be notified when the number of MIDI instrument maps on the
7615                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
Legend:
Removed from v.1387  
changed lines
  Added in v.1782
  ViewVC Help
Powered by ViewVC