/[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 1249 by schoenebeck, Fri Jun 22 13:40: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.3cvs">
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="June" 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 2113  Schoenebeck'> Line 2113  Schoenebeck'>
2113                      number of the sampler channel the instrument should be assigned to.                      number of the sampler channel the instrument should be assigned to.
2114                      Each sampler channel can only have one instrument.</t>                      Each sampler channel can only have one instrument.</t>
2115    
2116                        <t>Notice: since LSCP 1.3 the &lt;filename&gt; argument supports
2117                        escape characters for special characters (see chapter
2118                        "<xref target="character_set">Character Set and Escape Sequences</xref>"
2119                        for details) and accordingly backslash characters in the filename
2120                        MUST now be escaped as well!</t>
2121    
2122                      <t>The difference between regular and NON_MODAL versions of the command                      <t>The difference between regular and NON_MODAL versions of the command
2123                      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
2124                      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 4325  Schoenebeck'> Line 4331  Schoenebeck'>
4331                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4332                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4333                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4334                      of the instrument's file to be deployed (encapsulated into apostrophes),                      of the instrument's file to be deployed (encapsulated into apostrophes,
4335                        supporting escape sequences as described in chapter
4336                        "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4337                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4338                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4339                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
# Line 5691  Schoenebeck'> Line 5699  Schoenebeck'>
5699    
5700                        <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]                        <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5701                            <list>                            <list>
5702                                <t>Restricts the search to instruments, which                                <t>Restricts the search to instruments, which
5703                                size is in the specified range. If &lt;min&gt; is omitted,                                size is in the specified range. If &lt;min&gt; is omitted,
5704                                the search results are restricted to instruments with size less then                                the search results are restricted to instruments with size less then
5705                                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 5754  Schoenebeck'> Line 5762  Schoenebeck'>
5762    
5763                        <t>IS_DRUM=true | false                        <t>IS_DRUM=true | false
5764                            <list>                            <list>
5765                                <t>Either true or false. Restricts the search to                                <t>Either true or false. Restricts the search to
5766                                drum kits or chromatic instruments.</t>                                drum kits or chromatic instruments.</t>
5767                            </list>                            </list>
5768                        </t>                        </t>
# Line 5949  Schoenebeck'> Line 5957  Schoenebeck'>
5957                  </t>                  </t>
5958                  <t>/ COPY SP copy_instruction                  <t>/ COPY SP copy_instruction
5959                  </t>                  </t>
5960                    <t>/ EDIT SP edit_instruction
5961                    </t>
5962                  <t>/ RESET                  <t>/ RESET
5963                  </t>                  </t>
5964                  <t>/ QUIT                  <t>/ QUIT
# Line 6343  Schoenebeck'> Line 6353  Schoenebeck'>
6353                  </t>                  </t>
6354          </list>          </list>
6355  </t>  </t>
6356    <t>edit_instruction =
6357            <list>
6358                    <t>INSTRUMENT SP sampler_channel
6359                    </t>
6360            </list>
6361    </t>
6362  <t>modal_arg =  <t>modal_arg =
6363          <list>          <list>
6364                  <t>/* epsilon (empty argument) */                  <t>/* epsilon (empty argument) */
# Line 6531  Schoenebeck'> Line 6547  Schoenebeck'>
6547  </t>  </t>
6548  <t>filename =  <t>filename =
6549          <list>          <list>
6550                  <t>stringval                  <t>stringval_escaped
6551                  </t>                  </t>
6552          </list>          </list>
6553  </t>  </t>
# Line 6601  Schoenebeck'> Line 6617  Schoenebeck'>
6617  </t>  </t>
6618    
6619              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6620    
6621                <section title="Character Set and Escape Sequences" anchor="character_set">
6622                    <t>Older versions of this protocol up to and including v1.2 only
6623                    supported the standard ASCII character set (ASCII code 0 - 127)
6624                    <xref target="RFC20"/>, all younger versions of this protocol
6625                    however support the Extended ASCII character set (ASCII code
6626                    0 - 255). The same group of younger protocols also support
6627                    escape sequences, but only for certain, explicitly declared
6628                    parts of the protocol. The supported escape sequences are
6629                    defined as follows:</t>
6630                    <texttable>
6631                        <ttcol>ASCII Character Sequence</ttcol>
6632                        <ttcol>Translated into (Name)</ttcol>
6633                        <c>\n</c> <c>new line</c>
6634                        <c>\r</c> <c>carriage return</c>
6635                        <c>\f</c> <c>form feed</c>
6636                        <c>\t</c> <c>horizontal tab</c>
6637                        <c>\v</c> <c>vertical tab</c>
6638                        <c>\'</c> <c>apostrophe</c>
6639                        <c>\"</c> <c>quotation mark</c>
6640                        <c>\\</c> <c>backslash</c>
6641                        <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
6642                        <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
6643                    </texttable>
6644                    <t>Notice: due to the transition of certain parts of the
6645                    protocol which now support escape sequences, a slight backward
6646                    incompatibility to protocols version v1.2 and younger has been
6647                    introduced. The only difference is that in parts of the protocol
6648                    where escape characters are now supported, a backslash characters
6649                    MUST be escaped as well (that is as double backslash), whereas
6650                    in the old versions a single backslash was sufficient.</t>
6651                </section>
6652          </section>          </section>
6653    
6654          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 6786  Schoenebeck'> Line 6834  Schoenebeck'>
6834              </section>              </section>
6835    
6836              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">              <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
6837                  <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
6838                  a particular sampler channel is changed by issuing the following command:</t>                  a particular sampler channel is changed by issuing the following command:</t>
6839                  <t>                  <t>
6840                      <list>                      <list>
# Line 7146  Schoenebeck'> Line 7194  Schoenebeck'>
7194                  </front>                  </front>
7195                  <seriesInfo name="RFC" value="2234" />                  <seriesInfo name="RFC" value="2234" />
7196              </reference>              </reference>
7197                <reference anchor="RFC20">
7198                    <front>
7199                        <title>ASCII format for Network Interchange</title>
7200                        <author>
7201                            <organization>UCLA</organization>
7202                        </author>
7203                        <date year="1969"></date>
7204                    </front>
7205                    <seriesInfo name="RFC" value="20" />
7206                </reference>
7207           </references>           </references>
7208      </back>      </back>
7209    

Legend:
Removed from v.1200  
changed lines
  Added in v.1249

  ViewVC Help
Powered by ViewVC