/[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 1782 by iliev, Tue Sep 30 02:16:41 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="September" 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 5267  Schoenebeck'> Line 5350  Schoenebeck'>
5350                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5351                      <t>                      <t>
5352                          <list>                          <list>
5353                              <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>                              <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5354                          </list>                          </list>
5355                      </t>                      </t>
5356                      <t>Where &lt;db_dir&gt; is the absolute path name of a directory                      <t>Where &lt;db_dir&gt; is the absolute path name of a directory
# Line 5312  Schoenebeck'> Line 5395  Schoenebeck'>
5395                          </list>                          </list>
5396                      </t>                      </t>
5397    
5398                     <t> If FILE_AS_DIR argument is supplied, all instruments in an instrument
5399                     file will be added to a separate directory in the instruments database, which
5400                     name will be the name of the instrument file with the file extension stripped off.
5401                     </t>
5402                   <t>The difference between regular and NON_MODAL versions of the command                   <t>The difference between regular and NON_MODAL versions of the command
5403                      is that the regular command returns when the scanning is finished                      is that the regular command returns when the scanning is finished
5404                      while NON_MODAL version returns immediately and a background process is launched.                      while NON_MODAL version returns immediately and a background process is launched.
# Line 5715  Schoenebeck'> Line 5802  Schoenebeck'>
5802                          </list>                          </list>
5803                      </t>                      </t>
5804                      <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
5805                      &lt;desc&gt; is the new description for the instrument                      &lt;desc&gt; is the new description for the instrument
5806                      (encapsulated into apostrophes, supporting escape sequences as described in chapter                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
5807                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>                      "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5808    
# Line 5958  Schoenebeck'> Line 6045  Schoenebeck'>
6045                              <t>FORMAT INSTRUMENTS_DB</t>                              <t>FORMAT INSTRUMENTS_DB</t>
6046                          </list>                          </list>
6047                      </t>                      </t>
6048                        
6049                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
6050                      <t>                      <t>
6051                          <list>                          <list>
# Line 5977  Schoenebeck'> Line 6064  Schoenebeck'>
6064                      </t>                      </t>
6065                  </section>                  </section>
6066    
6067                    <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">
6068                        <t>The front-end can retrieve the list of all instrument files in the instruments database
6069                        that don't exist in the filesystem by sending the following command:</t>
6070                        <t>
6071                            <list>
6072                                <t>FIND LOST DB_INSTRUMENT_FILES</t>
6073                            </list>
6074                        </t>
6075    
6076                        <t>Possible Answers:</t>
6077                        <t>
6078                            <list>
6079                                <t>A comma separated list with the absolute path names
6080                                (encapsulated into apostrophes) of all lost instrument files.</t>
6081                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6082                                    <list>
6083                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6084                                    </list>
6085                                </t>
6086                            </list>
6087                        </t>
6088                        <t>Example:</t>
6089                        <t>
6090                            <list>
6091                                <t>C: "FIND LOST DB_INSTRUMENT_FILES"</t>
6092                                <t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t>
6093                            </list>
6094                        </t>
6095                    </section>
6096    
6097                    <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">
6098                        <t>The front-end can substitute all occurrences of an instrument file
6099                        in the instruments database with a new one by sending the following command:</t>
6100                        <t>
6101                            <list>
6102                                <t>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;</t>
6103                            </list>
6104                        </t>
6105                        <t>Where &lt;old_path&gt; is the absolute path name of the instrument file
6106                        to substitute with &lt;new_path&gt;.</t>
6107    
6108                        <t>Possible Answers:</t>
6109                        <t>
6110                            <list>
6111                                <t>"OK" -
6112                                    <list>
6113                                        <t>on success</t>
6114                                    </list>
6115                                </t>
6116                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6117                                    <list>
6118                                        <t>in case it failed, providing an appropriate error code and error message.</t>
6119                                    </list>
6120                                </t>
6121                            </list>
6122                        </t>
6123    
6124                        <t>Example:</t>
6125                        <t>
6126                            <list>
6127                                <t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t>
6128                                <t>S: "OK"</t>
6129                            </list>
6130                        </t>
6131                    </section>
6132    
6133              </section>              </section>
6134    
6135    
# Line 5997  Schoenebeck'> Line 6150  Schoenebeck'>
6150                      editor application by sending the following command:</t>                      editor application by sending the following command:</t>
6151                      <t>                      <t>
6152                          <list>                          <list>
6153                              <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>                              <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6154                          </list>                          </list>
6155                      </t>                      </t>
6156                      <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 6202  Schoenebeck'>
6202                      <t>Examples:</t>                      <t>Examples:</t>
6203                      <t>                      <t>
6204                          <list>                          <list>
6205                              <t>C: "EDIT INSTRUMENT 0"</t>                              <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6206                              <t>S: "OK"</t>                              <t>S: "OK"</t>
6207                          </list>                          </list>
6208                      </t>                      </t>
6209                  </section>                  </section>
6210              </section>              </section>
         </section>  
6211    
6212                <section title="Managing Files" anchor="file_management">
6213                    <t>You can query detailed informations about files located
6214                    at the same system where the sampler instance is running on.
6215                    Using this command set allows to retrieve file informations
6216                    even remotely from another machine.</t>
6217    
6218                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6219                        <t>The front-end can retrieve the amount of instruments
6220                        within a given instrument file by sending the
6221                        following command:</t>
6222                        <t>
6223                            <list>
6224                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6225                            </list>
6226                        </t>
6227                        <t>Where &lt;filename&gt; is the name of the instrument
6228                        file (encapsulated into apostrophes, supporting escape
6229                        sequences as described in chapter
6230                        "<xref target="character_set">Character Set and Escape
6231                            Sequences</xref>").</t>
6232    
6233                        <t>The sampler will try to ask all sampler engines,
6234                        whether they support the given file and ask the first
6235                        engine with a positive answer for the amount of
6236                        instruments.</t>
6237    
6238                        <t>Possible Answers:</t>
6239                        <t>
6240                            <list>
6241                                <t>On success, the sampler will answer by
6242                                   returning the amount of instruments.
6243                                </t>
6244                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6245                                    <list>
6246                                        <t>if the file could not be handled</t>
6247                                    </list>
6248                                </t>
6249                            </list>
6250                        </t>
6251    
6252                        <t>Examples:</t>
6253                        <t>
6254                            <list>
6255                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6256                                <t>S: "10"</t>
6257                            </list>
6258                        </t>
6259                    </section>
6260    
6261                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6262                        <t>The front-end can retrieve a list of all instruments
6263                        within a given instrument file by sending the
6264                        following command:</t>
6265                        <t>
6266                            <list>
6267                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6268                            </list>
6269                        </t>
6270                        <t>Where &lt;filename&gt; is the name of the instrument
6271                        file (encapsulated into apostrophes, supporting escape
6272                        sequences as described in chapter
6273                        "<xref target="character_set">Character Set and Escape
6274                            Sequences</xref>").</t>
6275    
6276                        <t>The sampler will try to ask all sampler engines,
6277                        whether they support the given file and ask the first
6278                        engine with a positive answer for a list of IDs for the
6279                        instruments in the given file.</t>
6280    
6281                        <t>Possible Answers:</t>
6282                        <t>
6283                            <list>
6284                                <t>On success, the sampler will answer by
6285                                   returning a comma separated list of
6286                                   instrument IDs.
6287                                </t>
6288                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6289                                    <list>
6290                                        <t>if the file could not be handled</t>
6291                                    </list>
6292                                </t>
6293                            </list>
6294                        </t>
6295    
6296                        <t>Examples:</t>
6297                        <t>
6298                            <list>
6299                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6300                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6301                            </list>
6302                        </t>
6303                    </section>
6304    
6305                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6306                        <t>The front-end can retrieve detailed informations
6307                        about a specific instrument within a given instrument
6308                        file by sending the following command:</t>
6309                        <t>
6310                            <list>
6311                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6312                                &lt;instr-id&gt;</t>
6313                            </list>
6314                        </t>
6315                        <t>Where &lt;filename&gt; is the name of the instrument
6316                        file (encapsulated into apostrophes, supporting escape
6317                        sequences as described in chapter
6318                        "<xref target="character_set">Character Set and Escape
6319                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6320                        instrument ID as returned by the
6321                        <xref target="LIST FILE INSTRUMENTS">
6322                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6323    
6324                        <t>The sampler will try to ask all sampler engines,
6325                        whether they support the given file and ask the first
6326                        engine with a positive answer for informations about the
6327                        specific instrument in the given file.</t>
6328    
6329                        <t>Possible Answers:</t>
6330                        <t>
6331                            <list>
6332                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6333                                Each answer line begins with the settings category name
6334                                followed by a colon and then a space character &lt;SP&gt; and finally
6335                                the info character string to that setting category. At the
6336                                moment the following categories are defined:</t>
6337    
6338                                <t>
6339                                    <list>
6340                                        <t>NAME -
6341                                            <list>
6342                                                <t>name of the instrument as
6343                                                stored in the instrument file</t>
6344                                            </list>
6345                                        </t>
6346                                        <t>FORMAT_FAMILY -
6347                                            <list>
6348                                                <t>name of the sampler format
6349                                                of the given instrument</t>
6350                                            </list>
6351                                        </t>
6352                                        <t>FORMAT_VERSION -
6353                                            <list>
6354                                                <t>version of the sampler format
6355                                                the instrumen is stored as</t>
6356                                            </list>
6357                                        </t>
6358                                        <t>PRODUCT -
6359                                            <list>
6360                                                <t>official product name of the
6361                                                instrument as stored in the file
6362                                                </t>
6363                                            </list>
6364                                        </t>
6365                                        <t>ARTISTS -
6366                                            <list>
6367                                                <t>artists / sample library
6368                                                vendor of the instrument</t>
6369                                            </list>
6370                                        </t>
6371                                        <t>KEY_BINDINGS -
6372                                            <list>
6373                                                <t>comma separated list of integer values representing
6374                                                   the instrument's key mapping in the range between 0 .. 127,
6375                                                   reflecting the analog meaning of the MIDI specification.</t>
6376                                            </list>
6377                                        </t>
6378                                        <t>KEYSWITCH_BINDINGS -
6379                                            <list>
6380                                                <t>comma separated list of integer values representing
6381                                                   the instrument's keyswitch mapping in the range between 0 .. 127,
6382                                                   reflecting the analog meaning of the MIDI specification.</t>
6383                                            </list>
6384                                        </t>
6385                                    </list>
6386                                </t>
6387                            </list>
6388                        </t>
6389                        <t>The mentioned fields above don't have to be in particular order.</t>
6390    
6391                        <t>Example:</t>
6392                        <t>
6393                            <list>
6394                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6395                                <t>S: "NAME: Lunatic Loops"</t>
6396                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6397                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6398                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6399                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6400                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6401                            </list>
6402                        </t>
6403                    </section>
6404                </section>
6405            </section>
6406    
6407          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
6408              <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 6144  Schoenebeck'> Line 6490  Schoenebeck'>
6490                  </t>                  </t>
6491                  <t>/ FORMAT SP format_instruction                  <t>/ FORMAT SP format_instruction
6492                  </t>                  </t>
6493                    <t>/ SEND SP send_instruction
6494                    </t>
6495                  <t>/ RESET                  <t>/ RESET
6496                  </t>                  </t>
6497                  <t>/ QUIT                  <t>/ QUIT
# Line 6158  Schoenebeck'> Line 6506  Schoenebeck'>
6506                  </t>                  </t>
6507                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6508                  </t>                  </t>
6509                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6510                    </t>
6511                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6512                  </t>                  </t>
6513                    <t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
6514                    </t>
6515                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6516                  </t>                  </t>
6517                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
# Line 6186  Schoenebeck'> Line 6538  Schoenebeck'>
6538                  </t>                  </t>
6539                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6540                  </t>                  </t>
6541                    <t>/ CHANNEL_MIDI
6542                    </t>
6543                    <t>/ DEVICE_MIDI
6544                    </t>
6545                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6546                  </t>                  </t>
6547                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6218  Schoenebeck'> Line 6574  Schoenebeck'>
6574                  </t>                  </t>
6575                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6576                  </t>                  </t>
6577                    <t>/ TOTAL_STREAM_COUNT
6578                    </t>
6579                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6580                  </t>                  </t>
6581                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6236  Schoenebeck'> Line 6594  Schoenebeck'>
6594                  </t>                  </t>
6595                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6596                  </t>                  </t>
6597                    <t>/ CHANNEL_MIDI
6598                    </t>
6599                    <t>/ DEVICE_MIDI
6600                    </t>
6601                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6602                  </t>                  </t>
6603                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6268  Schoenebeck'> Line 6630  Schoenebeck'>
6630                  </t>                  </t>
6631                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6632                  </t>                  </t>
6633                    <t>/ TOTAL_STREAM_COUNT
6634                    </t>
6635                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6636                  </t>                  </t>
6637                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6358  Schoenebeck'> Line 6722  Schoenebeck'>
6722                  </t>                  </t>
6723                  <t>/ SERVER SP INFO                  <t>/ SERVER SP INFO
6724                  </t>                  </t>
6725                    <t>/ TOTAL_STREAM_COUNT
6726                    </t>
6727                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6728                  </t>                  </t>
6729                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
# Line 6392  Schoenebeck'> Line 6758  Schoenebeck'>
6758                  </t>                  </t>
6759                  <t>/ VOLUME                  <t>/ VOLUME
6760                  </t>                  </t>
6761                    <t>/ FILE SP INSTRUMENTS SP filename
6762                    </t>
6763                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6764                    </t>
6765          </list>          </list>
6766  </t>  </t>
6767  <t>set_instruction =  <t>set_instruction =
# Line 6426  Schoenebeck'> Line 6796  Schoenebeck'>
6796                  </t>                  </t>
6797                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6798                  </t>                  </t>
6799                    <t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
6800                    </t>
6801                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6802                  </t>                  </t>
6803                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
# Line 6472  Schoenebeck'> Line 6844  Schoenebeck'>
6844                  </t>                  </t>
6845                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6846                  </t>                  </t>
6847                    <t>/ LOST SP DB_INSTRUMENT_FILES
6848                    </t>
6849          </list>          </list>
6850  </t>  </t>
6851  <t>move_instruction =  <t>move_instruction =
# Line 6542  Schoenebeck'> Line 6916  Schoenebeck'>
6916  </t>  </t>
6917  <t>edit_instruction =  <t>edit_instruction =
6918          <list>          <list>
6919                  <t>INSTRUMENT SP sampler_channel                  <t>CHANNEL SP INSTRUMENT SP sampler_channel
6920                  </t>                  </t>
6921          </list>          </list>
6922  </t>  </t>
# Line 6606  Schoenebeck'> Line 6980  Schoenebeck'>
6980                  </t>                  </t>
6981                  <t>/ DB_INSTRUMENTS SP db_path                  <t>/ DB_INSTRUMENTS SP db_path
6982                  </t>                  </t>
6983                    <t>/ FILE SP INSTRUMENTS SP filename
6984                    </t>
6985            </list>
6986    </t>
6987    <t>send_instruction =
6988            <list>
6989                    <t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
6990                    </t>
6991          </list>          </list>
6992  </t>  </t>
6993  <t>load_instr_args =  <t>load_instr_args =
# Line 6865  Schoenebeck'> Line 7247  Schoenebeck'>
7247                      <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>
7248                      <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>                      <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7249                      <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>
7250                        <t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t>
7251                        <t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t>
7252                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7253                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7254                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7255                  </list>                  </list>
7256                  Note that the forward slash character ('/') has a special meaning in                  Note that the forward slash character ('/') has a special meaning in
7257                  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 7262  Schoenebeck'>
7262                  </t>                  </t>
7263    
7264                  <t>                  <t>
7265                    Note for Windows: file path arguments in LSCP are expected
7266                    to use forward slashes as directory node separator similar
7267                    to Unix based operating systems. In contrast to Unix however
7268                    a Windows typical drive character is expected to be
7269                    prefixed to the path. That is an original Windows file path
7270                    like "D:\Sounds\My.gig" would become in LSCP:
7271                    "D:/Sounds/My.gig".
7272                    </t>
7273    
7274                    <t>
7275                  The following LSCP commands even support escape sequences as                  The following LSCP commands even support escape sequences as
7276                  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,
7277                  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 7405  Schoenebeck'>
7405                  of sampler channels.</t>                  of sampler channels.</t>
7406              </section>              </section>
7407    
7408                <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
7409                    <t>Client may want to be notified when MIDI data arrive on sampler channels on
7410                    back-end side, by issuing the following command:</t>
7411                    <t>
7412                        <list>
7413                            <t>SUBSCRIBE CHANNEL_MIDI</t>
7414                        </list>
7415                    </t>
7416                    <t>Server will start sending one of the the following notification messages:</t>
7417                    <t>
7418                        <list>
7419                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"</t>
7420                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7421                        </list>
7422                    </t>
7423                    <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
7424                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7425                    0 .. 127, reflecting the analog meaning of the MIDI specification.
7426                    </t>
7427                    <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7428                    delivered by this mechanism! With other words: events could be lost at any time!
7429                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7430                    thread unaffected by this feature.</t>
7431                </section>
7432    
7433                <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">
7434                        <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
7435                        <t>
7436                                <list>
7437                                        <t>SUBSCRIBE DEVICE_MIDI</t>
7438                                </list>
7439                        </t>
7440                        <t>Server will start sending one of the the following notification messages:</t>
7441                        <t>
7442                                <list>
7443                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
7444                                        <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7445                                </list>
7446                        </t>
7447                        <t>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
7448                           by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
7449                           data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7450                           0 .. 127, reflecting the analog meaning of the MIDI specification.
7451                        </t>
7452                        <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7453                           delivered by this mechanism! With other words: events could be lost at any time!
7454                           This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7455                           thread unaffected by this feature.</t>
7456                </section>
7457    
7458              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7459                  <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
7460                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 7145  Schoenebeck'> Line 7592  Schoenebeck'>
7592                  all currently active voices.</t>                  all currently active voices.</t>
7593              </section>              </section>
7594    
7595                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7596                    <t>Client may want to be notified when the total number of disk streams on the
7597                    back-end changes by issuing the following command:</t>
7598                    <t>
7599                        <list>
7600                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7601                        </list>
7602                    </t>
7603                    <t>Server will start sending the following notification messages:</t>
7604                    <t>
7605                        <list>
7606                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7607                        </list>
7608                    </t>
7609                    <t>where &lt;streams&gt; will be replaced by the new number of
7610                    all currently active disk streams.</t>
7611                </section>
7612    
7613              <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">
7614                  <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
7615                  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.1782
  ViewVC Help
Powered by ViewVC