/[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 1250 by schoenebeck, Fri Jun 22 14:21:03 2007 UTC revision 1686 by schoenebeck, Thu Feb 14 14:58:50 2008 UTC
# Line 16  Line 16 
16       to an annoying "missing Normative/Informative References" error message -->       to an annoying "missing Normative/Informative References" error message -->
17  <?rfc strict="no" ?>  <?rfc strict="no" ?>
18    
19  <rfc category="std" ipr="full3978" docName="LSCP 1.2cvs">  <rfc category="std" ipr="full3978" docName="LSCP 1.4">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol (draft)</title>          <title>LinuxSampler Control Protocol</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
23  Schoenebeck'>  Schoenebeck'>
24              <organization>              <organization>
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="June" year="2007"/>          <date month="February" year="2008"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# 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 2154  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 2435  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 2519  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 2529  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 3247  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 3437  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 3500  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 3904  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 3951  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 4067  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 4077  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 4248  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 4284  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 4415  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 4641  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 4652  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 4664  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 4752  Schoenebeck'> Line 4814  Schoenebeck'>
4814              <section title="Managing Instruments Database" anchor="Managing Instruments Database">              <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4815                  <t>The following commands describe how to use and manage                  <t>The following commands describe how to use and manage
4816                  the instruments database.</t>                  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">                  <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                      <t>The front-end can add a new instrument directory to the
# Line 4929  Schoenebeck'> Line 5003  Schoenebeck'>
5003                                  <list>                                  <list>
5004                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
5005                                          <list>                                          <list>
5006                                              <t>A brief description of the directory content</t>                                              <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>                                          </list>
5010                                      </t>                                      </t>
5011                                      <t>CREATED -                                      <t>CREATED -
# Line 5093  Schoenebeck'> Line 5169  Schoenebeck'>
5169                          </list>                          </list>
5170                      </t>                      </t>
5171                      <t>Where &lt;dir&gt; is the absolute path name of the directory and                      <t>Where &lt;dir&gt; is the absolute path name of the directory and
5172                      &lt;desc&gt; is the new description for the directory.</t>                      &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>                      <t>Possible Answers:</t>
5177                      <t>                      <t>
# Line 5138  Schoenebeck'> Line 5216  Schoenebeck'>
5216                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5217                            <list>                            <list>
5218                                <t>Restricts the search to directories, which names                                <t>Restricts the search to directories, which names
5219                                satisfy the supplied search string.</t>                                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>                            </list>
5223                        </t>                        </t>
5224    
# Line 5169  Schoenebeck'> Line 5249  Schoenebeck'>
5249                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5250                            <list>                            <list>
5251                                <t>Restricts the search to directories with description                                <t>Restricts the search to directories with description
5252                                that satisfies the supplied search string.</t>                                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>                            </list>
5257                        </t>                        </t>
5258                      </t>                      </t>
# Line 5430  Schoenebeck'> Line 5513  Schoenebeck'>
5513                                  <list>                                  <list>
5514                                      <t>INSTRUMENT_FILE -                                      <t>INSTRUMENT_FILE -
5515                                          <list>                                          <list>
5516                                              <t>File name of the instrument.</t>                                              <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>                                          </list>
5520                                      </t>                                      </t>
5521                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 5469  Schoenebeck'> Line 5554  Schoenebeck'>
5554                                      </t>                                      </t>
5555                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
5556                                          <list>                                          <list>
5557                                              <t>A brief description of the instrument</t>                                              <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>                                          </list>
5561                                      </t>                                      </t>
5562                                      <t>IS_DRUM -                                      <t>IS_DRUM -
# Line 5480  Schoenebeck'> Line 5567  Schoenebeck'>
5567                                      </t>                                      </t>
5568                                      <t>PRODUCT -                                      <t>PRODUCT -
5569                                          <list>                                          <list>
5570                                              <t>The product title of the instrument</t>                                              <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>                                          </list>
5574                                      </t>                                      </t>
5575                                      <t>ARTISTS -                                      <t>ARTISTS -
5576                                          <list>                                          <list>
5577                                              <t>Lists the artist names</t>                                              <t>Lists the artist names.
5578                                                Note that the character string may contain
5579                                                <xref target="character_set">escape sequences</xref>.</t>
5580                                          </list>                                          </list>
5581                                      </t>                                      </t>
5582                                      <t>KEYWORDS -                                      <t>KEYWORDS -
5583                                          <list>                                          <list>
5584                                              <t>Provides a list of keywords that refer to the instrument.                                              <t>Provides a list of keywords that refer to the instrument.
5585                                              Keywords are separated with semicolon and blank.</t>                                              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>                                          </list>
5589                                      </t>                                      </t>
5590                                  </list>                                  </list>
# Line 5648  Schoenebeck'> Line 5741  Schoenebeck'>
5741                          </list>                          </list>
5742                      </t>                      </t>
5743                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5744                      &lt;desc&gt; is the new description for the instrument.</t>                      &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>                      <t>Possible Answers:</t>
5749                      <t>                      <t>
# Line 5693  Schoenebeck'> Line 5788  Schoenebeck'>
5788                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5789                            <list>                            <list>
5790                                <t>Restricts the search to instruments, which names                                <t>Restricts the search to instruments, which names
5791                                satisfy the supplied search string.</t>                                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>                            </list>
5795                        </t>                        </t>
5796    
# Line 5735  Schoenebeck'> Line 5832  Schoenebeck'>
5832                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5833                            <list>                            <list>
5834                                <t>Restricts the search to instruments with description                                <t>Restricts the search to instruments with description
5835                                that satisfies the supplied search string.</t>                                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>                            </list>
5839                        </t>                        </t>
5840    
5841                        <t>PRODUCT='&lt;search-string&gt;'                        <t>PRODUCT='&lt;search-string&gt;'
5842                            <list>                            <list>
5843                                <t>Restricts the search to instruments with product info                                <t>Restricts the search to instruments with product info
5844                                that satisfies the supplied search string.</t>                                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>                            </list>
5848                        </t>                        </t>
5849    
5850                        <t>ARTISTS='&lt;search-string&gt;'                        <t>ARTISTS='&lt;search-string&gt;'
5851                            <list>                            <list>
5852                                <t>Restricts the search to instruments with artists info                                <t>Restricts the search to instruments with artists info
5853                                that satisfies the supplied search string.</t>                                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>                            </list>
5857                        </t>                        </t>
5858    
5859                        <t>KEYWORDS='&lt;search-string&gt;'                        <t>KEYWORDS='&lt;search-string&gt;'
5860                            <list>                            <list>
5861                                <t>Restricts the search to instruments with keyword list                                <t>Restricts the search to instruments with keyword list
5862                                that satisfies the supplied search string.</t>                                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>                            </list>
5866                        </t>                        </t>
5867    
# Line 5870  Schoenebeck'> Line 5975  Schoenebeck'>
5975                      </t>                      </t>
5976                  </section>                  </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>              </section>
6007    
         </section>  
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"/>
6268              is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)              is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
# Line 5959  Schoenebeck'> Line 6347  Schoenebeck'>
6347                  </t>                  </t>
6348                  <t>/ EDIT SP edit_instruction                  <t>/ EDIT SP edit_instruction
6349                  </t>                  </t>
6350                    <t>/ FORMAT SP format_instruction
6351                    </t>
6352                  <t>/ RESET                  <t>/ RESET
6353                  </t>                  </t>
6354                  <t>/ QUIT                  <t>/ QUIT
# Line 5969  Schoenebeck'> Line 6359  Schoenebeck'>
6359          <list>          <list>
6360                  <t>CHANNEL                  <t>CHANNEL
6361                  </t>                  </t>
6362                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6363                  </t>                  </t>
6364                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6365                  </t>                  </t>
6366                  <t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6367                  </t>                  </t>
6368                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6369                  </t>                  </t>
6370                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
6371                  </t>                  </t>
6372                  <t>/ DB_INSTRUMENTS SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP db_path SP filename
6373                  </t>                  </t>
6374                  <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index                  <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6375                  </t>                  </t>
6376                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
6377                  </t>                  </t>
# Line 6001  Schoenebeck'> Line 6391  Schoenebeck'>
6391                  </t>                  </t>
6392                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6393                  </t>                  </t>
6394                    <t>/ CHANNEL_MIDI
6395                    </t>
6396                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6397                  </t>                  </t>
6398                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6033  Schoenebeck'> Line 6425  Schoenebeck'>
6425                  </t>                  </t>
6426                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6427                  </t>                  </t>
6428                    <t>/ TOTAL_STREAM_COUNT
6429                    </t>
6430                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6431                  </t>                  </t>
6432                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6051  Schoenebeck'> Line 6445  Schoenebeck'>
6445                  </t>                  </t>
6446                  <t>/ CHANNEL_COUNT                  <t>/ CHANNEL_COUNT
6447                  </t>                  </t>
6448                    <t>/ CHANNEL_MIDI
6449                    </t>
6450                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
6451                  </t>                  </t>
6452                  <t>/ STREAM_COUNT                  <t>/ STREAM_COUNT
# Line 6083  Schoenebeck'> Line 6479  Schoenebeck'>
6479                  </t>                  </t>
6480                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6481                  </t>                  </t>
6482                    <t>/ TOTAL_STREAM_COUNT
6483                    </t>
6484                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6485                  </t>                  </t>
6486                  <t>/ GLOBAL_INFO                  <t>/ GLOBAL_INFO
# Line 6115  Schoenebeck'> Line 6513  Schoenebeck'>
6513                  </t>                  </t>
6514                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6515                  </t>                  </t>
6516                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6517                  </t>                  </t>
6518                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6519                  </t>                  </t>
6520                  <t>/ DB_INSTRUMENT SP pathname                  <t>/ DB_INSTRUMENT SP db_path
6521                  </t>                  </t>
6522          </list>          </list>
6523  </t>  </t>
# Line 6173  Schoenebeck'> Line 6571  Schoenebeck'>
6571                  </t>                  </t>
6572                  <t>/ SERVER SP INFO                  <t>/ SERVER SP INFO
6573                  </t>                  </t>
6574                    <t>/ TOTAL_STREAM_COUNT
6575                    </t>
6576                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
6577                  </t>                  </t>
6578                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
# Line 6191  Schoenebeck'> Line 6591  Schoenebeck'>
6591                  </t>                  </t>
6592                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6593                  </t>                  </t>
6594                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6595                  </t>                  </t>
6596                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6597                  </t>                  </t>
6598                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6599                  </t>                  </t>
6600                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6601                  </t>                  </t>
6602                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6603                  </t>                  </t>
6604                  <t>/ DB_INSTRUMENT SP INFO SP pathname                  <t>/ DB_INSTRUMENT SP INFO SP db_path
6605                  </t>                  </t>
6606                  <t>/ DB_INSTRUMENTS_JOB SP INFO SP number                  <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6607                  </t>                  </t>
6608                  <t>/ VOLUME                  <t>/ VOLUME
6609                  </t>                  </t>
6610                    <t>/ FILE SP INSTRUMENTS SP filename
6611                    </t>
6612                    <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
6613                    </t>
6614          </list>          </list>
6615  </t>  </t>
6616  <t>set_instruction =  <t>set_instruction =
# Line 6217  Schoenebeck'> Line 6621  Schoenebeck'>
6621                  </t>                  </t>
6622                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6623                  </t>                  </t>
6624                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6625                    </t>
6626                  <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
6627                  </t>                  </t>
6628                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
# Line 6231  Schoenebeck'> Line 6637  Schoenebeck'>
6637                  </t>                  </t>
6638                  <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
6639                  </t>                  </t>
6640                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6641                  </t>                  </t>
6642                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6643                  </t>                  </t>
6644                  <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6645                  </t>                  </t>
6646                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6647                  </t>                  </t>
6648                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6649                  </t>                  </t>
# Line 6277  Schoenebeck'> Line 6683  Schoenebeck'>
6683  </t>  </t>
6684  <t>find_instruction =  <t>find_instruction =
6685          <list>          <list>
6686                  <t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list                  <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6687                  </t>                  </t>
6688                  <t>/ DB_INSTRUMENTS SP pathname SP query_val_list                  <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6689                  </t>                  </t>
6690                  <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
6691                  </t>                  </t>
6692                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6693                  </t>                  </t>
6694          </list>          </list>
6695  </t>  </t>
6696  <t>move_instruction =  <t>move_instruction =
6697          <list>          <list>
6698                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6699                  </t>                  </t>
6700                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6701                  </t>                  </t>
6702          </list>          </list>
6703  </t>  </t>
6704  <t>copy_instruction =  <t>copy_instruction =
6705          <list>          <list>
6706                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6707                  </t>                  </t>
6708                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6709                  </t>                  </t>
6710          </list>          </list>
6711  </t>  </t>
# Line 6355  Schoenebeck'> Line 6761  Schoenebeck'>
6761  </t>  </t>
6762  <t>edit_instruction =  <t>edit_instruction =
6763          <list>          <list>
6764                  <t>INSTRUMENT SP sampler_channel                  <t>CHANNEL SP INSTRUMENT SP sampler_channel
6765                    </t>
6766            </list>
6767    </t>
6768    <t>format_instruction =
6769            <list>
6770                    <t>INSTRUMENTS_DB
6771                  </t>                  </t>
6772          </list>          </list>
6773  </t>  </t>
# Line 6405  Schoenebeck'> Line 6817  Schoenebeck'>
6817                  </t>                  </t>
6818                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6819                  </t>                  </t>
6820                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6821                  </t>                  </t>
6822                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6823                  </t>                  </t>
6824                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6825                  </t>                  </t>
6826                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6827                    </t>
6828                    <t>/ FILE SP INSTRUMENTS SP filename
6829                  </t>                  </t>
6830          </list>          </list>
6831  </t>  </t>
# Line 6533  Schoenebeck'> Line 6947  Schoenebeck'>
6947                  </t>                  </t>
6948          </list>          </list>
6949  </t>  </t>
6950  <t>pathname =  <t>filename =
         <list>  
                 <t>stringval  
                 </t>  
         </list>  
 </t>  
 <t>dirname =  
