/[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 1782 by iliev, Tue Sep 30 02:16:41 2008 UTC revision 2137 by schoenebeck, Mon Oct 4 12:20:23 2010 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.4">  <rfc category="std" ipr="full3978" docName="LSCP 1.5">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# 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="2008"/>          <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 2512  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 2543  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 2555  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 2564  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 3712  Schoenebeck'> Line 3719  Schoenebeck'>
3719                  </section>                  </section>
3720    
3721                  <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">                  <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3722                      <t>The front-end can send MIDI events to specific sampler channel                      <t>The front-end can send MIDI events to a specific sampler channel
3723                      by sending the following command:</t>                      by sending the following command:</t>
3724                      <t>                      <t>
3725                          <list>                          <list>
# Line 3740  Schoenebeck'> Line 3747  Schoenebeck'>
3747                                      as described in the MIDI specification.</t>                                      as described in the MIDI specification.</t>
3748                                  </list>                                  </list>
3749                              </t>                              </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>                          </list>
3759                      </t>                      </t>
3760                      <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards                      <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
# Line 4142  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 6492  Schoenebeck'> Line 6644  Schoenebeck'>
6644                  </t>                  </t>
6645                  <t>/ SEND SP send_instruction                  <t>/ SEND SP send_instruction
6646                  </t>                  </t>
6647                    <t>/ APPEND SP append_instruction
6648                    </t>
6649                    <t>/ INSERT SP insert_instruction
6650                    </t>
6651                  <t>/ RESET                  <t>/ RESET
6652                  </t>                  </t>
6653                  <t>/ QUIT                  <t>/ QUIT
# Line 6524  Schoenebeck'> Line 6680  Schoenebeck'>
6680                  </t>                  </t>
6681                  <t>/ MIDI_INSTRUMENT_MAP SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP map_name
6682                  </t>                  </t>
6683                    <t>/ SEND_EFFECT_CHAIN SP device_index
6684                    </t>
6685          </list>          </list>
6686  </t>  </t>
6687  <t>subscribe_event =  <t>subscribe_event =
# Line 6664  Schoenebeck'> Line 6822  Schoenebeck'>
6822                  </t>                  </t>
6823                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6824                  </t>                  </t>
6825                    <t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain
6826                    </t>
6827                    <t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos
6828                    </t>
6829                    <t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id
6830                    </t>
6831                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6832                  </t>                  </t>
6833                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
# Line 6676  Schoenebeck'> Line 6840  Schoenebeck'>
6840          <list>          <list>
6841                  <t>AVAILABLE_ENGINES                  <t>AVAILABLE_ENGINES
6842                  </t>                  </t>
6843                    <t>/ AVAILABLE_EFFECTS
6844                    </t>
6845                    <t>/ EFFECT_INSTANCES
6846                    </t>
6847                    <t>/ EFFECT SP INFO SP effect_index
6848                    </t>
6849                    <t>/ EFFECT_INSTANCE SP INFO SP effect_instance
6850                    </t>
6851                    <t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control
6852                    </t>
6853                    <t>/ SEND_EFFECT_CHAINS SP device_index
6854                    </t>
6855                    <t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
6856                    </t>
6857                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
6858                  </t>                  </t>
6859                  <t>/ MIDI_INPUT_DRIVER SP INFO SP string                  <t>/ MIDI_INPUT_DRIVER SP INFO SP string
# Line 6758  Schoenebeck'> Line 6936  Schoenebeck'>
6936                  </t>                  </t>
6937                  <t>/ VOLUME                  <t>/ VOLUME
6938                  </t>                  </t>
6939                    <t>/ VOICES
6940                    </t>
6941                    <t>/ STREAMS
6942                    </t>
6943                  <t>/ FILE SP INSTRUMENTS SP filename                  <t>/ FILE SP INSTRUMENTS SP filename
6944                  </t>                  </t>
6945                  <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index                  <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
# Line 6776  Schoenebeck'> Line 6958  Schoenebeck'>
6958                  </t>                  </t>
6959                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6960                  </t>                  </t>
6961                    <t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value
6962                    </t>
6963                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
6964                  </t>                  </t>
6965                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
# Line 6788  Schoenebeck'> Line 6972  Schoenebeck'>
6972                  </t>                  </t>
6973                  <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
6974                  </t>                  </t>
6975                    <t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos
6976                    </t>
6977                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6978                  </t>                  </t>
6979                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
# Line 6802  Schoenebeck'> Line 6988  Schoenebeck'>
6988                  </t>                  </t>
6989                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
6990                  </t>                  </t>
6991                    <t>/ VOICES SP number
6992                    </t>
6993                    <t>/ STREAMS SP number
6994                    </t>
6995          </list>          </list>
6996  </t>  </t>
6997  <t>create_instruction =  <t>create_instruction =
# Line 6818  Schoenebeck'> Line 7008  Schoenebeck'>
7008                  </t>                  </t>
7009                  <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name                  <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
7010                  </t>                  </t>
7011                    <t>/ EFFECT_INSTANCE SP effect_index
7012                    </t>
7013                    <t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name
7014                    </t>
7015          </list>          </list>
7016  </t>  </t>
7017  <t>reset_instruction =  <t>reset_instruction =
# Line 6872  Schoenebeck'> Line 7066  Schoenebeck'>
7066                  </t>                  </t>
7067                  <t>/ FX_SEND SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP sampler_channel SP fx_send_id
7068                  </t>                  </t>
7069                    <t>/ EFFECT_INSTANCE SP number
7070                    </t>
7071          </list>          </list>
7072  </t>  </t>
7073  <t>load_instruction =  <t>load_instruction =
# Line 6882  Schoenebeck'> Line 7078  Schoenebeck'>
7078                  </t>                  </t>
7079          </list>          </list>
7080  </t>  </t>
7081    <t>append_instruction =
7082            <list>
7083                    <t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance
7084                    </t>
7085            </list>
7086    </t>
7087    <t>insert_instruction =
7088            <list>
7089                    <t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance
7090                    </t>
7091            </list>
7092    </t>
7093  <t>set_chan_instruction =  <t>set_chan_instruction =
7094          <list>          <list>
7095                  <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index                  <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
# Line 6960  Schoenebeck'> Line 7168  Schoenebeck'>
7168                  </t>                  </t>
7169                  <t>/ AVAILABLE_ENGINES                  <t>/ AVAILABLE_ENGINES
7170                  </t>                  </t>
7171                    <t>/ AVAILABLE_EFFECTS
7172                    </t>
7173                    <t>/ EFFECT_INSTANCES
7174                    </t>
7175                    <t>/ SEND_EFFECT_CHAINS SP number
7176                    </t>
7177                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS                  <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
7178                  </t>                  </t>
7179                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
# Line 7014  Schoenebeck'> Line 7228  Schoenebeck'>
7228                  </t>                  </t>
7229          </list>          </list>
7230  </t>  </t>
7231    <t>effect_instance =
7232            <list>
7233                    <t>number
7234                    </t>
7235            </list>
7236    </t>
7237  <t>device_index =  <t>device_index =
7238          <list>          <list>
7239                  <t>number                  <t>number
# Line 7084  Schoenebeck'> Line 7304  Schoenebeck'>
7304                  </t>                  </t>
7305          </list>          </list>
7306  </t>  </t>
7307    <t>control_value =
7308            <list>
7309                    <t>real
7310                    </t>
7311            </list>
7312    </t>
7313  <t>sampler_channel =  <t>sampler_channel =
7314          <list>          <list>
7315                  <t>number                  <t>number
# Line 7138  Schoenebeck'> Line 7364  Schoenebeck'>
7364                  </t>                  </t>
7365          </list>          </list>
7366  </t>  </t>
7367    <t>effect_name =
7368            <list>
7369                    <t>stringval_escaped
7370                    </t>
7371            </list>
7372    </t>
7373    <t>effect_index =
7374            <list>
7375                    <t>number
7376                    </t>
7377            </list>
7378    </t>
7379    <t>effect_chain =
7380            <list>
7381                    <t>number
7382                    </t>
7383            </list>
7384    </t>
7385    <t>chain_pos =
7386            <list>
7387                    <t>number
7388                    </t>
7389            </list>
7390    </t>
7391    <t>input_control =
7392            <list>
7393                    <t>number
7394                    </t>
7395            </list>
7396    </t>
7397  <t>param_val_list =  <t>param_val_list =
7398          <list>          <list>
7399                  <t>param_val                  <t>param_val
# Line 7185  Schoenebeck'> Line 7441  Schoenebeck'>
7441                  </t>                  </t>
7442          </list>          </list>
7443  </t>  </t>
7444    <t>effect_system =
7445            <list>
7446                    <t>string
7447                    </t>
7448            </list>
7449    </t>
7450    <t>module =
7451            <list>
7452                    <t>filename
7453                    </t>
7454            </list>
7455    </t>
7456    
7457              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
7458    
# Line 7708  Schoenebeck'> Line 7976  Schoenebeck'>
7976                          replaced by the optional dotted floating point value, reflecting the                          replaced by the optional dotted floating point value, reflecting the
7977                          new global volume parameter.</t>                          new global volume parameter.</t>
7978                      </list>                      </list>
7979                        <list>
7980                            <t>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
7981                            golbal limit of the sampler for maximum voices is changed, where
7982                            &lt;max-voices&gt; will be an integer value, reflecting the
7983                            new global voice limit parameter.</t>
7984                        </list>
7985                        <list>
7986                            <t>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
7987                            golbal limit of the sampler for maximum disk streams is changed, where
7988                            &lt;max-streams&gt; will be an integer value, reflecting the
7989                            new global disk streams limit parameter.</t>
7990                        </list>
7991                  </t>                  </t>
7992              </section>              </section>
7993    
Legend:
Removed from v.1782  
changed lines
  Added in v.2137
  ViewVC Help
Powered by ViewVC