/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Diff of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1401 by iliev, Thu Oct 11 20:45:49 2007 UTC revision 1771 by iliev, Wed Sep 10 15:02:24 2008 UTC
# Line 16  Line 16 
16       to an annoying "missing Normative/Informative References" error message -->       to an annoying "missing Normative/Informative References" error message -->
17  <?rfc strict="no" ?>  <?rfc strict="no" ?>
18    
19  <rfc category="std" ipr="full3978" docName="LSCP 1.2cvs">  <rfc category="std" ipr="full3978" docName="LSCP 1.4">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol (draft)</title>          <title>LinuxSampler Control Protocol</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
23  Schoenebeck'>  Schoenebeck'>
24              <organization>              <organization>
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="October" year="2007"/>          <date month="April" year="2008"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 2162  Schoenebeck'> Line 2162  Schoenebeck'>
2162                              </t>                              </t>
2163                          </list>                          </list>
2164                      </t>                      </t>
2165                      <t>Example:</t>                      <t>Example (Unix):</t>
2166                      <t>                      <t>
2167                          <list>                          <list>
2168                              <t></t>                              <t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t>
2169                                <t>S: OK</t>
2170                            </list>
2171                        </t>
2172                        <t>Example (Windows):</t>
2173                        <t>
2174                            <list>
2175                                <t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t>
2176                                <t>S: OK</t>
2177                          </list>                          </list>
2178                      </t>                      </t>
2179                  </section>                  </section>
# Line 3703  Schoenebeck'> Line 3711  Schoenebeck'>
3711                      </t>                      </t>
3712                  </section>                  </section>
3713    
3714                    <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3715                        <t>The front-end can send MIDI events to specific sampler channel
3716                        by sending the following command:</t>
3717                        <t>
3718                            <list>
3719                                <t>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;</t>
3720                            </list>
3721                        </t>
3722                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3723                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3724                        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
3726                        specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3727                        <t>
3728                            <list>
3729                                <t>"NOTE_ON" -
3730                                    <list>
3731                                        <t>For turning on MIDI notes, where &lt;arg1&gt;
3732                                        specifies the key number and &lt;arg2&gt; the velocity
3733                                        as described in the MIDI specification.</t>
3734                                    </list>
3735                                </t>
3736                                <t>"NOTE_OFF" -
3737                                    <list>
3738                                        <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3739                                        specifies the key number and &lt;arg2&gt; the velocity
3740                                        as described in the MIDI specification.</t>
3741                                    </list>
3742                                </t>
3743                            </list>
3744                        </t>
3745                        <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3746                        and no realtime guarantee whatsoever will be made!</t>
3747                        <t>Possible Answers:</t>
3748                        <t>
3749                            <list>
3750                                <t>"OK" -
3751                                    <list>
3752                                        <t>on success</t>
3753                                    </list>
3754                                </t>
3755                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3756                                    <list>
3757                                        <t>in case it failed, providing an appropriate error code and error message</t>
3758                                    </list>
3759                                </t>
3760                            </list>
3761                        </t>
3762                        <t>Example:</t>
3763                        <t>
3764                            <list>
3765                                <t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t>
3766                                <t>S: "OK"</t>
3767                            </list>
3768                        </t>
3769                    </section>
3770    
3771                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3772                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
3773                      <t>                      <t>
# Line 3924  Schoenebeck'> Line 3989  Schoenebeck'>
3989                      </t>                      </t>
3990                  </section>                  </section>
3991    
3992                    <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
3993                        <t>The front-end can ask for the current number of active disk streams on
3994                        the sampler by sending the following command:</t>
3995                        <t>
3996                            <list>
3997                                <t>GET TOTAL_STREAM_COUNT</t>
3998                            </list>
3999                        </t>
4000    
4001                        <t>Possible Answers:</t>
4002                        <t>
4003                            <list>
4004                                <t>LinuxSampler will answer by returning the number of all active
4005                                disk streams on the sampler.</t>
4006                            </list>
4007                        </t>
4008                    </section>
4009    
4010                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
4011                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
4012                      <t>                      <t>
# Line 5715  Schoenebeck'> Line 5798  Schoenebeck'>
5798                          </list>                          </list>
5799                      </t>                      </t>
5800                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5801                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
5802                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
5803                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5804    
# Line 5958  Schoenebeck'> Line 6041  Schoenebeck'>
6041                              <t>FORMAT INSTRUMENTS_DB</t>                              <t>FORMAT INSTRUMENTS_DB</t>
6042                          </list>                          </list>
6043                      </t>                      </t>
6044                        
6045                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
6046                      <t>                      <t>
6047                          <list>                          <list>
# Line 5977  Schoenebeck'> Line 6060  Schoenebeck'>
6060                      </t>                      </t>
6061                  </section>                  </section>
6062    
6063                    <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">
6064                        <t>The front-end can retrieve the list of all instrument files in the instruments database
6065                        that don't exist in the filesystem by sending the following command:</t>
6066                        <t>
6067                            <list>
6068                                <t>FIND LOST DB_INSTRUMENT_FILES</t>
6069                            </list>
6070                        </t>
6071    
6072                        <t>Possible Answers:</t>
6073                        <t>
6074                            <list>
6075                                <t>A comma separated list with the absolute path names
6076                                (encapsulated into apostrophes) of all lost instrument files.</t>
6077                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6078                                    <list>
6079                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6080                                    </list>
6081                                </t>
6082                            </list>
6083                        </t>
6084                        <t>Example:</t>
6085                        <t>
6086                            <list>
6087                                <t>C: "FIND LOST DB_INSTRUMENT_FILES"</t>
6088                                <t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t>
6089                            </list>
6090                        </t>
6091                    </section>
6092    
6093                    <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">
6094                        <t>The front-end can substitute all occurrences of an instrument file
6095                        in the instruments database with a new one by sending the following command:</t>
6096                        <t>
6097                            <list>
6098                                <t>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;</t>
6099                            </list>
6100                        </t>
6101                        <t>Where &lt;old_path&gt; is the absolute path name of the instrument file
6102                        to substitute with &lt;new_path&gt;.</t>
6103    
6104                        <t>Possible Answers:</t>
6105                        <t>
6106                            <list>
6107                                <t>"OK" -
6108                                    <list>
6109                                        <t>on success</t>
6110                                    </list>
6111                                </t>
6112                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6113                                    <list>
6114                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6115                                    </list>
6116                                </t>
6117                            </list>
6118                        </t>
6119    
6120                        <t>Example:</t>
6121                        <t>
6122                            <list>
6123                                <t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t>
6124                                <t>S: "OK"</t>
6125                            </list>
6126                        </t>
6127                    </section>
6128    
6129              </section>              </section>
6130    
6131    
# Line 5997  Schoenebeck'> Line 6146  Schoenebeck'>
6146                      editor application by sending the following command:</t>                      editor application by sending the following command:</t>
6147                      <t>                      <t>
6148                          <list>                          <list>
6149                              <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>                              <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6150                          </list>                          </list>
6151                      </t>                      </t>
6152                      <t>Where &lt;sampler-channel&gt; should be replaced by the                      <t>Where &lt;sampler-channel&gt; should be replaced by the
# Line 6049  Schoenebeck'> Line 6198  Schoenebeck'>
6198                      <t>Examples:</t>                      <t>Examples:</t>
6199                      <t>                      <t>
6200                          <list>                          <list>
6201                              <t>C: "EDIT INSTRUMENT 0"</t>                              <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6202                              <t>S: "OK"</t>                              <t>S: "OK"</t>
6203                          </list>                          </list>
6204                      </t>                      </t>
6205                  </section>                  </section>
6206              </section>              </section>
         </section>  
