/[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 1771 by iliev, Wed Sep 10 15:02:24 2008 UTC revision 1800 by schoenebeck, Sun Dec 7 01:26:46 2008 UTC
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="April" year="2008"/>          <date month="December" year="2008"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 3722  Schoenebeck'> Line 3722  Schoenebeck'>
3722                      <t>Where &lt;sampler-chan&gt; is the sampler channel number                      <t>Where &lt;sampler-chan&gt; is the sampler channel number
3723                      as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>                      as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3724                      or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,                      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                      &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>                      specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3727                      <t>                      <t>
3728                          <list>                          <list>
3729                              <t>"NOTE_ON" -                              <t>"NOTE_ON" -
3730                                  <list>                                  <list>
3731                                      <t>For turning on MIDI notes, where &lt;arg1&gt;                                      <t>For turning on MIDI notes, where &lt;arg1&gt;
3732                                      specifies the key number and &lt;arg2&gt; the velocity                                      specifies the key number and &lt;arg2&gt; the velocity
3733                                      as described in the MIDI specification.</t>                                      as described in the MIDI specification.</t>
3734                                  </list>                                  </list>
3735                              </t>                              </t>
3736                              <t>"NOTE_OFF" -                              <t>"NOTE_OFF" -
3737                                  <list>                                  <list>
3738                                      <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;                                      <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3739                                      specifies the key number and &lt;arg2&gt; the velocity                                      specifies the key number and &lt;arg2&gt; the velocity
3740                                      as described in the MIDI specification.</t>                                      as described in the MIDI specification.</t>
3741                                  </list>                                  </list>
3742                              </t>                              </t>
3743                          </list>                          </list>
3744                      </t>                      </t>
3745                      <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards                      <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3746                      and no realtime guarantee whatsoever will be made!</t>                      and no realtime guarantee whatsoever will be made!</t>
3747                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3748                      <t>                      <t>
# Line 4142  Schoenebeck'> Line 4142  Schoenebeck'>
4142                          </list>                          </list>
4143                      </t>                      </t>
4144                  </section>                  </section>
4145    
4146                    <section title="Getting global voice limit" anchor="GET VOICES">
4147                        <t>The client can ask for the current global sampler-wide limit
4148                           for maximum voices by sending the following command:</t>
4149                        <t>
4150                            <list>
4151                                <t>GET VOICES</t>
4152                            </list>
4153                        </t>
4154                        <t>Possible Answers:</t>
4155                        <t>
4156                            <list>
4157                                <t>LinuxSampler will answer by returning the number for
4158                                   the current limit of maximum voices.</t>
4159                            </list>
4160                        </t>
4161    
4162                        <t>The voice limit setting defines how many voices should maximum
4163                           be processed by the sampler at the same time. If the user
4164                           triggers new notes which would exceed that voice limit, the
4165                           sampler engine will react by stealing old voices for those
4166                           newly triggered notes. Note that the amount of voices triggered
4167                           by a new note can be larger than one and is dependent to the
4168                           respective instrument and probably further criterias.</t>
4169                    </section>
4170    
4171                    <section title="Setting global voice limit" anchor="SET VOICES">
4172                        <t>The client can alter the current global sampler-wide limit
4173                        for maximum voices by sending the following command:</t>
4174                        <t>
4175                            <list>
4176                                <t>SET VOICES &lt;max-voices&gt;</t>
4177                            </list>
4178                        </t>
4179                       <t>Where &lt;max-voices&gt; should be replaced by the integer
4180                       value, reflecting the new global amount limit of maximum voices.
4181                       This value has to be larger than 0.</t>
4182    
4183                        <t>Possible Answers:</t>
4184                        <t>
4185                            <list>
4186                                <t>"OK" -
4187                                    <list>
4188                                        <t>on success</t>
4189                                    </list>
4190                                </t>
4191                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4192                                    <list>
4193                                        <t>if the voice limit was set, but there are noteworthy
4194                                        issue(s) related, providing an appropriate warning code and
4195                                        warning message</t>
4196                                    </list>
4197                                </t>
4198                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4199                                    <list>
4200                                        <t>in case it failed, providing an appropriate error code and error message</t>
4201                                    </list>
4202                                </t>
4203                            </list>
4204                        </t>
4205    
4206                        <t>Note: the given value will be passed to all sampler engine instances.
4207                           The total amount of maximum voices on the running system might thus
4208                           be as big as the given value multiplied by the current amount of engine
4209                           instances.</t>
4210    
4211                         <t>Caution: when adjusting the voice limit, you SHOULD also
4212                            adjust the disk stream limit respectively and vice versa.</t>
4213                    </section>
4214    
4215                    <section title="Getting global disk stream limit" anchor="GET STREAMS">
4216                        <t>The client can ask for the current global sampler-wide limit
4217                           for maximum disk streams by sending the following command:</t>
4218                        <t>
4219                            <list>
4220                                <t>GET STREAMS</t>
4221                            </list>
4222                        </t>
4223                        <t>Possible Answers:</t>
4224                        <t>
4225                            <list>
4226                                <t>LinuxSampler will answer by returning the number for
4227                                   the current limit of maximum disk streams.</t>
4228                            </list>
4229                        </t>
4230    
4231                        <t>The disk stream limit setting defines how many disk streams should
4232                           maximum be processed by a sampler engine at the same time. The
4233                           higher this value, the more memory (RAM) will be occupied, since
4234                           every disk streams allocates a certain buffer size for being able
4235                           to perform its streaming operations.</t>
4236                    </section>
4237    
4238                    <section title="Setting global disk stream limit" anchor="SET STREAMS">
4239                        <t>The client can alter the current global sampler-wide limit
4240                        for maximum disk streams by sending the following command:</t>
4241                        <t>
4242                            <list>
4243                                <t>SET STREAMS &lt;max-streams&gt;</t>
4244                            </list>
4245                        </t>
4246                       <t>Where &lt;max-streams&gt; should be replaced by the integer
4247                       value, reflecting the new global amount limit of maximum disk streams.
4248                       This value has to be positive.</t>
4249    
4250                        <t>Possible Answers:</t>
4251                        <t>
4252                            <list>
4253                                <t>"OK" -
4254                                    <list>
4255                                        <t>on success</t>
4256                                    </list>
4257                                </t>
4258                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4259                                    <list>
4260                                        <t>if the disk stream limit was set, but there are noteworthy
4261                                        issue(s) related, providing an appropriate warning code and
4262                                        warning message</t>
4263                                    </list>
4264                                </t>
4265                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4266                                    <list>
4267                                        <t>in case it failed, providing an appropriate error code and error message</t>
4268                                    </list>
4269                                </t>
4270                            </list>
4271                        </t>
4272    
4273                        <t>Note: the given value will be passed to all sampler engine instances.
4274                           The total amount of maximum disk streams on the running system might
4275                           thus be as big as the given value multiplied by the current amount of
4276                           engine instances.</t>
4277    
4278                         <t>Caution: when adjusting the disk stream limit, you SHOULD also
4279                            adjust the voice limit respectively and vice versa.</t>
4280                    </section>
4281    
4282              </section>              </section>
4283    
4284    
# Line 5350  Schoenebeck'> Line 5487  Schoenebeck'>
5487                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5488                      <t>                      <t>
5489                          <list>                          <list>
5490                              <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>
5491                          </list>                          </list>
5492                      </t>                      </t>
5493                      <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 5395  Schoenebeck'> Line 5532  Schoenebeck'>
5532                          </list>                          </list>
5533                      </t>                      </t>
5534    
5535                     <t> If FILE_AS_DIR argument is supplied, all instruments in an instrument
5536                     file will be added to a separate directory in the instruments database, which
5537                     name will be the name of the instrument file with the file extension stripped off.
5538                     </t>
5539                   <t>The difference between regular and NON_MODAL versions of the command                   <t>The difference between regular and NON_MODAL versions of the command
5540                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
5541                      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 6366  Schoenebeck'> Line 6507  Schoenebeck'>
6507                                      </t>                                      </t>
6508                                      <t>KEY_BINDINGS -                                      <t>KEY_BINDINGS -
6509                                          <list>                                          <list>
6510                                              <t>comma separated list of integer values representing                                              <t>comma separated list of integer values representing
6511                                                 the instrument's key mapping in the range between 0 .. 127,                                                 the instrument's key mapping in the range between 0 .. 127,
6512                                                 reflecting the analog meaning of the MIDI specification.</t>                                                 reflecting the analog meaning of the MIDI specification.</t>
6513                                          </list>                                          </list>
6514                                      </t>                                      </t>
6515                                      <t>KEYSWITCH_BINDINGS -                                      <t>KEYSWITCH_BINDINGS -
6516                                          <list>                                          <list>
6517                                              <t>comma separated list of integer values representing                                              <t>comma separated list of integer values representing
6518                                                 the instrument's keyswitch mapping in the range between 0 .. 127,                                                 the instrument's keyswitch mapping in the range between 0 .. 127,
6519                                                 reflecting the analog meaning of the MIDI specification.</t>                                                 reflecting the analog meaning of the MIDI specification.</t>
6520                                          </list>                                          </list>
6521                                      </t>                                      </t>
# Line 6484  Schoenebeck'> Line 6625  Schoenebeck'>
6625                  </t>                  </t>
6626                  <t>/ EDIT SP edit_instruction                  <t>/ EDIT SP edit_instruction
6627                  </t>                  </t>
6628                  <t>/ FORMAT SP format_instruction                  <t>/ FORMAT SP format_instruction
6629                  </t>                  </t>
6630                  <t>SEND SP send_instruction                  <t>/ SEND SP send_instruction
6631                  </t>                  </t>
6632                  <t>/ RESET                  <t>/ RESET
6633                  </t>                  </t>
# Line 6502  Schoenebeck'> Line 6643  Schoenebeck'>
6643                  </t>                  </t>
6644                  <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
6645                  </t>                  </t>
6646                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6647                    </t>
6648                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6649                  </t>                  </t>
6650                    <t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6651                    </t>
6652                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6653                  </t>                  </t>
6654                  <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 6750  Schoenebeck'> Line 6895  Schoenebeck'>
6895                  </t>                  </t>
6896                  <t>/ VOLUME                  <t>/ VOLUME
6897                  </t>                  </t>
6898                    <t>/ VOICES
6899                    </t>
6900                    <t>/ STREAMS
6901                    </t>
6902                  <t>/ FILE SP INSTRUMENTS SP filename                  <t>/ FILE SP INSTRUMENTS SP filename
6903                  </t>                  </t>
6904                  <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index                  <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
# Line 6794  Schoenebeck'> Line 6943  Schoenebeck'>
6943                  </t>                  </t>
6944                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
6945                  </t>                  </t>
6946                    <t>/ VOICES SP number
6947                    </t>
6948                    <t>/ STREAMS SP number
6949                    </t>
6950          </list>          </list>
6951  </t>  </t>
6952  <t>create_instruction =  <t>create_instruction =
# Line 7700  Schoenebeck'> Line 7853  Schoenebeck'>
7853                          replaced by the optional dotted floating point value, reflecting the                          replaced by the optional dotted floating point value, reflecting the
7854                          new global volume parameter.</t>                          new global volume parameter.</t>
7855                      </list>                      </list>
7856                        <list>
7857                            <t>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
7858                            golbal limit of the sampler for maximum voices is changed, where
7859                            &lt;max-voices&gt; will be an integer value, reflecting the
7860                            new global voice limit parameter.</t>
7861                        </list>
7862                        <list>
7863                            <t>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
7864                            golbal limit of the sampler for maximum disk streams is changed, where
7865                            &lt;max-streams&gt; will be an integer value, reflecting the
7866                            new global disk streams limit parameter.</t>
7867                        </list>
7868                  </t>                  </t>
7869              </section>              </section>
7870    
Legend:
Removed from v.1771  
changed lines
  Added in v.1800
  ViewVC Help
Powered by ViewVC