/[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 1249 by schoenebeck, Fri Jun 22 13:40:53 2007 UTC revision 1353 by iliev, Mon Sep 17 23:15:25 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.3cvs">  <rfc category="std" ipr="full3978" docName="LSCP 1.2cvs">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol (draft)</title>          <title>LinuxSampler Control Protocol (draft)</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="June" 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 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.3 the &lt;filename&gt; argument supports                      <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125                      escape characters for special characters (see chapter                      escape characters for special characters (see chapter
2126                      "<xref target="character_set">Character Set and Escape Sequences</xref>"                      "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127                      for details) and accordingly backslash characters in the filename                      for details) and accordingly backslash characters in the filename
# Line 4751  Schoenebeck'> Line 4759  Schoenebeck'>
4759    
4760              <section title="Managing Instruments Database" anchor="Managing Instruments Database">              <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4761                  <t>The following commands describe how to use and manage                  <t>The following commands describe how to use and manage
4762                  the instruments database.</t>                  the instruments database.</t>
4763                    <t>Notice:</t>
4764                        <t>
4765                            <list>
4766                                <t>All command arguments representing a path or
4767                                instrument/directory name support escape sequences as described in chapter
4768                                "<xref target="character_set">Character Set and Escape Sequences</xref>".
4769                                </t>
4770                                <t>All occurrences of a forward slash in instrument and directory
4771                                   names are escaped with its hex (\x2f) or octal (\057) escape sequence.
4772                                </t>
4773                            </list>
4774                        </t>
4775    
4776                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">                  <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4777                      <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 4949  Schoenebeck'>
4949                                  <list>                                  <list>
4950                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
4951                                          <list>                                          <list>
4952                                              <t>A brief description of the directory content</t>                                              <t>A brief description of the directory content.
4953                                                Note that the character string may contain
4954                                                <xref target="character_set">escape sequences</xref>.</t>
4955                                          </list>                                          </list>
4956                                      </t>                                      </t>
4957                                      <t>CREATED -                                      <t>CREATED -
# Line 5093  Schoenebeck'> Line 5115  Schoenebeck'>
5115                          </list>                          </list>
5116                      </t>                      </t>
5117                      <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
5118                      &lt;desc&gt; is the new description for the directory.</t>                      &lt;desc&gt; is the new description for the directory
5119                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5120                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5121    
5122                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5123                      <t>                      <t>
# Line 5138  Schoenebeck'> Line 5162  Schoenebeck'>
5162                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5163                            <list>                            <list>
5164                                <t>Restricts the search to directories, which names                                <t>Restricts the search to directories, which names
5165                                satisfy the supplied search string.</t>                                satisfy the supplied search string (encapsulated into apostrophes,
5166                                  supporting escape sequences as described in chapter
5167                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5168                            </list>                            </list>
5169                        </t>                        </t>
5170    
# Line 5169  Schoenebeck'> Line 5195  Schoenebeck'>
5195                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5196                            <list>                            <list>
5197                                <t>Restricts the search to directories with description                                <t>Restricts the search to directories with description
5198                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string
5199                                  (encapsulated into apostrophes, supporting escape
5200                                  sequences as described in chapter
5201                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5202                            </list>                            </list>
5203                        </t>                        </t>
5204                      </t>                      </t>
# Line 5430  Schoenebeck'> Line 5459  Schoenebeck'>
5459                                  <list>                                  <list>
5460                                      <t>INSTRUMENT_FILE -                                      <t>INSTRUMENT_FILE -
5461                                          <list>                                          <list>
5462                                              <t>File name of the instrument.</t>                                              <t>File name of the instrument.
5463                                                Note that the character string may contain
5464                                                <xref target="character_set">escape sequences</xref>.</t>
5465                                          </list>                                          </list>
5466                                      </t>                                      </t>
5467                                      <t>INSTRUMENT_NR -                                      <t>INSTRUMENT_NR -
# Line 5469  Schoenebeck'> Line 5500  Schoenebeck'>
5500                                      </t>                                      </t>
5501                                      <t>DESCRIPTION -                                      <t>DESCRIPTION -
5502                                          <list>                                          <list>
5503                                              <t>A brief description of the instrument</t>                                              <t>A brief description of the instrument.
5504                                                Note that the character string may contain
5505                                                <xref target="character_set">escape sequences</xref>.</t>
5506                                          </list>                                          </list>
5507                                      </t>                                      </t>
5508                                      <t>IS_DRUM -                                      <t>IS_DRUM -
# Line 5480  Schoenebeck'> Line 5513  Schoenebeck'>
5513                                      </t>                                      </t>
5514                                      <t>PRODUCT -                                      <t>PRODUCT -
5515                                          <list>                                          <list>
5516                                              <t>The product title of the instrument</t>                                              <t>The product title of the instrument.
5517                                                Note that the character string may contain
5518                                                <xref target="character_set">escape sequences</xref>.</t>
5519                                          </list>                                          </list>
5520                                      </t>                                      </t>
5521                                      <t>ARTISTS -                                      <t>ARTISTS -
5522                                          <list>                                          <list>
5523                                              <t>Lists the artist names</t>                                              <t>Lists the artist names.
5524                                                Note that the character string may contain
5525                                                <xref target="character_set">escape sequences</xref>.</t>
5526                                          </list>                                          </list>
5527                                      </t>                                      </t>
5528                                      <t>KEYWORDS -                                      <t>KEYWORDS -
5529                                          <list>                                          <list>
5530                                              <t>Provides a list of keywords that refer to the instrument.                                              <t>Provides a list of keywords that refer to the instrument.
5531                                              Keywords are separated with semicolon and blank.</t>                                              Keywords are separated with semicolon and blank.
5532                                                Note that the character string may contain
5533                                                <xref target="character_set">escape sequences</xref>.</t>
5534                                          </list>                                          </list>
5535                                      </t>                                      </t>
5536                                  </list>                                  </list>
# Line 5648  Schoenebeck'> Line 5687  Schoenebeck'>
5687                          </list>                          </list>
5688                      </t>                      </t>
5689                      <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
5690                      &lt;desc&gt; is the new description for the instrument.</t>                      &lt;desc&gt; is the new description for the instrument
5691                        (encapsulated into apostrophes, supporting escape sequences as described in chapter
5692                        "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5693    
5694                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
5695                      <t>                      <t>
# Line 5693  Schoenebeck'> Line 5734  Schoenebeck'>
5734                        <t>NAME='&lt;search-string&gt;'                        <t>NAME='&lt;search-string&gt;'
5735                            <list>                            <list>
5736                                <t>Restricts the search to instruments, which names                                <t>Restricts the search to instruments, which names
5737                                satisfy the supplied search string.</t>                                satisfy the supplied search string (encapsulated into apostrophes,
5738                                  supporting escape sequences as described in chapter
5739                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5740                            </list>                            </list>
5741                        </t>                        </t>
5742    
# Line 5735  Schoenebeck'> Line 5778  Schoenebeck'>
5778                        <t>DESCRIPTION='&lt;search-string&gt;'                        <t>DESCRIPTION='&lt;search-string&gt;'
5779                            <list>                            <list>
5780                                <t>Restricts the search to instruments with description                                <t>Restricts the search to instruments with description
5781                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5782                                  supporting escape sequences as described in chapter
5783                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5784                            </list>                            </list>
5785                        </t>                        </t>
5786    
5787                        <t>PRODUCT='&lt;search-string&gt;'                        <t>PRODUCT='&lt;search-string&gt;'
5788                            <list>                            <list>
5789                                <t>Restricts the search to instruments with product info                                <t>Restricts the search to instruments with product info
5790                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5791                                  supporting escape sequences as described in chapter
5792                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5793                            </list>                            </list>
5794                        </t>                        </t>
5795    
5796                        <t>ARTISTS='&lt;search-string&gt;'                        <t>ARTISTS='&lt;search-string&gt;'
5797                            <list>                            <list>
5798                                <t>Restricts the search to instruments with artists info                                <t>Restricts the search to instruments with artists info
5799                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5800                                  supporting escape sequences as described in chapter
5801                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5802                            </list>                            </list>
5803                        </t>                        </t>
5804    
5805                        <t>KEYWORDS='&lt;search-string&gt;'                        <t>KEYWORDS='&lt;search-string&gt;'
5806                            <list>                            <list>
5807                                <t>Restricts the search to instruments with keyword list                                <t>Restricts the search to instruments with keyword list
5808                                that satisfies the supplied search string.</t>                                that satisfies the supplied search string (encapsulated into apostrophes,
5809                                  supporting escape sequences as described in chapter
5810                                  "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5811                            </list>                            </list>
5812                        </t>                        </t>
5813    
# Line 5870  Schoenebeck'> Line 5921  Schoenebeck'>
5921                      </t>                      </t>
5922                  </section>                  </section>
5923    
5924                    <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
5925                        <t>The front-end can remove all instruments and directories and re-create
5926                        the instruments database structure (e.g., in case of a database corruption)
5927                        by sending the following command:</t>
5928                        <t>
5929                            <list>
5930                                <t>FORMAT INSTRUMENTS_DB</t>
5931                            </list>
5932                        </t>
5933                        
5934                        <t>Possible Answers:</t>
5935                        <t>
5936                            <list>
5937                                <t>"OK" -
5938                                    <list>
5939                                        <t>on success</t>
5940                                    </list>
5941                                </t>
5942                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5943                                    <list>
5944                                        <t>If the formatting of the instruments database
5945                                        failed.</t>
5946                                    </list>
5947                                </t>
5948                            </list>
5949                        </t>
5950                    </section>
5951    
5952              </section>              </section>
5953    
5954          </section>          </section>
# Line 6217  Schoenebeck'> Line 6296  Schoenebeck'>
6296                  </t>                  </t>
6297                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list                  <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
6298                  </t>                  </t>
6299                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6300                    </t>
6301                  <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
6302                  </t>                  </t>
6303                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
# Line 6619  Schoenebeck'> Line 6700  Schoenebeck'>
6700              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6701    
6702              <section title="Character Set and Escape Sequences" anchor="character_set">              <section title="Character Set and Escape Sequences" anchor="character_set">
6703                  <t>Older versions of this protocol up to and including v1.2 only                  <t>Older versions of this protocol up to and including v1.1 only
6704                  supported the standard ASCII character set (ASCII code 0 - 127)                  supported the standard ASCII character set (ASCII code 0 - 127)
6705                  <xref target="RFC20"/>, all younger versions of this protocol                  <xref target="RFC20"/>, all younger versions of this protocol
6706                  however support the Extended ASCII character set (ASCII code                  however support the Extended ASCII character set (ASCII code
# Line 6643  Schoenebeck'> Line 6724  Schoenebeck'>
6724                  </texttable>                  </texttable>
6725                  <t>Notice: due to the transition of certain parts of the                  <t>Notice: due to the transition of certain parts of the
6726                  protocol which now support escape sequences, a slight backward                  protocol which now support escape sequences, a slight backward
6727                  incompatibility to protocols version v1.2 and younger has been                  incompatibility to protocols version v1.1 and younger has been
6728                  introduced. The only difference is that in parts of the protocol                  introduced. The only difference is that in parts of the protocol
6729                  where escape characters are now supported, a backslash characters                  where escape characters are now supported, a backslash characters
6730                  MUST be escaped as well (that is as double backslash), whereas                  MUST be escaped as well (that is as double backslash), whereas
Legend:
Removed from v.1249  
changed lines
  Added in v.1353
  ViewVC Help
Powered by ViewVC