/[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 1387 by iliev, Sun Oct 7 10:32:53 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="September" 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 2061  Schoenebeck'> Line 2061  Schoenebeck'>
2061                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2063                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
2064                      parameter.</t>                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
2065                        for specifying no value for parameters allowing a list of values.</t>
2066    
2067                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2068                      <t>                      <t>
# Line 2088  Schoenebeck'> Line 2089  Schoenebeck'>
2089                      <t>Example:</t>                      <t>Example:</t>
2090                      <t>                      <t>
2091                          <list>                          <list>
2092                              <t></t>                              <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t>
2093                                <t>S: "OK"</t>
2094                            </list>
2095                        </t>
2096                        <t>
2097                            <list>
2098                                <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t>
2099                                <t>S: "OK"</t>
2100                          </list>                          </list>
2101                      </t>                      </t>
2102                  </section>                  </section>
# Line 2113  Schoenebeck'> Line 2121  Schoenebeck'>
2121                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
2122                      Each sampler channel can only have one instrument.</t>                      Each sampler channel can only have one instrument.</t>
2123    
2124                        <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125                        escape characters for special characters (see chapter
2126                        "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127                        for details) and accordingly backslash characters in the filename
2128                        MUST now be escaped as well!</t>
2129    
2130                      <t>The difference between regular and NON_MODAL versions of the command                      <t>The difference between regular and NON_MODAL versions of the command
2131                      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
2132                      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 3945  Schoenebeck'> Line 3959  Schoenebeck'>
3959                                  <list>                                  <list>
3960                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
3961                                          <list>                                          <list>
3962                                              <t>arbitrary textual description about the sampler</t>                                              <t>arbitrary textual description about the sampler
3963                                                (note that the character string may contain
3964                                                <xref target="character_set">escape sequences</xref>)</t>
3965                                          </list>                                          </list>
3966                                      </t>                                      </t>
3967                                      <t>VERSION -                                      <t>VERSION -
# Line 4325  Schoenebeck'> Line 4341  Schoenebeck'>
4341                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4342                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4343                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4344                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
4345                        supporting escape sequences as described in chapter
4346                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4347                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4348                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4349                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 4407  Schoenebeck'> Line 4425  Schoenebeck'>
4425                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
4426                      mode by i.e. sending                      mode by i.e. sending
4427                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4428                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
4429                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
4430                      entry, useful for frontends for displaying an appropriate name for                      "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4431                        mapping entry, useful for frontends for displaying an appropriate name for
4432                      mapped instruments (using                      mapped instruments (using
4433                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4434                      </t>                      </t>
# Line 4744  Schoenebeck'> Line 4763  Schoenebeck'>
4763              <section title="Managing Instruments Database" anchor="Managing Instruments Database">              <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4764                  <t>The following commands describe how to use and manage                  <t>The following commands describe how to use and manage
4765                  the instruments database.</t>                  the instruments database.</t>
4766                    <t>Notice:</t>
4767                        <t>
4768                            <list>
4769                                <t>All command arguments representing a path or
4770                                instrument/directory name support escape sequences as described in chapter
4771                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4772                                </t>
4773                                <t>All occurrences of a forward slash in instrument and directory
4774                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4775                                </t>
4776                            </list>
4777                        </t>
4778    
4779                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4780                      <t>The front-end can add a new instrument directory to the                      <t>The front-end can add a new instrument directory to the
# Line 4827  Schoenebeck'> Line 4858  Schoenebeck'>
4858                      directories in a specific directory by sending the following command:</t>                      directories in a specific directory by sending the following command:</t>
4859                      <t>                      <t>
4860                          <list>                          <list>
4861                              <t>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>                              <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4862                          </list>                          </list>
4863                      </t>                      </t>
4864                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
4865                      name of the directory.</t>                      name of the directory. If RECURSIVE is specified, the number of
4866                        all directories, including those located in subdirectories of the
4867                        specified directory, will be returned.</t>
4868    
4869                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4870                      <t>                      <t>
# Line 4860  Schoenebeck'> Line 4893  Schoenebeck'>
4893                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
4894                      <t>                      <t>
4895                          <list>                          <list>
4896                              <t>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>                              <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4897                          </list>                          </list>
4898                      </t>                      </t>
4899                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
4900                      name of the directory.</t>                      name of the directory. If RECURSIVE is specified, the absolute path names
4901                        of all directories, including those located in subdirectories of the
4902                        specified directory, will be returned.</t>
4903    
4904                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4905                      <t>                      <t>
# Line 4885  Schoenebeck'> Line 4920  Schoenebeck'>
4920                              <t>S: "'Piano Collection','Percussion Collection'"</t>                              <t>S: "'Piano Collection','Percussion Collection'"</t>
4921                          </list>                          </list>
4922                      </t>                      </t>
4923                        <t>
4924                            <list>
4925                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4926                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4927                            </list>
4928                        </t>
4929                  </section>                  </section>
4930    
4931                  <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 4911  Schoenebeck'> Line 4952  Schoenebeck'>
4952                                  <list>                                  <list>
4953                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
4954                                          <list>                                          <list>
4955                                              <t>A brief description of the directory content</t>                                              <t>A brief description of the directory content.
4956                                                Note that the character string may contain
4957                                                <xref target="character_set">escape sequences</xref>.</t>
4958                                          </list>                                          </list>
4959                                      </t>                                      </t>
4960                                      <t>CREATED -                                      <t>CREATED -
# Line 5024  Schoenebeck'> Line 5067  Schoenebeck'>
5067                      </t>                      </t>
5068                  </section>                  </section>
5069    
5070                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5071                        <t>The front-end can copy a specific
5072                        instrument directory by sending the following command:</t>
5073                        <t>
5074                            <list>
5075                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5076                            </list>
5077                        </t>
5078                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5079                        to copy and &lt;dst&gt; is the location where the directory will
5080                        be copied to.</t>
5081    
5082                        <t>Possible Answers:</t>
5083                        <t>
5084                            <list>
5085                                <t>"OK" -
5086                                    <list>
5087                                        <t>on success</t>
5088                                    </list>
5089                                </t>
5090                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5091                                    <list>
5092                                        <t>in case a given directory does not exists,
5093                                        or if a directory with name equal to the name
5094                                        of the specified directory already exists in
5095                                        the destination directory. Error is also thrown
5096                                        when trying to copy a directory to a subdirectory
5097                                        of itself.</t>
5098                                    </list>
5099                                </t>
5100                            </list>
5101                        </t>
5102    
5103                        <t>Example:</t>
5104                        <t>
5105                            <list>
5106                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5107                                <t>S: "OK"</t>
5108                            </list>
5109                        </t>
5110                    </section>
5111    
5112                  <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">
5113                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
5114                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
# Line 5033  Schoenebeck'> Line 5118  Schoenebeck'>
5118                          </list>                          </list>
5119                      </t>                      </t>
5120                      <t>Where &lt;dir&gt; is the absolute path name of the directory and                      <t>Where &lt;dir&gt; is the absolute path name of the directory and
5121                      &lt;desc&gt; is the new description for the directory.</t>                      &lt;desc&gt; is the new description for the directory
5122                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5123                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5124    
5125                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5126                      <t>                      <t>
# Line 5060  Schoenebeck'> Line 5147  Schoenebeck'>
5147                      </t>                      </t>
5148                  </section>                  </section>
5149    
5150                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5151                        <t>The front-end can search for directories
5152                        in specific directory by sending the following command:</t>
5153                        <t>
5154                            <list>
5155                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5156                            </list>
5157                        </t>
5158                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5159                        name of the directory to search in. If NON_RECURSIVE is specified, the
5160                        directories located in subdirectories of the specified directory will not
5161                        be searched. &lt;criteria-list&gt; is a list of search criterias
5162                        in form of "key1=val1 key2=val2 ...". The following criterias are
5163                        allowed:</t>
5164                        <t>
5165                          <t>NAME='&lt;search-string&gt;'
5166                              <list>
5167                                  <t>Restricts the search to directories, which names
5168                                  satisfy the supplied search string (encapsulated into apostrophes,
5169                                  supporting escape sequences as described in chapter
5170                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5171                              </list>
5172                          </t>
5173    
5174                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5175                              <list>
5176                                  <t>Restricts the search to directories, which creation
5177                                  date satisfies the specified period, where &lt;date-after&gt;
5178                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5179                                  If &lt;date-after&gt; is omitted the search is restricted to
5180                                  directories created before &lt;date-before&gt;. If
5181                                  &lt;date-before&gt; is omitted, the search is restricted
5182                                  to directories created after &lt;date-after&gt;.</t>
5183                              </list>
5184                          </t>
5185    
5186                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5187                              <list>
5188                                  <t>Restricts the search to directories, which
5189                                  date of last modification satisfies the specified period, where
5190                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5191                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5192                                  directories, which are last modified before &lt;date-before&gt;. If
5193                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5194                                  which are last modified after &lt;date-after&gt;.</t>
5195                              </list>
5196                          </t>
5197    
5198                          <t>DESCRIPTION='&lt;search-string&gt;'
5199                              <list>
5200                                  <t>Restricts the search to directories with description
5201                                  that satisfies the supplied search string
5202                                  (encapsulated into apostrophes, supporting escape
5203                                  sequences as described in chapter
5204                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5205                              </list>
5206                          </t>
5207                        </t>
5208    
5209                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5210                        word list separated with spaces for OR search and with '+' for AND search.</t>
5211    
5212                        <t>Possible Answers:</t>
5213                        <t>
5214                            <list>
5215                                <t>A comma separated list with the absolute path names (encapsulated into
5216                                apostrophes) of all directories in the specified directory that satisfy
5217                                the supplied search criterias.</t>
5218                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5219                                    <list>
5220                                        <t>if the given directory does not exist.</t>
5221                                    </list>
5222                                </t>
5223                            </list>
5224                        </t>
5225                        <t>Example:</t>
5226                        <t>
5227                            <list>
5228                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5229                                <t>S: "'/Piano Collection'"</t>
5230                            </list>
5231                        </t>
5232                        <t>
5233                            <list>
5234                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5235                                <t>S: "'/Piano Collection','/Percussions'"</t>
5236                            </list>
5237                        </t>
5238                    </section>
5239    
5240                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5241                      <t>The front-end can add one or more instruments                      <t>The front-end can add one or more instruments
5242                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5243                      <t>                      <t>
5244                          <list>                          <list>
5245                              <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>
5246                          </list>                          </list>
5247                      </t>                      </t>
5248                      <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 5260  Schoenebeck'>
5260                      scanning will be done and has exactly the following possibilities:</t>                      scanning will be done and has exactly the following possibilities:</t>
5261                      <t>                      <t>
5262                          <list>                          <list>
5263                                <t>"RECURSIVE" -
5264                                    <list>
5265                                        <t>All instruments will be processed, including those
5266                                        in the subdirectories, and the respective subdirectory
5267                                        tree structure will be recreated in the instruments
5268                                        database</t>
5269                                    </list>
5270                                </t>
5271                              <t>"NON_RECURSIVE" -                              <t>"NON_RECURSIVE" -
5272                                  <list>                                  <list>
5273                                      <t>Only the instruments in the specified directory                                      <t>Only the instruments in the specified directory
# Line 5099  Schoenebeck'> Line 5284  Schoenebeck'>
5284                                      the specified database directory.</t>                                      the specified database directory.</t>
5285                                  </list>                                  </list>
5286                              </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>  
5287                          </list>                          </list>
5288                      </t>                      </t>
5289    
5290                     <t>The difference between regular and NON_MODAL versions of the command
5291                        is that the regular command returns when the scanning is finished
5292                        while NON_MODAL version returns immediately and a background process is launched.
5293                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5294                        command can be used to monitor the scanning progress.</t>
5295    
5296                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5297                      <t>                      <t>
5298                          <list>                          <list>
5299                              <t>"OK" -                              <t>"OK" -
5300                                  <list>                                  <list>
5301                                      <t>on success</t>                                      <t>on success when NON_MODAL is not supplied</t>
5302                                    </list>
5303                                </t>
5304                                <t>"OK[&lt;job-id&gt;]" -
5305                                    <list>
5306                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5307                                        is a numerical ID used to obtain status information about the job progress.
5308                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5309                                        </t>
5310                                  </list>                                  </list>
5311                              </t>                              </t>
5312                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
# Line 5177  Schoenebeck'> Line 5368  Schoenebeck'>
5368                      instruments in a specific directory by sending the following command:</t>                      instruments in a specific directory by sending the following command:</t>
5369                      <t>                      <t>
5370                          <list>                          <list>
5371                              <t>GET DB_INSTRUMENTS &lt;dir&gt;</t>                              <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5372                          </list>                          </list>
5373                      </t>                      </t>
5374                      <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
5375                      of the directory.</t>                      of the directory. If RECURSIVE is specified, the number of all
5376                        instruments, including those located in subdirectories of the
5377                        specified directory, will be returned.</t>
5378    
5379                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5380                      <t>                      <t>
# Line 5210  Schoenebeck'> Line 5403  Schoenebeck'>
5403                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
5404                      <t>                      <t>
5405                          <list>                          <list>
5406                              <t>LIST DB_INSTRUMENTS &lt;dir&gt;</t>                              <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5407                          </list>                          </list>
5408                      </t>                      </t>
5409                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
5410                      name of the directory.</t>                      name of the directory. If RECURSIVE is specified, the absolute path
5411                        names of all instruments, including those located in subdirectories
5412                        of the specified directory, will be returned.</t>
5413    
5414                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5415                      <t>                      <t>
# Line 5235  Schoenebeck'> Line 5430  Schoenebeck'>
5430                              <t>S: "'Bosendorfer 290','Steinway D'"</t>                              <t>S: "'Bosendorfer 290','Steinway D'"</t>
5431                          </list>                          </list>
5432                      </t>                      </t>
5433                        <t>
5434                            <list>
5435                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5436                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5437                            </list>
5438                        </t>
5439                  </section>                  </section>
5440    
5441                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
# Line 5261  Schoenebeck'> Line 5462  Schoenebeck'>
5462                                  <list>                                  <list>
5463                                      <t>INSTRUMENT_FILE -                                      <t>INSTRUMENT_FILE -
5464                                          <list>                                          <list>
5465                                              <t>File name of the instrument.</t>                                              <t>File name of the instrument.
5466                                                Note that the character string may contain
5467                                                <xref target="character_set">escape sequences</xref>.</t>
5468                                          </list>                                          </list>
5469                                      </t>                                      </t>
5470                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 5300  Schoenebeck'> Line 5503  Schoenebeck'>
5503                                      </t>                                      </t>
5504                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
5505                                          <list>                                          <list>
5506                                              <t>A brief description of the instrument</t>                                              <t>A brief description of the instrument.
5507                                                Note that the character string may contain
5508                                                <xref target="character_set">escape sequences</xref>.</t>
5509                                          </list>                                          </list>
5510                                      </t>                                      </t>
5511                                      <t>IS_DRUM -                                      <t>IS_DRUM -
# Line 5311  Schoenebeck'> Line 5516  Schoenebeck'>
5516                                      </t>                                      </t>
5517                                      <t>PRODUCT -                                      <t>PRODUCT -
5518                                          <list>                                          <list>
5519                                              <t>The product title of the instrument</t>                                              <t>The product title of the instrument.
5520                                                Note that the character string may contain
5521                                                <xref target="character_set">escape sequences</xref>.</t>
5522                                          </list>                                          </list>
5523                                      </t>                                      </t>
5524                                      <t>ARTISTS -                                      <t>ARTISTS -
5525                                          <list>                                          <list>
5526                                              <t>Lists the artist names</t>                                              <t>Lists the artist names.
5527                                                Note that the character string may contain
5528                                                <xref target="character_set">escape sequences</xref>.</t>
5529                                          </list>                                          </list>
5530                                      </t>                                      </t>
5531                                      <t>KEYWORDS -                                      <t>KEYWORDS -
5532                                          <list>                                          <list>
5533                                              <t>Provides a list of keywords that refer to the instrument.                                              <t>Provides a list of keywords that refer to the instrument.
5534                                              Keywords are separated with semicolon and blank.</t>                                              Keywords are separated with semicolon and blank.
5535                                                Note that the character string may contain
5536                                                <xref target="character_set">escape sequences</xref>.</t>
5537                                          </list>                                          </list>
5538                                      </t>                                      </t>
5539                                  </list>                                  </list>
# Line 5430  Schoenebeck'> Line 5641  Schoenebeck'>
5641                      </t>                      </t>
5642                  </section>                  </section>
5643    
5644                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5645                        <t>The front-end can copy a specific instrument to another directory by
5646                        sending the following command:</t>
5647                        <t>
5648                            <list>
5649                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5650                            </list>
5651                        </t>
5652                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5653                        to copy and &lt;dst&gt; is the directory where the instrument will
5654                        be copied to.</t>
5655    
5656                        <t>Possible Answers:</t>
5657                        <t>
5658                            <list>
5659                                <t>"OK" -
5660                                    <list>
5661                                        <t>on success</t>
5662                                    </list>
5663                                </t>
5664                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5665                                    <list>
5666                                        <t>in case the given instrument does not exists,
5667                                        or if an instrument with name equal to the name of the
5668                                        specified instrument already exists in the destination
5669                                        directory.</t>
5670                                    </list>
5671                                </t>
5672                            </list>
5673                        </t>
5674    
5675                        <t>Example:</t>
5676                        <t>
5677                            <list>
5678                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5679                                <t>S: "OK"</t>
5680                            </list>
5681                        </t>
5682                    </section>
5683    
5684                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5685                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
5686                      instrument by sending the following command:</t>                      instrument by sending the following command:</t>
# Line 5439  Schoenebeck'> Line 5690  Schoenebeck'>
5690                          </list>                          </list>
5691                      </t>                      </t>
5692                      <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
5693                      &lt;desc&gt; is the new description for the instrument.</t>                      &lt;desc&gt; is the new description for the instrument
5694                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5695                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5696    
5697                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5698                      <t>                      <t>
# Line 5466  Schoenebeck'> Line 5719  Schoenebeck'>
5719                      </t>                      </t>
5720                  </section>                  </section>
5721    
5722                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5723                        <t>The front-end can search for instruments
5724                        in specific directory by sending the following command:</t>
5725                        <t>
5726                            <list>
5727                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5728                            </list>
5729                        </t>
5730                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5731                        name of the directory to search in. If NON_RECURSIVE is specified, the
5732                        directories located in subdirectories of the specified directory will not
5733                        be searched. &lt;criteria-list&gt; is a list of search criterias
5734                        in form of "key1=val1 key2=val2 ...". The following criterias are
5735                        allowed:</t>
5736                        <t>
5737                          <t>NAME='&lt;search-string&gt;'
5738                              <list>
5739                                  <t>Restricts the search to instruments, which names
5740                                  satisfy the supplied search string (encapsulated into apostrophes,
5741                                  supporting escape sequences as described in chapter
5742                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5743                              </list>
5744                          </t>
5745    
5746                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5747                              <list>
5748                                  <t>Restricts the search to instruments, which
5749                                  size is in the specified range. If &lt;min&gt; is omitted,
5750                                  the search results are restricted to instruments with size less then
5751                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5752                                  search is restricted to instruments with size greater then
5753                                  or equal to &lt;min&gt;.</t>
5754                              </list>
5755                          </t>
5756    
5757                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5758                              <list>
5759                                  <t>Restricts the search to instruments, which creation
5760                                  date satisfies the specified period, where &lt;date-after&gt;
5761                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5762                                  If &lt;date-after&gt; is omitted the search is restricted to
5763                                  instruments created before &lt;date-before&gt;. If
5764                                  &lt;date-before&gt; is omitted, the search is restricted
5765                                  to instruments created after &lt;date-after&gt;.</t>
5766                              </list>
5767                          </t>
5768    
5769                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5770                              <list>
5771                                  <t>Restricts the search to instruments, which
5772                                  date of last modification satisfies the specified period, where
5773                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5774                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5775                                  instruments, which are last modified before &lt;date-before&gt;. If
5776                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5777                                  which are last modified after &lt;date-after&gt;.</t>
5778                              </list>
5779                          </t>
5780    
5781                          <t>DESCRIPTION='&lt;search-string&gt;'
5782                              <list>
5783                                  <t>Restricts the search to instruments with description
5784                                  that satisfies the supplied search string (encapsulated into apostrophes,
5785                                  supporting escape sequences as described in chapter
5786                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5787                              </list>
5788                          </t>
5789    
5790                          <t>PRODUCT='&lt;search-string&gt;'
5791                              <list>
5792                                  <t>Restricts the search to instruments with product info
5793                                  that satisfies the supplied search string (encapsulated into apostrophes,
5794                                  supporting escape sequences as described in chapter
5795                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5796                              </list>
5797                          </t>
5798    
5799                          <t>ARTISTS='&lt;search-string&gt;'
5800                              <list>
5801                                  <t>Restricts the search to instruments with artists info
5802                                  that satisfies the supplied search string (encapsulated into apostrophes,
5803                                  supporting escape sequences as described in chapter
5804                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5805                              </list>
5806                          </t>
5807    
5808                          <t>KEYWORDS='&lt;search-string&gt;'
5809                              <list>
5810                                  <t>Restricts the search to instruments with keyword list
5811                                  that satisfies the supplied search string (encapsulated into apostrophes,
5812                                  supporting escape sequences as described in chapter
5813                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5814                              </list>
5815                          </t>
5816    
5817                          <t>IS_DRUM=true | false
5818                              <list>
5819                                  <t>Either true or false. Restricts the search to
5820                                  drum kits or chromatic instruments.</t>
5821                              </list>
5822                          </t>
5823    
5824                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5825                              <list>
5826                                  <t>Restricts the search to instruments of the supplied format families,
5827                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5828                              </list>
5829                          </t>
5830                        </t>
5831    
5832                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5833                        word list separated with spaces for OR search and with '+' for AND search.</t>
5834    
5835                        <t>Possible Answers:</t>
5836                        <t>
5837                            <list>
5838                                <t>A comma separated list with the absolute path names (encapsulated into
5839                                apostrophes) of all instruments in the specified directory that satisfy
5840                                the supplied search criterias.</t>
5841                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5842                                    <list>
5843                                        <t>if the given directory does not exist.</t>
5844                                    </list>
5845                                </t>
5846                            </list>
5847                        </t>
5848                        <t>Example:</t>
5849                        <t>
5850                            <list>
5851                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5852                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5853                            </list>
5854                        </t>
5855                        <t>
5856                            <list>
5857                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5858                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5859                            </list>
5860                        </t>
5861                    </section>
5862    
5863                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
5864                        <t>The front-end can ask for the current status of a
5865                        particular database instruments job by sending the following command:</t>
5866                        <t>
5867                            <list>
5868                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
5869                            </list>
5870                        </t>
5871                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
5872                        of the job the front-end is interested in.</t>
5873    
5874                        <t>Possible Answers:</t>
5875                        <t>
5876                            <list>
5877                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5878                                Each answer line begins with the settings category name
5879                                followed by a colon and then a space character &lt;SP&gt; and finally
5880                                the info character string to that setting category. At the
5881                                moment the following categories are defined:</t>
5882    
5883                                <t>
5884                                    <list>
5885                                        <t>FILES_TOTAL -
5886                                            <list>
5887                                                <t>The total number of files scheduled for scanning</t>
5888                                            </list>
5889                                        </t>
5890                                        <t>FILES_SCANNED -
5891                                            <list>
5892                                                <t>The current number of scanned files</t>
5893                                            </list>
5894                                        </t>
5895                                        <t>SCANNING -
5896                                            <list>
5897                                                <t>The absolute path name of the file which is currently
5898                                                being scanned</t>
5899                                            </list>
5900                                        </t>
5901                                        <t>STATUS -
5902                                            <list>
5903                                                <t>An integer value between 0 and 100 indicating the
5904                                                scanning progress percentage of the file which is
5905                                                currently being scanned</t>
5906                                            </list>
5907                                        </t>
5908                                    </list>
5909                                </t>
5910                            </list>
5911                        </t>
5912                        <t>The mentioned fields above don't have to be in particular order.</t>
5913    
5914                        <t>Example:</t>
5915                        <t>
5916                            <list>
5917                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
5918                                <t>S: "FILES_TOTAL: 12"</t>
5919                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
5920                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
5921                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
5922                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5923                            </list>
5924                        </t>
5925                    </section>
5926    
5927                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5928                        <t>The front-end can remove all instruments and directories and re-create
5929                        the instruments database structure (e.g., in case of a database corruption)
5930                        by sending the following command:</t>
5931                        <t>
5932                            <list>
5933                                <t>FORMAT INSTRUMENTS_DB</t>
5934                            </list>
5935                        </t>
5936                        
5937                        <t>Possible Answers:</t>
5938                        <t>
5939                            <list>
5940                                <t>"OK" -
5941                                    <list>
5942                                        <t>on success</t>
5943                                    </list>
5944                                </t>
5945                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5946                                    <list>
5947                                        <t>If the formatting of the instruments database
5948                                        failed.</t>
5949                                    </list>
5950                                </t>
5951                            </list>
5952                        </t>
5953                    </section>
5954    
5955              </section>              </section>
5956    
5957    
5958    
5959                <section title="Editing Instruments" anchor="editing_instruments">
5960                    <t>The sampler allows to edit instruments while playing with the
5961                    sampler by spawning an external (3rd party) instrument editor
5962                    application for a given instrument. The 3rd party instrument
5963                    editor applications have to place a respective plugin DLL file
5964                    into the sampler's plugins directory. The sampler will
5965                    automatically try to load all plugin DLLs in that directory on
5966                    startup and only on startup!</t>
5967                    <t>At the moment there is only one command for this feature set,
5968                    but this will most probably change in future.</t>
5969    
5970                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
5971                        <t>The front-end can request to open an appropriate instrument
5972                        editor application by sending the following command:</t>
5973                        <t>
5974                            <list>
5975                                <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>
5976                            </list>
5977                        </t>
5978                        <t>Where &lt;sampler-channel&gt; should be replaced by the
5979                        number of the sampler channel as given by the
5980                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
5981                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
5982                        command.</t>
5983    
5984                        <t>The sampler will try to ask all registered instrument
5985                        editors (or to be more specific: their sampler plugins)
5986                        whether they are capable to handle the instrument on the
5987                        given sampler channel. The sampler will simply use the first
5988                        instrument editor application which replied with a positive
5989                        answer and spawn that instrument editor application within
5990                        the sampler's process and provide that application access
5991                        to the instrument's data structures, so both applications
5992                        can share and access the same instruments data at the same
5993                        time, thus allowing to immediately hear changes with the
5994                        sampler made by the instrument editor.</t>
5995    
5996                        <t>Note: consequently instrument editors are always spawned
5997                        locally on the same machine where the sampler is running
5998                        on!</t>
5999    
6000                        <t>Possible Answers:</t>
6001                        <t>
6002                            <list>
6003                                <t>"OK" -
6004                                    <list>
6005                                        <t>when an appropriate instrument editor was
6006                                        launched</t>
6007                                    </list>
6008                                </t>
6009                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6010                                    <list>
6011                                        <t>when an appropriate instrument editor was
6012                                        launched, but there are noteworthy issues</t>
6013                                    </list>
6014                                </t>
6015                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6016                                    <list>
6017                                        <t>when an appropriate instrument editor
6018                                        could not be launched</t>
6019                                    </list>
6020                                </t>
6021                            </list>
6022                        </t>
6023    
6024                        <t>Examples:</t>
6025                        <t>
6026                            <list>
6027                                <t>C: "EDIT INSTRUMENT 0"</t>
6028                                <t>S: "OK"</t>
6029                            </list>
6030                        </t>
6031                    </section>
6032                </section>
6033          </section>          </section>
6034    
6035    
# Line 5547  Schoenebeck'> Line 6109  Schoenebeck'>
6109                  </t>                  </t>
6110                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
6111                  </t>                  </t>
6112                    <t>/ FIND SP find_instruction
6113                    </t>
6114                  <t>/ MOVE SP move_instruction                  <t>/ MOVE SP move_instruction
6115                  </t>                  </t>
6116                    <t>/ COPY SP copy_instruction
6117                    </t>
6118                    <t>/ EDIT SP edit_instruction
6119                    </t>
6120                    <t>/ FORMAT SP format_instruction
6121                    </t>
6122                  <t>/ RESET                  <t>/ RESET
6123                  </t>                  </t>
6124                  <t>/ QUIT                  <t>/ QUIT
# Line 5559  Schoenebeck'> Line 6129  Schoenebeck'>
6129          <list>          <list>
6130                  <t>CHANNEL                  <t>CHANNEL
6131                  </t>                  </t>
6132                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6133                    </t>
6134                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6135                  </t>                  </t>
6136                  <t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6137                  </t>                  </t>
6138                  <t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6139                  </t>                  </t>
6140                  <t>/ DB_INSTRUMENTS SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
6141                  </t>                  </t>
6142                  <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index                  <t>/ DB_INSTRUMENTS SP db_path SP filename
6143                    </t>
6144                    <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6145                  </t>                  </t>
6146                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
6147                  </t>                  </t>
# Line 5615  Schoenebeck'> Line 6189  Schoenebeck'>
6189                  </t>                  </t>
6190                  <t>/ DB_INSTRUMENT_INFO                  <t>/ DB_INSTRUMENT_INFO
6191                  </t>                  </t>
6192                    <t>/ DB_INSTRUMENTS_JOB_INFO
6193                    </t>
6194                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6195                  </t>                  </t>
6196                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 5663  Schoenebeck'> Line 6239  Schoenebeck'>
6239                  </t>                  </t>
6240                  <t>/ DB_INSTRUMENT_INFO                  <t>/ DB_INSTRUMENT_INFO
6241                  </t>                  </t>
6242                    <t>/ DB_INSTRUMENTS_JOB_INFO
6243                    </t>
6244                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6245                  </t>                  </t>
6246                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 5697  Schoenebeck'> Line 6275  Schoenebeck'>
6275                  </t>                  </t>
6276                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6277                  </t>                  </t>
6278                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6279                  </t>                  </t>
6280                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6281                  </t>                  </t>
6282                  <t>/ DB_INSTRUMENT SP pathname                  <t>/ DB_INSTRUMENT SP db_path
6283                  </t>                  </t>
6284          </list>          </list>
6285  </t>  </t>
# Line 5773  Schoenebeck'> Line 6351  Schoenebeck'>
6351                  </t>                  </t>
6352                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6353                  </t>                  </t>
6354                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6355                    </t>
6356                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6357                    </t>
6358                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6359                  </t>                  </t>
6360                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6361                  </t>                  </t>
6362                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6363                  </t>                  </t>
6364                  <t>/ DB_INSTRUMENT SP INFO SP pathname                  <t>/ DB_INSTRUMENT SP INFO SP db_path
6365                    </t>
6366                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6367                  </t>                  </t>
6368                  <t>/ VOLUME                  <t>/ VOLUME
6369                  </t>                  </t>
# Line 5793  Schoenebeck'> Line 6377  Schoenebeck'>
6377                  </t>                  </t>
6378                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6379                  </t>                  </t>
6380                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6381                    </t>
6382                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6383                  </t>                  </t>
6384                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
# Line 5807  Schoenebeck'> Line 6393  Schoenebeck'>
6393                  </t>                  </t>
6394                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6395                  </t>                  </t>
6396                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP raw_path
6397                  </t>                  </t>
6398                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP raw_path
6399                  </t>                  </t>
6400                  <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT SP NAME SP db_path SP raw_path
6401                  </t>                  </t>
6402                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP raw_path
6403                  </t>                  </t>
6404                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6405                  </t>                  </t>
# Line 5851  Schoenebeck'> Line 6437  Schoenebeck'>
6437                  </t>                  </t>
6438          </list>          </list>
6439  </t>  </t>
6440    <t>find_instruction =
6441            <list>
6442                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6443                    </t>
6444                    <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6445                    </t>
6446                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
6447                    </t>
6448                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6449                    </t>
6450            </list>
6451    </t>
6452  <t>move_instruction =  <t>move_instruction =
6453          <list>          <list>
6454                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6455                    </t>
6456                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6457                    </t>
6458            </list>
6459    </t>
6460    <t>copy_instruction =
6461            <list>
6462                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6463                  </t>                  </t>
6464                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6465                  </t>                  </t>
6466          </list>          </list>
6467  </t>  </t>
# Line 5909  Schoenebeck'> Line 6515  Schoenebeck'>
6515                  </t>                  </t>
6516          </list>          </list>
6517  </t>  </t>
6518    <t>edit_instruction =
6519            <list>
6520                    <t>INSTRUMENT SP sampler_channel
6521                    </t>
6522            </list>
6523    </t>
6524    <t>format_instruction =
6525            <list>
6526                    <t>INSTRUMENTS_DB
6527                    </t>
6528            </list>
6529    </t>
6530  <t>modal_arg =  <t>modal_arg =
6531          <list>          <list>
6532                  <t>/* epsilon (empty argument) */                  <t>/* epsilon (empty argument) */
# Line 5955  Schoenebeck'> Line 6573  Schoenebeck'>
6573                  </t>                  </t>
6574                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6575                  </t>                  </t>
6576                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6577                    </t>
6578                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6579                    </t>
6580                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6581                  </t>                  </t>
6582                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6583                  </t>                  </t>
6584          </list>          </list>
6585  </t>  </t>
# Line 6079  Schoenebeck'> Line 6701  Schoenebeck'>
6701                  </t>                  </t>
6702          </list>          </list>
6703  </t>  </t>
6704  <t>pathname =  <t>filename =
         <list>  
                 <t>stringval  
                 </t>  
         </list>  
 </t>  
 <t>dirname =  
6705          <list>          <list>
6706                  <t>stringval                  <t>path
6707                  </t>                  </t>
6708          </list>          </list>
6709  </t>  </t>
6710  <t>filename =  <t>db_path =
6711          <list>          <list>
6712                  <t>stringval                  <t>path
6713                  </t>                  </t>
6714          </list>          </list>
6715  </t>  </t>
# Line 6123  Schoenebeck'> Line 6739  Schoenebeck'>
6739                  </t>                  </t>
6740          </list>          </list>
6741  </t>  </t>
6742    
6743  <t>param_val =  <t>param_val =
6744          <list>          <list>
6745                  <t>string                  <t>string
# Line 6135  Schoenebeck'> Line 6752  Schoenebeck'>
6752                  </t>                  </t>
6753          </list>          </list>
6754  </t>  </t>
6755    <t>query_val_list =
6756            <list>
6757                    <t>string '=' query_val
6758                    </t>
6759                    <t>/ query_val_list SP string '=' query_val
6760                    </t>
6761            </list>
6762    </t>
6763    <t>query_val =
6764            <list>
6765                    <t>raw_path_base
6766                    </t>
6767                    <t>/ raw_path
6768                    </t>
6769            </list>
6770    </t>
6771    <t>scan_mode =
6772            <list>
6773                    <t>RECURSIVE
6774                    </t>
6775                    <t>/ NON_RECURSIVE
6776                    </t>
6777                    <t>/ FLAT
6778                    </t>
6779            </list>
6780    </t>
6781    
6782              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6783    
6784                <section title="Character Set and Escape Sequences" anchor="character_set">
6785                    <t>Older versions of this protocol up to and including v1.1 only
6786                    supported the standard ASCII character set (ASCII code 0 - 127)
6787                    <xref target="RFC20"/>, all younger versions of this protocol
6788                    however support the Extended ASCII character set (ASCII code
6789                    0 - 255). The same group of younger protocols also support
6790                    escape sequences, but only for certain, explicitly declared
6791                    parts of the protocol. The supported escape sequences are
6792                    defined as follows:</t>
6793                    <texttable>
6794                        <ttcol>ASCII Character Sequence</ttcol>
6795                        <ttcol>Translated into (Name)</ttcol>
6796                        <c>\n</c> <c>new line</c>
6797                        <c>\r</c> <c>carriage return</c>
6798                        <c>\f</c> <c>form feed</c>
6799                        <c>\t</c> <c>horizontal tab</c>
6800                        <c>\v</c> <c>vertical tab</c>
6801                        <c>\'</c> <c>apostrophe</c>
6802                        <c>\"</c> <c>quotation mark</c>
6803                        <c>\\</c> <c>backslash</c>
6804                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
6805                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
6806                    </texttable>
6807                    <t>Notice: due to the transition of certain parts of the
6808                    protocol which now support escape sequences, a slight backward
6809                    incompatibility to protocols version v1.1 and younger has been
6810                    introduced. The only difference is that in parts of the protocol
6811                    where escape characters are now supported, a backslash characters
6812                    MUST be escaped as well (that is as double backslash), whereas
6813                    in the old versions a single backslash was sufficient.</t>
6814                </section>
6815          </section>          </section>
6816    
6817          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 6322  Schoenebeck'> Line 6997  Schoenebeck'>
6997              </section>              </section>
6998    
6999              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
7000                  <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
7001                  a particular sampler channel is changed by issuing the following command:</t>                  a particular sampler channel is changed by issuing the following command:</t>
7002                  <t>                  <t>
7003                      <list>                      <list>
# Line 6582  Schoenebeck'> Line 7257  Schoenebeck'>
7257                  the new name of the instrument, encapsulated into apostrophes.</t>                  the new name of the instrument, encapsulated into apostrophes.</t>
7258              </section>              </section>
7259    
7260                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7261                    <t>Client may want to be notified when the status of particular database
7262                    instruments job is changed by issuing the following command:</t>
7263                    <t>
7264                        <list>
7265                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7266                        </list>
7267                    </t>
7268                    <t>Server will start sending the following notification messages:</t>
7269                    <t>
7270                        <list>
7271                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7272                        </list>
7273                    </t>
7274                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7275                    which status is changed. The front-end will have to send the respective
7276                    command to actually get the status info. Because these messages
7277                    will be triggered by LSCP commands issued by other clients rather than real
7278                    time events happening on the server, it is believed that an empty notification
7279                    message is sufficient here.</t>
7280                </section>
7281    
7282              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7283                  <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
7284                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
# Line 6660  Schoenebeck'> Line 7357  Schoenebeck'>
7357                  </front>                  </front>
7358                  <seriesInfo name="RFC" value="2234" />                  <seriesInfo name="RFC" value="2234" />
7359              </reference>              </reference>
7360                <reference anchor="RFC20">
7361                    <front>
7362                        <title>ASCII format for Network Interchange</title>
7363                        <author>
7364                            <organization>UCLA</organization>
7365                        </author>
7366                        <date year="1969"></date>
7367                    </front>
7368                    <seriesInfo name="RFC" value="20" />
7369                </reference>
7370           </references>           </references>
7371      </back>      </back>
7372    
Legend:
Removed from v.1161  
changed lines
  Added in v.1387
  ViewVC Help
Powered by ViewVC