/[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 1399 by schoenebeck, Thu Oct 11 18:53:29 2007 UTC
# 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="October" year="2007"/>
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 2435  Schoenebeck'> Line 2443  Schoenebeck'>
2443                                  <list>                                  <list>
2444                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
2445                                          <list>                                          <list>
2446                                              <t>arbitrary description text about the engine</t>                                              <t>arbitrary description text about the engine
2447                                                (note that the character string may contain
2448                                                <xref target="character_set">escape sequences</xref>)</t>
2449                                          </list>                                          </list>
2450                                      </t>                                      </t>
2451                                       <t>VERSION -                                       <t>VERSION -
# Line 2519  Schoenebeck'> Line 2529  Schoenebeck'>
2529                                          <list>                                          <list>
2530                                              <t>the file name of the loaded instrument, "NONE" if                                              <t>the file name of the loaded instrument, "NONE" if
2531                                              there's no instrument yet loaded for this sampler                                              there's no instrument yet loaded for this sampler
2532                                              channel</t>                                              channel (note: since LSCP 1.2 this path may contain
2533                                                <xref target="character_set">escape sequences</xref>)</t>
2534                                          </list>                                          </list>
2535                                      </t>                                      </t>
2536                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 2529  Schoenebeck'> Line 2540  Schoenebeck'>
2540                                      </t>                                      </t>
2541                                      <t>INSTRUMENT_NAME -                                      <t>INSTRUMENT_NAME -
2542                                          <list>                                          <list>
2543                                              <t>the instrument name of the loaded instrument</t>                                              <t>the instrument name of the loaded instrument
2544                                                (note: since LSCP 1.2 this character string may contain
2545                                                <xref target="character_set">escape sequences</xref>)</t>
2546                                          </list>                                          </list>
2547                                      </t>                                      </t>
2548                                      <t>INSTRUMENT_STATUS -                                      <t>INSTRUMENT_STATUS -
# Line 3247  Schoenebeck'> Line 3260  Schoenebeck'>
3260                      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;
3261                      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
3262                      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
3263                      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
3264                        encapsulated into apostrophes and supports escape sequences as described in chapter
3265                        "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3266    
3267                      <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
3268                      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 3452  Schoenebeck'>
3452                                  <list>                                  <list>
3453                                      <t>NAME -                                      <t>NAME -
3454                                          <list>                                          <list>
3455                                              <t>name of the effect send entity</t>                                              <t>name of the effect send entity
3456                                                (note that this character string may contain
3457                                                 <xref target="character_set">escape sequences</xref>)</t>
3458                                          </list>                                          </list>
3459                                      </t>                                      </t>
3460                                      <t>MIDI_CONTROLLER -                                      <t>MIDI_CONTROLLER -
# Line 3500  Schoenebeck'> Line 3517  Schoenebeck'>
3517                      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>
3518                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and                      or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3519                      &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
3520                      does not have to be unique.</t>                      does not have to be unique (name MUST be encapsulated into apostrophes
3521                        and supports escape sequences as described in chapter
3522                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
3523                        </t>
3524    
3525                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
3526                      <t>                      <t>
# Line 3951  Schoenebeck'> Line 3971  Schoenebeck'>
3971                                  <list>                                  <list>
3972                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
3973                                          <list>                                          <list>
3974                                              <t>arbitrary textual description about the sampler</t>                                              <t>arbitrary textual description about the sampler
3975                                                (note that the character string may contain
3976                                                <xref target="character_set">escape sequences</xref>)</t>
3977                                          </list>                                          </list>
3978                                      </t>                                      </t>
3979                                      <t>VERSION -                                      <t>VERSION -
# Line 4067  Schoenebeck'> Line 4089  Schoenebeck'>
4089                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
4090                  reflected by the current MIDI instrument map.</t>                  reflected by the current MIDI instrument map.</t>
4091    
4092                  <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">
4093                      <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
4094                      the following command:</t>                      the following command:</t>
4095                      <t>                      <t>
# Line 4077  Schoenebeck'> Line 4099  Schoenebeck'>
4099                      </t>                      </t>
4100                      <t>Where &lt;name&gt; is an optional argument allowing to                      <t>Where &lt;name&gt; is an optional argument allowing to
4101                      assign a custom name to the new map. MIDI instrument Map                      assign a custom name to the new map. MIDI instrument Map
4102                      names do not have to be unique.</t>                      names do not have to be unique, but MUST be encapsulated
4103                        into apostrophes and support escape sequences as described
4104                        in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4105                        </t>
4106    
4107                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4108                      <t>                      <t>
# Line 4248  Schoenebeck'> Line 4273  Schoenebeck'>
4273                                      <t>NAME -                                      <t>NAME -
4274                                          <list>                                          <list>
4275                                              <t>custom name of the given map,                                              <t>custom name of the given map,
4276                                              which does not have to be unique</t>                                              which does not have to be unique
4277                                                (note that this character string may contain
4278                                                 <xref target="character_set">escape sequences</xref>)</t>
4279                                          </list>                                          </list>
4280                                      </t>                                      </t>
4281                                      <t>DEFAULT -                                      <t>DEFAULT -
# Line 4284  Schoenebeck'> Line 4311  Schoenebeck'>
4311                      </t>                      </t>
4312                      <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
4313                      &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
4314                      have to be unique.</t>                      have to be unique (name MUST be encapsulated into apostrophes
4315                        and supports escape sequences as described in chapter
4316                        "<xref target="character_set">Character Set and Escape Sequences</xref>").
4317                        </t>
4318    
4319                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4320                      <t>                      <t>
# Line 4415  Schoenebeck'> Line 4445  Schoenebeck'>
4445                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
4446                      mode by i.e. sending                      mode by i.e. sending
4447                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4448                      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
4449                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
4450                      entry, useful for frontends for displaying an appropriate name for                      "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4451                        mapping entry, useful for frontends for displaying an appropriate name for
4452                      mapped instruments (using                      mapped instruments (using
4453                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4454                      </t>                      </t>
# Line 4641  Schoenebeck'> Line 4672  Schoenebeck'>
4672                                      name for this mapped instrument. It can be set and                                      name for this mapped instrument. It can be set and
4673                                      changed with the                                      changed with the
4674                                      <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>                                      <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
4675                                      command and does not have to be unique.</t>                                      command and does not have to be unique.
4676                                        (note that this character string may contain
4677                                        <xref target="character_set">escape sequences</xref>)</t>
4678                                  </list>                                  </list>
4679                              </t>                              </t>
4680                              <t>"ENGINE_NAME" -                              <t>"ENGINE_NAME" -
# Line 4652  Schoenebeck'> Line 4685  Schoenebeck'>
4685                              </t>                              </t>
4686                              <t>"INSTRUMENT_FILE" -                              <t>"INSTRUMENT_FILE" -
4687                                  <list>                                  <list>
4688                                      <t>File name of the instrument.</t>                                      <t>File name of the instrument
4689                                        (note that this path may contain
4690                                        <xref target="character_set">escape sequences</xref>).</t>
4691                                  </list>                                  </list>
4692                              </t>                              </t>
4693                              <t>"INSTRUMENT_NR" -                              <t>"INSTRUMENT_NR" -
# Line 4664  Schoenebeck'> Line 4699  Schoenebeck'>
4699                                  <list>                                  <list>
4700                                      <t>Name of the loaded instrument as reflected by its file.                                      <t>Name of the loaded instrument as reflected by its file.
4701                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field                                      In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4702                                      cannot be changed.</t>                                      cannot be changed (note that this character string may contain
4703                                        <xref target="character_set">escape sequences</xref>).</t>
4704                                  </list>                                  </list>
4705                              </t>                              </t>
4706                              <t>"LOAD_MODE" -                              <t>"LOAD_MODE" -
# Line 4752  Schoenebeck'> Line 4788  Schoenebeck'>
4788              <section title="Managing Instruments Database" anchor="Managing Instruments Database">              <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4789                  <t>The following commands describe how to use and manage                  <t>The following commands describe how to use and manage
4790                  the instruments database.</t>                  the instruments database.</t>
4791                    <t>Notice:</t>
4792                        <t>
4793                            <list>
4794                                <t>All command arguments representing a path or
4795                                instrument/directory name support escape sequences as described in chapter
4796                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4797                                </t>
4798                                <t>All occurrences of a forward slash in instrument and directory
4799                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4800                                </t>
4801                            </list>
4802                        </t>
4803    
4804                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4805                      <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 4977  Schoenebeck'>
4977                                  <list>                                  <list>
4978                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
4979                                          <list>                                          <list>
4980                                              <t>A brief description of the directory content</t>                                              <t>A brief description of the directory content.
4981                                                Note that the character string may contain
4982                                                <xref target="character_set">escape sequences</xref>.</t>
4983                                          </list>                                          </list>
4984                                      </t>                                      </t>
4985                                      <t>CREATED -                                      <t>CREATED -
# Line 5093  Schoenebeck'> Line 5143  Schoenebeck'>
5143                          </list>                          </list>
5144                      </t>                      </t>
5145                      <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
5146                      &lt;desc&gt; is the new description for the directory.</t>                      &lt;desc&gt; is the new description for the directory
5147                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5148                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5149    
5150                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5151                      <t>                      <t>
# Line 5138  Schoenebeck'> Line 5190  Schoenebeck'>
5190                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5191                            <list>                            <list>
5192                                <t>Restricts the search to directories, which names                                <t>Restricts the search to directories, which names
5193                                satisfy the supplied search string.</t>                                satisfy the supplied search string (encapsulated into apostrophes,
5194                                  supporting escape sequences as described in chapter
5195                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5196                            </list>                            </list>
5197                        </t>                        </t>
5198    
# Line 5169  Schoenebeck'> Line 5223  Schoenebeck'>
5223                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5224                            <list>                            <list>
5225                                <t>Restricts the search to directories with description                                <t>Restricts the search to directories with description
5226                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string
5227                                  (encapsulated into apostrophes, supporting escape
5228                                  sequences as described in chapter
5229                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5230                            </list>                            </list>
5231                        </t>                        </t>
5232                      </t>                      </t>
# Line 5430  Schoenebeck'> Line 5487  Schoenebeck'>
5487                                  <list>                                  <list>
5488                                      <t>INSTRUMENT_FILE -                                      <t>INSTRUMENT_FILE -
5489                                          <list>                                          <list>
5490                                              <t>File name of the instrument.</t>                                              <t>File name of the instrument.
5491                                                Note that the character string may contain
5492                                                <xref target="character_set">escape sequences</xref>.</t>
5493                                          </list>                                          </list>
5494                                      </t>                                      </t>
5495                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 5469  Schoenebeck'> Line 5528  Schoenebeck'>
5528                                      </t>                                      </t>
5529                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
5530                                          <list>                                          <list>
5531                                              <t>A brief description of the instrument</t>                                              <t>A brief description of the instrument.
5532                                                Note that the character string may contain
5533                                                <xref target="character_set">escape sequences</xref>.</t>
5534                                          </list>                                          </list>
5535                                      </t>                                      </t>
5536                                      <t>IS_DRUM -                                      <t>IS_DRUM -
# Line 5480  Schoenebeck'> Line 5541  Schoenebeck'>
5541                                      </t>                                      </t>
5542                                      <t>PRODUCT -                                      <t>PRODUCT -
5543                                          <list>                                          <list>
5544                                              <t>The product title of the instrument</t>                                              <t>The product title of the instrument.
5545                                                Note that the character string may contain
5546                                                <xref target="character_set">escape sequences</xref>.</t>
5547                                          </list>                                          </list>
5548                                      </t>                                      </t>
5549                                      <t>ARTISTS -                                      <t>ARTISTS -
5550                                          <list>                                          <list>
5551                                              <t>Lists the artist names</t>                                              <t>Lists the artist names.
5552                                                Note that the character string may contain
5553                                                <xref target="character_set">escape sequences</xref>.</t>
5554                                          </list>                                          </list>
5555                                      </t>                                      </t>
5556                                      <t>KEYWORDS -                                      <t>KEYWORDS -
5557                                          <list>                                          <list>
5558                                              <t>Provides a list of keywords that refer to the instrument.                                              <t>Provides a list of keywords that refer to the instrument.
5559                                              Keywords are separated with semicolon and blank.</t>                                              Keywords are separated with semicolon and blank.
5560                                                Note that the character string may contain
5561                                                <xref target="character_set">escape sequences</xref>.</t>
5562                                          </list>                                          </list>
5563                                      </t>                                      </t>
5564                                  </list>                                  </list>
# Line 5648  Schoenebeck'> Line 5715  Schoenebeck'>
5715                          </list>                          </list>
5716                      </t>                      </t>
5717                      <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
5718                      &lt;desc&gt; is the new description for the instrument.</t>                      &lt;desc&gt; is the new description for the instrument
5719                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5720                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5721    
5722                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5723                      <t>                      <t>
# Line 5693  Schoenebeck'> Line 5762  Schoenebeck'>
5762                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5763                            <list>                            <list>
5764                                <t>Restricts the search to instruments, which names                                <t>Restricts the search to instruments, which names
5765                                satisfy the supplied search string.</t>                                satisfy the supplied search string (encapsulated into apostrophes,
5766                                  supporting escape sequences as described in chapter
5767                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5768                            </list>                            </list>
5769                        </t>                        </t>
5770    
# Line 5735  Schoenebeck'> Line 5806  Schoenebeck'>
5806                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5807                            <list>                            <list>
5808                                <t>Restricts the search to instruments with description                                <t>Restricts the search to instruments with description
5809                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5810                                  supporting escape sequences as described in chapter
5811                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5812                            </list>                            </list>
5813                        </t>                        </t>
5814    
5815                        <t>PRODUCT='&lt;search-string&gt;'                        <t>PRODUCT='&lt;search-string&gt;'
5816                            <list>                            <list>
5817                                <t>Restricts the search to instruments with product info                                <t>Restricts the search to instruments with product info
5818                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5819                                  supporting escape sequences as described in chapter
5820                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5821                            </list>                            </list>
5822                        </t>                        </t>
5823    
5824                        <t>ARTISTS='&lt;search-string&gt;'                        <t>ARTISTS='&lt;search-string&gt;'
5825                            <list>                            <list>
5826                                <t>Restricts the search to instruments with artists info                                <t>Restricts the search to instruments with artists info
5827                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5828                                  supporting escape sequences as described in chapter
5829                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5830                            </list>                            </list>
5831                        </t>                        </t>
5832    
5833                        <t>KEYWORDS='&lt;search-string&gt;'                        <t>KEYWORDS='&lt;search-string&gt;'
5834                            <list>                            <list>
5835                                <t>Restricts the search to instruments with keyword list                                <t>Restricts the search to instruments with keyword list
5836                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5837                                  supporting escape sequences as described in chapter
5838                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5839                            </list>                            </list>
5840                        </t>                        </t>
5841    
# Line 5870  Schoenebeck'> Line 5949  Schoenebeck'>
5949                      </t>                      </t>
5950                  </section>                  </section>
5951    
5952                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5953                        <t>The front-end can remove all instruments and directories and re-create
5954                        the instruments database structure (e.g., in case of a database corruption)
5955                        by sending the following command:</t>
5956                        <t>
5957                            <list>
5958                                <t>FORMAT INSTRUMENTS_DB</t>
5959                            </list>
5960                        </t>
5961                        
5962                        <t>Possible Answers:</t>
5963                        <t>
5964                            <list>
5965                                <t>"OK" -
5966                                    <list>
5967                                        <t>on success</t>
5968                                    </list>
5969                                </t>
5970                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5971                                    <list>
5972                                        <t>If the formatting of the instruments database
5973                                        failed.</t>
5974                                    </list>
5975                                </t>
5976                            </list>
5977                        </t>
5978                    </section>
5979    
5980              </section>              </section>
5981    
5982    
5983    
5984                <section title="Editing Instruments" anchor="editing_instruments">
5985                    <t>The sampler allows to edit instruments while playing with the
5986                    sampler by spawning an external (3rd party) instrument editor
5987                    application for a given instrument. The 3rd party instrument
5988                    editor applications have to place a respective plugin DLL file
5989                    into the sampler's plugins directory. The sampler will
5990                    automatically try to load all plugin DLLs in that directory on
5991                    startup and only on startup!</t>
5992                    <t>At the moment there is only one command for this feature set,
5993                    but this will most probably change in future.</t>
5994    
5995                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
5996                        <t>The front-end can request to open an appropriate instrument
5997                        editor application by sending the following command:</t>
5998                        <t>
5999                            <list>
6000                                <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>
6001                            </list>
6002                        </t>
6003                        <t>Where &lt;sampler-channel&gt; should be replaced by the
6004                        number of the sampler channel as given by the
6005                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
6006                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
6007                        command.</t>
6008    
6009                        <t>The sampler will try to ask all registered instrument
6010                        editors (or to be more specific: their sampler plugins)
6011                        whether they are capable to handle the instrument on the
6012                        given sampler channel. The sampler will simply use the first
6013                        instrument editor application which replied with a positive
6014                        answer and spawn that instrument editor application within
6015                        the sampler's process and provide that application access
6016                        to the instrument's data structures, so both applications
6017                        can share and access the same instruments data at the same
6018                        time, thus allowing to immediately hear changes with the
6019                        sampler made by the instrument editor.</t>
6020    
6021                        <t>Note: consequently instrument editors are always spawned
6022                        locally on the same machine where the sampler is running
6023                        on!</t>
6024    
6025                        <t>Possible Answers:</t>
6026                        <t>
6027                            <list>
6028                                <t>"OK" -
6029                                    <list>
6030                                        <t>when an appropriate instrument editor was
6031                                        launched</t>
6032                                    </list>
6033                                </t>
6034                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6035                                    <list>
6036                                        <t>when an appropriate instrument editor was
6037                                        launched, but there are noteworthy issues</t>
6038                                    </list>
6039                                </t>
6040                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6041                                    <list>
6042                                        <t>when an appropriate instrument editor
6043                                        could not be launched</t>
6044                                    </list>
6045                                </t>
6046                            </list>
6047                        </t>
6048    
6049                        <t>Examples:</t>
6050                        <t>
6051                            <list>
6052                                <t>C: "EDIT INSTRUMENT 0"</t>
6053                                <t>S: "OK"</t>
6054                            </list>
6055                        </t>
6056                    </section>
6057                </section>
6058          </section>          </section>
6059    
6060    
# Line 5959  Schoenebeck'> Line 6142  Schoenebeck'>
6142                  </t>                  </t>
6143                  <t>/ EDIT SP edit_instruction                  <t>/ EDIT SP edit_instruction
6144                  </t>                  </t>
6145                    <t>/ FORMAT SP format_instruction
6146                    </t>
6147                  <t>/ RESET                  <t>/ RESET
6148                  </t>                  </t>
6149                  <t>/ QUIT                  <t>/ QUIT
# Line 5969  Schoenebeck'> Line 6154  Schoenebeck'>
6154          <list>          <list>
6155                  <t>CHANNEL                  <t>CHANNEL
6156                  </t>                  </t>
6157                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6158                  </t>                  </t>
6159                  <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
6160                  </t>                  </t>
6161                  <t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6162                  </t>                  </t>
6163                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6164                  </t>                  </t>
6165                  <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
6166                  </t>                  </t>
6167                  <t>/ DB_INSTRUMENTS SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP db_path SP filename
6168                  </t>                  </t>
6169                  <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index                  <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6170                  </t>                  </t>
6171                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
6172                  </t>                  </t>
# Line 6115  Schoenebeck'> Line 6300  Schoenebeck'>
6300                  </t>                  </t>
6301                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6302                  </t>                  </t>
6303                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6304                  </t>                  </t>
6305                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6306                  </t>                  </t>
6307                  <t>/ DB_INSTRUMENT SP pathname                  <t>/ DB_INSTRUMENT SP db_path
6308                  </t>                  </t>
6309          </list>          </list>
6310  </t>  </t>
# Line 6191  Schoenebeck'> Line 6376  Schoenebeck'>
6376                  </t>                  </t>
6377                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6378                  </t>                  </t>
6379                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6380                  </t>                  </t>
6381                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6382                  </t>                  </t>
6383                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6384                  </t>                  </t>
6385                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6386                  </t>                  </t>
6387                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6388                  </t>                  </t>
6389                  <t>/ DB_INSTRUMENT SP INFO SP pathname                  <t>/ DB_INSTRUMENT SP INFO SP db_path
6390                  </t>                  </t>
6391                  <t>/ DB_INSTRUMENTS_JOB SP INFO SP number                  <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6392                  </t>                  </t>
# Line 6217  Schoenebeck'> Line 6402  Schoenebeck'>
6402                  </t>                  </t>
6403                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6404                  </t>                  </t>
6405                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6406                    </t>
6407                  <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
6408                  </t>                  </t>
6409                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
# Line 6231  Schoenebeck'> Line 6418  Schoenebeck'>
6418                  </t>                  </t>
6419                  <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
6420                  </t>                  </t>
6421                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6422                  </t>                  </t>
6423                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
6424                  </t>                  </t>
6425                  <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6426                  </t>                  </t>
6427                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6428                  </t>                  </t>
6429                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6430                  </t>                  </t>
# Line 6277  Schoenebeck'> Line 6464  Schoenebeck'>
6464  </t>  </t>
6465  <t>find_instruction =  <t>find_instruction =
6466          <list>          <list>
6467                  <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
6468                  </t>                  </t>
6469                  <t>/ DB_INSTRUMENTS SP pathname SP query_val_list                  <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6470                  </t>                  </t>
6471                  <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
6472                  </t>                  </t>
6473                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6474                  </t>                  </t>
6475          </list>          </list>
6476  </t>  </t>
6477  <t>move_instruction =  <t>move_instruction =
6478          <list>          <list>
6479                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6480                  </t>                  </t>
6481                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6482                  </t>                  </t>
6483          </list>          </list>
6484  </t>  </t>
6485  <t>copy_instruction =  <t>copy_instruction =
6486          <list>          <list>
6487                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6488                  </t>                  </t>
6489                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6490                  </t>                  </t>
6491          </list>          </list>
6492  </t>  </t>
# Line 6359  Schoenebeck'> Line 6546  Schoenebeck'>
6546                  </t>                  </t>
6547          </list>          </list>
6548  </t>  </t>
6549    <t>format_instruction =
6550            <list>
6551                    <t>INSTRUMENTS_DB
6552                    </t>
6553            </list>
6554    </t>
6555  <t>modal_arg =  <t>modal_arg =
6556          <list>          <list>
6557                  <t>/* epsilon (empty argument) */                  <t>/* epsilon (empty argument) */
# Line 6405  Schoenebeck'> Line 6598  Schoenebeck'>
6598                  </t>                  </t>
6599                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6600                  </t>                  </t>
6601                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6602                  </t>                  </t>
6603                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6604                  </t>                  </t>
6605                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6606                  </t>                  </t>
6607                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6608                  </t>                  </t>
6609          </list>          </list>
6610  </t>  </t>
# Line 6533  Schoenebeck'> Line 6726  Schoenebeck'>
6726                  </t>                  </t>
6727          </list>          </list>
6728  </t>  </t>
6729  <t>pathname =  <t>filename =
         <list>  
                 <t>stringval  
                 </t>  
         </list>  
 </t>  
 <t>dirname =  
6730          <list>          <list>
6731                  <t>stringval                  <t>path
6732                  </t>                  </t>
6733          </list>          </list>
6734  </t>  </t>
6735  <t>filename =  <t>db_path =
6736          <list>          <list>
6737                  <t>stringval_escaped                  <t>path
6738                  </t>                  </t>
6739          </list>          </list>
6740  </t>  </t>
6741  <t>map_name =  <t>map_name =
6742          <list>          <list>
6743                  <t>stringval                  <t>stringval_escaped
6744                  </t>                  </t>
6745          </list>          </list>
6746  </t>  </t>
6747  <t>entry_name =  <t>entry_name =
6748          <list>          <list>
6749                  <t>stringval                  <t>stringval_escaped
6750                  </t>                  </t>
6751          </list>          </list>
6752  </t>  </t>
6753  <t>fx_send_name =  <t>fx_send_name =
6754          <list>          <list>
6755                  <t>stringval                  <t>stringval_escaped
6756                  </t>                  </t>
6757          </list>          </list>
6758  </t>  </t>
# Line 6577  Schoenebeck'> Line 6764  Schoenebeck'>
6764                  </t>                  </t>
6765          </list>          </list>
6766  </t>  </t>
6767    
6768  <t>param_val =  <t>param_val =
6769          <list>          <list>
6770                  <t>string                  <t>string
# Line 6599  Schoenebeck'> Line 6787  Schoenebeck'>
6787  </t>  </t>
6788  <t>query_val =  <t>query_val =
6789          <list>          <list>
6790                  <t>string                  <t>text_escaped
6791                  </t>                  </t>
6792                  <t>/ stringval                  <t>/ stringval_escaped
6793                  </t>                  </t>
6794          </list>          </list>
6795  </t>  </t>
# Line 6648  Schoenebeck'> Line 6836  Schoenebeck'>
6836                  where escape characters are now supported, a backslash characters                  where escape characters are now supported, a backslash characters
6837                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
6838                  in the old versions a single backslash was sufficient.</t>                  in the old versions a single backslash was sufficient.</t>
6839    
6840                    <t>The following LSCP commands support escape sequences as part
6841                    of their filename / path based arguments and / or may contain
6842                    a filename / path with escape sequences in their response:
6843                    <list>
6844                        <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
6845                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
6846                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
6847                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
6848                        <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
6849                        <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
6850                        <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
6851                        <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
6852                        <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
6853                        <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
6854                        <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
6855                        <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
6856                        <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
6857                        <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
6858                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
6859                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
6860                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
6861                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
6862                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
6863                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
6864                        <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
6865                        <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
6866                        <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
6867                        <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
6868                    </list>
6869                    Note that the forward slash character ('/') has a special meaning in
6870                    filename / path based arguments: it acts as separator of the nodes in
6871                    the path, thus if a directory- or filename includes a forward slash
6872                    (not intended as path node separator), you MUST escape that slash
6873                    either with the respective hex escape sequence ("\x2f") or with the
6874                    respective octal escape sequence ("\057").
6875                    </t>
6876    
6877                    <t>
6878                    The following LSCP commands even support escape sequences as
6879                    part of at least one of their text-based arguments (i.e. entity name,
6880                    description) and / or may contain escape sequences in at least one of
6881                    their text-based fields in their response:
6882                    <list>
6883                        <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
6884                        <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
6885                        <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
6886                        <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
6887                        <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
6888                        <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
6889                        <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
6890                        <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
6891                        <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
6892                        <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
6893                        <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
6894                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
6895                        <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
6896                        <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
6897                        <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
6898                        <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
6899                        <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
6900                    </list>
6901                    Please note that these lists are manually maintained. If you
6902                    find a command that also supports escape sequences we forgot to
6903                    mention here, please report it!
6904                    </t>
6905              </section>              </section>
6906          </section>          </section>
6907    
Legend:
Removed from v.1250  
changed lines
  Added in v.1399
  ViewVC Help
Powered by ViewVC