/[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 1161 by iliev, Mon Apr 16 15:51:18 2007 UTC revision 1250 by schoenebeck, Fri Jun 22 14:21:03 2007 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.2">  <rfc category="std" ipr="full3978" docName="LSCP 1.2cvs">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol (draft)</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="April" year="2007"/>          <date month="June" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 61  Schoenebeck'> Line 61  Schoenebeck'>
61              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
62              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
63              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
64              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard <xref target="RFC20"/>),
65              example:</t>              thus the following example:</t>
66    
67              <t>              <t>
68                  <list>                  <list>
# Line 2113  Schoenebeck'> Line 2113  Schoenebeck'>
2113                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
2114                      Each sampler channel can only have one instrument.</t>                      Each sampler channel can only have one instrument.</t>
2115    
2116                        <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2117                        escape characters for special characters (see chapter
2118                        "<xref target="character_set">Character Set and Escape Sequences</xref>"
2119                        for details) and accordingly backslash characters in the filename
2120                        MUST now be escaped as well!</t>
2121    
2122                      <t>The difference between regular and NON_MODAL versions of the command                      <t>The difference between regular and NON_MODAL versions of the command
2123                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
2124                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
# Line 4325  Schoenebeck'> Line 4331  Schoenebeck'>
4331                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4332                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4333                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4334                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
4335                        supporting escape sequences as described in chapter
4336                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4337                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4338                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4339                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 4827  Schoenebeck'> Line 4835  Schoenebeck'>
4835                      directories in a specific directory by sending the following command:</t>                      directories in a specific directory by sending the following command:</t>
4836                      <t>                      <t>
4837                          <list>                          <list>
4838                              <t>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>                              <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4839                          </list>                          </list>
4840                      </t>                      </t>
4841                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
4842                      name of the directory.</t>                      name of the directory. If RECURSIVE is specified, the number of
4843                        all directories, including those located in subdirectories of the
4844                        specified directory, will be returned.</t>
4845    
4846                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4847                      <t>                      <t>
# Line 4860  Schoenebeck'> Line 4870  Schoenebeck'>
4870                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
4871                      <t>                      <t>
4872                          <list>                          <list>
4873                              <t>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>                              <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4874                          </list>                          </list>
4875                      </t>                      </t>
4876                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
4877                      name of the directory.</t>                      name of the directory. If RECURSIVE is specified, the absolute path names
4878                        of all directories, including those located in subdirectories of the
4879                        specified directory, will be returned.</t>
4880    
4881                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4882                      <t>                      <t>
# Line 4885  Schoenebeck'> Line 4897  Schoenebeck'>
4897                              <t>S: "'Piano Collection','Percussion Collection'"</t>                              <t>S: "'Piano Collection','Percussion Collection'"</t>
4898                          </list>                          </list>
4899                      </t>                      </t>
4900                        <t>
4901                            <list>
4902                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4903                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4904                            </list>
4905                        </t>
4906                  </section>                  </section>
4907    
4908                  <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">                  <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
# Line 5024  Schoenebeck'> Line 5042  Schoenebeck'>
5042                      </t>                      </t>
5043                  </section>                  </section>
5044    
5045                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5046                        <t>The front-end can copy a specific
5047                        instrument directory by sending the following command:</t>
5048                        <t>
5049                            <list>
5050                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5051                            </list>
5052                        </t>
5053                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5054                        to copy and &lt;dst&gt; is the location where the directory will
5055                        be copied to.</t>
5056    
5057                        <t>Possible Answers:</t>
5058                        <t>
5059                            <list>
5060                                <t>"OK" -
5061                                    <list>
5062                                        <t>on success</t>
5063                                    </list>
5064                                </t>
5065                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5066                                    <list>
5067                                        <t>in case a given directory does not exists,
5068                                        or if a directory with name equal to the name
5069                                        of the specified directory already exists in
5070                                        the destination directory. Error is also thrown
5071                                        when trying to copy a directory to a subdirectory
5072                                        of itself.</t>
5073                                    </list>
5074                                </t>
5075                            </list>
5076                        </t>
5077    
5078                        <t>Example:</t>
5079                        <t>
5080                            <list>
5081                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5082                                <t>S: "OK"</t>
5083                            </list>
5084                        </t>
5085                    </section>
5086    
5087                  <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">                  <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5088                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
5089                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
# Line 5060  Schoenebeck'> Line 5120  Schoenebeck'>
5120                      </t>                      </t>
5121                  </section>                  </section>
5122    
5123                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5124                        <t>The front-end can search for directories
5125                        in specific directory by sending the following command:</t>
5126                        <t>
5127                            <list>
5128                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5129                            </list>
5130                        </t>
5131                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5132                        name of the directory to search in. If NON_RECURSIVE is specified, the
5133                        directories located in subdirectories of the specified directory will not
5134                        be searched. &lt;criteria-list&gt; is a list of search criterias
5135                        in form of "key1=val1 key2=val2 ...". The following criterias are
5136                        allowed:</t>
5137                        <t>
5138                          <t>NAME='&lt;search-string&gt;'
5139                              <list>
5140                                  <t>Restricts the search to directories, which names
5141                                  satisfy the supplied search string.</t>
5142                              </list>
5143                          </t>
5144    
5145                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5146                              <list>
5147                                  <t>Restricts the search to directories, which creation
5148                                  date satisfies the specified period, where &lt;date-after&gt;
5149                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5150                                  If &lt;date-after&gt; is omitted the search is restricted to
5151                                  directories created before &lt;date-before&gt;. If
5152                                  &lt;date-before&gt; is omitted, the search is restricted
5153                                  to directories created after &lt;date-after&gt;.</t>
5154                              </list>
5155                          </t>
5156    
5157                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5158                              <list>
5159                                  <t>Restricts the search to directories, which
5160                                  date of last modification satisfies the specified period, where
5161                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5162                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5163                                  directories, which are last modified before &lt;date-before&gt;. If
5164                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5165                                  which are last modified after &lt;date-after&gt;.</t>
5166                              </list>
5167                          </t>
5168    
5169                          <t>DESCRIPTION='&lt;search-string&gt;'
5170                              <list>
5171                                  <t>Restricts the search to directories with description
5172                                  that satisfies the supplied search string.</t>
5173                              </list>
5174                          </t>
5175                        </t>
5176    
5177                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5178                        word list separated with spaces for OR search and with '+' for AND search.</t>
5179    
5180                        <t>Possible Answers:</t>
5181                        <t>
5182                            <list>
5183                                <t>A comma separated list with the absolute path names (encapsulated into
5184                                apostrophes) of all directories in the specified directory that satisfy
5185                                the supplied search criterias.</t>
5186                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5187                                    <list>
5188                                        <t>if the given directory does not exist.</t>
5189                                    </list>
5190                                </t>
5191                            </list>
5192                        </t>
5193                        <t>Example:</t>
5194                        <t>
5195                            <list>
5196                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5197                                <t>S: "'/Piano Collection'"</t>
5198                            </list>
5199                        </t>
5200                        <t>
5201                            <list>
5202                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5203                                <t>S: "'/Piano Collection','/Percussions'"</t>
5204                            </list>
5205                        </t>
5206                    </section>
5207    
5208                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5209                      <t>The front-end can add one or more instruments                      <t>The front-end can add one or more instruments
5210                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5211                      <t>                      <t>
5212                          <list>                          <list>
5213                              <t>ADD DB_INSTRUMENTS [&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;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5214                          </list>                          </list>
5215                      </t>                      </t>
5216                      <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 5083  Schoenebeck'> Line 5228  Schoenebeck'>
5228                      scanning will be done and has exactly the following possibilities:</t>                      scanning will be done and has exactly the following possibilities:</t>
5229                      <t>                      <t>
5230                          <list>                          <list>
5231                                <t>"RECURSIVE" -
5232                                    <list>
5233                                        <t>All instruments will be processed, including those
5234                                        in the subdirectories, and the respective subdirectory
5235                                        tree structure will be recreated in the instruments
5236                                        database</t>
5237                                    </list>
5238                                </t>
5239                              <t>"NON_RECURSIVE" -                              <t>"NON_RECURSIVE" -
5240                                  <list>                                  <list>
5241                                      <t>Only the instruments in the specified directory                                      <t>Only the instruments in the specified directory
# Line 5099  Schoenebeck'> Line 5252  Schoenebeck'>
5252                                      the specified database directory.</t>                                      the specified database directory.</t>
5253                                  </list>                                  </list>
5254                              </t>                              </t>
                             <t>not supplied -  
                                 <list>  
                                     <t>The subdirectory tree structure will be recreated  
                                     in the instruments database and all instruments will be  
                                     processed and added to the respective subdirectory  
                                     in the instruments database.</t>  
                                 </list>  
                             </t>  
5255                          </list>                          </list>
5256                      </t>                      </t>
5257    
5258                     <t>The difference between regular and NON_MODAL versions of the command
5259                        is that the regular command returns when the scanning is finished
5260                        while NON_MODAL version returns immediately and a background process is launched.
5261                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5262                        command can be used to monitor the scanning progress.</t>
5263    
5264                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5265                      <t>                      <t>
5266                          <list>                          <list>
5267                              <t>"OK" -                              <t>"OK" -
5268                                  <list>                                  <list>
5269                                      <t>on success</t>                                      <t>on success when NON_MODAL is not supplied</t>
5270                                    </list>
5271                                </t>
5272                                <t>"OK[&lt;job-id&gt;]" -
5273                                    <list>
5274                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5275                                        is a numerical ID used to obtain status information about the job progress.
5276                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5277                                        </t>
5278                                  </list>                                  </list>
5279                              </t>                              </t>
5280                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
# Line 5177  Schoenebeck'> Line 5336  Schoenebeck'>
5336                      instruments in a specific directory by sending the following command:</t>                      instruments in a specific directory by sending the following command:</t>
5337                      <t>                      <t>
5338                          <list>                          <list>
5339                              <t>GET DB_INSTRUMENTS &lt;dir&gt;</t>                              <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5340                          </list>                          </list>
5341                      </t>                      </t>
5342                      <t>Where &lt;dir&gt; should be replaced by the absolute path name                      <t>Where &lt;dir&gt; should be replaced by the absolute path name
5343                      of the directory.</t>                      of the directory. If RECURSIVE is specified, the number of all
5344                        instruments, including those located in subdirectories of the
5345                        specified directory, will be returned.</t>
5346    
5347                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5348                      <t>                      <t>
# Line 5210  Schoenebeck'> Line 5371  Schoenebeck'>
5371                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
5372                      <t>                      <t>
5373                          <list>                          <list>
5374                              <t>LIST DB_INSTRUMENTS &lt;dir&gt;</t>                              <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5375                          </list>                          </list>
5376                      </t>                      </t>
5377                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
5378                      name of the directory.</t>                      name of the directory. If RECURSIVE is specified, the absolute path
5379                        names of all instruments, including those located in subdirectories
5380                        of the specified directory, will be returned.</t>
5381    
5382                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5383                      <t>                      <t>
# Line 5235  Schoenebeck'> Line 5398  Schoenebeck'>
5398                              <t>S: "'Bosendorfer 290','Steinway D'"</t>                              <t>S: "'Bosendorfer 290','Steinway D'"</t>
5399                          </list>                          </list>
5400                      </t>                      </t>
5401                        <t>
5402                            <list>
5403                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5404                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5405                            </list>
5406                        </t>
5407                  </section>                  </section>
5408    
5409                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
# Line 5430  Schoenebeck'> Line 5599  Schoenebeck'>
5599                      </t>                      </t>
5600                  </section>                  </section>
5601    
5602                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5603                        <t>The front-end can copy a specific instrument to another directory by
5604                        sending the following command:</t>
5605                        <t>
5606                            <list>
5607                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5608                            </list>
5609                        </t>
5610                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5611                        to copy and &lt;dst&gt; is the directory where the instrument will
5612                        be copied to.</t>
5613    
5614                        <t>Possible Answers:</t>
5615                        <t>
5616                            <list>
5617                                <t>"OK" -
5618                                    <list>
5619                                        <t>on success</t>
5620                                    </list>
5621                                </t>
5622                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5623                                    <list>
5624                                        <t>in case the given instrument does not exists,
5625                                        or if an instrument with name equal to the name of the
5626                                        specified instrument already exists in the destination
5627                                        directory.</t>
5628                                    </list>
5629                                </t>
5630                            </list>
5631                        </t>
5632    
5633                        <t>Example:</t>
5634                        <t>
5635                            <list>
5636                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5637                                <t>S: "OK"</t>
5638                            </list>
5639                        </t>
5640                    </section>
5641    
5642                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5643                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
5644                      instrument by sending the following command:</t>                      instrument by sending the following command:</t>
# Line 5466  Schoenebeck'> Line 5675  Schoenebeck'>
5675                      </t>                      </t>
5676                  </section>                  </section>
5677    
5678                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5679                        <t>The front-end can search for instruments
5680                        in specific directory by sending the following command:</t>
5681                        <t>
5682                            <list>
5683                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5684                            </list>
5685                        </t>
5686                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5687                        name of the directory to search in. If NON_RECURSIVE is specified, the
5688                        directories located in subdirectories of the specified directory will not
5689                        be searched. &lt;criteria-list&gt; is a list of search criterias
5690                        in form of "key1=val1 key2=val2 ...". The following criterias are
5691                        allowed:</t>
5692                        <t>
5693                          <t>NAME='&lt;search-string&gt;'
5694                              <list>
5695                                  <t>Restricts the search to instruments, which names
5696                                  satisfy the supplied search string.</t>
5697                              </list>
5698                          </t>
5699    
5700                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5701                              <list>
5702                                  <t>Restricts the search to instruments, which
5703                                  size is in the specified range. If &lt;min&gt; is omitted,
5704                                  the search results are restricted to instruments with size less then
5705                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5706                                  search is restricted to instruments with size greater then
5707                                  or equal to &lt;min&gt;.</t>
5708                              </list>
5709                          </t>
5710    
5711                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5712                              <list>
5713                                  <t>Restricts the search to instruments, which creation
5714                                  date satisfies the specified period, where &lt;date-after&gt;
5715                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5716                                  If &lt;date-after&gt; is omitted the search is restricted to
5717                                  instruments created before &lt;date-before&gt;. If
5718                                  &lt;date-before&gt; is omitted, the search is restricted
5719                                  to instruments created after &lt;date-after&gt;.</t>
5720                              </list>
5721                          </t>
5722    
5723                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5724                              <list>
5725                                  <t>Restricts the search to instruments, which
5726                                  date of last modification satisfies the specified period, where
5727                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5728                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5729                                  instruments, which are last modified before &lt;date-before&gt;. If
5730                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5731                                  which are last modified after &lt;date-after&gt;.</t>
5732                              </list>
5733                          </t>
5734    
5735                          <t>DESCRIPTION='&lt;search-string&gt;'
5736                              <list>
5737                                  <t>Restricts the search to instruments with description
5738                                  that satisfies the supplied search string.</t>
5739                              </list>
5740                          </t>
5741    
5742                          <t>PRODUCT='&lt;search-string&gt;'
5743                              <list>
5744                                  <t>Restricts the search to instruments with product info
5745                                  that satisfies the supplied search string.</t>
5746                              </list>
5747                          </t>
5748    
5749                          <t>ARTISTS='&lt;search-string&gt;'
5750                              <list>
5751                                  <t>Restricts the search to instruments with artists info
5752                                  that satisfies the supplied search string.</t>
5753                              </list>
5754                          </t>
5755    
5756                          <t>KEYWORDS='&lt;search-string&gt;'
5757                              <list>
5758                                  <t>Restricts the search to instruments with keyword list
5759                                  that satisfies the supplied search string.</t>
5760                              </list>
5761                          </t>
5762    
5763                          <t>IS_DRUM=true | false
5764                              <list>
5765                                  <t>Either true or false. Restricts the search to
5766                                  drum kits or chromatic instruments.</t>
5767                              </list>
5768                          </t>
5769    
5770                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5771                              <list>
5772                                  <t>Restricts the search to instruments of the supplied format families,
5773                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5774                              </list>
5775                          </t>
5776                        </t>
5777    
5778                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5779                        word list separated with spaces for OR search and with '+' for AND search.</t>
5780    
5781                        <t>Possible Answers:</t>
5782                        <t>
5783                            <list>
5784                                <t>A comma separated list with the absolute path names (encapsulated into
5785                                apostrophes) of all instruments in the specified directory that satisfy
5786                                the supplied search criterias.</t>
5787                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5788                                    <list>
5789                                        <t>if the given directory does not exist.</t>
5790                                    </list>
5791                                </t>
5792                            </list>
5793                        </t>
5794                        <t>Example:</t>
5795                        <t>
5796                            <list>
5797                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5798                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5799                            </list>
5800                        </t>
5801                        <t>
5802                            <list>
5803                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5804                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5805                            </list>
5806                        </t>
5807                    </section>
5808    
5809                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
5810                        <t>The front-end can ask for the current status of a
5811                        particular database instruments job by sending the following command:</t>
5812                        <t>
5813                            <list>
5814                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
5815                            </list>
5816                        </t>
5817                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
5818                        of the job the front-end is interested in.</t>
5819    
5820                        <t>Possible Answers:</t>
5821                        <t>
5822                            <list>
5823                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5824                                Each answer line begins with the settings category name
5825                                followed by a colon and then a space character &lt;SP&gt; and finally
5826                                the info character string to that setting category. At the
5827                                moment the following categories are defined:</t>
5828    
5829                                <t>
5830                                    <list>
5831                                        <t>FILES_TOTAL -
5832                                            <list>
5833                                                <t>The total number of files scheduled for scanning</t>
5834                                            </list>
5835                                        </t>
5836                                        <t>FILES_SCANNED -
5837                                            <list>
5838                                                <t>The current number of scanned files</t>
5839                                            </list>
5840                                        </t>
5841                                        <t>SCANNING -
5842                                            <list>
5843                                                <t>The absolute path name of the file which is currently
5844                                                being scanned</t>
5845                                            </list>
5846                                        </t>
5847                                        <t>STATUS -
5848                                            <list>
5849                                                <t>An integer value between 0 and 100 indicating the
5850                                                scanning progress percentage of the file which is
5851                                                currently being scanned</t>
5852                                            </list>
5853                                        </t>
5854                                    </list>
5855                                </t>
5856                            </list>
5857                        </t>
5858                        <t>The mentioned fields above don't have to be in particular order.</t>
5859    
5860                        <t>Example:</t>
5861                        <t>
5862                            <list>
5863                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
5864                                <t>S: "FILES_TOTAL: 12"</t>
5865                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
5866                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
5867                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
5868                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5869                            </list>
5870                        </t>
5871                    </section>
5872    
5873              </section>              </section>
5874    
5875          </section>          </section>
# Line 5547  Schoenebeck'> Line 5951  Schoenebeck'>
5951                  </t>                  </t>
5952                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
5953                  </t>                  </t>
5954                    <t>/ FIND SP find_instruction
5955                    </t>
5956                  <t>/ MOVE SP move_instruction                  <t>/ MOVE SP move_instruction
5957                  </t>                  </t>
5958                    <t>/ COPY SP copy_instruction
5959                    </t>
5960                    <t>/ EDIT SP edit_instruction
5961                    </t>
5962                  <t>/ RESET                  <t>/ RESET
5963                  </t>                  </t>
5964                  <t>/ QUIT                  <t>/ QUIT
# Line 5561  Schoenebeck'> Line 5971  Schoenebeck'>
5971                  </t>                  </t>
5972                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5973                  </t>                  </t>
5974                  <t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname
5975                    </t>
5976                    <t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname
5977                  </t>                  </t>
5978                  <t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname
5979                    </t>
5980                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index
5981                  </t>                  </t>
5982                  <t>/ DB_INSTRUMENTS SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP pathname SP pathname
5983                  </t>                  </t>
# Line 5615  Schoenebeck'> Line 6029  Schoenebeck'>
6029                  </t>                  </t>
6030                  <t>/ DB_INSTRUMENT_INFO                  <t>/ DB_INSTRUMENT_INFO
6031                  </t>                  </t>
6032                    <t>/ DB_INSTRUMENTS_JOB_INFO
6033                    </t>
6034                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6035                  </t>                  </t>
6036                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 5663  Schoenebeck'> Line 6079  Schoenebeck'>
6079                  </t>                  </t>
6080                  <t>/ DB_INSTRUMENT_INFO                  <t>/ DB_INSTRUMENT_INFO
6081                  </t>                  </t>
6082                    <t>/ DB_INSTRUMENTS_JOB_INFO
6083                    </t>
6084                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6085                  </t>                  </t>
6086                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 5773  Schoenebeck'> Line 6191  Schoenebeck'>
6191                  </t>                  </t>
6192                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6193                  </t>                  </t>
6194                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6195                    </t>
6196                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6197                  </t>                  </t>
6198                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6199                  </t>                  </t>
6200                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6201                    </t>
6202                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP pathname
6203                  </t>                  </t>
6204                  <t>/ DB_INSTRUMENT SP INFO SP pathname                  <t>/ DB_INSTRUMENT SP INFO SP pathname
6205                  </t>                  </t>
6206                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6207                    </t>
6208                  <t>/ VOLUME                  <t>/ VOLUME
6209                  </t>                  </t>
6210          </list>          </list>
# Line 5851  Schoenebeck'> Line 6275  Schoenebeck'>
6275                  </t>                  </t>
6276          </list>          </list>
6277  </t>  </t>
6278    <t>find_instruction =
6279            <list>
6280                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6281                    </t>
6282                    <t>/ DB_INSTRUMENTS SP pathname SP query_val_list
6283                    </t>
6284                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
6285                    </t>
6286                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6287                    </t>
6288            </list>
6289    </t>
6290  <t>move_instruction =  <t>move_instruction =
6291          <list>          <list>
6292                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
# Line 5859  Schoenebeck'> Line 6295  Schoenebeck'>
6295                  </t>                  </t>
6296          </list>          </list>
6297  </t>  </t>
6298    <t>copy_instruction =
6299            <list>
6300                    <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6301                    </t>
6302                    <t>/ DB_INSTRUMENT SP pathname SP pathname
6303                    </t>
6304            </list>
6305    </t>
6306  <t>destroy_instruction =  <t>destroy_instruction =
6307          <list>          <list>
6308                  <t>AUDIO_OUTPUT_DEVICE SP number                  <t>AUDIO_OUTPUT_DEVICE SP number
# Line 5909  Schoenebeck'> Line 6353  Schoenebeck'>
6353                  </t>                  </t>
6354          </list>          </list>
6355  </t>  </t>
6356    <t>edit_instruction =
6357            <list>
6358                    <t>INSTRUMENT SP sampler_channel
6359                    </t>
6360            </list>
6361    </t>
6362  <t>modal_arg =  <t>modal_arg =
6363          <list>          <list>
6364                  <t>/* epsilon (empty argument) */                  <t>/* epsilon (empty argument) */
# Line 5955  Schoenebeck'> Line 6405  Schoenebeck'>
6405                  </t>                  </t>
6406                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6407                  </t>                  </t>
6408                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6409                    </t>
6410                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6411                  </t>                  </t>
6412                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6413                    </t>
6414                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP pathname
6415                  </t>                  </t>
6416          </list>          </list>
# Line 6093  Schoenebeck'> Line 6547  Schoenebeck'>
6547  </t>  </t>
6548  <t>filename =  <t>filename =
6549          <list>          <list>
6550                  <t>stringval                  <t>stringval_escaped
6551                  </t>                  </t>
6552          </list>          </list>
6553  </t>  </t>
# Line 6135  Schoenebeck'> Line 6589  Schoenebeck'>
6589                  </t>                  </t>
6590          </list>          </list>
6591  </t>  </t>
6592    <t>query_val_list =
6593            <list>
6594                    <t>string '=' query_val
6595                    </t>
6596                    <t>/ query_val_list SP string '=' query_val
6597                    </t>
6598            </list>
6599    </t>
6600    <t>query_val =
6601            <list>
6602                    <t>string
6603                    </t>
6604                    <t>/ stringval
6605                    </t>
6606            </list>
6607    </t>
6608    <t>scan_mode =
6609            <list>
6610                    <t>RECURSIVE
6611                    </t>
6612                    <t>/ NON_RECURSIVE
6613                    </t>
6614                    <t>/ FLAT
6615                    </t>
6616            </list>
6617    </t>
6618    
6619              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6620    
6621                <section title="Character Set and Escape Sequences" anchor="character_set">
6622                    <t>Older versions of this protocol up to and including v1.1 only
6623                    supported the standard ASCII character set (ASCII code 0 - 127)
6624                    <xref target="RFC20"/>, all younger versions of this protocol
6625                    however support the Extended ASCII character set (ASCII code
6626                    0 - 255). The same group of younger protocols also support
6627                    escape sequences, but only for certain, explicitly declared
6628                    parts of the protocol. The supported escape sequences are
6629                    defined as follows:</t>
6630                    <texttable>
6631                        <ttcol>ASCII Character Sequence</ttcol>
6632                        <ttcol>Translated into (Name)</ttcol>
6633                        <c>\n</c> <c>new line</c>
6634                        <c>\r</c> <c>carriage return</c>
6635                        <c>\f</c> <c>form feed</c>
6636                        <c>\t</c> <c>horizontal tab</c>
6637                        <c>\v</c> <c>vertical tab</c>
6638                        <c>\'</c> <c>apostrophe</c>
6639                        <c>\"</c> <c>quotation mark</c>
6640                        <c>\\</c> <c>backslash</c>
6641                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
6642                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
6643                    </texttable>
6644                    <t>Notice: due to the transition of certain parts of the
6645                    protocol which now support escape sequences, a slight backward
6646                    incompatibility to protocols version v1.1 and younger has been
6647                    introduced. The only difference is that in parts of the protocol
6648                    where escape characters are now supported, a backslash characters
6649                    MUST be escaped as well (that is as double backslash), whereas
6650                    in the old versions a single backslash was sufficient.</t>
6651                </section>
6652          </section>          </section>
6653    
6654          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 6322  Schoenebeck'> Line 6834  Schoenebeck'>
6834              </section>              </section>
6835    
6836              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
6837                  <t>Client may want to be notified when the number of effect sends on                  <t>Client may want to be notified when the number of effect sends on
6838                  a particular sampler channel is changed by issuing the following command:</t>                  a particular sampler channel is changed by issuing the following command:</t>
6839                  <t>                  <t>
6840                      <list>                      <list>
# Line 6582  Schoenebeck'> Line 7094  Schoenebeck'>
7094                  the new name of the instrument, encapsulated into apostrophes.</t>                  the new name of the instrument, encapsulated into apostrophes.</t>
7095              </section>              </section>
7096    
7097                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7098                    <t>Client may want to be notified when the status of particular database
7099                    instruments job is changed by issuing the following command:</t>
7100                    <t>
7101                        <list>
7102                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7103                        </list>
7104                    </t>
7105                    <t>Server will start sending the following notification messages:</t>
7106                    <t>
7107                        <list>
7108                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7109                        </list>
7110                    </t>
7111                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7112                    which status is changed. The front-end will have to send the respective
7113                    command to actually get the status info. Because these messages
7114                    will be triggered by LSCP commands issued by other clients rather than real
7115                    time events happening on the server, it is believed that an empty notification
7116                    message is sufficient here.</t>
7117                </section>
7118    
7119              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7120                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
7121                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
# Line 6660  Schoenebeck'> Line 7194  Schoenebeck'>
7194                  </front>                  </front>
7195                  <seriesInfo name="RFC" value="2234" />                  <seriesInfo name="RFC" value="2234" />
7196              </reference>              </reference>
7197                <reference anchor="RFC20">
7198                    <front>
7199                        <title>ASCII format for Network Interchange</title>
7200                        <author>
7201                            <organization>UCLA</organization>
7202                        </author>
7203                        <date year="1969"></date>
7204                    </front>
7205                    <seriesInfo name="RFC" value="20" />
7206                </reference>
7207           </references>           </references>
7208      </back>      </back>
7209    

Legend:
Removed from v.1161  
changed lines
  Added in v.1250

  ViewVC Help
Powered by ViewVC