/[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 1401 by iliev, Thu Oct 11 20:45:49 2007 UTC revision 2025 by schoenebeck, Sun Nov 1 18:47:59 2009 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.5">
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="October" year="2007"/>          <date month="November" year="2009"/>
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 2504  Schoenebeck'> Line 2512  Schoenebeck'>
2512                                          <list>                                          <list>
2513                                              <t>numerical ID of the audio output device which is                                              <t>numerical ID of the audio output device which is
2514                                              currently connected to this sampler channel to output                                              currently connected to this sampler channel to output
2515                                              the audio signal, "NONE" if there's no device                                              the audio signal, "-1" if there's no device
2516                                              connected to this sampler channel</t>                                              connected to this sampler channel</t>
2517                                          </list>                                          </list>
2518                                      </t>                                      </t>
# Line 2535  Schoenebeck'> Line 2543  Schoenebeck'>
2543                                      </t>                                      </t>
2544                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
2545                                          <list>                                          <list>
2546                                              <t>the instrument index number of the loaded instrument</t>                                              <t>the instrument index number of the loaded instrument,
2547                                                "-1" if there's no instrument loaded for this sampler
2548                                                channel</t>
2549                                          </list>                                          </list>
2550                                      </t>                                      </t>
2551                                      <t>INSTRUMENT_NAME -                                      <t>INSTRUMENT_NAME -
# Line 2547  Schoenebeck'> Line 2557  Schoenebeck'>
2557                                      </t>                                      </t>
2558                                      <t>INSTRUMENT_STATUS -                                      <t>INSTRUMENT_STATUS -
2559                                          <list>                                          <list>
2560                                              <t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative                                              <t>Integer values 0 to 100 indicating loading progress
2561                                              value indicates a loading exception. Value of 100 indicates that the instrument is fully                                              percentage for the instrument. Negative
2562                                                value indicates a loading exception (also returns "-1" in case no
2563                                                instrument was yet to be loaded on the sampler channel).
2564                                                Value of 100 indicates that the instrument is fully
2565                                              loaded.</t>                                              loaded.</t>
2566                                          </list>                                          </list>
2567                                      </t>                                      </t>
# Line 2556  Schoenebeck'> Line 2569  Schoenebeck'>
2569                                          <list>                                          <list>
2570                                              <t>numerical ID of the MIDI input device which is                                              <t>numerical ID of the MIDI input device which is
2571                                              currently connected to this sampler channel to deliver                                              currently connected to this sampler channel to deliver
2572                                              MIDI input commands, "NONE" if there's no device                                              MIDI input commands, "-1" if there's no device
2573                                              connected to this sampler channel</t>                                              connected to this sampler channel</t>
2574                                          </list>                                          </list>
2575                                      </t>                                      </t>
2576                                      <t>MIDI_INPUT_PORT -                                      <t>MIDI_INPUT_PORT -
2577                                          <list>                                          <list>
2578                                              <t>port number of the MIDI input device</t>                                              <t>port number of the MIDI input device (in case a
2579                                                MIDI device was already assigned to the sampler
2580                                                channel)</t>
2581                                          </list>                                          </list>
2582                                      </t>                                      </t>
2583                                      <t>MIDI_INPUT_CHANNEL -                                      <t>MIDI_INPUT_CHANNEL -
# Line 3703  Schoenebeck'> Line 3718  Schoenebeck'>
3718                      </t>                      </t>
3719                  </section>                  </section>
3720    
3721                    <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3722                        <t>The front-end can send MIDI events to a specific sampler channel
3723                        by sending the following command:</t>
3724                        <t>
3725                            <list>
3726                                <t>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;</t>
3727                            </list>
3728                        </t>
3729                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3730                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3731                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3732                        &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
3733                        specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3734                        <t>
3735                            <list>
3736                                <t>"NOTE_ON" -
3737                                    <list>
3738                                        <t>For turning on MIDI notes, 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                                <t>"NOTE_OFF" -
3744                                    <list>
3745                                        <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3746                                        specifies the key number and &lt;arg2&gt; the velocity
3747                                        as described in the MIDI specification.</t>
3748                                    </list>
3749                                </t>
3750                                <t>"CC" -
3751                                    <list>
3752                                        <t>For changing a MIDI controller, where &lt;arg1&gt;
3753                                        specifies the controller number and &lt;arg2&gt; the
3754                                        new value of the controller as described in the Control
3755                                        Change section of the MIDI specification.</t>
3756                                    </list>
3757                                </t>
3758                            </list>
3759                        </t>
3760                        <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3761                        and no realtime guarantee whatsoever will be made!</t>
3762                        <t>Possible Answers:</t>
3763                        <t>
3764                            <list>
3765                                <t>"OK" -
3766                                    <list>
3767                                        <t>on success</t>
3768                                    </list>
3769                                </t>
3770                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3771                                    <list>
3772                                        <t>in case it failed, providing an appropriate error code and error message</t>
3773                                    </list>
3774                                </t>
3775                            </list>
3776                        </t>
3777                        <t>Example:</t>
3778                        <t>
3779                            <list>
3780                                <t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t>
3781                                <t>S: "OK"</t>
3782                            </list>
3783                        </t>
3784                    </section>
3785    
3786                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3787                      <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>
3788                      <t>                      <t>
# Line 3924  Schoenebeck'> Line 4004  Schoenebeck'>
4004                      </t>                      </t>
4005                  </section>                  </section>
4006    
4007                    <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
4008                        <t>The front-end can ask for the current number of active disk streams on
4009                        the sampler by sending the following command:</t>
4010                        <t>
4011                            <list>
4012                                <t>GET TOTAL_STREAM_COUNT</t>
4013                            </list>
4014                        </t>
4015    
4016                        <t>Possible Answers:</t>
4017                        <t>
4018                            <list>
4019                                <t>LinuxSampler will answer by returning the number of all active
4020                                disk streams on the sampler.</t>
4021                            </list>
4022                        </t>
4023                    </section>
4024    
4025                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
4026                      <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>
4027                      <t>                      <t>
# Line 4059  Schoenebeck'> Line 4157  Schoenebeck'>
4157                          </list>                          </list>
4158                      </t>                      </t>
4159                  </section>                  </section>
4160    
4161                    <section title="Getting global voice limit" anchor="GET VOICES">
4162                        <t>The client can ask for the current global sampler-wide limit
4163                           for maximum voices by sending the following command:</t>
4164                        <t>
4165                            <list>
4166                                <t>GET VOICES</t>
4167                            </list>
4168                        </t>
4169                        <t>Possible Answers:</t>
4170                        <t>
4171                            <list>
4172                                <t>LinuxSampler will answer by returning the number for
4173                                   the current limit of maximum voices.</t>
4174                            </list>
4175                        </t>
4176    
4177                        <t>The voice limit setting defines how many voices should maximum
4178                           be processed by the sampler at the same time. If the user
4179                           triggers new notes which would exceed that voice limit, the
4180                           sampler engine will react by stealing old voices for those
4181                           newly triggered notes. Note that the amount of voices triggered
4182                           by a new note can be larger than one and is dependent to the
4183                           respective instrument and probably further criterias.</t>
4184                    </section>
4185    
4186                    <section title="Setting global voice limit" anchor="SET VOICES">
4187                        <t>The client can alter the current global sampler-wide limit
4188                        for maximum voices by sending the following command:</t>
4189                        <t>
4190                            <list>
4191                                <t>SET VOICES &lt;max-voices&gt;</t>
4192                            </list>
4193                        </t>
4194                       <t>Where &lt;max-voices&gt; should be replaced by the integer
4195                       value, reflecting the new global amount limit of maximum voices.
4196                       This value has to be larger than 0.</t>
4197    
4198                        <t>Possible Answers:</t>
4199                        <t>
4200                            <list>
4201                                <t>"OK" -
4202                                    <list>
4203                                        <t>on success</t>
4204                                    </list>
4205                                </t>
4206                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4207                                    <list>
4208                                        <t>if the voice limit was set, but there are noteworthy
4209                                        issue(s) related, providing an appropriate warning code and
4210                                        warning message</t>
4211                                    </list>
4212                                </t>
4213                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4214                                    <list>
4215                                        <t>in case it failed, providing an appropriate error code and error message</t>
4216                                    </list>
4217                                </t>
4218                            </list>
4219                        </t>
4220    
4221                        <t>Note: the given value will be passed to all sampler engine instances.
4222                           The total amount of maximum voices on the running system might thus
4223                           be as big as the given value multiplied by the current amount of engine
4224                           instances.</t>
4225    
4226                         <t>Caution: when adjusting the voice limit, you SHOULD also
4227                            adjust the disk stream limit respectively and vice versa.</t>
4228                    </section>
4229    
4230                    <section title="Getting global disk stream limit" anchor="GET STREAMS">
4231                        <t>The client can ask for the current global sampler-wide limit
4232                           for maximum disk streams by sending the following command:</t>
4233                        <t>
4234                            <list>
4235                                <t>GET STREAMS</t>
4236                            </list>
4237                        </t>
4238                        <t>Possible Answers:</t>
4239                        <t>
4240                            <list>
4241                                <t>LinuxSampler will answer by returning the number for
4242                                   the current limit of maximum disk streams.</t>
4243                            </list>
4244                        </t>
4245    
4246                        <t>The disk stream limit setting defines how many disk streams should
4247                           maximum be processed by a sampler engine at the same time. The
4248                           higher this value, the more memory (RAM) will be occupied, since
4249                           every disk streams allocates a certain buffer size for being able
4250                           to perform its streaming operations.</t>
4251                    </section>
4252    
4253                    <section title="Setting global disk stream limit" anchor="SET STREAMS">
4254                        <t>The client can alter the current global sampler-wide limit
4255                        for maximum disk streams by sending the following command:</t>
4256                        <t>
4257                            <list>
4258                                <t>SET STREAMS &lt;max-streams&gt;</t>
4259                            </list>
4260                        </t>
4261                       <t>Where &lt;max-streams&gt; should be replaced by the integer
4262                       value, reflecting the new global amount limit of maximum disk streams.
4263                       This value has to be positive.</t>
4264    
4265                        <t>Possible Answers:</t>
4266                        <t>
4267                            <list>
4268                                <t>"OK" -
4269                                    <list>
4270                                        <t>on success</t>
4271                                    </list>
4272                                </t>
4273                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4274                                    <list>
4275                                        <t>if the disk stream limit was set, but there are noteworthy
4276                                        issue(s) related, providing an appropriate warning code and
4277                                        warning message</t>
4278                                    </list>
4279                                </t>
4280                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4281                                    <list>
4282                                        <t>in case it failed, providing an appropriate error code and error message</t>
4283                                    </list>
4284                                </t>
4285                            </list>
4286                        </t>
4287    
4288                        <t>Note: the given value will be passed to all sampler engine instances.
4289                           The total amount of maximum disk streams on the running system might
4290                           thus be as big as the given value multiplied by the current amount of
4291                           engine instances.</t>
4292    
4293                         <t>Caution: when adjusting the disk stream limit, you SHOULD also
4294                            adjust the voice limit respectively and vice versa.</t>
4295                    </section>
4296    
4297              </section>              </section>
4298    
4299    
# Line 5267  Schoenebeck'> Line 5502  Schoenebeck'>
5502                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5503                      <t>                      <t>
5504                          <list>                          <list>
5505                              <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>
5506                          </list>                          </list>
5507                      </t>                      </t>
5508                      <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 5312  Schoenebeck'> Line 5547  Schoenebeck'>
5547                          </list>                          </list>
5548                      </t>                      </t>
5549    
5550                     <t> If FILE_AS_DIR argument is supplied, all instruments in an instrument
5551                     file will be added to a separate directory in the instruments database, which
5552                     name will be the name of the instrument file with the file extension stripped off.
5553                     </t>
5554                   <t>The difference between regular and NON_MODAL versions of the command                   <t>The difference between regular and NON_MODAL versions of the command
5555                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
5556                      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 5715  Schoenebeck'> Line 5954  Schoenebeck'>
5954                          </list>                          </list>
5955                      </t>                      </t>
5956                      <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
5957                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
5958                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
5959                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5960    
# Line 5958  Schoenebeck'> Line 6197  Schoenebeck'>
6197                              <t>FORMAT INSTRUMENTS_DB</t>                              <t>FORMAT INSTRUMENTS_DB</t>
6198                          </list>                          </list>
6199                      </t>                      </t>
6200                        
6201                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
6202                      <t>                      <t>
6203                          <list>                          <list>
# Line 5977  Schoenebeck'> Line 6216  Schoenebeck'>
6216                      </t>                      </t>
6217                  </section>                  </section>
6218    
6219                    <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">
6220                        <t>The front-end can retrieve the list of all instrument files in the instruments database
6221                        that don't exist in the filesystem by sending the following command:</t>
6222                        <t>
6223                            <list>
6224                                <t>FIND LOST DB_INSTRUMENT_FILES</t>
6225                            </list>
6226                        </t>
6227    
6228                        <t>Possible Answers:</t>
6229                        <t>
6230                            <list>
6231                                <t>A comma separated list with the absolute path names
6232                                (encapsulated into apostrophes) of all lost instrument files.</t>
6233                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6234                                    <list>
6235                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6236                                    </list>
6237                                </t>
6238                            </list>
6239                        </t>
6240                        <t>Example:</t>
6241                        <t>
6242                            <list>
6243                                <t>C: "FIND LOST DB_INSTRUMENT_FILES"</t>
6244                                <t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t>
6245                            </list>
6246                        </t>
6247                    </section>
6248    
6249                    <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">
6250                        <t>The front-end can substitute all occurrences of an instrument file
6251                        in the instruments database with a new one by sending the following command:</t>
6252                        <t>
6253                            <list>
6254                                <t>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;</t>
6255                            </list>
6256                        </t>
6257                        <t>Where &lt;old_path&gt; is the absolute path name of the instrument file
6258                        to substitute with &lt;new_path&gt;.</t>
6259    
6260                        <t>Possible Answers:</t>
6261                        <t>
6262                            <list>
6263                                <t>"OK" -
6264                                    <list>
6265                                        <t>on success</t>
6266                                    </list>
6267                                </t>
6268                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6269                                    <list>
6270                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6271                                    </list>
6272                                </t>
6273                            </list>
6274                        </t>
6275    
6276                        <t>Example:</t>
6277                        <t>
6278                            <list>
6279                                <t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t>
6280                                <t>S: "OK"</t>
6281                            </list>
6282                        </t>
6283                    </section>
6284    
6285              </section>              </section>
6286    
6287    
# Line 5997  Schoenebeck'> Line 6302  Schoenebeck'>
6302                      editor application by sending the following command:</t>                      editor application by sending the following command:</t>
6303                      <t>                      <t>
6304                          <list>                          <list>
6305                              <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>                              <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6306                          </list>                          </list>
6307                      </t>                      </t>
6308                      <t>Where &lt;sampler-channel&gt; should be replaced by the                      <t>Where &lt;sampler-channel&gt; should be replaced by the
# Line 6049  Schoenebeck'> Line 6354  Schoenebeck'>
6354                      <t>Examples:</t>                      <t>Examples:</t>
6355                      <t>                      <t>
6356                          <list>                          <list>
6357                              <t>C: "EDIT INSTRUMENT 0"</t>                              <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6358                              <t>S: "OK"</t>                              <t>S: "OK"</t>
6359                          </list>                          </list>
6360                      </t>                      </t>
6361                  </section>                  </section>
6362              </section>              </section>
         </section>  
6363    
6364                <section title="Managing Files" anchor="file_management">
6365                    <t>You can query detailed informations about files located
6366                    at the same system where the sampler instance is running on.
6367                    Using this command set allows to retrieve file informations
6368                    even remotely from another machine.</t>
6369    
6370                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6371                        <t>The front-end can retrieve the amount of instruments
6372                        within a given instrument file by sending the
6373                        following command:</t>
6374                        <t>
6375                            <list>
6376                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6377                            </list>
6378                        </t>
6379                        <t>Where &lt;filename&gt; is the name of the instrument
6380                        file (encapsulated into apostrophes, supporting escape
6381                        sequences as described in chapter
6382                        "<xref target="character_set">Character Set and Escape
6383                            Sequences</xref>").</t>
6384    
6385                        <t>The sampler will try to ask all sampler engines,
6386                        whether they support the given file and ask the first
6387                        engine with a positive answer for the amount of
6388                        instruments.</t>
6389    
6390                        <t>Possible Answers:</t>
6391                        <t>
6392                            <list>
6393                                <t>On success, the sampler will answer by
6394                                   returning the amount of instruments.
6395                                </t>
6396                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6397                                    <list>
6398                                        <t>if the file could not be handled</t>
6399                                    </list>
6400                                </t>
6401                            </list>
6402                        </t>
6403    
6404                        <t>Examples:</t>
6405                        <t>
6406                            <list>
6407                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6408                                <t>S: "10"</t>
6409                            </list>
6410                        </t>
6411                    </section>
6412    
6413                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6414                        <t>The front-end can retrieve a list of all instruments
6415                        within a given instrument file by sending the
6416                        following command:</t>
6417                        <t>
6418                            <list>
6419                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6420                            </list>
6421                        </t>
6422                        <t>Where &lt;filename&gt; is the name of the instrument
6423                        file (encapsulated into apostrophes, supporting escape
6424                        sequences as described in chapter
6425                        "<xref target="character_set">Character Set and Escape
6426                            Sequences</xref>").</t>
6427    
6428                        <t>The sampler will try to ask all sampler engines,
6429                        whether they support the given file and ask the first
6430                        engine with a positive answer for a list of IDs for the
6431                        instruments in the given file.</t>
6432    
6433                        <t>Possible Answers:</t>
6434                        <t>
6435                            <list>
6436                                <t>On success, the sampler will answer by
6437                                   returning a comma separated list of
6438                                   instrument IDs.
6439                                </t>
6440                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6441                                    <list>
6442                                        <t>if the file could not be handled</t>
6443                                    </list>
6444                                </t>
6445                            </list>
6446                        </t>
6447    
6448                        <t>Examples:</t>
6449                        <t>
6450                            <list>
6451                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6452                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6453                            </list>
6454                        </t>
6455                    </section>
6456    
6457                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6458                        <t>The front-end can retrieve detailed informations
6459                        about a specific instrument within a given instrument
6460                        file by sending the following command:</t>
6461                        <t>
6462                            <list>
6463                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6464                                &lt;instr-id&gt;</t>
6465                            </list>
6466                        </t>
6467                        <t>Where &lt;filename&gt; is the name of the instrument
6468                        file (encapsulated into apostrophes, supporting escape
6469                        sequences as described in chapter
6470                        "<xref target="character_set">Character Set and Escape
6471                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6472                        instrument ID as returned by the
6473                        <xref target="LIST FILE INSTRUMENTS">
6474                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6475    
6476                        <t>The sampler will try to ask all sampler engines,
6477                        whether they support the given file and ask the first
6478                        engine with a positive answer for informations about the
6479                        specific instrument in the given file.</t>
6480    
6481                        <t>Possible Answers:</t>
6482                        <t>
6483                            <list>
6484                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6485                                Each answer line begins with the settings category name
6486                                followed by a colon and then a space character &lt;SP&gt; and finally
6487                                the info character string to that setting category. At the
6488                                moment the following categories are defined:</t>
6489    
6490                                <t>
6491                                    <list>
6492                                        <t>NAME -
6493                                            <list>
6494                                                <t>name of the instrument as
6495                                                stored in the instrument file</t>
6496                                            </list>
6497                                        </t>
6498                                        <t>FORMAT_FAMILY -
6499                                            <list>
6500                                                <t>name of the sampler format
6501                                                of the given instrument</t>
6502                                            </list>
6503                                        </t>
6504                                        <t>FORMAT_VERSION -
6505                                            <list>
6506                                                <t>version of the sampler format
6507                                                the instrumen is stored as</t>
6508                                            </list>
6509                                        </t>
6510                                        <t>PRODUCT -
6511                                            <list>
6512                                                <t>official product name of the
6513                                                instrument as stored in the file
6514                                                </t>
6515                                            </list>
6516                                        </t>
6517                                        <t>ARTISTS -
6518                                            <list>
6519                                                <t>artists / sample library
6520                                                vendor of the instrument</t>
6521                                            </list>
6522                                        </t>
6523                                        <t>KEY_BINDINGS -
6524                                            <list>
6525                                                <t>comma separated list of integer values representing
6526                                                   the instrument's key mapping in the range between 0 .. 127,
6527                                                   reflecting the analog meaning of the MIDI specification.</t>
6528                                            </list>
6529                                        </t>
6530                                        <t>KEYSWITCH_BINDINGS -
6531                                            <list>
6532                                                <t>comma separated list of integer values representing
6533                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
6534                                                   reflecting the analog meaning of the MIDI specification.</t>
6535                                            </list>
6536                                        </t>
6537                                    </list>
6538                                </t>
6539                            </list>
6540                        </t>
6541                        <t>The mentioned fields above don't have to be in particular order.</t>
6542    
6543                        <t>Example:</t>
6544                        <t>
6545                            <list>
6546                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6547                                <t>S: "NAME: Lunatic Loops"</t>
6548                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6549                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6550                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6551                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6552                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6553                            </list>
6554                        </t>
6555                    </section>
6556                </section>
6557            </section>
6558    
6559          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
6560              <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 6144  Schoenebeck'> Line 6642  Schoenebeck'>
6642                  </t>                  </t>
6643                  <t>/ FORMAT SP format_instruction                  <t>/ FORMAT SP format_instruction
6644                  </t>                  </t>
6645                    <t>/ SEND SP send_instruction
6646                    </t>
6647                  <t>/ RESET                  <t>/ RESET
6648                  </t>                  </t>
6649                  <t>/ QUIT                  <t>/ QUIT
# Line 6158  Schoenebeck'> Line 6658  Schoenebeck'>
6658                  </t>                  </t>
6659                  <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
6660                  </t>                  </t>
6661                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6662                    </t>
6663                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6664                  </t>                  </t>
6665                    <t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6666                    </t>
6667                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6668                  </t>                  </t>
6669                  <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 6186  Schoenebeck'> Line 6690  Schoenebeck'>
6690                  </t>                  </t>
6691                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6692                  </t>                  </t>
6693                    <t>/ CHANNEL_MIDI
6694                    </t>
6695                    <t>/ DEVICE_MIDI
6696                    </t>
6697                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6698                  </t>                  </t>
6699                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6218  Schoenebeck'> Line 6726  Schoenebeck'>
6726                  </t>                  </t>
6727                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6728                  </t>                  </t>
6729                    <t>/ TOTAL_STREAM_COUNT
6730                    </t>
6731                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6732                  </t>                  </t>
6733                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6236  Schoenebeck'> Line 6746  Schoenebeck'>
6746                  </t>                  </t>
6747                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6748                  </t>                  </t>
6749                    <t>/ CHANNEL_MIDI
6750                    </t>
6751                    <t>/ DEVICE_MIDI
6752                    </t>
6753                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6754                  </t>                  </t>
6755                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6268  Schoenebeck'> Line 6782  Schoenebeck'>
6782                  </t>                  </t>
6783                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6784                  </t>                  </t>
6785                    <t>/ TOTAL_STREAM_COUNT
6786                    </t>
6787                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6788                  </t>                  </t>
6789                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6358  Schoenebeck'> Line 6874  Schoenebeck'>
6874                  </t>                  </t>
6875                  <t>/ SERVER SP INFO                  <t>/ SERVER SP INFO
6876                  </t>                  </t>
6877                    <t>/ TOTAL_STREAM_COUNT
6878                    </t>
6879                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6880                  </t>                  </t>
6881                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
# Line 6392  Schoenebeck'> Line 6910  Schoenebeck'>
6910                  </t>                  </t>
6911                  <t>/ VOLUME                  <t>/ VOLUME
6912                  </t>                  </t>
6913                    <t>/ VOICES
6914                    </t>
6915                    <t>/ STREAMS
6916                    </t>
6917                    <t>/ FILE SP INSTRUMENTS SP filename
6918                    </t>
6919                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6920                    </t>
6921          </list>          </list>
6922  </t>  </t>
6923  <t>set_instruction =  <t>set_instruction =
# Line 6426  Schoenebeck'> Line 6952  Schoenebeck'>
6952                  </t>                  </t>
6953                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6954                  </t>                  </t>
6955                    <t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6956                    </t>
6957                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6958                  </t>                  </t>
6959                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
6960                  </t>                  </t>
6961                    <t>/ VOICES SP number
6962                    </t>
6963                    <t>/ STREAMS SP number
6964                    </t>
6965          </list>          </list>
6966  </t>  </t>
6967  <t>create_instruction =  <t>create_instruction =
# Line 6472  Schoenebeck'> Line 7004  Schoenebeck'>
7004                  </t>                  </t>
7005                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
7006                  </t>                  </t>
7007                    <t>/ LOST SP DB_INSTRUMENT_FILES
7008                    </t>
7009          </list>          </list>
7010  </t>  </t>
7011  <t>move_instruction =  <t>move_instruction =
# Line 6542  Schoenebeck'> Line 7076  Schoenebeck'>
7076  </t>  </t>
7077  <t>edit_instruction =  <t>edit_instruction =
7078          <list>          <list>
7079                  <t>INSTRUMENT SP sampler_channel                  <t>CHANNEL SP INSTRUMENT SP sampler_channel
7080                  </t>                  </t>
7081          </list>          </list>
7082  </t>  </t>
# Line 6606  Schoenebeck'> Line 7140  Schoenebeck'>
7140                  </t>                  </t>
7141                  <t>/ DB_INSTRUMENTS SP db_path                  <t>/ DB_INSTRUMENTS SP db_path
7142                  </t>                  </t>
7143                    <t>/ FILE SP INSTRUMENTS SP filename
7144                    </t>
7145            </list>
7146    </t>
7147    <t>send_instruction =
7148            <list>
7149                    <t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
7150                    </t>
7151          </list>          </list>
7152  </t>  </t>
7153  <t>load_instr_args =  <t>load_instr_args =
# Line 6865  Schoenebeck'> Line 7407  Schoenebeck'>
7407                      <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>                      <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7408                      <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>                      <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7409                      <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>                      <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7410                        <t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t>
7411                        <t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t>
7412                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7413                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7414                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7415                  </list>                  </list>
7416                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
7417                  filename / path based arguments: it acts as separator of the nodes in                  filename / path based arguments: it acts as separator of the nodes in
# Line 6875  Schoenebeck'> Line 7422  Schoenebeck'>
7422                  </t>                  </t>
7423    
7424                  <t>                  <t>
7425                    Note for Windows: file path arguments in LSCP are expected
7426                    to use forward slashes as directory node separator similar
7427                    to Unix based operating systems. In contrast to Unix however
7428                    a Windows typical drive character is expected to be
7429                    prefixed to the path. That is an original Windows file path
7430                    like "D:\Sounds\My.gig" would become in LSCP:
7431                    "D:/Sounds/My.gig".
7432                    </t>
7433    
7434                    <t>
7435                  The following LSCP commands even support escape sequences as                  The following LSCP commands even support escape sequences as
7436                  part of at least one of their text-based arguments (i.e. entity name,                  part of at least one of their text-based arguments (i.e. entity name,
7437                  description) and / or may contain escape sequences in at least one of                  description) and / or may contain escape sequences in at least one of
# Line 7008  Schoenebeck'> Line 7565  Schoenebeck'>
7565                  of sampler channels.</t>                  of sampler channels.</t>
7566              </section>              </section>
7567    
7568                <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
7569                    <t>Client may want to be notified when MIDI data arrive on sampler channels on
7570                    back-end side, by issuing the following command:</t>
7571                    <t>
7572                        <list>
7573                            <t>SUBSCRIBE CHANNEL_MIDI</t>
7574                        </list>
7575                    </t>
7576                    <t>Server will start sending one of the the following notification messages:</t>
7577                    <t>
7578                        <list>
7579                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"</t>
7580                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7581                        </list>
7582                    </t>
7583                    <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
7584                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7585                    0 .. 127, reflecting the analog meaning of the MIDI specification.
7586                    </t>
7587                    <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7588                    delivered by this mechanism! With other words: events could be lost at any time!
7589                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7590                    thread unaffected by this feature.</t>
7591                </section>
7592    
7593                <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">
7594                        <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
7595                        <t>
7596                                <list>
7597                                        <t>SUBSCRIBE DEVICE_MIDI</t>
7598                                </list>
7599                        </t>
7600                        <t>Server will start sending one of the the following notification messages:</t>
7601                        <t>
7602                                <list>
7603                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
7604                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7605                                </list>
7606                        </t>
7607                        <t>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
7608                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
7609                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7610                           0 .. 127, reflecting the analog meaning of the MIDI specification.
7611                        </t>
7612                        <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7613                           delivered by this mechanism! With other words: events could be lost at any time!
7614                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7615                           thread unaffected by this feature.</t>
7616                </section>
7617    
7618              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7619                  <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
7620                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 7145  Schoenebeck'> Line 7752  Schoenebeck'>
7752                  all currently active voices.</t>                  all currently active voices.</t>
7753              </section>              </section>
7754    
7755                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7756                    <t>Client may want to be notified when the total number of disk streams on the
7757                    back-end changes by issuing the following command:</t>
7758                    <t>
7759                        <list>
7760                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7761                        </list>
7762                    </t>
7763                    <t>Server will start sending the following notification messages:</t>
7764                    <t>
7765                        <list>
7766                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7767                        </list>
7768                    </t>
7769                    <t>where &lt;streams&gt; will be replaced by the new number of
7770                    all currently active disk streams.</t>
7771                </section>
7772    
7773              <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">
7774                  <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
7775                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 7243  Schoenebeck'> Line 7868  Schoenebeck'>
7868                          replaced by the optional dotted floating point value, reflecting the                          replaced by the optional dotted floating point value, reflecting the
7869                          new global volume parameter.</t>                          new global volume parameter.</t>
7870                      </list>                      </list>
7871                        <list>
7872                            <t>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
7873                            golbal limit of the sampler for maximum voices is changed, where
7874                            &lt;max-voices&gt; will be an integer value, reflecting the
7875                            new global voice limit parameter.</t>
7876                        </list>
7877                        <list>
7878                            <t>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
7879                            golbal limit of the sampler for maximum disk streams is changed, where
7880                            &lt;max-streams&gt; will be an integer value, reflecting the
7881                            new global disk streams limit parameter.</t>
7882                        </list>
7883                  </t>                  </t>
7884              </section>              </section>
7885    
Legend:
Removed from v.1401  
changed lines
  Added in v.2025
  ViewVC Help
Powered by ViewVC