/[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 1136 by iliev, Thu Mar 29 10:01:50 2007 UTC revision 1554 by schoenebeck, Thu Dec 6 01:38:31 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.3">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="March" year="2007"/>          <date month="December" 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 2148  Schoenebeck'> Line 2162  Schoenebeck'>
2162                              </t>                              </t>
2163                          </list>                          </list>
2164                      </t>                      </t>
2165                      <t>Example:</t>                      <t>Example (Unix):</t>
2166                      <t>                      <t>
2167                          <list>                          <list>
2168                              <t></t>                              <t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t>
2169                                <t>S: OK</t>
2170                            </list>
2171                        </t>
2172                        <t>Example (Windows):</t>
2173                        <t>
2174                            <list>
2175                                <t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t>
2176                                <t>S: OK</t>
2177                          </list>                          </list>
2178                      </t>                      </t>
2179                  </section>                  </section>
# Line 2429  Schoenebeck'> Line 2451  Schoenebeck'>
2451                                  <list>                                  <list>
2452                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
2453                                          <list>                                          <list>
2454                                              <t>arbitrary description text about the engine</t>                                              <t>arbitrary description text about the engine
2455                                                (note that the character string may contain
2456                                                <xref target="character_set">escape sequences</xref>)</t>
2457                                          </list>                                          </list>
2458                                      </t>                                      </t>
2459                                       <t>VERSION -                                       <t>VERSION -
# Line 2513  Schoenebeck'> Line 2537  Schoenebeck'>
2537                                          <list>                                          <list>
2538                                              <t>the file name of the loaded instrument, "NONE" if                                              <t>the file name of the loaded instrument, "NONE" if
2539                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
2540                                              channel</t>                                              channel (note: since LSCP 1.2 this path may contain
2541                                                <xref target="character_set">escape sequences</xref>)</t>
2542                                          </list>                                          </list>
2543                                      </t>                                      </t>
2544                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 2523  Schoenebeck'> Line 2548  Schoenebeck'>
2548                                      </t>                                      </t>
2549                                      <t>INSTRUMENT_NAME -                                      <t>INSTRUMENT_NAME -
2550                                          <list>                                          <list>
2551                                              <t>the instrument name of the loaded instrument</t>                                              <t>the instrument name of the loaded instrument
2552                                                (note: since LSCP 1.2 this character string may contain
2553                                                <xref target="character_set">escape sequences</xref>)</t>
2554                                          </list>                                          </list>
2555                                      </t>                                      </t>
2556                                      <t>INSTRUMENT_STATUS -                                      <t>INSTRUMENT_STATUS -
# Line 3241  Schoenebeck'> Line 3268  Schoenebeck'>
3268                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;                      sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3269                      is a number between 0..127 defining the MIDI controller which can alter the                      is a number between 0..127 defining the MIDI controller which can alter the
3270                      effect send level and &lt;name&gt; is an optional argument defining a name                      effect send level and &lt;name&gt; is an optional argument defining a name
3271                      for the effect send entity. The name does not have to be unique.</t>                      for the effect send entity. The name does not have to be unique, but MUST be
3272                        encapsulated into apostrophes and supports escape sequences as described in chapter
3273                        "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3274    
3275                      <t>By default, that is as initial routing, the effect send's audio channels                      <t>By default, that is as initial routing, the effect send's audio channels
3276                      are automatically routed to the last audio channels of the sampler channel's                      are automatically routed to the last audio channels of the sampler channel's
# Line 3431  Schoenebeck'> Line 3460  Schoenebeck'>
3460                                  <list>                                  <list>
3461                                      <t>NAME -                                      <t>NAME -
3462                                          <list>                                          <list>
3463                                              <t>name of the effect send entity</t>                                              <t>name of the effect send entity
3464                                                (note that this character string may contain
3465                                                 <xref target="character_set">escape sequences</xref>)</t>
3466                                          </list>                                          </list>
3467                                      </t>                                      </t>
3468                                      <t>MIDI_CONTROLLER -                                      <t>MIDI_CONTROLLER -
# Line 3494  Schoenebeck'> Line 3525  Schoenebeck'>
3525                      as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>                      as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3526                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3527                      &lt;name&gt; is the new name of the effect send entity, which                      &lt;name&gt; is the new name of the effect send entity, which
3528                      does not have to be unique.</t>                      does not have to be unique (name MUST be encapsulated into apostrophes
3529                        and supports escape sequences as described in chapter
3530                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
3531                        </t>
3532    
3533                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3534                      <t>                      <t>
# Line 3898  Schoenebeck'> Line 3932  Schoenebeck'>
3932                      </t>                      </t>
3933                  </section>                  </section>
3934    
3935                    <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
3936                        <t>The front-end can ask for the current number of active disk streams on
3937                        the sampler by sending the following command:</t>
3938                        <t>
3939                            <list>
3940                                <t>GET TOTAL_STREAM_COUNT</t>
3941                            </list>
3942                        </t>
3943    
3944                        <t>Possible Answers:</t>
3945                        <t>
3946                            <list>
3947                                <t>LinuxSampler will answer by returning the number of all active
3948                                disk streams on the sampler.</t>
3949                            </list>
3950                        </t>
3951                    </section>
3952    
3953                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
3954                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
3955                      <t>                      <t>
# Line 3945  Schoenebeck'> Line 3997  Schoenebeck'>
3997                                  <list>                                  <list>
3998                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
3999                                          <list>                                          <list>
4000                                              <t>arbitrary textual description about the sampler</t>                                              <t>arbitrary textual description about the sampler
4001                                                (note that the character string may contain
4002                                                <xref target="character_set">escape sequences</xref>)</t>
4003                                          </list>                                          </list>
4004                                      </t>                                      </t>
4005                                      <t>VERSION -                                      <t>VERSION -
# Line 3959  Schoenebeck'> Line 4013  Schoenebeck'>
4013                                              complies with (see <xref target="LSCP versioning" /> for details)</t>                                              complies with (see <xref target="LSCP versioning" /> for details)</t>
4014                                          </list>                                          </list>
4015                                      </t>                                      </t>
4016                                        <t>INSTRUMENTS_DB_SUPPORT -
4017                                            <list>
4018                                                <t>either yes or no, specifies whether the
4019                                                sampler is build with instruments database support.</t>
4020                                            </list>
4021                                        </t>
4022                                  </list>                                  </list>
4023                              </t>                              </t>
4024                          </list>                          </list>
# Line 4055  Schoenebeck'> Line 4115  Schoenebeck'>
4115                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
4116                  reflected by the current MIDI instrument map.</t>                  reflected by the current MIDI instrument map.</t>
4117    
4118                  <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP">                  <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP">
4119                      <t>The front-end can add a new MIDI instrument map by sending                      <t>The front-end can add a new MIDI instrument map by sending
4120                      the following command:</t>                      the following command:</t>
4121                      <t>                      <t>
# Line 4065  Schoenebeck'> Line 4125  Schoenebeck'>
4125                      </t>                      </t>
4126                      <t>Where &lt;name&gt; is an optional argument allowing to                      <t>Where &lt;name&gt; is an optional argument allowing to
4127                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
4128                      names do not have to be unique.</t>                      names do not have to be unique, but MUST be encapsulated
4129                        into apostrophes and support escape sequences as described
4130                        in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4131                        </t>
4132    
4133                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4134                      <t>                      <t>
# Line 4236  Schoenebeck'> Line 4299  Schoenebeck'>
4299                                      <t>NAME -                                      <t>NAME -
4300                                          <list>                                          <list>
4301                                              <t>custom name of the given map,                                              <t>custom name of the given map,
4302                                              which does not have to be unique</t>                                              which does not have to be unique
4303                                                (note that this character string may contain
4304                                                 <xref target="character_set">escape sequences</xref>)</t>
4305                                          </list>                                          </list>
4306                                      </t>                                      </t>
4307                                      <t>DEFAULT -                                      <t>DEFAULT -
# Line 4272  Schoenebeck'> Line 4337  Schoenebeck'>
4337                      </t>                      </t>
4338                      <t>Where &lt;map&gt; is the numerical ID of the map and                      <t>Where &lt;map&gt; is the numerical ID of the map and
4339                      &lt;name&gt; the new custom name of the map, which does not                      &lt;name&gt; the new custom name of the map, which does not
4340                      have to be unique.</t>                      have to be unique (name MUST be encapsulated into apostrophes
4341                        and supports escape sequences as described in chapter
4342                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
4343                        </t>
4344    
4345                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4346                      <t>                      <t>
# Line 4319  Schoenebeck'> Line 4387  Schoenebeck'>
4387                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4388                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4389                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4390                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
4391                        supporting escape sequences as described in chapter
4392                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4393                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4394                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4395                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 4401  Schoenebeck'> Line 4471  Schoenebeck'>
4471                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
4472                      mode by i.e. sending                      mode by i.e. sending
4473                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4474                      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
4475                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
4476                      entry, useful for frontends for displaying an appropriate name for                      "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4477                        mapping entry, useful for frontends for displaying an appropriate name for
4478                      mapped instruments (using                      mapped instruments (using
4479                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4480                      </t>                      </t>
# Line 4627  Schoenebeck'> Line 4698  Schoenebeck'>
4698                                      name for this mapped instrument. It can be set and                                      name for this mapped instrument. It can be set and
4699                                      changed with the                                      changed with the
4700                                      <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>                                      <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
4701                                      command and does not have to be unique.</t>                                      command and does not have to be unique.
4702                                        (note that this character string may contain
4703                                        <xref target="character_set">escape sequences</xref>)</t>
4704                                  </list>                                  </list>
4705                              </t>                              </t>
4706                              <t>"ENGINE_NAME" -                              <t>"ENGINE_NAME" -
# Line 4638  Schoenebeck'> Line 4711  Schoenebeck'>
4711                              </t>                              </t>
4712                              <t>"INSTRUMENT_FILE" -                              <t>"INSTRUMENT_FILE" -
4713                                  <list>                                  <list>
4714                                      <t>File name of the instrument.</t>                                      <t>File name of the instrument
4715                                        (note that this path may contain
4716                                        <xref target="character_set">escape sequences</xref>).</t>
4717                                  </list>                                  </list>
4718                              </t>                              </t>
4719                              <t>"INSTRUMENT_NR" -                              <t>"INSTRUMENT_NR" -
# Line 4650  Schoenebeck'> Line 4725  Schoenebeck'>
4725                                  <list>                                  <list>
4726                                      <t>Name of the loaded instrument as reflected by its file.                                      <t>Name of the loaded instrument as reflected by its file.
4727                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4728                                      cannot be changed.</t>                                      cannot be changed (note that this character string may contain
4729                                        <xref target="character_set">escape sequences</xref>).</t>
4730                                  </list>                                  </list>
4731                              </t>                              </t>
4732                              <t>"LOAD_MODE" -                              <t>"LOAD_MODE" -
# Line 4734  Schoenebeck'> Line 4810  Schoenebeck'>
4810                  </section>                  </section>
4811              </section>              </section>
4812    
         </section>  
4813    
4814                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4815                    <t>The following commands describe how to use and manage
4816                    the instruments database.</t>
4817                    <t>Notice:</t>
4818                        <t>
4819                            <list>
4820                                <t>All command arguments representing a path or
4821                                instrument/directory name support escape sequences as described in chapter
4822                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4823                                </t>
4824                                <t>All occurrences of a forward slash in instrument and directory
4825                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4826                                </t>
4827                            </list>
4828                        </t>
4829    
4830                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4831                        <t>The front-end can add a new instrument directory to the
4832                        instruments database by sending the following command:</t>
4833                        <t>
4834                            <list>
4835                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4836                            </list>
4837                        </t>
4838                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4839                        to be created (encapsulated into apostrophes).</t>
4840    
4841                        <t>Possible Answers:</t>
4842                        <t>
4843                            <list>
4844                                <t>"OK" -
4845                                    <list>
4846                                        <t>on success</t>
4847                                    </list>
4848                                </t>
4849                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4850                                    <list>
4851                                        <t>when the directory could not be created, which
4852                                        can happen if the directory already exists or the
4853                                        name contains not allowed symbols</t>
4854                                    </list>
4855                                </t>
4856                            </list>
4857                        </t>
4858    
4859                        <t>Examples:</t>
4860                        <t>
4861                            <list>
4862                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4863                                <t>S: "OK"</t>
4864                            </list>
4865                        </t>
4866                    </section>
4867    
4868                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4869                        <t>The front-end can delete a particular instrument directory
4870                        from the instruments database by sending the following command:</t>
4871                        <t>
4872                            <list>
4873                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4874                            </list>
4875                        </t>
4876                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4877                        to delete. The optional FORCE argument can be used to
4878                        force the deletion of a non-empty directory and all its content.</t>
4879    
4880                        <t>Possible Answers:</t>
4881                        <t>
4882                            <list>
4883                                <t>"OK" -
4884                                    <list>
4885                                        <t>if the directory is deleted successfully</t>
4886                                    </list>
4887                                </t>
4888                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4889                                    <list>
4890                                        <t>if the given directory does not exist, or
4891                                        if trying to delete a non-empty directory,
4892                                        without using the FORCE argument.</t>
4893                                    </list>
4894                                </t>
4895                            </list>
4896                        </t>
4897    
4898                        <t>Examples:</t>
4899                        <t>
4900                            <list>
4901                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4902                                <t>S: "OK"</t>
4903                            </list>
4904                        </t>
4905                    </section>
4906    
4907                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4908                        <t>The front-end can retrieve the current amount of
4909                        directories in a specific directory by sending the following command:</t>
4910                        <t>
4911                            <list>
4912                                <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4913                            </list>
4914                        </t>
4915                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4916                        name of the directory. If RECURSIVE is specified, the number of
4917                        all directories, including those located in subdirectories of the
4918                        specified directory, will be returned.</t>
4919    
4920                        <t>Possible Answers:</t>
4921                        <t>
4922                            <list>
4923                                <t>The current number of instrument directories
4924                                in the specified directory.</t>
4925                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4926                                    <list>
4927                                        <t>if the given directory does not exist.</t>
4928                                    </list>
4929                                </t>
4930                            </list>
4931                        </t>
4932    
4933                        <t>Example:</t>
4934                        <t>
4935                            <list>
4936                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4937                                <t>S: "2"</t>
4938                            </list>
4939                        </t>
4940                    </section>
4941    
4942                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4943                        <t>The front-end can retrieve the current list of directories
4944                        in specific directory by sending the following command:</t>
4945                        <t>
4946                            <list>
4947                                <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4948                            </list>
4949                        </t>
4950                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4951                        name of the directory. If RECURSIVE is specified, the absolute path names
4952                        of all directories, including those located in subdirectories of the
4953                        specified directory, will be returned.</t>
4954    
4955                        <t>Possible Answers:</t>
4956                        <t>
4957                            <list>
4958                                <t>A comma separated list of all instrument directories
4959                                (encapsulated into apostrophes) in the specified directory.</t>
4960                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4961                                    <list>
4962                                        <t>if the given directory does not exist.</t>
4963                                    </list>
4964                                </t>
4965                            </list>
4966                        </t>
4967                        <t>Example:</t>
4968                        <t>
4969                            <list>
4970                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4971                                <t>S: "'Piano Collection','Percussion Collection'"</t>
4972                            </list>
4973                        </t>
4974                        <t>
4975                            <list>
4976                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4977                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4978                            </list>
4979                        </t>
4980                    </section>
4981    
4982                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4983                        <t>The front-end can ask for the current settings of an
4984                        instrument directory by sending the following command:</t>
4985                        <t>
4986                            <list>
4987                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4988                            </list>
4989                        </t>
4990                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4991                        name of the directory the front-end is interested in.</t>
4992    
4993                        <t>Possible Answers:</t>
4994                        <t>
4995                            <list>
4996                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4997                                Each answer line begins with the settings category name
4998                                followed by a colon and then a space character &lt;SP&gt; and finally
4999                                the info character string to that setting category. At the
5000                                moment the following categories are defined:</t>
5001    
5002                                <t>
5003                                    <list>
5004                                        <t>DESCRIPTION -
5005                                            <list>
5006                                                <t>A brief description of the directory content.
5007                                                Note that the character string may contain
5008                                                <xref target="character_set">escape sequences</xref>.</t>
5009                                            </list>
5010                                        </t>
5011                                        <t>CREATED -
5012                                            <list>
5013                                                <t>The creation date and time of the directory,
5014                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
5015                                            </list>
5016                                        </t>
5017                                        <t>MODIFIED -
5018                                            <list>
5019                                                <t>The date and time of the last modification of the
5020                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
5021                                            </list>
5022                                        </t>
5023                                    </list>
5024                                </t>
5025                            </list>
5026                        </t>
5027                        <t>The mentioned fields above don't have to be in particular order.</t>
5028    
5029                        <t>Example:</t>
5030                        <t>
5031                            <list>
5032                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
5033                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
5034                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5035                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5036                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5037                            </list>
5038                        </t>
5039                    </section>
5040    
5041                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
5042                        <t>The front-end can alter the name of a specific
5043                        instrument directory by sending the following command:</t>
5044                        <t>
5045                            <list>
5046                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
5047                            </list>
5048                        </t>
5049                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5050                        &lt;name&gt; is the new name for that directory.</t>
5051    
5052                        <t>Possible Answers:</t>
5053                        <t>
5054                            <list>
5055                                <t>"OK" -
5056                                    <list>
5057                                        <t>on success</t>
5058                                    </list>
5059                                </t>
5060                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5061                                    <list>
5062                                        <t>in case the given directory does not exists,
5063                                        or if a directory with name equal to the new
5064                                        name already exists.</t>
5065                                    </list>
5066                                </t>
5067                            </list>
5068                        </t>
5069    
5070                        <t>Example:</t>
5071                        <t>
5072                            <list>
5073                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
5074                                <t>S: "OK"</t>
5075                            </list>
5076                        </t>
5077                    </section>
5078    
5079                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
5080                        <t>The front-end can move a specific
5081                        instrument directory by sending the following command:</t>
5082                        <t>
5083                            <list>
5084                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5085                            </list>
5086                        </t>
5087                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5088                        to move and &lt;dst&gt; is the location where the directory will
5089                        be moved to.</t>
5090    
5091                        <t>Possible Answers:</t>
5092                        <t>
5093                            <list>
5094                                <t>"OK" -
5095                                    <list>
5096                                        <t>on success</t>
5097                                    </list>
5098                                </t>
5099                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5100                                    <list>
5101                                        <t>in case a given directory does not exists,
5102                                        or if a directory with name equal to the name
5103                                        of the specified directory already exists in
5104                                        the destination directory. Error is also thrown
5105                                        when trying to move a directory to a subdirectory
5106                                        of itself.</t>
5107                                    </list>
5108                                </t>
5109                            </list>
5110                        </t>
5111    
5112                        <t>Example:</t>
5113                        <t>
5114                            <list>
5115                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5116                                <t>S: "OK"</t>
5117                            </list>
5118                        </t>
5119                    </section>
5120    
5121                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5122                        <t>The front-end can copy a specific
5123                        instrument directory by sending the following command:</t>
5124                        <t>
5125                            <list>
5126                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5127                            </list>
5128                        </t>
5129                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5130                        to copy and &lt;dst&gt; is the location where the directory will
5131                        be copied to.</t>
5132    
5133                        <t>Possible Answers:</t>
5134                        <t>
5135                            <list>
5136                                <t>"OK" -
5137                                    <list>
5138                                        <t>on success</t>
5139                                    </list>
5140                                </t>
5141                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5142                                    <list>
5143                                        <t>in case a given directory does not exists,
5144                                        or if a directory with name equal to the name
5145                                        of the specified directory already exists in
5146                                        the destination directory. Error is also thrown
5147                                        when trying to copy a directory to a subdirectory
5148                                        of itself.</t>
5149                                    </list>
5150                                </t>
5151                            </list>
5152                        </t>
5153    
5154                        <t>Example:</t>
5155                        <t>
5156                            <list>
5157                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5158                                <t>S: "OK"</t>
5159                            </list>
5160                        </t>
5161                    </section>
5162    
5163                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5164                        <t>The front-end can alter the description of a specific
5165                        instrument directory by sending the following command:</t>
5166                        <t>
5167                            <list>
5168                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5169                            </list>
5170                        </t>
5171                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5172                        &lt;desc&gt; is the new description for the directory
5173                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5174                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5175    
5176                        <t>Possible Answers:</t>
5177                        <t>
5178                            <list>
5179                                <t>"OK" -
5180                                    <list>
5181                                        <t>on success</t>
5182                                    </list>
5183                                </t>
5184                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5185                                    <list>
5186                                        <t>in case the given directory does not exists.</t>
5187                                    </list>
5188                                </t>
5189                            </list>
5190                        </t>
5191    
5192                        <t>Example:</t>
5193                        <t>
5194                            <list>
5195                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5196                                <t>S: "OK"</t>
5197                            </list>
5198                        </t>
5199                    </section>
5200    
5201                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5202                        <t>The front-end can search for directories
5203                        in specific directory by sending the following command:</t>
5204                        <t>
5205                            <list>
5206                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5207                            </list>
5208                        </t>
5209                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5210                        name of the directory to search in. If NON_RECURSIVE is specified, the
5211                        directories located in subdirectories of the specified directory will not
5212                        be searched. &lt;criteria-list&gt; is a list of search criterias
5213                        in form of "key1=val1 key2=val2 ...". The following criterias are
5214                        allowed:</t>
5215                        <t>
5216                          <t>NAME='&lt;search-string&gt;'
5217                              <list>
5218                                  <t>Restricts the search to directories, which names
5219                                  satisfy the supplied search string (encapsulated into apostrophes,
5220                                  supporting escape sequences as described in chapter
5221                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5222                              </list>
5223                          </t>
5224    
5225                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5226                              <list>
5227                                  <t>Restricts the search to directories, which creation
5228                                  date satisfies the specified period, where &lt;date-after&gt;
5229                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5230                                  If &lt;date-after&gt; is omitted the search is restricted to
5231                                  directories created before &lt;date-before&gt;. If
5232                                  &lt;date-before&gt; is omitted, the search is restricted
5233                                  to directories created after &lt;date-after&gt;.</t>
5234                              </list>
5235                          </t>
5236    
5237                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5238                              <list>
5239                                  <t>Restricts the search to directories, which
5240                                  date of last modification satisfies the specified period, where
5241                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5242                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5243                                  directories, which are last modified before &lt;date-before&gt;. If
5244                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5245                                  which are last modified after &lt;date-after&gt;.</t>
5246                              </list>
5247                          </t>
5248    
5249                          <t>DESCRIPTION='&lt;search-string&gt;'
5250                              <list>
5251                                  <t>Restricts the search to directories with description
5252                                  that satisfies the supplied search string
5253                                  (encapsulated into apostrophes, supporting escape
5254                                  sequences as described in chapter
5255                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5256                              </list>
5257                          </t>
5258                        </t>
5259    
5260                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5261                        word list separated with spaces for OR search and with '+' for AND search.</t>
5262    
5263                        <t>Possible Answers:</t>
5264                        <t>
5265                            <list>
5266                                <t>A comma separated list with the absolute path names (encapsulated into
5267                                apostrophes) of all directories in the specified directory that satisfy
5268                                the supplied search criterias.</t>
5269                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5270                                    <list>
5271                                        <t>if the given directory does not exist.</t>
5272                                    </list>
5273                                </t>
5274                            </list>
5275                        </t>
5276                        <t>Example:</t>
5277                        <t>
5278                            <list>
5279                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5280                                <t>S: "'/Piano Collection'"</t>
5281                            </list>
5282                        </t>
5283                        <t>
5284                            <list>
5285                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5286                                <t>S: "'/Piano Collection','/Percussions'"</t>
5287                            </list>
5288                        </t>
5289                    </section>
5290    
5291                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5292                        <t>The front-end can add one or more instruments
5293                        to the instruments database by sending the following command:</t>
5294                        <t>
5295                            <list>
5296                                <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5297                            </list>
5298                        </t>
5299                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5300                        (encapsulated into apostrophes) in the instruments database in which
5301                        only the new instruments (that are not already in the database) will
5302                        be added, &lt;file_path&gt; is the absolute path name of a file or
5303                        directory in the file system (encapsulated into apostrophes). In case
5304                        an instrument file is supplied, only the instruments in the specified
5305                        file will be added to the instruments database. If the optional
5306                        &lt;instr_index&gt; (the index of the instrument within the given file)
5307                        is supplied too, then only the specified instrument will be added.
5308                        In case a directory is supplied, the instruments in that directory
5309                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5310                        when a directory is provided as &lt;file_path&gt; and specifies how the
5311                        scanning will be done and has exactly the following possibilities:</t>
5312                        <t>
5313                            <list>
5314                                <t>"RECURSIVE" -
5315                                    <list>
5316                                        <t>All instruments will be processed, including those
5317                                        in the subdirectories, and the respective subdirectory
5318                                        tree structure will be recreated in the instruments
5319                                        database</t>
5320                                    </list>
5321                                </t>
5322                                <t>"NON_RECURSIVE" -
5323                                    <list>
5324                                        <t>Only the instruments in the specified directory
5325                                        will be added, the instruments in the subdirectories
5326                                        will not be processed.</t>
5327                                    </list>
5328                                </t>
5329                                <t>"FLAT" -
5330                                    <list>
5331                                        <t>All instruments will be processed, including those
5332                                        in the subdirectories, but the respective subdirectory
5333                                        structure will not be recreated in the instruments
5334                                        database. All instruments will be added directly in
5335                                        the specified database directory.</t>
5336                                    </list>
5337                                </t>
5338                            </list>
5339                        </t>
5340    
5341                     <t>The difference between regular and NON_MODAL versions of the command
5342                        is that the regular command returns when the scanning is finished
5343                        while NON_MODAL version returns immediately and a background process is launched.
5344                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5345                        command can be used to monitor the scanning progress.</t>
5346    
5347                        <t>Possible Answers:</t>
5348                        <t>
5349                            <list>
5350                                <t>"OK" -
5351                                    <list>
5352                                        <t>on success when NON_MODAL is not supplied</t>
5353                                    </list>
5354                                </t>
5355                                <t>"OK[&lt;job-id&gt;]" -
5356                                    <list>
5357                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5358                                        is a numerical ID used to obtain status information about the job progress.
5359                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5360                                        </t>
5361                                    </list>
5362                                </t>
5363                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5364                                    <list>
5365                                        <t>if an invalid path is specified.</t>
5366                                    </list>
5367                                </t>
5368                            </list>
5369                        </t>
5370    
5371                        <t>Examples:</t>
5372                        <t>
5373                            <list>
5374                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5375                                <t>S: "OK"</t>
5376                            </list>
5377                        </t>
5378                    </section>
5379    
5380                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5381                        <t>The front-end can remove a particular instrument
5382                        from the instruments database by sending the following command:</t>
5383                        <t>
5384                            <list>
5385                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5386                            </list>
5387                        </t>
5388                        <t>Where &lt;instr_path&gt; is the absolute path name
5389                        (in the instruments database) of the instrument to remove.</t>
5390    
5391                        <t>Possible Answers:</t>
5392                        <t>
5393                            <list>
5394                                <t>"OK" -
5395                                    <list>
5396                                        <t>if the instrument is removed successfully</t>
5397                                    </list>
5398                                </t>
5399                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5400                                    <list>
5401                                        <t>if the given path does not exist or
5402                                        is a directory.</t>
5403                                    </list>
5404                                </t>
5405                            </list>
5406                        </t>
5407    
5408                        <t>Examples:</t>
5409                        <t>
5410                            <list>
5411                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5412                                <t>S: "OK"</t>
5413                            </list>
5414                        </t>
5415                    </section>
5416    
5417                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5418                        <t>The front-end can retrieve the current amount of
5419                        instruments in a specific directory by sending the following command:</t>
5420                        <t>
5421                            <list>
5422                                <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5423                            </list>
5424                        </t>
5425                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5426                        of the directory. If RECURSIVE is specified, the number of all
5427                        instruments, including those located in subdirectories of the
5428                        specified directory, will be returned.</t>
5429    
5430                        <t>Possible Answers:</t>
5431                        <t>
5432                            <list>
5433                                <t>The current number of instruments
5434                                in the specified directory.</t>
5435                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5436                                    <list>
5437                                        <t>if the given directory does not exist.</t>
5438                                    </list>
5439                                </t>
5440                            </list>
5441                        </t>
5442    
5443                        <t>Example:</t>
5444                        <t>
5445                            <list>
5446                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5447                                <t>S: "2"</t>
5448                            </list>
5449                        </t>
5450                    </section>
5451    
5452                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5453                        <t>The front-end can retrieve the current list of instruments
5454                        in specific directory by sending the following command:</t>
5455                        <t>
5456                            <list>
5457                                <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5458                            </list>
5459                        </t>
5460                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5461                        name of the directory. If RECURSIVE is specified, the absolute path
5462                        names of all instruments, including those located in subdirectories
5463                        of the specified directory, will be returned.</t>
5464    
5465                        <t>Possible Answers:</t>
5466                        <t>
5467                            <list>
5468                                <t>A comma separated list of all instruments
5469                                (encapsulated into apostrophes) in the specified directory.</t>
5470                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5471                                    <list>
5472                                        <t>if the given directory does not exist.</t>
5473                                    </list>
5474                                </t>
5475                            </list>
5476                        </t>
5477                        <t>Example:</t>
5478                        <t>
5479                            <list>
5480                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5481                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5482                            </list>
5483                        </t>
5484                        <t>
5485                            <list>
5486                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5487                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5488                            </list>
5489                        </t>
5490                    </section>
5491    
5492                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5493                        <t>The front-end can ask for the current settings of an
5494                        instrument by sending the following command:</t>
5495                        <t>
5496                            <list>
5497                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5498                            </list>
5499                        </t>
5500                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5501                        name of the instrument the front-end is interested in.</t>
5502    
5503                        <t>Possible Answers:</t>
5504                        <t>
5505                            <list>
5506                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5507                                Each answer line begins with the settings category name
5508                                followed by a colon and then a space character &lt;SP&gt; and finally
5509                                the info character string to that setting category. At the
5510                                moment the following categories are defined:</t>
5511    
5512                                <t>
5513                                    <list>
5514                                        <t>INSTRUMENT_FILE -
5515                                            <list>
5516                                                <t>File name of the instrument.
5517                                                Note that the character string may contain
5518                                                <xref target="character_set">escape sequences</xref>.</t>
5519                                            </list>
5520                                        </t>
5521                                        <t>INSTRUMENT_NR -
5522                                            <list>
5523                                                <t>Index of the instrument within the file.</t>
5524                                            </list>
5525                                        </t>
5526                                        <t>FORMAT_FAMILY -
5527                                            <list>
5528                                                <t>The format family of the instrument.</t>
5529                                            </list>
5530                                        </t>
5531                                        <t>FORMAT_VERSION -
5532                                            <list>
5533                                                <t>The format version of the instrument.</t>
5534                                            </list>
5535                                        </t>
5536                                        <t>SIZE -
5537                                            <list>
5538                                                <t>The size of the instrument in bytes.</t>
5539                                            </list>
5540                                        </t>
5541                                        <t>CREATED -
5542                                            <list>
5543                                                <t>The date and time when the instrument is added
5544                                                in the instruments database, represented in
5545                                               "YYYY-MM-DD HH:MM:SS" format</t>
5546                                            </list>
5547                                        </t>
5548                                        <t>MODIFIED -
5549                                            <list>
5550                                                <t>The date and time of the last modification of the
5551                                                instrument's database settings, represented in
5552                                                "YYYY-MM-DD HH:MM:SS" format</t>
5553                                            </list>
5554                                        </t>
5555                                        <t>DESCRIPTION -
5556                                            <list>
5557                                                <t>A brief description of the instrument.
5558                                                Note that the character string may contain
5559                                                <xref target="character_set">escape sequences</xref>.</t>
5560                                            </list>
5561                                        </t>
5562                                        <t>IS_DRUM -
5563                                            <list>
5564                                                <t>either true or false, determines whether the
5565                                                instrument is a drumkit or a chromatic instrument</t>
5566                                            </list>
5567                                        </t>
5568                                        <t>PRODUCT -
5569                                            <list>
5570                                                <t>The product title of the instrument.
5571                                                Note that the character string may contain
5572                                                <xref target="character_set">escape sequences</xref>.</t>
5573                                            </list>
5574                                        </t>
5575                                        <t>ARTISTS -
5576                                            <list>
5577                                                <t>Lists the artist names.
5578                                                Note that the character string may contain
5579                                                <xref target="character_set">escape sequences</xref>.</t>
5580                                            </list>
5581                                        </t>
5582                                        <t>KEYWORDS -
5583                                            <list>
5584                                                <t>Provides a list of keywords that refer to the instrument.
5585                                                Keywords are separated with semicolon and blank.
5586                                                Note that the character string may contain
5587                                                <xref target="character_set">escape sequences</xref>.</t>
5588                                            </list>
5589                                        </t>
5590                                    </list>
5591                                </t>
5592                            </list>
5593                        </t>
5594                        <t>The mentioned fields above don't have to be in particular order.</t>
5595    
5596                        <t>Example:</t>
5597                        <t>
5598                            <list>
5599                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5600                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5601                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5602                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5603                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5604                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5605                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5606                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5607                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5608                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5609                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5610                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5611                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5612                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5613                            </list>
5614                        </t>
5615                    </section>
5616    
5617                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5618                        <t>The front-end can alter the name of a specific
5619                        instrument by sending the following command:</t>
5620                        <t>
5621                            <list>
5622                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5623                            </list>
5624                        </t>
5625                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5626                        &lt;name&gt; is the new name for that instrument.</t>
5627    
5628                        <t>Possible Answers:</t>
5629                        <t>
5630                            <list>
5631                                <t>"OK" -
5632                                    <list>
5633                                        <t>on success</t>
5634                                    </list>
5635                                </t>
5636                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5637                                    <list>
5638                                        <t>in case the given instrument does not exists,
5639                                        or if an instrument with name equal to the new
5640                                        name already exists.</t>
5641                                    </list>
5642                                </t>
5643                            </list>
5644                        </t>
5645    
5646                        <t>Example:</t>
5647                        <t>
5648                            <list>
5649                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5650                                <t>S: "OK"</t>
5651                            </list>
5652                        </t>
5653                    </section>
5654    
5655                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5656                        <t>The front-end can move a specific instrument to another directory by
5657                        sending the following command:</t>
5658                        <t>
5659                            <list>
5660                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5661                            </list>
5662                        </t>
5663                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5664                        to move and &lt;dst&gt; is the directory where the instrument will
5665                        be moved to.</t>
5666    
5667                        <t>Possible Answers:</t>
5668                        <t>
5669                            <list>
5670                                <t>"OK" -
5671                                    <list>
5672                                        <t>on success</t>
5673                                    </list>
5674                                </t>
5675                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5676                                    <list>
5677                                        <t>in case the given instrument does not exists,
5678                                        or if an instrument with name equal to the name of the
5679                                        specified instrument already exists in the destination
5680                                        directory.</t>
5681                                    </list>
5682                                </t>
5683                            </list>
5684                        </t>
5685    
5686                        <t>Example:</t>
5687                        <t>
5688                            <list>
5689                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5690                                <t>S: "OK"</t>
5691                            </list>
5692                        </t>
5693                    </section>
5694    
5695                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5696                        <t>The front-end can copy a specific instrument to another directory by
5697                        sending the following command:</t>
5698                        <t>
5699                            <list>
5700                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5701                            </list>
5702                        </t>
5703                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5704                        to copy and &lt;dst&gt; is the directory where the instrument will
5705                        be copied to.</t>
5706    
5707                        <t>Possible Answers:</t>
5708                        <t>
5709                            <list>
5710                                <t>"OK" -
5711                                    <list>
5712                                        <t>on success</t>
5713                                    </list>
5714                                </t>
5715                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5716                                    <list>
5717                                        <t>in case the given instrument does not exists,
5718                                        or if an instrument with name equal to the name of the
5719                                        specified instrument already exists in the destination
5720                                        directory.</t>
5721                                    </list>
5722                                </t>
5723                            </list>
5724                        </t>
5725    
5726                        <t>Example:</t>
5727                        <t>
5728                            <list>
5729                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5730                                <t>S: "OK"</t>
5731                            </list>
5732                        </t>
5733                    </section>
5734    
5735                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5736                        <t>The front-end can alter the description of a specific
5737                        instrument by sending the following command:</t>
5738                        <t>
5739                            <list>
5740                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5741                            </list>
5742                        </t>
5743                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5744                        &lt;desc&gt; is the new description for the instrument
5745                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5746                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5747    
5748                        <t>Possible Answers:</t>
5749                        <t>
5750                            <list>
5751                                <t>"OK" -
5752                                    <list>
5753                                        <t>on success</t>
5754                                    </list>
5755                                </t>
5756                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5757                                    <list>
5758                                        <t>in case the given instrument does not exists.</t>
5759                                    </list>
5760                                </t>
5761                            </list>
5762                        </t>
5763    
5764                        <t>Example:</t>
5765                        <t>
5766                            <list>
5767                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5768                                <t>S: "OK"</t>
5769                            </list>
5770                        </t>
5771                    </section>
5772    
5773                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5774                        <t>The front-end can search for instruments
5775                        in specific directory by sending the following command:</t>
5776                        <t>
5777                            <list>
5778                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5779                            </list>
5780                        </t>
5781                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5782                        name of the directory to search in. If NON_RECURSIVE is specified, the
5783                        directories located in subdirectories of the specified directory will not
5784                        be searched. &lt;criteria-list&gt; is a list of search criterias
5785                        in form of "key1=val1 key2=val2 ...". The following criterias are
5786                        allowed:</t>
5787                        <t>
5788                          <t>NAME='&lt;search-string&gt;'
5789                              <list>
5790                                  <t>Restricts the search to instruments, which names
5791                                  satisfy the supplied search string (encapsulated into apostrophes,
5792                                  supporting escape sequences as described in chapter
5793                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5794                              </list>
5795                          </t>
5796    
5797                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5798                              <list>
5799                                  <t>Restricts the search to instruments, which
5800                                  size is in the specified range. If &lt;min&gt; is omitted,
5801                                  the search results are restricted to instruments with size less then
5802                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5803                                  search is restricted to instruments with size greater then
5804                                  or equal to &lt;min&gt;.</t>
5805                              </list>
5806                          </t>
5807    
5808                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5809                              <list>
5810                                  <t>Restricts the search to instruments, which creation
5811                                  date satisfies the specified period, where &lt;date-after&gt;
5812                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5813                                  If &lt;date-after&gt; is omitted the search is restricted to
5814                                  instruments created before &lt;date-before&gt;. If
5815                                  &lt;date-before&gt; is omitted, the search is restricted
5816                                  to instruments created after &lt;date-after&gt;.</t>
5817                              </list>
5818                          </t>
5819    
5820                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5821                              <list>
5822                                  <t>Restricts the search to instruments, which
5823                                  date of last modification satisfies the specified period, where
5824                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5825                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5826                                  instruments, which are last modified before &lt;date-before&gt;. If
5827                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5828                                  which are last modified after &lt;date-after&gt;.</t>
5829                              </list>
5830                          </t>
5831    
5832                          <t>DESCRIPTION='&lt;search-string&gt;'
5833                              <list>
5834                                  <t>Restricts the search to instruments with description
5835                                  that satisfies the supplied search string (encapsulated into apostrophes,
5836                                  supporting escape sequences as described in chapter
5837                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5838                              </list>
5839                          </t>
5840    
5841                          <t>PRODUCT='&lt;search-string&gt;'
5842                              <list>
5843                                  <t>Restricts the search to instruments with product info
5844                                  that satisfies the supplied search string (encapsulated into apostrophes,
5845                                  supporting escape sequences as described in chapter
5846                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5847                              </list>
5848                          </t>
5849    
5850                          <t>ARTISTS='&lt;search-string&gt;'
5851                              <list>
5852                                  <t>Restricts the search to instruments with artists info
5853                                  that satisfies the supplied search string (encapsulated into apostrophes,
5854                                  supporting escape sequences as described in chapter
5855                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5856                              </list>
5857                          </t>
5858    
5859                          <t>KEYWORDS='&lt;search-string&gt;'
5860                              <list>
5861                                  <t>Restricts the search to instruments with keyword list
5862                                  that satisfies the supplied search string (encapsulated into apostrophes,
5863                                  supporting escape sequences as described in chapter
5864                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5865                              </list>
5866                          </t>
5867    
5868                          <t>IS_DRUM=true | false
5869                              <list>
5870                                  <t>Either true or false. Restricts the search to
5871                                  drum kits or chromatic instruments.</t>
5872                              </list>
5873                          </t>
5874    
5875                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5876                              <list>
5877                                  <t>Restricts the search to instruments of the supplied format families,
5878                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5879                              </list>
5880                          </t>
5881                        </t>
5882    
5883                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5884                        word list separated with spaces for OR search and with '+' for AND search.</t>
5885    
5886                        <t>Possible Answers:</t>
5887                        <t>
5888                            <list>
5889                                <t>A comma separated list with the absolute path names (encapsulated into
5890                                apostrophes) of all instruments in the specified directory that satisfy
5891                                the supplied search criterias.</t>
5892                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5893                                    <list>
5894                                        <t>if the given directory does not exist.</t>
5895                                    </list>
5896                                </t>
5897                            </list>
5898                        </t>
5899                        <t>Example:</t>
5900                        <t>
5901                            <list>
5902                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5903                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5904                            </list>
5905                        </t>
5906                        <t>
5907                            <list>
5908                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5909                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5910                            </list>
5911                        </t>
5912                    </section>
5913    
5914                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
5915                        <t>The front-end can ask for the current status of a
5916                        particular database instruments job by sending the following command:</t>
5917                        <t>
5918                            <list>
5919                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
5920                            </list>
5921                        </t>
5922                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
5923                        of the job the front-end is interested in.</t>
5924    
5925                        <t>Possible Answers:</t>
5926                        <t>
5927                            <list>
5928                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5929                                Each answer line begins with the settings category name
5930                                followed by a colon and then a space character &lt;SP&gt; and finally
5931                                the info character string to that setting category. At the
5932                                moment the following categories are defined:</t>
5933    
5934                                <t>
5935                                    <list>
5936                                        <t>FILES_TOTAL -
5937                                            <list>
5938                                                <t>The total number of files scheduled for scanning</t>
5939                                            </list>
5940                                        </t>
5941                                        <t>FILES_SCANNED -
5942                                            <list>
5943                                                <t>The current number of scanned files</t>
5944                                            </list>
5945                                        </t>
5946                                        <t>SCANNING -
5947                                            <list>
5948                                                <t>The absolute path name of the file which is currently
5949                                                being scanned</t>
5950                                            </list>
5951                                        </t>
5952                                        <t>STATUS -
5953                                            <list>
5954                                                <t>An integer value between 0 and 100 indicating the
5955                                                scanning progress percentage of the file which is
5956                                                currently being scanned</t>
5957                                            </list>
5958                                        </t>
5959                                    </list>
5960                                </t>
5961                            </list>
5962                        </t>
5963                        <t>The mentioned fields above don't have to be in particular order.</t>
5964    
5965                        <t>Example:</t>
5966                        <t>
5967                            <list>
5968                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
5969                                <t>S: "FILES_TOTAL: 12"</t>
5970                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
5971                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
5972                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
5973                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5974                            </list>
5975                        </t>
5976                    </section>
5977    
5978                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5979                        <t>The front-end can remove all instruments and directories and re-create
5980                        the instruments database structure (e.g., in case of a database corruption)
5981                        by sending the following command:</t>
5982                        <t>
5983                            <list>
5984                                <t>FORMAT INSTRUMENTS_DB</t>
5985                            </list>
5986                        </t>
5987    
5988                        <t>Possible Answers:</t>
5989                        <t>
5990                            <list>
5991                                <t>"OK" -
5992                                    <list>
5993                                        <t>on success</t>
5994                                    </list>
5995                                </t>
5996                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5997                                    <list>
5998                                        <t>If the formatting of the instruments database
5999                                        failed.</t>
6000                                    </list>
6001                                </t>
6002                            </list>
6003                        </t>
6004                    </section>
6005    
6006                </section>
6007    
6008    
6009    
6010                <section title="Editing Instruments" anchor="editing_instruments">
6011                    <t>The sampler allows to edit instruments while playing with the
6012                    sampler by spawning an external (3rd party) instrument editor
6013                    application for a given instrument. The 3rd party instrument
6014                    editor applications have to place a respective plugin DLL file
6015                    into the sampler's plugins directory. The sampler will
6016                    automatically try to load all plugin DLLs in that directory on
6017                    startup and only on startup!</t>
6018                    <t>At the moment there is only one command for this feature set,
6019                    but this will most probably change in future.</t>
6020    
6021                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
6022                        <t>The front-end can request to open an appropriate instrument
6023                        editor application by sending the following command:</t>
6024                        <t>
6025                            <list>
6026                                <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6027                            </list>
6028                        </t>
6029                        <t>Where &lt;sampler-channel&gt; should be replaced by the
6030                        number of the sampler channel as given by the
6031                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
6032                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
6033                        command.</t>
6034    
6035                        <t>The sampler will try to ask all registered instrument
6036                        editors (or to be more specific: their sampler plugins)
6037                        whether they are capable to handle the instrument on the
6038                        given sampler channel. The sampler will simply use the first
6039                        instrument editor application which replied with a positive
6040                        answer and spawn that instrument editor application within
6041                        the sampler's process and provide that application access
6042                        to the instrument's data structures, so both applications
6043                        can share and access the same instruments data at the same
6044                        time, thus allowing to immediately hear changes with the
6045                        sampler made by the instrument editor.</t>
6046    
6047                        <t>Note: consequently instrument editors are always spawned
6048                        locally on the same machine where the sampler is running
6049                        on!</t>
6050    
6051                        <t>Possible Answers:</t>
6052                        <t>
6053                            <list>
6054                                <t>"OK" -
6055                                    <list>
6056                                        <t>when an appropriate instrument editor was
6057                                        launched</t>
6058                                    </list>
6059                                </t>
6060                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6061                                    <list>
6062                                        <t>when an appropriate instrument editor was
6063                                        launched, but there are noteworthy issues</t>
6064                                    </list>
6065                                </t>
6066                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6067                                    <list>
6068                                        <t>when an appropriate instrument editor
6069                                        could not be launched</t>
6070                                    </list>
6071                                </t>
6072                            </list>
6073                        </t>
6074    
6075                        <t>Examples:</t>
6076                        <t>
6077                            <list>
6078                                <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6079                                <t>S: "OK"</t>
6080                            </list>
6081                        </t>
6082                    </section>
6083                </section>
6084    
6085                <section title="Managing Files" anchor="file_management">
6086                    <t>You can query detailed informations about files located
6087                    at the same system where the sampler instance is running on.
6088                    Using this command set allows to retrieve file informations
6089                    even remotely from another machine.</t>
6090    
6091                    <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6092                        <t>The front-end can retrieve the amount of instruments
6093                        within a given instrument file by sending the
6094                        following command:</t>
6095                        <t>
6096                            <list>
6097                                <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6098                            </list>
6099                        </t>
6100                        <t>Where &lt;filename&gt; is the name of the instrument
6101                        file (encapsulated into apostrophes, supporting escape
6102                        sequences as described in chapter
6103                        "<xref target="character_set">Character Set and Escape
6104                            Sequences</xref>").</t>
6105    
6106                        <t>The sampler will try to ask all sampler engines,
6107                        whether they support the given file and ask the first
6108                        engine with a positive answer for the amount of
6109                        instruments.</t>
6110    
6111                        <t>Possible Answers:</t>
6112                        <t>
6113                            <list>
6114                                <t>On success, the sampler will answer by
6115                                   returning the amount of instruments.
6116                                </t>
6117                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6118                                    <list>
6119                                        <t>if the file could not be handled</t>
6120                                    </list>
6121                                </t>
6122                            </list>
6123                        </t>
6124    
6125                        <t>Examples:</t>
6126                        <t>
6127                            <list>
6128                                <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6129                                <t>S: "10"</t>
6130                            </list>
6131                        </t>
6132                    </section>
6133    
6134                    <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6135                        <t>The front-end can retrieve a list of all instruments
6136                        within a given instrument file by sending the
6137                        following command:</t>
6138                        <t>
6139                            <list>
6140                                <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6141                            </list>
6142                        </t>
6143                        <t>Where &lt;filename&gt; is the name of the instrument
6144                        file (encapsulated into apostrophes, supporting escape
6145                        sequences as described in chapter
6146                        "<xref target="character_set">Character Set and Escape
6147                            Sequences</xref>").</t>
6148    
6149                        <t>The sampler will try to ask all sampler engines,
6150                        whether they support the given file and ask the first
6151                        engine with a positive answer for a list of IDs for the
6152                        instruments in the given file.</t>
6153    
6154                        <t>Possible Answers:</t>
6155                        <t>
6156                            <list>
6157                                <t>On success, the sampler will answer by
6158                                   returning a comma separated list of
6159                                   instrument IDs.
6160                                </t>
6161                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6162                                    <list>
6163                                        <t>if the file could not be handled</t>
6164                                    </list>
6165                                </t>
6166                            </list>
6167                        </t>
6168    
6169                        <t>Examples:</t>
6170                        <t>
6171                            <list>
6172                                <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6173                                <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6174                            </list>
6175                        </t>
6176                    </section>
6177    
6178                    <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6179                        <t>The front-end can retrieve detailed informations
6180                        about a specific instrument within a given instrument
6181                        file by sending the following command:</t>
6182                        <t>
6183                            <list>
6184                                <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6185                                &lt;instr-id&gt;</t>
6186                            </list>
6187                        </t>
6188                        <t>Where &lt;filename&gt; is the name of the instrument
6189                        file (encapsulated into apostrophes, supporting escape
6190                        sequences as described in chapter
6191                        "<xref target="character_set">Character Set and Escape
6192                            Sequences</xref>") and &lt;instr-id&gt; is the numeric
6193                        instrument ID as returned by the
6194                        <xref target="LIST FILE INSTRUMENTS">
6195                        "LIST FILE INSTRUMENTS"</xref> command.</t>
6196    
6197                        <t>The sampler will try to ask all sampler engines,
6198                        whether they support the given file and ask the first
6199                        engine with a positive answer for informations about the
6200                        specific instrument in the given file.</t>
6201    
6202                        <t>Possible Answers:</t>
6203                        <t>
6204                            <list>
6205                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6206                                Each answer line begins with the settings category name
6207                                followed by a colon and then a space character &lt;SP&gt; and finally
6208                                the info character string to that setting category. At the
6209                                moment the following categories are defined:</t>
6210    
6211                                <t>
6212                                    <list>
6213                                        <t>NAME -
6214                                            <list>
6215                                                <t>name of the instrument as
6216                                                stored in the instrument file</t>
6217                                            </list>
6218                                        </t>
6219                                        <t>FORMAT_FAMILY -
6220                                            <list>
6221                                                <t>name of the sampler format
6222                                                of the given instrument</t>
6223                                            </list>
6224                                        </t>
6225                                        <t>FORMAT_VERSION -
6226                                            <list>
6227                                                <t>version of the sampler format
6228                                                the instrumen is stored as</t>
6229                                            </list>
6230                                        </t>
6231                                        <t>PRODUCT -
6232                                            <list>
6233                                                <t>official product name of the
6234                                                instrument as stored in the file
6235                                                </t>
6236                                            </list>
6237                                        </t>
6238                                        <t>ARTISTS -
6239                                            <list>
6240                                                <t>artists / sample library
6241                                                vendor of the instrument</t>
6242                                            </list>
6243                                        </t>
6244                                    </list>
6245                                </t>
6246                            </list>
6247                        </t>
6248                        <t>The mentioned fields above don't have to be in particular order.</t>
6249    
6250                        <t>Example:</t>
6251                        <t>
6252                            <list>
6253                                <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6254                                <t>S: "NAME: Lunatic Loops"</t>
6255                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6256                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6257                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6258                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6259                                <t>&nbsp;&nbsp;&nbsp;"."</t>
6260                            </list>
6261                        </t>
6262                    </section>
6263                </section>
6264            </section>
6265    
6266          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
6267              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
# Line 4809  Schoenebeck'> Line 6335  Schoenebeck'>
6335                  </t>                  </t>
6336                  <t>/ UNSUBSCRIBE SP unsubscribe_event                  <t>/ UNSUBSCRIBE SP unsubscribe_event
6337                  </t>                  </t>
                 <t>/ SELECT SP text  
                 </t>  
6338                  <t>/ RESET SP reset_instruction                  <t>/ RESET SP reset_instruction
6339                  </t>                  </t>
6340                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
6341                  </t>                  </t>
6342                    <t>/ FIND SP find_instruction
6343                    </t>
6344                    <t>/ MOVE SP move_instruction
6345                    </t>
6346                    <t>/ COPY SP copy_instruction
6347                    </t>
6348                    <t>/ EDIT SP edit_instruction
6349                    </t>
6350                    <t>/ FORMAT SP format_instruction
6351                    </t>
6352                  <t>/ RESET                  <t>/ RESET
6353                  </t>                  </t>
6354                  <t>/ QUIT                  <t>/ QUIT
# Line 4825  Schoenebeck'> Line 6359  Schoenebeck'>
6359          <list>          <list>
6360                  <t>CHANNEL                  <t>CHANNEL
6361                  </t>                  </t>
6362                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6363                    </t>
6364                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6365                    </t>
6366                    <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6367                    </t>
6368                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6369                    </t>
6370                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
6371                    </t>
6372                    <t>/ DB_INSTRUMENTS SP db_path SP filename
6373                    </t>
6374                    <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6375                    </t>
6376                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
6377                  </t>                  </t>
6378                  <t>/ MIDI_INSTRUMENT_MAP SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP map_name
# Line 4863  Schoenebeck'> Line 6411  Schoenebeck'>
6411                  </t>                  </t>
6412                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
6413                  </t>                  </t>
6414                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6415                    </t>
6416                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6417                    </t>
6418                    <t>/ DB_INSTRUMENT_COUNT
6419                    </t>
6420                    <t>/ DB_INSTRUMENT_INFO
6421                    </t>
6422                    <t>/ DB_INSTRUMENTS_JOB_INFO
6423                    </t>
6424                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6425                  </t>                  </t>
6426                    <t>/ TOTAL_STREAM_COUNT
6427                    </t>
6428                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6429                  </t>                  </t>
6430                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 4903  Schoenebeck'> Line 6463  Schoenebeck'>
6463                  </t>                  </t>
6464                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
6465                  </t>                  </t>
6466                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6467                    </t>
6468                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6469                    </t>
6470                    <t>/ DB_INSTRUMENT_COUNT
6471                    </t>
6472                    <t>/ DB_INSTRUMENT_INFO
6473                    </t>
6474                    <t>/ DB_INSTRUMENTS_JOB_INFO
6475                    </t>
6476                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6477                  </t>                  </t>
6478                    <t>/ TOTAL_STREAM_COUNT
6479                    </t>
6480                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6481                  </t>                  </t>
6482                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 4937  Schoenebeck'> Line 6509  Schoenebeck'>
6509                  </t>                  </t>
6510                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6511                  </t>                  </t>
6512                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6513                    </t>
6514                    <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6515                    </t>
6516                    <t>/ DB_INSTRUMENT SP db_path
6517                    </t>
6518          </list>          </list>
6519  </t>  </t>
6520  <t>get_instruction =  <t>get_instruction =
# Line 4989  Schoenebeck'> Line 6567  Schoenebeck'>
6567                  </t>                  </t>
6568                  <t>/ SERVER SP INFO                  <t>/ SERVER SP INFO
6569                  </t>                  </t>
6570                    <t>/ TOTAL_STREAM_COUNT
6571                    </t>
6572                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6573                  </t>                  </t>
6574                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
# Line 5007  Schoenebeck'> Line 6587  Schoenebeck'>
6587                  </t>                  </t>
6588                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6589                  </t>                  </t>
6590                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6591                    </t>
6592                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6593                    </t>
6594                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6595                    </t>
6596                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6597                    </t>
6598                    <t>/ DB_INSTRUMENTS SP db_path
6599                    </t>
6600                    <t>/ DB_INSTRUMENT SP INFO SP db_path
6601                    </t>
6602                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6603                    </t>
6604                  <t>/ VOLUME                  <t>/ VOLUME
6605                  </t>                  </t>
6606                    <t>/ FILE SP INSTRUMENTS SP filename
6607                    </t>
6608                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6609                    </t>
6610          </list>          </list>
6611  </t>  </t>
6612  <t>set_instruction =  <t>set_instruction =
# Line 5019  Schoenebeck'> Line 6617  Schoenebeck'>
6617                  </t>                  </t>
6618                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6619                  </t>                  </t>
6620                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6621                    </t>
6622                  <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
6623                  </t>                  </t>
6624                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
# Line 5033  Schoenebeck'> Line 6633  Schoenebeck'>
6633                  </t>                  </t>
6634                  <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
6635                  </t>                  </t>
6636                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6637                    </t>
6638                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6639                    </t>
6640                    <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6641                    </t>
6642                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6643                    </t>
6644                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6645                  </t>                  </t>
6646                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
# Line 5069  Schoenebeck'> Line 6677  Schoenebeck'>
6677                  </t>                  </t>
6678          </list>          </list>
6679  </t>  </t>
6680    <t>find_instruction =
6681            <list>
6682                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6683                    </t>
6684                    <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6685                    </t>
6686                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
6687                    </t>
6688                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6689                    </t>
6690            </list>
6691    </t>
6692    <t>move_instruction =
6693            <list>
6694                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6695                    </t>
6696                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6697                    </t>
6698            </list>
6699    </t>
6700    <t>copy_instruction =
6701            <list>
6702                    <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6703                    </t>
6704                    <t>/ DB_INSTRUMENT SP db_path SP db_path
6705                    </t>
6706            </list>
6707    </t>
6708  <t>destroy_instruction =  <t>destroy_instruction =
6709          <list>          <list>
6710                  <t>AUDIO_OUTPUT_DEVICE SP number                  <t>AUDIO_OUTPUT_DEVICE SP number
# Line 5119  Schoenebeck'> Line 6755  Schoenebeck'>
6755                  </t>                  </t>
6756          </list>          </list>
6757  </t>  </t>
6758    <t>edit_instruction =
6759            <list>
6760                    <t>CHANNEL SP INSTRUMENT SP sampler_channel
6761                    </t>
6762            </list>
6763    </t>
6764    <t>format_instruction =
6765            <list>
6766                    <t>INSTRUMENTS_DB
6767                    </t>
6768            </list>
6769    </t>
6770  <t>modal_arg =  <t>modal_arg =
6771          <list>          <list>
6772                  <t>/* epsilon (empty argument) */                  <t>/* epsilon (empty argument) */
# Line 5165  Schoenebeck'> Line 6813  Schoenebeck'>
6813                  </t>                  </t>
6814                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6815                  </t>                  </t>
6816                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6817                    </t>
6818                    <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6819                    </t>
6820                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6821                    </t>
6822                    <t>/ DB_INSTRUMENTS SP db_path
6823                    </t>
6824                    <t>/ FILE SP INSTRUMENTS SP filename
6825                    </t>
6826          </list>          </list>
6827  </t>  </t>
6828  <t>load_instr_args =  <t>load_instr_args =
# Line 5287  Schoenebeck'> Line 6945  Schoenebeck'>
6945  </t>  </t>
6946  <t>filename =  <t>filename =
6947          <list>          <list>
6948                  <t>stringval                  <t>path
6949                    </t>
6950            </list>
6951    </t>
6952    <t>db_path =
6953            <list>
6954                    <t>path
6955                  </t>                  </t>
6956          </list>          </list>
6957  </t>  </t>
6958  <t>map_name =  <t>map_name =
6959          <list>          <list>
6960                  <t>stringval                  <t>stringval_escaped
6961                  </t>                  </t>
6962          </list>          </list>
6963  </t>  </t>
6964  <t>entry_name =  <t>entry_name =
6965          <list>          <list>
6966                  <t>stringval                  <t>stringval_escaped
6967                  </t>                  </t>
6968          </list>          </list>
6969  </t>  </t>
6970  <t>fx_send_name =  <t>fx_send_name =
6971          <list>          <list>
6972                  <t>stringval                  <t>stringval_escaped
6973                  </t>                  </t>
6974          </list>          </list>
6975  </t>  </t>
# Line 5317  Schoenebeck'> Line 6981  Schoenebeck'>
6981                  </t>                  </t>
6982          </list>          </list>
6983  </t>  </t>
6984    
6985  <t>param_val =  <t>param_val =
6986          <list>          <list>
6987                  <t>string                  <t>string
# Line 5329  Schoenebeck'> Line 6994  Schoenebeck'>
6994                  </t>                  </t>
6995          </list>          </list>
6996  </t>  </t>
6997    <t>query_val_list =
6998            <list>
6999                    <t>string '=' query_val
7000                    </t>
7001                    <t>/ query_val_list SP string '=' query_val
7002                    </t>
7003            </list>
7004    </t>
7005    <t>query_val =
7006            <list>
7007                    <t>text_escaped
7008                    </t>
7009                    <t>/ stringval_escaped
7010                    </t>
7011            </list>
7012    </t>
7013    <t>scan_mode =
7014            <list>
7015                    <t>RECURSIVE
7016                    </t>
7017                    <t>/ NON_RECURSIVE
7018                    </t>
7019                    <t>/ FLAT
7020                    </t>
7021            </list>
7022    </t>
7023    
7024              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
7025    
7026                <section title="Character Set and Escape Sequences" anchor="character_set">
7027                    <t>Older versions of this protocol up to and including v1.1 only
7028                    supported the standard ASCII character set (ASCII code 0 - 127)
7029                    <xref target="RFC20"/>, all younger versions of this protocol
7030                    however support the Extended ASCII character set (ASCII code
7031                    0 - 255). The same group of younger protocols also support
7032                    escape sequences, but only for certain, explicitly declared
7033                    parts of the protocol. The supported escape sequences are
7034                    defined as follows:</t>
7035                    <texttable>
7036                        <ttcol>ASCII Character Sequence</ttcol>
7037                        <ttcol>Translated into (Name)</ttcol>
7038                        <c>\n</c> <c>new line</c>
7039                        <c>\r</c> <c>carriage return</c>
7040                        <c>\f</c> <c>form feed</c>
7041                        <c>\t</c> <c>horizontal tab</c>
7042                        <c>\v</c> <c>vertical tab</c>
7043                        <c>\'</c> <c>apostrophe</c>
7044                        <c>\"</c> <c>quotation mark</c>
7045                        <c>\\</c> <c>backslash</c>
7046                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
7047                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
7048                    </texttable>
7049                    <t>Notice: due to the transition of certain parts of the
7050                    protocol which now support escape sequences, a slight backward
7051                    incompatibility to protocols version v1.1 and younger has been
7052                    introduced. The only difference is that in parts of the protocol
7053                    where escape characters are now supported, a backslash characters
7054                    MUST be escaped as well (that is as double backslash), whereas
7055                    in the old versions a single backslash was sufficient.</t>
7056    
7057                    <t>The following LSCP commands support escape sequences as part
7058                    of their filename / path based arguments and / or may contain
7059                    a filename / path with escape sequences in their response:
7060                    <list>
7061                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
7062                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7063                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7064                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7065                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
7066                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
7067                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7068                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
7069                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
7070                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
7071                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7072                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
7073                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
7074                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7075                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7076                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7077                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7078                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7079                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7080                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7081                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
7082                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7083                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7084                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7085                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7086                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7087                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7088                    </list>
7089                    Note that the forward slash character ('/') has a special meaning in
7090                    filename / path based arguments: it acts as separator of the nodes in
7091                    the path, thus if a directory- or filename includes a forward slash
7092                    (not intended as path node separator), you MUST escape that slash
7093                    either with the respective hex escape sequence ("\x2f") or with the
7094                    respective octal escape sequence ("\057").
7095                    </t>
7096    
7097                    <t>
7098                    Note for Windows: file path arguments in LSCP are expected
7099                    to use forward slashes as directory node separator similar
7100                    to Unix based operating systems. In contrast to Unix however
7101                    a Windows typical drive character is expected to be
7102                    prefixed to the path. That is an original Windows file path
7103                    like "D:\Sounds\My.gig" would become in LSCP:
7104                    "D:/Sounds/My.gig".
7105                    </t>
7106    
7107                    <t>
7108                    The following LSCP commands even support escape sequences as
7109                    part of at least one of their text-based arguments (i.e. entity name,
7110                    description) and / or may contain escape sequences in at least one of
7111                    their text-based fields in their response:
7112                    <list>
7113                        <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
7114                        <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
7115                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7116                        <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
7117                        <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
7118                        <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
7119                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7120                        <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
7121                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
7122                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7123                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
7124                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7125                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7126                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7127                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7128                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7129                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7130                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7131                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7132                    </list>
7133                    Please note that these lists are manually maintained. If you
7134                    find a command that also supports escape sequences we forgot to
7135                    mention here, please report it!
7136                    </t>
7137                </section>
7138          </section>          </section>
7139    
7140          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 5516  Schoenebeck'> Line 7320  Schoenebeck'>
7320              </section>              </section>
7321    
7322              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
7323                  <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
7324                  a particular sampler channel is changed by issuing the following command:</t>                  a particular sampler channel is changed by issuing the following command:</t>
7325                  <t>                  <t>
7326                      <list>                      <list>
# Line 5571  Schoenebeck'> Line 7375  Schoenebeck'>
7375                  all currently active voices.</t>                  all currently active voices.</t>
7376              </section>              </section>
7377    
7378                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7379                    <t>Client may want to be notified when the total number of disk streams on the
7380                    back-end changes by issuing the following command:</t>
7381                    <t>
7382                        <list>
7383                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7384                        </list>
7385                    </t>
7386                    <t>Server will start sending the following notification messages:</t>
7387                    <t>
7388                        <list>
7389                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7390                        </list>
7391                    </t>
7392                    <t>where &lt;streams&gt; will be replaced by the new number of
7393                    all currently active disk streams.</t>
7394                </section>
7395    
7396              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">              <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
7397                  <t>Client may want to be notified when the number of MIDI instrument maps on the                  <t>Client may want to be notified when the number of MIDI instrument maps on the
7398                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 5672  Schoenebeck'> Line 7494  Schoenebeck'>
7494                  </t>                  </t>
7495              </section>              </section>
7496    
7497                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
7498                    <t>Client may want to be notified when the number of instrument
7499                    directories in a particular directory in the instruments database
7500                    is changed by issuing the following command:</t>
7501                    <t>
7502                        <list>
7503                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
7504                        </list>
7505                    </t>
7506                    <t>Server will start sending the following notification messages:</t>
7507                    <t>
7508                        <list>
7509                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
7510                        </list>
7511                    </t>
7512                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7513                    name of the directory in the instruments database,
7514                    in which the number of directories is changed.</t>
7515                    <t>Note that when a non-empty directory is removed, this event
7516                    is not sent for the subdirectories in that directory.</t>
7517                </section>
7518    
7519                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
7520                    <t>Client may want to be notified when changes were made to directories
7521                    in the instruments database by issuing the following command:</t>
7522                    <t>
7523                        <list>
7524                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
7525                        </list>
7526                    </t>
7527                    <t>Server will start sending the following notification messages:</t>
7528                    <t>
7529                        <list>
7530                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
7531                        </list>
7532                    </t>
7533                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
7534                    of the directory, for which information changes occurred. The front-end will have to send
7535                    the respective command to actually get the updated directory info. Because these messages
7536                    will be triggered by LSCP commands issued by other clients rather than real
7537                    time events happening on the server, it is believed that an empty notification
7538                    message is sufficient here.</t>
7539                    <t>
7540                        <list>
7541                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
7542                        </list>
7543                    </t>
7544                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
7545                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7546                    the new name of the directory, encapsulated into apostrophes.</t>
7547                </section>
7548    
7549                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
7550                    <t>Client may want to be notified when the number of instruments
7551                    in a particular directory in the instruments database
7552                    is changed by issuing the following command:</t>
7553                    <t>
7554                        <list>
7555                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
7556                        </list>
7557                    </t>
7558                    <t>Server will start sending the following notification messages:</t>
7559                    <t>
7560                        <list>
7561                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
7562                        </list>
7563                    </t>
7564                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7565                    name of the directory in the instruments database,
7566                    in which the number of instruments is changed.</t>
7567                    <t>Note that when a non-empty directory is removed, this event
7568                    is not sent for the instruments in that directory.</t>
7569                </section>
7570    
7571                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
7572                    <t>Client may want to be notified when changes were made to instruments
7573                    in the instruments database by issuing the following command:</t>
7574                    <t>
7575                        <list>
7576                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
7577                        </list>
7578                    </t>
7579                    <t>Server will start sending the following notification messages:</t>
7580                    <t>
7581                        <list>
7582                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
7583                        </list>
7584                    </t>
7585                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
7586                    of the instrument, which settings are changed. The front-end will have to send
7587                    the respective command to actually get the updated directory info. Because these messages
7588                    will be triggered by LSCP commands issued by other clients rather than real
7589                    time events happening on the server, it is believed that an empty notification
7590                    message is sufficient here.</t>
7591                    <t>
7592                        <list>
7593                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
7594                        </list>
7595                    </t>
7596                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
7597                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7598                    the new name of the instrument, encapsulated into apostrophes.</t>
7599                </section>
7600    
7601                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7602                    <t>Client may want to be notified when the status of particular database
7603                    instruments job is changed by issuing the following command:</t>
7604                    <t>
7605                        <list>
7606                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7607                        </list>
7608                    </t>
7609                    <t>Server will start sending the following notification messages:</t>
7610                    <t>
7611                        <list>
7612                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7613                        </list>
7614                    </t>
7615                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7616                    which status is changed. The front-end will have to send the respective
7617                    command to actually get the status info. Because these messages
7618                    will be triggered by LSCP commands issued by other clients rather than real
7619                    time events happening on the server, it is believed that an empty notification
7620                    message is sufficient here.</t>
7621                </section>
7622    
7623              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7624                  <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
7625                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
# Line 5750  Schoenebeck'> Line 7698  Schoenebeck'>
7698                  </front>                  </front>
7699                  <seriesInfo name="RFC" value="2234" />                  <seriesInfo name="RFC" value="2234" />
7700              </reference>              </reference>
7701                <reference anchor="RFC20">
7702                    <front>
7703                        <title>ASCII format for Network Interchange</title>
7704                        <author>
7705                            <organization>UCLA</organization>
7706                        </author>
7707                        <date year="1969"></date>
7708                    </front>
7709                    <seriesInfo name="RFC" value="20" />
7710                </reference>
7711           </references>           </references>
7712      </back>      </back>
7713    
Legend:
Removed from v.1136  
changed lines
  Added in v.1554
  ViewVC Help
Powered by ViewVC