/[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 1200 by iliev, Thu May 24 14:04:18 2007 UTC revision 1387 by iliev, Sun Oct 7 10:32:53 2007 UTC
# Line 16  Line 16 
16       to an annoying "missing Normative/Informative References" error message -->       to an annoying "missing Normative/Informative References" error message -->
17  <?rfc strict="no" ?>  <?rfc strict="no" ?>
18    
19  <rfc category="std" ipr="full3978" docName="LSCP 1.2">  <rfc category="std" ipr="full3978" docName="LSCP 1.2cvs">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol (draft)</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
23  Schoenebeck'>  Schoenebeck'>
24              <organization>              <organization>
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="May" year="2007"/>          <date month="September" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 61  Schoenebeck'> Line 61  Schoenebeck'>
61              (front-end) and server (LinuxSampler) respectively. Lines in              (front-end) and server (LinuxSampler) respectively. Lines in
62              examples must be interpreted as every line being CRLF              examples must be interpreted as every line being CRLF
63              terminated (carriage return character followed by line feed              terminated (carriage return character followed by line feed
64              character as defined in the ASCII standard), thus the following              character as defined in the ASCII standard <xref target="RFC20"/>),
65              example:</t>              thus the following example:</t>
66    
67              <t>              <t>
68                  <list>                  <list>
# Line 2061  Schoenebeck'> Line 2061  Schoenebeck'>
2061                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2063                      the parameter to change and &lt;value&gt; by the new value for this                      the parameter to change and &lt;value&gt; by the new value for this
2064                      parameter.</t>                      parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
2065                        for specifying no value for parameters allowing a list of values.</t>
2066    
2067                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2068                      <t>                      <t>
# Line 2088  Schoenebeck'> Line 2089  Schoenebeck'>
2089                      <t>Example:</t>                      <t>Example:</t>
2090                      <t>                      <t>
2091                          <list>                          <list>
2092                              <t></t>                              <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t>
2093                                <t>S: "OK"</t>
2094                            </list>
2095                        </t>
2096                        <t>
2097                            <list>
2098                                <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t>
2099                                <t>S: "OK"</t>
2100                          </list>                          </list>
2101                      </t>                      </t>
2102                  </section>                  </section>
# Line 2113  Schoenebeck'> Line 2121  Schoenebeck'>
2121                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
2122                      Each sampler channel can only have one instrument.</t>                      Each sampler channel can only have one instrument.</t>
2123    
2124                        <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125                        escape characters for special characters (see chapter
2126                        "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127                        for details) and accordingly backslash characters in the filename
2128                        MUST now be escaped as well!</t>
2129    
2130                      <t>The difference between regular and NON_MODAL versions of the command                      <t>The difference between regular and NON_MODAL versions of the command
2131                      is that the regular command returns OK only after the instrument has been                      is that the regular command returns OK only after the instrument has been
2132                      fully loaded and the channel is ready to be used while NON_MODAL version                      fully loaded and the channel is ready to be used while NON_MODAL version
# Line 3945  Schoenebeck'> Line 3959  Schoenebeck'>
3959                                  <list>                                  <list>
3960                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
3961                                          <list>                                          <list>
3962                                              <t>arbitrary textual description about the sampler</t>                                              <t>arbitrary textual description about the sampler
3963                                                (note that the character string may contain
3964                                                <xref target="character_set">escape sequences</xref>)</t>
3965                                          </list>                                          </list>
3966                                      </t>                                      </t>
3967                                      <t>VERSION -                                      <t>VERSION -
# Line 4325  Schoenebeck'> Line 4341  Schoenebeck'>
4341                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4342                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4343                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4344                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
4345                        supporting escape sequences as described in chapter
4346                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4347                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4348                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4349                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 4407  Schoenebeck'> Line 4425  Schoenebeck'>
4425                      load modes of entries, the frontend should retrieve the actual                      load modes of entries, the frontend should retrieve the actual
4426                      mode by i.e. sending                      mode by i.e. sending
4427                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4428                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to                      command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
4429                      set a custom name (encapsulated into apostrophes) for the mapping                      (encapsulated into apostrophes, supporting escape sequences as described in chapter
4430                      entry, useful for frontends for displaying an appropriate name for                      "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4431                        mapping entry, useful for frontends for displaying an appropriate name for
4432                      mapped instruments (using                      mapped instruments (using
4433                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4434                      </t>                      </t>
# Line 4744  Schoenebeck'> Line 4763  Schoenebeck'>
4763              <section title="Managing Instruments Database" anchor="Managing Instruments Database">              <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4764                  <t>The following commands describe how to use and manage                  <t>The following commands describe how to use and manage
4765                  the instruments database.</t>                  the instruments database.</t>
4766                    <t>Notice:</t>
4767                        <t>
4768                            <list>
4769                                <t>All command arguments representing a path or
4770                                instrument/directory name support escape sequences as described in chapter
4771                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4772                                </t>
4773                                <t>All occurrences of a forward slash in instrument and directory
4774                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4775                                </t>
4776                            </list>
4777                        </t>
4778    
4779                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4780                      <t>The front-end can add a new instrument directory to the                      <t>The front-end can add a new instrument directory to the
# Line 4921  Schoenebeck'> Line 4952  Schoenebeck'>
4952                                  <list>                                  <list>
4953                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
4954                                          <list>                                          <list>
4955                                              <t>A brief description of the directory content</t>                                              <t>A brief description of the directory content.
4956                                                Note that the character string may contain
4957                                                <xref target="character_set">escape sequences</xref>.</t>
4958                                          </list>                                          </list>
4959                                      </t>                                      </t>
4960                                      <t>CREATED -                                      <t>CREATED -
# Line 5085  Schoenebeck'> Line 5118  Schoenebeck'>
5118                          </list>                          </list>
5119                      </t>                      </t>
5120                      <t>Where &lt;dir&gt; is the absolute path name of the directory and                      <t>Where &lt;dir&gt; is the absolute path name of the directory and
5121                      &lt;desc&gt; is the new description for the directory.</t>                      &lt;desc&gt; is the new description for the directory
5122                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5123                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5124    
5125                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5126                      <t>                      <t>
# Line 5130  Schoenebeck'> Line 5165  Schoenebeck'>
5165                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5166                            <list>                            <list>
5167                                <t>Restricts the search to directories, which names                                <t>Restricts the search to directories, which names
5168                                satisfy the supplied search string.</t>                                satisfy the supplied search string (encapsulated into apostrophes,
5169                                  supporting escape sequences as described in chapter
5170                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5171                            </list>                            </list>
5172                        </t>                        </t>
5173    
# Line 5161  Schoenebeck'> Line 5198  Schoenebeck'>
5198                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5199                            <list>                            <list>
5200                                <t>Restricts the search to directories with description                                <t>Restricts the search to directories with description
5201                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string
5202                                  (encapsulated into apostrophes, supporting escape
5203                                  sequences as described in chapter
5204                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5205                            </list>                            </list>
5206                        </t>                        </t>
5207                      </t>                      </t>
# Line 5422  Schoenebeck'> Line 5462  Schoenebeck'>
5462                                  <list>                                  <list>
5463                                      <t>INSTRUMENT_FILE -                                      <t>INSTRUMENT_FILE -
5464                                          <list>                                          <list>
5465                                              <t>File name of the instrument.</t>                                              <t>File name of the instrument.
5466                                                Note that the character string may contain
5467                                                <xref target="character_set">escape sequences</xref>.</t>
5468                                          </list>                                          </list>
5469                                      </t>                                      </t>
5470                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 5461  Schoenebeck'> Line 5503  Schoenebeck'>
5503                                      </t>                                      </t>
5504                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
5505                                          <list>                                          <list>
5506                                              <t>A brief description of the instrument</t>                                              <t>A brief description of the instrument.
5507                                                Note that the character string may contain
5508                                                <xref target="character_set">escape sequences</xref>.</t>
5509                                          </list>                                          </list>
5510                                      </t>                                      </t>
5511                                      <t>IS_DRUM -                                      <t>IS_DRUM -
# Line 5472  Schoenebeck'> Line 5516  Schoenebeck'>
5516                                      </t>                                      </t>
5517                                      <t>PRODUCT -                                      <t>PRODUCT -
5518                                          <list>                                          <list>
5519                                              <t>The product title of the instrument</t>                                              <t>The product title of the instrument.
5520                                                Note that the character string may contain
5521                                                <xref target="character_set">escape sequences</xref>.</t>
5522                                          </list>                                          </list>
5523                                      </t>                                      </t>
5524                                      <t>ARTISTS -                                      <t>ARTISTS -
5525                                          <list>                                          <list>
5526                                              <t>Lists the artist names</t>                                              <t>Lists the artist names.
5527                                                Note that the character string may contain
5528                                                <xref target="character_set">escape sequences</xref>.</t>
5529                                          </list>                                          </list>
5530                                      </t>                                      </t>
5531                                      <t>KEYWORDS -                                      <t>KEYWORDS -
5532                                          <list>                                          <list>
5533                                              <t>Provides a list of keywords that refer to the instrument.                                              <t>Provides a list of keywords that refer to the instrument.
5534                                              Keywords are separated with semicolon and blank.</t>                                              Keywords are separated with semicolon and blank.
5535                                                Note that the character string may contain
5536                                                <xref target="character_set">escape sequences</xref>.</t>
5537                                          </list>                                          </list>
5538                                      </t>                                      </t>
5539                                  </list>                                  </list>
# Line 5640  Schoenebeck'> Line 5690  Schoenebeck'>
5690                          </list>                          </list>
5691                      </t>                      </t>
5692                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and                      <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5693                      &lt;desc&gt; is the new description for the instrument.</t>                      &lt;desc&gt; is the new description for the instrument
5694                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5695                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5696    
5697                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5698                      <t>                      <t>
# Line 5685  Schoenebeck'> Line 5737  Schoenebeck'>
5737                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5738                            <list>                            <list>
5739                                <t>Restricts the search to instruments, which names                                <t>Restricts the search to instruments, which names
5740                                satisfy the supplied search string.</t>                                satisfy the supplied search string (encapsulated into apostrophes,
5741                                  supporting escape sequences as described in chapter
5742                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5743                            </list>                            </list>
5744                        </t>                        </t>
5745    
5746                        <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]                        <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5747                            <list>                            <list>
5748                                <t>Restricts the search to instruments, which                                <t>Restricts the search to instruments, which
5749                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
5750                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
5751                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the                                or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
# Line 5727  Schoenebeck'> Line 5781  Schoenebeck'>
5781                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5782                            <list>                            <list>
5783                                <t>Restricts the search to instruments with description                                <t>Restricts the search to instruments with description
5784                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5785                                  supporting escape sequences as described in chapter
5786                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5787                            </list>                            </list>
5788                        </t>                        </t>
5789    
5790                        <t>PRODUCT='&lt;search-string&gt;'                        <t>PRODUCT='&lt;search-string&gt;'
5791                            <list>                            <list>
5792                                <t>Restricts the search to instruments with product info                                <t>Restricts the search to instruments with product info
5793                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5794                                  supporting escape sequences as described in chapter
5795                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5796                            </list>                            </list>
5797                        </t>                        </t>
5798    
5799                        <t>ARTISTS='&lt;search-string&gt;'                        <t>ARTISTS='&lt;search-string&gt;'
5800                            <list>                            <list>
5801                                <t>Restricts the search to instruments with artists info                                <t>Restricts the search to instruments with artists info
5802                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5803                                  supporting escape sequences as described in chapter
5804                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5805                            </list>                            </list>
5806                        </t>                        </t>
5807    
5808                        <t>KEYWORDS='&lt;search-string&gt;'                        <t>KEYWORDS='&lt;search-string&gt;'
5809                            <list>                            <list>
5810                                <t>Restricts the search to instruments with keyword list                                <t>Restricts the search to instruments with keyword list
5811                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5812                                  supporting escape sequences as described in chapter
5813                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5814                            </list>                            </list>
5815                        </t>                        </t>
5816    
5817                        <t>IS_DRUM=true | false                        <t>IS_DRUM=true | false
5818                            <list>                            <list>
5819                                <t>Either true or false. Restricts the search to                                <t>Either true or false. Restricts the search to
5820                                drum kits or chromatic instruments.</t>                                drum kits or chromatic instruments.</t>
5821                            </list>                            </list>
5822                        </t>                        </t>
# Line 5862  Schoenebeck'> Line 5924  Schoenebeck'>
5924                      </t>                      </t>
5925                  </section>                  </section>
5926    
5927                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5928                        <t>The front-end can remove all instruments and directories and re-create
5929                        the instruments database structure (e.g., in case of a database corruption)
5930                        by sending the following command:</t>
5931                        <t>
5932                            <list>
5933                                <t>FORMAT INSTRUMENTS_DB</t>
5934                            </list>
5935                        </t>
5936                        
5937                        <t>Possible Answers:</t>
5938                        <t>
5939                            <list>
5940                                <t>"OK" -
5941                                    <list>
5942                                        <t>on success</t>
5943                                    </list>
5944                                </t>
5945                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5946                                    <list>
5947                                        <t>If the formatting of the instruments database
5948                                        failed.</t>
5949                                    </list>
5950                                </t>
5951                            </list>
5952                        </t>
5953                    </section>
5954    
5955              </section>              </section>
5956    
5957    
5958    
5959                <section title="Editing Instruments" anchor="editing_instruments">
5960                    <t>The sampler allows to edit instruments while playing with the
5961                    sampler by spawning an external (3rd party) instrument editor
5962                    application for a given instrument. The 3rd party instrument
5963                    editor applications have to place a respective plugin DLL file
5964                    into the sampler's plugins directory. The sampler will
5965                    automatically try to load all plugin DLLs in that directory on
5966                    startup and only on startup!</t>
5967                    <t>At the moment there is only one command for this feature set,
5968                    but this will most probably change in future.</t>
5969    
5970                    <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
5971                        <t>The front-end can request to open an appropriate instrument
5972                        editor application by sending the following command:</t>
5973                        <t>
5974                            <list>
5975                                <t>EDIT INSTRUMENT &lt;sampler-channel&gt;</t>
5976                            </list>
5977                        </t>
5978                        <t>Where &lt;sampler-channel&gt; should be replaced by the
5979                        number of the sampler channel as given by the
5980                        <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
5981                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
5982                        command.</t>
5983    
5984                        <t>The sampler will try to ask all registered instrument
5985                        editors (or to be more specific: their sampler plugins)
5986                        whether they are capable to handle the instrument on the
5987                        given sampler channel. The sampler will simply use the first
5988                        instrument editor application which replied with a positive
5989                        answer and spawn that instrument editor application within
5990                        the sampler's process and provide that application access
5991                        to the instrument's data structures, so both applications
5992                        can share and access the same instruments data at the same
5993                        time, thus allowing to immediately hear changes with the
5994                        sampler made by the instrument editor.</t>
5995    
5996                        <t>Note: consequently instrument editors are always spawned
5997                        locally on the same machine where the sampler is running
5998                        on!</t>
5999    
6000                        <t>Possible Answers:</t>
6001                        <t>
6002                            <list>
6003                                <t>"OK" -
6004                                    <list>
6005                                        <t>when an appropriate instrument editor was
6006                                        launched</t>
6007                                    </list>
6008                                </t>
6009                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6010                                    <list>
6011                                        <t>when an appropriate instrument editor was
6012                                        launched, but there are noteworthy issues</t>
6013                                    </list>
6014                                </t>
6015                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6016                                    <list>
6017                                        <t>when an appropriate instrument editor
6018                                        could not be launched</t>
6019                                    </list>
6020                                </t>
6021                            </list>
6022                        </t>
6023    
6024                        <t>Examples:</t>
6025                        <t>
6026                            <list>
6027                                <t>C: "EDIT INSTRUMENT 0"</t>
6028                                <t>S: "OK"</t>
6029                            </list>
6030                        </t>
6031                    </section>
6032                </section>
6033          </section>          </section>
6034    
6035    
# Line 5949  Schoenebeck'> Line 6115  Schoenebeck'>
6115                  </t>                  </t>
6116                  <t>/ COPY SP copy_instruction                  <t>/ COPY SP copy_instruction
6117                  </t>                  </t>
6118                    <t>/ EDIT SP edit_instruction
6119                    </t>
6120                    <t>/ FORMAT SP format_instruction
6121                    </t>
6122                  <t>/ RESET                  <t>/ RESET
6123                  </t>                  </t>
6124                  <t>/ QUIT                  <t>/ QUIT
# Line 5959  Schoenebeck'> Line 6129  Schoenebeck'>
6129          <list>          <list>
6130                  <t>CHANNEL                  <t>CHANNEL
6131                  </t>                  </t>
6132                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6133                  </t>                  </t>
6134                  <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
6135                  </t>                  </t>
6136                  <t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6137                  </t>                  </t>
6138                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6139                  </t>                  </t>
6140                  <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
6141                  </t>                  </t>
6142                  <t>/ DB_INSTRUMENTS SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP db_path SP filename
6143                  </t>                  </t>
6144                  <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index                  <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6145                  </t>                  </t>
6146                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
6147                  </t>                  </t>
# Line 6105  Schoenebeck'> Line 6275  Schoenebeck'>
6275                  </t>                  </t>
6276                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6277                  </t>                  </t>
6278                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6279                  </t>                  </t>
6280                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
6281                  </t>                  </t>
6282                  <t>/ DB_INSTRUMENT SP pathname                  <t>/ DB_INSTRUMENT SP db_path
6283                  </t>                  </t>
6284          </list>          </list>
6285  </t>  </t>
# Line 6181  Schoenebeck'> Line 6351  Schoenebeck'>
6351                  </t>                  </t>
6352                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6353                  </t>                  </t>
6354                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6355                  </t>                  </t>
6356                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6357                  </t>                  </t>
6358                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6359                  </t>                  </t>
6360                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6361                  </t>                  </t>
6362                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6363                  </t>                  </t>
6364                  <t>/ DB_INSTRUMENT SP INFO SP pathname                  <t>/ DB_INSTRUMENT SP INFO SP db_path
6365                  </t>                  </t>
6366                  <t>/ DB_INSTRUMENTS_JOB SP INFO SP number                  <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6367                  </t>                  </t>
# Line 6207  Schoenebeck'> Line 6377  Schoenebeck'>
6377                  </t>                  </t>
6378                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6379                  </t>                  </t>
6380                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6381                    </t>
6382                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
6383                  </t>                  </t>
6384                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
# Line 6221  Schoenebeck'> Line 6393  Schoenebeck'>
6393                  </t>                  </t>
6394                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6395                  </t>                  </t>
6396                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP raw_path
6397                  </t>                  </t>
6398                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP raw_path
6399                  </t>                  </t>
6400                  <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname                  <t>/ DB_INSTRUMENT SP NAME SP db_path SP raw_path
6401                  </t>                  </t>
6402                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval                  <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP raw_path
6403                  </t>                  </t>
6404                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6405                  </t>                  </t>
# Line 6267  Schoenebeck'> Line 6439  Schoenebeck'>
6439  </t>  </t>
6440  <t>find_instruction =  <t>find_instruction =
6441          <list>          <list>
6442                  <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
6443                  </t>                  </t>
6444                  <t>/ DB_INSTRUMENTS SP pathname SP query_val_list                  <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
6445                  </t>                  </t>
6446                  <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
6447                  </t>                  </t>
6448                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6449                  </t>                  </t>
6450          </list>          </list>
6451  </t>  </t>
6452  <t>move_instruction =  <t>move_instruction =
6453          <list>          <list>
6454                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6455                  </t>                  </t>
6456                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6457                  </t>                  </t>
6458          </list>          </list>
6459  </t>  </t>
6460  <t>copy_instruction =  <t>copy_instruction =
6461          <list>          <list>
6462                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6463                  </t>                  </t>
6464                  <t>/ DB_INSTRUMENT SP pathname SP pathname                  <t>/ DB_INSTRUMENT SP db_path SP db_path
6465                  </t>                  </t>
6466          </list>          </list>
6467  </t>  </t>
# Line 6343  Schoenebeck'> Line 6515  Schoenebeck'>
6515                  </t>                  </t>
6516          </list>          </list>
6517  </t>  </t>
6518    <t>edit_instruction =
6519            <list>
6520                    <t>INSTRUMENT SP sampler_channel
6521                    </t>
6522            </list>
6523    </t>
6524    <t>format_instruction =
6525            <list>
6526                    <t>INSTRUMENTS_DB
6527                    </t>
6528            </list>
6529    </t>
6530  <t>modal_arg =  <t>modal_arg =
6531          <list>          <list>
6532                  <t>/* epsilon (empty argument) */                  <t>/* epsilon (empty argument) */
# Line 6389  Schoenebeck'> Line 6573  Schoenebeck'>
6573                  </t>                  </t>
6574                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6575                  </t>                  </t>
6576                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6577                  </t>                  </t>
6578                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
6579                  </t>                  </t>
6580                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname                  <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
6581                  </t>                  </t>
6582                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP db_path
6583                  </t>                  </t>
6584          </list>          </list>
6585  </t>  </t>
# Line 6517  Schoenebeck'> Line 6701  Schoenebeck'>
6701                  </t>                  </t>
6702          </list>          </list>
6703  </t>  </t>
6704  <t>pathname =  <t>filename =
         <list>  
                 <t>stringval  
                 </t>  
         </list>  
 </t>  
 <t>dirname =  
6705          <list>          <list>
6706                  <t>stringval                  <t>path
6707                  </t>                  </t>
6708          </list>          </list>
6709  </t>  </t>
6710  <t>filename =  <t>db_path =
6711          <list>          <list>
6712                  <t>stringval                  <t>path
6713                  </t>                  </t>
6714          </list>          </list>
6715  </t>  </t>
# Line 6561  Schoenebeck'> Line 6739  Schoenebeck'>
6739                  </t>                  </t>
6740          </list>          </list>
6741  </t>  </t>
6742    
6743  <t>param_val =  <t>param_val =
6744          <list>          <list>
6745                  <t>string                  <t>string
# Line 6583  Schoenebeck'> Line 6762  Schoenebeck'>
6762  </t>  </t>
6763  <t>query_val =  <t>query_val =
6764          <list>          <list>
6765                  <t>string                  <t>raw_path_base
6766                  </t>                  </t>
6767                  <t>/ stringval                  <t>/ raw_path
6768                  </t>                  </t>
6769          </list>          </list>
6770  </t>  </t>
# Line 6601  Schoenebeck'> Line 6780  Schoenebeck'>
6780  </t>  </t>
6781    
6782              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6783    
6784                <section title="Character Set and Escape Sequences" anchor="character_set">
6785                    <t>Older versions of this protocol up to and including v1.1 only
6786                    supported the standard ASCII character set (ASCII code 0 - 127)
6787                    <xref target="RFC20"/>, all younger versions of this protocol
6788                    however support the Extended ASCII character set (ASCII code
6789                    0 - 255). The same group of younger protocols also support
6790                    escape sequences, but only for certain, explicitly declared
6791                    parts of the protocol. The supported escape sequences are
6792                    defined as follows:</t>
6793                    <texttable>
6794                        <ttcol>ASCII Character Sequence</ttcol>
6795                        <ttcol>Translated into (Name)</ttcol>
6796                        <c>\n</c> <c>new line</c>
6797                        <c>\r</c> <c>carriage return</c>
6798                        <c>\f</c> <c>form feed</c>
6799                        <c>\t</c> <c>horizontal tab</c>
6800                        <c>\v</c> <c>vertical tab</c>
6801                        <c>\'</c> <c>apostrophe</c>
6802                        <c>\"</c> <c>quotation mark</c>
6803                        <c>\\</c> <c>backslash</c>
6804                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
6805                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
6806                    </texttable>
6807                    <t>Notice: due to the transition of certain parts of the
6808                    protocol which now support escape sequences, a slight backward
6809                    incompatibility to protocols version v1.1 and younger has been
6810                    introduced. The only difference is that in parts of the protocol
6811                    where escape characters are now supported, a backslash characters
6812                    MUST be escaped as well (that is as double backslash), whereas
6813                    in the old versions a single backslash was sufficient.</t>
6814                </section>
6815          </section>          </section>
6816    
6817          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 6786  Schoenebeck'> Line 6997  Schoenebeck'>
6997              </section>              </section>
6998    
6999              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
7000                  <t>Client may want to be notified when the number of effect sends on                  <t>Client may want to be notified when the number of effect sends on
7001                  a particular sampler channel is changed by issuing the following command:</t>                  a particular sampler channel is changed by issuing the following command:</t>
7002                  <t>                  <t>
7003                      <list>                      <list>
# Line 7146  Schoenebeck'> Line 7357  Schoenebeck'>
7357                  </front>                  </front>
7358                  <seriesInfo name="RFC" value="2234" />                  <seriesInfo name="RFC" value="2234" />
7359              </reference>              </reference>
7360                <reference anchor="RFC20">
7361                    <front>
7362                        <title>ASCII format for Network Interchange</title>
7363                        <author>
7364                            <organization>UCLA</organization>
7365                        </author>
7366                        <date year="1969"></date>
7367                    </front>
7368                    <seriesInfo name="RFC" value="20" />
7369                </reference>
7370           </references>           </references>
7371      </back>      </back>
7372    
Legend:
Removed from v.1200  
changed lines
  Added in v.1387
  ViewVC Help
Powered by ViewVC