6951          <list>          <list>
6952                  <t>stringval                  <t>path
6953                  </t>                  </t>
6954          </list>          </list>
6955  </t>  </t>
6956  <t>filename =  <t>db_path =
6957          <list>          <list>
6958                  <t>stringval_escaped                  <t>path
6959                  </t>                  </t>
6960          </list>          </list>
6961  </t>  </t>
6962  <t>map_name =  <t>map_name =
6963          <list>          <list>
6964                  <t>stringval                  <t>stringval_escaped
6965                  </t>                  </t>
6966          </list>          </list>
6967  </t>  </t>
6968  <t>entry_name =  <t>entry_name =
6969          <list>          <list>
6970                  <t>stringval                  <t>stringval_escaped
6971                  </t>                  </t>
6972          </list>          </list>
6973  </t>  </t>
6974  <t>fx_send_name =  <t>fx_send_name =
6975          <list>          <list>
6976                  <t>stringval                  <t>stringval_escaped
6977                  </t>                  </t>
6978          </list>          </list>
6979  </t>  </t>
# Line 6577  Schoenebeck'> Line 6985  Schoenebeck'>
6985                  </t>                  </t>
6986          </list>          </list>
6987  </t>  </t>
6988    
6989  <t>param_val =  <t>param_val =
6990          <list>          <list>
6991                  <t>string                  <t>string
# Line 6599  Schoenebeck'> Line 7008  Schoenebeck'>
7008  </t>  </t>
7009  <t>query_val =  <t>query_val =
7010          <list>          <list>
7011                  <t>string                  <t>text_escaped
7012                  </t>                  </t>
7013                  <t>/ stringval                  <t>/ stringval_escaped
7014                  </t>                  </t>
7015          </list>          </list>
7016  </t>  </t>
# Line 6648  Schoenebeck'> Line 7057  Schoenebeck'>
7057                  where escape characters are now supported, a backslash characters                  where escape characters are now supported, a backslash characters
7058                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
7059                  in the old versions a single backslash was sufficient.</t>                  in the old versions a single backslash was sufficient.</t>
7060    
7061                    <t>The following LSCP commands support escape sequences as part
7062                    of their filename / path based arguments and / or may contain
7063                    a filename / path with escape sequences in their response:
7064                    <list>
7065                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
7066                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7067                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7068                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7069                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
7070                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
7071                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7072                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
7073                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
7074                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
7075                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7076                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
7077                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
7078                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7079                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7080                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7081                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7082                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7083                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7084                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7085                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
7086                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
7087                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
7088                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
7089                        <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
7090                        <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
7091                        <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
7092                    </list>
7093                    Note that the forward slash character ('/') has a special meaning in
7094                    filename / path based arguments: it acts as separator of the nodes in
7095                    the path, thus if a directory- or filename includes a forward slash
7096                    (not intended as path node separator), you MUST escape that slash
7097                    either with the respective hex escape sequence ("\x2f") or with the
7098                    respective octal escape sequence ("\057").
7099                    </t>
7100    
7101                    <t>
7102                    Note for Windows: file path arguments in LSCP are expected
7103                    to use forward slashes as directory node separator similar
7104                    to Unix based operating systems. In contrast to Unix however
7105                    a Windows typical drive character is expected to be
7106                    prefixed to the path. That is an original Windows file path
7107                    like "D:\Sounds\My.gig" would become in LSCP:
7108                    "D:/Sounds/My.gig".
7109                    </t>
7110    
7111                    <t>
7112                    The following LSCP commands even support escape sequences as
7113                    part of at least one of their text-based arguments (i.e. entity name,
7114                    description) and / or may contain escape sequences in at least one of
7115                    their text-based fields in their response:
7116                    <list>
7117                        <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
7118                        <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
7119                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
7120                        <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
7121                        <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
7122                        <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
7123                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
7124                        <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
7125                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
7126                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
7127                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
7128                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
7129                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
7130                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
7131                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
7132                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
7133                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
7134                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
7135                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
7136                    </list>
7137                    Please note that these lists are manually maintained. If you
7138                    find a command that also supports escape sequences we forgot to
7139                    mention here, please report it!
7140                    </t>
7141              </section>              </section>
7142          </section>          </section>
7143    
# Line 6752  Schoenebeck'> Line 7242  Schoenebeck'>
7242                  of sampler channels.</t>                  of sampler channels.</t>
7243              </section>              </section>
7244    
7245                <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
7246                    <t>Client may want to be notified when MIDI data arrive on sampler channels on
7247                    back-end side, by issuing the following command:</t>
7248                    <t>
7249                        <list>
7250                            <t>SUBSCRIBE CHANNEL_MIDI</t>
7251                        </list>
7252                    </t>
7253                    <t>Server will start sending one of the the following notification messages:</t>
7254                    <t>
7255                        <list>
7256                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON  &lt;note&gt; &lt;velocity&gt;"</t>
7257                            <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
7258                        </list>
7259                    </t>
7260                    <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
7261                    data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
7262                    0 .. 127, reflecting the analog meaning of the MIDI specification.
7263                    </t>
7264                    <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
7265                    delivered by this mechanism! With other words: events could be lost at any time!
7266                    This restriction was made to keep the RT-safeness of the backend's MIDI and audio
7267                    thread unaffected by this feature.</t>
7268                </section>
7269    
7270              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">              <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
7271                  <t>Client may want to be notified when the number of voices on the                  <t>Client may want to be notified when the number of voices on the
7272                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 6889  Schoenebeck'> Line 7404  Schoenebeck'>
7404                  all currently active voices.</t>                  all currently active voices.</t>
7405              </section>              </section>
7406    
7407                <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
7408                    <t>Client may want to be notified when the total number of disk streams on the
7409                    back-end changes by issuing the following command:</t>
7410                    <t>
7411                        <list>
7412                            <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
7413                        </list>
7414                    </t>
7415                    <t>Server will start sending the following notification messages:</t>
7416                    <t>
7417                        <list>
7418                            <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
7419                        </list>
7420                    </t>
7421                    <t>where &lt;streams&gt; will be replaced by the new number of
7422                    all currently active disk streams.</t>
7423                </section>
7424    
7425              <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">
7426                  <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
7427                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
Legend:
Removed from v.1250  
changed lines
  Added in v.1686
  ViewVC Help
Powered by ViewVC