/[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 1026 by schoenebeck, Sun Jan 14 17:10:59 2007 UTC revision 1136 by iliev, Thu Mar 29 10:01:50 2007 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="December" year="2006"/>          <date month="March" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 3479  Schoenebeck'> Line 3479  Schoenebeck'>
3479                      </t>                      </t>
3480                  </section>                  </section>
3481    
3482                    <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3483                        <t>The front-end can alter the current name of an effect
3484                        send entity by sending the following command:</t>
3485                        <t>
3486                            <list>
3487                                <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3488                            </list>
3489                        </t>
3490                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3491                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3492                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3493                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3494                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3495                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3496                        &lt;name&gt; is the new name of the effect send entity, which
3497                        does not have to be unique.</t>
3498    
3499                        <t>Possible Answers:</t>
3500                        <t>
3501                            <list>
3502                                <t>"OK" -
3503                                    <list>
3504                                        <t>on success</t>
3505                                    </list>
3506                                </t>
3507                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3508                                    <list>
3509                                        <t>in case it failed, providing an appropriate error code and error message</t>
3510                                    </list>
3511                                </t>
3512                            </list>
3513                        </t>
3514                        <t>Example:</t>
3515                        <t>
3516                            <list>
3517                                <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3518                                <t>S: "OK"</t>
3519                            </list>
3520                        </t>
3521                    </section>
3522    
3523                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3524                      <t>The front-end can alter the destination of an effect send's audio channel on a specific                      <t>The front-end can alter the destination of an effect send's audio channel on a specific
3525                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
# Line 4198  Schoenebeck'> Line 4239  Schoenebeck'>
4239                                              which does not have to be unique</t>                                              which does not have to be unique</t>
4240                                          </list>                                          </list>
4241                                      </t>                                      </t>
4242                                        <t>DEFAULT -
4243                                            <list>
4244                                                <t>either true or false,
4245                                                defines whether this map is the default map</t>
4246                                            </list>
4247                                        </t>
4248                                  </list>                                  </list>
4249                              </t>                              </t>
4250                          </list>                          </list>
# Line 4209  Schoenebeck'> Line 4256  Schoenebeck'>
4256                          <list>                          <list>
4257                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4258                              <t>S: "NAME: Standard Map"</t>                              <t>S: "NAME: Standard Map"</t>
4259                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4260                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
4261                          </list>                          </list>
4262                      </t>                      </t>
# Line 4257  Schoenebeck'> Line 4305  Schoenebeck'>
4305                      command:</t>                      command:</t>
4306                      <t>                      <t>
4307                          <list>                          <list>
4308                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4309                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4310                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4311                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
# Line 4310  Schoenebeck'> Line 4358  Schoenebeck'>
4358                              <t>"PERSISTENT" -                              <t>"PERSISTENT" -
4359                                  <list>                                  <list>
4360                                      <t>The instrument will immediately be loaded                                      <t>The instrument will immediately be loaded
4361                                      into memory in the background when this mapping                                      into memory when this mapping
4362                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
4363                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
4364                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 4360  Schoenebeck'> Line 4408  Schoenebeck'>
4408                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4409                      </t>                      </t>
4410                      <t>                      <t>
4411                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4412                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4413                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
4414                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
4415                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
4416                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
4417                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
4418                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4419                        because it has the following drawbacks: as "NON_MODAL" instructions return
4420                        immediately, they may not necessarily return an error i.e. when the given
4421                        instrument file turns out to be corrupt, beside that subsequent commands
4422                        in a LSCP instruction sequence might fail, because mandatory mappings are
4423                        not yet completed.
4424                      </t>                      </t>
4425    
4426                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 4409  Schoenebeck'> Line 4463  Schoenebeck'>
4463                      </t>                      </t>
4464                      <t>                      <t>
4465                          <list>                          <list>
4466                              <t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>                              <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4467                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4468                          </list>                          </list>
4469                      </t>                      </t>
# Line 4797  Schoenebeck'> Line 4851  Schoenebeck'>
4851                  </t>                  </t>
4852                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4853                  </t>                  </t>
4854                    <t>/ FX_SEND_COUNT
4855                    </t>
4856                    <t>/ FX_SEND_INFO
4857                    </t>
4858                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
4859                  </t>                  </t>
4860                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4809  Schoenebeck'> Line 4867  Schoenebeck'>
4867                  </t>                  </t>
4868                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4869                  </t>                  </t>
4870                    <t>/ GLOBAL_INFO
4871                    </t>
4872          </list>          </list>
4873  </t>  </t>
4874  <t>unsubscribe_event =  <t>unsubscribe_event =
# Line 4831  Schoenebeck'> Line 4891  Schoenebeck'>
4891                  </t>                  </t>
4892                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4893                  </t>                  </t>
4894                    <t>/ FX_SEND_COUNT
4895                    </t>
4896                    <t>/ FX_SEND_INFO
4897                    </t>
4898                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
4899                  </t>                  </t>
4900                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4843  Schoenebeck'> Line 4907  Schoenebeck'>
4907                  </t>                  </t>
4908                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4909                  </t>                  </t>
4910                    <t>/ GLOBAL_INFO
4911                    </t>
4912          </list>          </list>
4913  </t>  </t>
4914  <t>map_instruction =  <t>map_instruction =
4915          <list>          <list>
4916                  <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value                  <t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
4917                  </t>                  </t>
4918                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
4919                  </t>                  </t>
4920                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
4921                  </t>                  </t>
4922                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
4923                  </t>                  </t>
4924          </list>          </list>
4925  </t>  </t>
# Line 4959  Schoenebeck'> Line 5025  Schoenebeck'>
5025                  </t>                  </t>
5026                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5027                  </t>                  </t>
5028                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5029                    </t>
5030                  <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index                  <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
5031                  </t>                  </t>
5032                  <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl                  <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
# Line 5051  Schoenebeck'> Line 5119  Schoenebeck'>
5119                  </t>                  </t>
5120          </list>          </list>
5121  </t>  </t>
5122    <t>modal_arg =
5123            <list>
5124                    <t>/* epsilon (empty argument) */
5125                    </t>
5126                    <t>/ NON_MODAL SP
5127                    </t>
5128            </list>
5129    </t>
5130  <t>key_val_list =  <t>key_val_list =
5131          <list>          <list>
5132                  <t>string '=' param_val_list                  <t>string '=' param_val_list
# Line 5369  Schoenebeck'> Line 5445  Schoenebeck'>
5445                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5446                  <t>                  <t>
5447                      <list>                      <list>
5448                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
5449                      </list>                      </list>
5450                  </t>                  </t>
5451                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
# Line 5439  Schoenebeck'> Line 5515  Schoenebeck'>
5515                  message is sufficient here.</t>                  message is sufficient here.</t>
5516              </section>              </section>
5517    
5518                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
5519                    <t>Client may want to be notified when the number of effect sends on
5520                    a particular sampler channel is changed by issuing the following command:</t>
5521                    <t>
5522                        <list>
5523                            <t>SUBSCRIBE FX_SEND_COUNT</t>
5524                        </list>
5525                    </t>
5526                    <t>Server will start sending the following notification messages:</t>
5527                    <t>
5528                        <list>
5529                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
5530                        </list>
5531                    </t>
5532                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5533                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
5534                    be replaced by the new number of effect sends on that channel.</t>
5535                </section>
5536    
5537                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
5538                    <t>Client may want to be notified when changes were made to effect sends on a
5539                    a particular sampler channel by issuing the following command:</t>
5540                    <t>
5541                        <list>
5542                            <t>SUBSCRIBE FX_SEND_INFO</t>
5543                        </list>
5544                    </t>
5545                    <t>Server will start sending the following notification messages:</t>
5546                    <t>
5547                        <list>
5548                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
5549                        </list>
5550                    </t>
5551                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5552                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
5553                    be replaced by the numerical ID of the changed effect send.</t>
5554                </section>
5555    
5556              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
5557                  <t>Client may want to be notified when the total number of voices on the                  <t>Client may want to be notified when the total number of voices on the
5558                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 5450  Schoenebeck'> Line 5564  Schoenebeck'>
5564                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5565                  <t>                  <t>
5566                      <list>                      <list>
5567                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
5568                      </list>                      </list>
5569                  </t>                  </t>
5570                  <t>where &lt;voices&gt; will be replaced by the new number of                  <t>where &lt;voices&gt; will be replaced by the new number of
# Line 5539  Schoenebeck'> Line 5653  Schoenebeck'>
5653                  message is sufficient here.</t>                  message is sufficient here.</t>
5654              </section>              </section>
5655    
5656                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
5657                    <t>Client may want to be notified when changes to the global settings
5658                    of the sampler were made by issuing the following command:</t>
5659                    <t>
5660                        <list>
5661                            <t>SUBSCRIBE GLOBAL_INFO</t>
5662                        </list>
5663                    </t>
5664                    <t>Server will start sending the following types of notification messages:</t>
5665                    <t>
5666                        <list>
5667                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
5668                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
5669                            replaced by the optional dotted floating point value, reflecting the
5670                            new global volume parameter.</t>
5671                        </list>
5672                    </t>
5673                </section>
5674    
5675              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
5676                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
5677                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.1026  
changed lines
  Added in v.1136
  ViewVC Help
Powered by ViewVC