6207    
6208                <section title="Managing Files" anchor="file_management">
6209                    <t>You can query detailed informations about files located
6210                    at the same system where the sampler instance is running on.
6211                    Using this command set allows to retrieve file informations
6212                    even remotely from another machine.</t>
6213    
6214                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6215                        <t>The front-end can retrieve the amount of instruments
6216                        within a given instrument file by sending the
6217                        following command:</t>
6218                        <t>
6219                            <list>
6220                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6221                            </list>
6222                        </t>
6223                        <t>Where &lt;filename&gt; is the name of the instrument
6224                        file (encapsulated into apostrophes, supporting escape
6225                        sequences as described in chapter
6226                        "<xref target="character_set">Character Set and Escape
6227                            Sequences</xref>").</t>
6228    
6229                        <t>The sampler will try to ask all sampler engines,
6230                        whether they support the given file and ask the first
6231                        engine with a positive answer for the amount of
6232                        instruments.</t>
6233    
6234                        <t>Possible Answers:</t>
6235                        <t>
6236                            <list>
6237                                <t>On success, the sampler will answer by
6238                                   returning the amount of instruments.
6239                                </t>
6240                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6241                                    <list>
6242                                        <t>if the file could not be handled</t>
6243                                    </list>
6244                                </t>
6245                            </list>
6246                        </t>
6247    
6248                        <t>Examples:</t>
6249                        <t>
6250                            <list>
6251                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6252                                <t>S: "10"</t>
6253                            </list>
6254                        </t>
6255                    </section>
6256    
6257                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6258                        <t>The front-end can retrieve a list of all instruments
6259                        within a given instrument file by sending the
6260                        following command:</t>
6261                        <t>
6262                            <list>
6263                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6264                            </list>
6265                        </t>
6266                        <t>Where &lt;filename&gt; is the name of the instrument
6267                        file (encapsulated into apostrophes, supporting escape
6268                        sequences as described in chapter
6269                        "<xref target="character_set">Character Set and Escape
6270                            Sequences</xref>").</t>
6271    
6272                        <t>The sampler will try to ask all sampler engines,
6273                        whether they support the given file and ask the first
6274                        engine with a positive answer for a list of IDs for the
6275                        instruments in the given file.</t>
6276    
6277                        <t>Possible Answers:</t>
6278                        <t>
6279                            <list>
6280                                <t>On success, the sampler will answer by
6281                                   returning a comma separated list of
6282                                   instrument IDs.
6283                                </t>
6284                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6285                                    <list>
6286                                        <t>if the file could not be handled</t>
6287                                    </list>
6288                                </t>
6289                            </list>
6290                        </t>
6291    
6292                        <t>Examples:</t>
6293                        <t>
6294                            <list>
6295                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6296                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6297                            </list>
6298                        </t>
6299                    </section>
6300    
6301                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6302                        <t>The front-end can retrieve detailed informations
6303                        about a specific instrument within a given instrument
6304                        file by sending the following command:</t>
6305                        <t>
6306                            <list>
6307                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6308                                &lt;instr-id&gt;</t>
6309                            </list>
6310                        </t>
6311                        <t>Where &lt;filename&gt; is the name of the instrument
6312                        file (encapsulated into apostrophes, supporting escape
6313                        sequences as described in chapter
6314                        "<xref target="character_set">Character Set and Escape
6315                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6316                        instrument ID as returned by the
6317                        <xref target="LIST FILE INSTRUMENTS">
6318                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6319    
6320                        <t>The sampler will try to ask all sampler engines,
6321                        whether they support the given file and ask the first
6322                        engine with a positive answer for informations about the
6323                        specific instrument in the given file.</t>
6324    
6325                        <t>Possible Answers:</t>
6326                        <t>
6327                            <list>
6328                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6329                                Each answer line begins with the settings category name
6330                                followed by a colon and then a space character &lt;SP&gt; and finally
6331                                the info character string to that setting category. At the
6332                                moment the following categories are defined:</t>
6333    
6334                                <t>
6335                                    <list>
6336                                        <t>NAME -
6337                                            <list>
6338                                                <t>name of the instrument as
6339                                                stored in the instrument file</t>
6340                                            </list>
6341                                        </t>
6342                                        <t>FORMAT_FAMILY -
6343                                            <list>
6344                                                <t>name of the sampler format
6345                                                of the given instrument</t>
6346                                            </list>
6347                                        </t>
6348                                        <t>FORMAT_VERSION -
6349                                            <list>
6350                                                <t>version of the sampler format
6351                                                the instrumen is stored as</t>
6352                                            </list>
6353                                        </t>
6354                                        <t>PRODUCT -
6355                                            <list>
6356                                                <t>official product name of the
6357                                                instrument as stored in the file
6358                                                </t>
6359                                            </list>
6360                                        </t>
6361                                        <t>ARTISTS -
6362                                            <list>
6363                                                <t>artists / sample library
6364                                                vendor of the instrument</t>
6365                                            </list>
6366                                        </t>
6367                                        <t>KEY_BINDINGS -
6368                                            <list>
6369                                                <t>comma separated list of integer values representing
6370                                                   the instrument's key mapping in the range between 0 .. 127,
6371                                                   reflecting the analog meaning of the MIDI specification.</t>
6372                                            </list>
6373                                        </t>
6374                                        <t>KEYSWITCH_BINDINGS -
6375                                            <list>
6376                                                <t>comma separated list of integer values representing
6377                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
6378                                                   reflecting the analog meaning of the MIDI specification.</t>
6379                                            </list>
6380                                        </t>
6381                                    </list>
6382                                </t>
6383                            </list>
6384                        </t>
6385                        <t>The mentioned fields above don't have to be in particular order.</t>
6386    
6387                        <t>Example:</t>
6388                        <t>
6389                            <list>
6390                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6391                                <t>S: "NAME: Lunatic Loops"</t>
6392                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6393                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6394                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6395                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6396                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6397                            </list>
6398                        </t>
6399                    </section>
6400                </section>
6401            </section>
6402    
6403          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
6404              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
# Line 6142  Schoenebeck'> Line 6484  Schoenebeck'>
6484                  </t>                  </t>
6485                  <t>/ EDIT SP edit_instruction                  <t>/ EDIT SP edit_instruction
6486                  </t>                  </t>
6487                  <t>/ FORMAT SP format_instruction                  <t>/ FORMAT SP format_instruction
6488                    </t>
6489                    <t>SEND SP send_instruction
6490                  </t>                  </t>
6491                  <t>/ RESET                  <t>/ RESET
6492                  </t>                  </t>
# Line 6186  Schoenebeck'> Line 6530  Schoenebeck'>
6530                  </t>                  </t>
6531                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6532                  </t>                  </t>
6533                    <t>/ CHANNEL_MIDI
6534                    </t>
6535                    <t>/ DEVICE_MIDI
6536                    </t>
6537                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6538                  </t>                  </t>
6539                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6218  Schoenebeck'> Line 6566  Schoenebeck'>
6566                  </t>                  </t>
6567                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6568                  </t>                  </t>
6569                    <t>/ TOTAL_STREAM_COUNT
6570                    </t>
6571                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6572                  </t>                  </t>
6573                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6236  Schoenebeck'> Line 6586  Schoenebeck'>
6586                  </t>                  </t>
6587                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6588                  </t>                  </t>
6589                    <t>/ CHANNEL_MIDI
6590                    </t>
6591                    <t>/ DEVICE_MIDI
6592                    </t>
6593                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6594                  </t>                  </t>
6595                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6268  Schoenebeck'> Line 6622  Schoenebeck'>
6622                  </t>                  </t>
6623                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6624                  </t>                  </t>
6625                    <t>/ TOTAL_STREAM_COUNT
6626                    </t>
6627                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6628                  </t>                  </t>
6629                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6358  Schoenebeck'> Line 6714  Schoenebeck'>
6714                  </t>                  </t>
6715                  <t>/ SERVER SP INFO                  <t>/ SERVER SP INFO
6716                  </t>                  </t>
6717                    <t>/ TOTAL_STREAM_COUNT
6718                    </t>
6719                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6720                  </t>                  </t>
6721                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
# Line 6392  Schoenebeck'> Line 6750  Schoenebeck'>
6750                  </t>                  </t>
6751                  <t>/ VOLUME                  <t>/ VOLUME
6752                  </t>                  </t>
6753                    <t>/ FILE SP INSTRUMENTS SP filename
6754                    </t>
6755                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6756                    </t>
6757          </list>          </list>
6758  </t>  </t>
6759  <t>set_instruction =  <t>set_instruction =
# Line 6426  Schoenebeck'> Line 6788  Schoenebeck'>
6788                  </t>                  </t>
6789                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6790                  </t>                  </t>
6791                    <t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6792                    </t>
6793                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6794                  </t>                  </t>
6795                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
# Line 6472  Schoenebeck'> Line 6836  Schoenebeck'>
6836                  </t>                  </t>
6837                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6838                  </t>                  </t>
6839                    <t>/ LOST SP DB_INSTRUMENT_FILES
6840                    </t>
6841          </list>          </list>
6842  </t>  </t>
6843  <t>move_instruction =  <t>move_instruction =
# Line 6542  Schoenebeck'> Line 6908  Schoenebeck'>
6908  </t>  </t>
6909  <t>edit_instruction =  <t>edit_instruction =
6910          <list>          <list>
6911                  <t>INSTRUMENT SP sampler_channel                  <t>CHANNEL SP INSTRUMENT SP sampler_channel
6912                  </t>                  </t>
6913          </list>          </list>
6914  </t>  </t>
# Line 6606  Schoenebeck'> Line 6972  Schoenebeck'>
6972                  </t>                  </t>
6973                  <t>/ DB_INSTRUMENTS SP db_path                  <t>/ DB_INSTRUMENTS SP db_path
6974                  </t>                  </t>
6975                    <t>/ FILE SP INSTRUMENTS SP filename
6976                    </t>
6977            </list>
6978    </t>
6979    <t>send_instruction =
6980            <list>
6981                    <t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
6982                    </t>
6983          </list>          </list>
6984  </t>  </t>
6985  <t>load_instr_args =  <t>load_instr_args =
# Line 6865  Schoenebeck'> Line 7239  Schoenebeck'>
7239                      <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>                      <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7240                      <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>                      <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7241                      <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>                      <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7242                        <t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t>
7243                        <t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t>
7244                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7245                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7246                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7247                  </list>                  </list>
7248                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
7249                  filename / path based arguments: it acts as separator of the nodes in                  filename / path based arguments: it acts as separator of the nodes in
# Line 6875  Schoenebeck'> Line 7254  Schoenebeck'>
7254                  </t>                  </t>
7255    
7256                  <t>                  <t>
7257                    Note for Windows: file path arguments in LSCP are expected
7258                    to use forward slashes as directory node separator similar
7259                    to Unix based operating systems. In contrast to Unix however
7260                    a Windows typical drive character is expected to be
7261                    prefixed to the path. That is an original Windows file path
7262                    like "D:\Sounds\My.gig" would become in LSCP:
7263                    "D:/Sounds/My.gig".
7264                    </t>
7265    
7266                    <t>
7267                  The following LSCP commands even support escape sequences as                  The following LSCP commands even support escape sequences as
7268                  part of at least one of their text-based arguments (i.e. entity name,                  part of at least one of their text-based arguments (i.e. entity name,
7269                  description) and / or may contain escape sequences in at least one of                  description) and / or may contain escape sequences in at least one of
# Line 7008  Schoenebeck'> Line 7397  Schoenebeck'>
7397                  of sampler channels.</t>                  of sampler channels.</t>
7398              </section>              </section>
7399    
7400                <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
7401                    <t>Client may want to be notified when MIDI data arrive on sampler channels on
7402                    back-end side, by issuing the following command:</t>
7403                    <t>
7404                        <list>
7405                            <t>SUBSCRIBE CHANNEL_MIDI</t>
7406                        </list>
7407                    </t>
7408                    <t>Server will start sending one of the the following notification messages:</t>
7409                    <t>
7410                        <list>
7411                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"</t>
7412                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7413                        </list>
7414                    </t>
7415                    <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
7416                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7417                    0 .. 127, reflecting the analog meaning of the MIDI specification.
7418                    </t>
7419                    <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7420                    delivered by this mechanism! With other words: events could be lost at any time!
7421                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7422                    thread unaffected by this feature.</t>
7423                </section>
7424    
7425                <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">
7426                        <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
7427                        <t>
7428                                <list>
7429                                        <t>SUBSCRIBE DEVICE_MIDI</t>
7430                                </list>
7431                        </t>
7432                        <t>Server will start sending one of the the following notification messages:</t>
7433                        <t>
7434                                <list>
7435                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
7436                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7437                                </list>
7438                        </t>
7439                        <t>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
7440                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
7441                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7442                           0 .. 127, reflecting the analog meaning of the MIDI specification.
7443                        </t>
7444                        <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7445                           delivered by this mechanism! With other words: events could be lost at any time!
7446                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7447                           thread unaffected by this feature.</t>
7448                </section>
7449    
7450              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7451                  <t>Client may want to be notified when the number of voices on the                  <t>Client may want to be notified when the number of voices on the
7452                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 7145  Schoenebeck'> Line 7584  Schoenebeck'>
7584                  all currently active voices.</t>                  all currently active voices.</t>
7585              </section>              </section>
7586    
7587                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7588                    <t>Client may want to be notified when the total number of disk streams on the
7589                    back-end changes by issuing the following command:</t>
7590                    <t>
7591                        <list>
7592                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7593                        </list>
7594                    </t>
7595                    <t>Server will start sending the following notification messages:</t>
7596                    <t>
7597                        <list>
7598                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7599                        </list>
7600                    </t>
7601                    <t>where &lt;streams&gt; will be replaced by the new number of
7602                    all currently active disk streams.</t>
7603                </section>
7604    
7605              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
7606                  <t>Client may want to be notified when the number of MIDI instrument maps on the                  <t>Client may want to be notified when the number of MIDI instrument maps on the
7607                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
Legend:
Removed from v.1401  
changed lines
  Added in v.1771
  ViewVC Help
Powered by ViewVC