/[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 1800 by schoenebeck, Sun Dec 7 01:26:46 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="December" 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 6629  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 6661  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 6801  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 6813  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 6917  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 6929  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 6963  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 7017  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 7027  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 7105  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 7159  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 7229  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 7283  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 7330  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    
Legend:
Removed from v.1800  
changed lines
  Added in v.2137
  ViewVC Help
Powered by ViewVC