/[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 556 by schoenebeck, Sat May 21 01:10:12 2005 UTC revision 828 by schoenebeck, Sun Jan 8 21:12:33 2006 UTC
# Line 13  Line 13 
13  <?rfc iprnotified="no" ?>  <?rfc iprnotified="no" ?>
14  <?rfc strict="yes" ?>  <?rfc strict="yes" ?>
15    
16  <rfc category="std" ipr="full2026" docName="lscp.txt">  <rfc category="std" ipr="full2026" docName="LSCP 1.1">
17      <front>      <front>
18          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
19          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 31  Schoenebeck'> Line 31  Schoenebeck'>
31                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
32              </address>              </address>
33          </author>          </author>
34          <date month="May" year="2005"/>          <date month="September" year="2005"/>
35          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
36          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
37          <abstract>          <abstract>
38              <t>The LinuxSampler Control Protocol (LSCP) is an              <t>The LinuxSampler Control Protocol (LSCP) is an
39              application-level protocol primarily intended for local and              application-level protocol primarily intended for local and
40              remote controlling the LinuxSampler main application, which is a              remote controlling the LinuxSampler backend application, which is a
41              sophisticated console application essentially playing back audio              sophisticated server-like console application essentially playing
42              samples and manipulating the samples in real time to certain              back audio samples and manipulating the samples in real time to
43              extent.</t>              certain extent.</t>
44          </abstract>          </abstract>
45      </front>      </front>
46    
# Line 112  Schoenebeck'> Line 112  Schoenebeck'>
112              return and line feed characters respectively.</t>              return and line feed characters respectively.</t>
113          </section>          </section>
114    
115            <section title="Versioning of this specification" anchor="LSCP versioning">
116                <t>LSCP will certainly be extended and enhanced by-and-by. Each official
117                release of the LSCP specification will be tagged with a unique version
118                tuple. The version tuple consists at least of a major and minor version
119                number like:
120                </t>
121                <t>
122                    <list>
123                        <t>"1.2"</t>
124                    </list>
125                </t>
126                <t>
127                In this example the major version number would be "1" and the minor
128                version number would be "2". Note that the version tuple might also
129                have more than two elements. The major version number defines a
130                group of backward compatible versions. That means a frontend is
131                compatible to the connected sampler if and only if the LSCP versions
132                to which each of the two parties complies to, match both of the
133                following rules:
134                </t>
135                <t>Compatibility:</t>
136                <t>
137                    <list style="numbers">
138                        <t>The frontend's LSCP major version and the sampler's LSCP
139                        major version are exactly equal.</t>
140                        <t>The frontend's LSCP minor version is less or equal than
141                        the sampler's LSCP minor version.</t>
142                    </list>
143                </t>
144                <t>
145                Compatibility can only be claimed if both rules are true.
146                The frontend can use the
147                <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
148                get the version of the LSCP specification the sampler complies with.
149                </t>
150            </section>
151    
152          <section title="Introduction">          <section title="Introduction">
153              <t>LinuxSampler is a so called software sampler application              <t>LinuxSampler is a so called software sampler application
154              capable to playback audio samples from a computer's Random              capable to playback audio samples from a computer's Random
# Line 124  Schoenebeck'> Line 161  Schoenebeck'>
161              arbitrary MIDI input method and arbitrary MIDI channel (e.g.              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
162              sampler channel 17 could be connected to an ALSA sequencer              sampler channel 17 could be connected to an ALSA sequencer
163              device 64:0 and listening to MIDI channel 1 there). Each sampler              device 64:0 and listening to MIDI channel 1 there). Each sampler
164              engine will be assigned an own instance of one of the available              channel will be associated with an instance of one of the available
165              sampler engines (e.g. GigEngine, DLSEngine). The audio output of              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
166              each sampler channel can be routed to an arbitrary audio output              each sampler channel can be routed to an arbitrary audio output
167              method (ALSA / JACK) and an arbitrary audio output channel              method (ALSA / JACK) and an arbitrary audio output channel
# Line 154  Schoenebeck'> Line 191  Schoenebeck'>
191              methods will be described next.</t>              methods will be described next.</t>
192    
193              <section title="Request/response communication method">              <section title="Request/response communication method">
194                  <t>This simple communication method is based on TCP. The                  <t>This simple communication method is based on
195                    <xref target="RFC793">TCP</xref>. The
196                  front-end application establishes a TCP connection to the                  front-end application establishes a TCP connection to the
197                  LinuxSampler instance on a certain host system. Then the                  LinuxSampler instance on a certain host system. Then the
198                  front-end application will send certain ASCII based commands                  front-end application will send certain ASCII based commands
# Line 425  Schoenebeck'> Line 463  Schoenebeck'>
463              </section>              </section>
464          </section>          </section>
465    
466          <section title="Description for control commands">          <section title="Description for control commands" anchor="control_commands">
467              <t>This chapter will describe the available control commands              <t>This chapter will describe the available control commands
468              that can be sent on the TCP connection in detail. Some certain              that can be sent on the TCP connection in detail. Some certain
469              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
# Line 683  Schoenebeck'> Line 721  Schoenebeck'>
721    
722                              <t>DEPENDS -                              <t>DEPENDS -
723                                <list>                                <list>
724                                  <t>comma separated list of paramters this parameter depends                                  <t>comma separated list of parameters this parameter depends
725                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
726                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
727                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 796  Schoenebeck'> Line 834  Schoenebeck'>
834                      </t>                      </t>
835    
836                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
837                      output system and &lt;param-list&gt; by an optional list of driver                      output system as returned by the
838                        <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
839                        command and &lt;param-list&gt; by an optional list of driver
840                      specific parameters in form of "key1=val1 key2=val2 ...", where                      specific parameters in form of "key1=val1 key2=val2 ...", where
841                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
842                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 1017  Schoenebeck'> Line 1057  Schoenebeck'>
1057                          </list>                          </list>
1058                      </t>                      </t>
1059                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1060                      audio output device, &lt;key&gt; by the name of the parameter to change                      audio output device as given by the
1061                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1062                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1063                        command, &lt;key&gt; by the name of the parameter to change
1064                      and &lt;value&gt; by the new value for this parameter.</t>                      and &lt;value&gt; by the new value for this parameter.</t>
1065                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1066                      <t>                      <t>
# Line 1058  Schoenebeck'> Line 1101  Schoenebeck'>
1101                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
1102                          </list>                          </list>
1103                      </t>                      </t>
1104                      <t>Where &lt;device-id&gt; is the numerical ID of the audio output device                      <t>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1105                      and &lt;audio-chan&gt; the audio channel number.</t>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1106                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1107                        command and &lt;audio-chan&gt; the audio channel number.</t>
1108                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1109                      <t>                      <t>
1110                          <list>                          <list>
# Line 1158  Schoenebeck'> Line 1203  Schoenebeck'>
1203                          </list>                          </list>
1204                      </t>                      </t>
1205    
1206                      <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned                      <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
1207                      by the <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1208                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1209                      command, &lt;chan&gt; the audio channel number                      command, &lt;chan&gt; the audio channel number
1210                      and &lt;param&gt; a specific channel parameter name for which information should                      and &lt;param&gt; a specific channel parameter name for which information should
1211                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
# Line 1261  Schoenebeck'> Line 1307  Schoenebeck'>
1307                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
1308                          </list>                          </list>
1309                      </t>                      </t>
1310                      <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio                      <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
1311                      device, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the                      <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1312                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1313                        command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
1314                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>
1315                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1316                      <t>                      <t>
# Line 1386  Schoenebeck'> Line 1434  Schoenebeck'>
1434                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
1435                          </list>                          </list>
1436                      </t>                      </t>
1437                      <t>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver.</t>                      <t>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
1438                        by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1439                        "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
1440                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1441                      <t>                      <t>
1442                          <list>                          <list>
# Line 1441  Schoenebeck'> Line 1491  Schoenebeck'>
1491                          </list>                          </list>
1492                      </t>                      </t>
1493    
1494                      <t>Where &lt;midi-t&gt; is the name of the MIDI input driver as returned                      <t>Where &lt;midit&gt; is the name of the MIDI input driver as returned
1495                      by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">                      by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1496                      "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific                      "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
1497                      parameter name for which information should be obtained (as returned by the                      parameter name for which information should be obtained (as returned by the
# Line 1514  Schoenebeck'> Line 1564  Schoenebeck'>
1564    
1565                              <t>DEPENDS -                              <t>DEPENDS -
1566                                <list>                                <list>
1567                                  <t>comma separated list of paramters this parameter depends                                  <t>comma separated list of parameters this parameter depends
1568                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1569                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1570                                  listed parameters, for example assuming that an audio                                  listed parameters, for example assuming that an audio
# Line 1596  Schoenebeck'> Line 1646  Schoenebeck'>
1646                          </list>                          </list>
1647                      </t>                      </t>
1648    
1649                      <t>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system and &lt;param-list&gt; by an                      <t>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
1650                        by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1651                        "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
1652                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
1653                      character string values should be encapsulated into apostrophes (').                      character string values should be encapsulated into apostrophes (').
1654                      Note that there might be drivers which require parameter(s) to be                      Note that there might be drivers which require parameter(s) to be
# Line 1643  Schoenebeck'> Line 1695  Schoenebeck'>
1695                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
1696                          </list>                          </list>
1697                      </t>                      </t>
1698                      <t>Where &lt;device-id&gt; should be replaced by the device's numerical ID.</t>                      <t>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
1699                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1700                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1701                        command.</t>
1702                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1703                      <t>                      <t>
1704                          <list>                          <list>
# Line 1735  Schoenebeck'> Line 1790  Schoenebeck'>
1790                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
1791                          </list>                          </list>
1792                      </t>                      </t>
1793                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device.</t>                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1794                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1795                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1796                        command.</t>
1797                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1798                      <t>                      <t>
1799                          <list>                          <list>
# Line 1800  Schoenebeck'> Line 1858  Schoenebeck'>
1858                      </t>                      </t>
1859    
1860                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1861                      MIDI input device, &lt;key&gt; by the name of the parameter to change and                      MIDI input device as returned by the
1862                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1863                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1864                        command, &lt;key&gt; by the name of the parameter to change and
1865                      &lt;value&gt; by the new value for this parameter.</t>                      &lt;value&gt; by the new value for this parameter.</t>
1866    
1867                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 1841  Schoenebeck'> Line 1902  Schoenebeck'>
1902                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
1903                          </list>                          </list>
1904                      </t>                      </t>
1905                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device                      <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1906                      and &lt;midi-port&gt; the MIDI input port number.</t>                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1907                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1908                        command and &lt;midi-port&gt; the MIDI input port number.</t>
1909                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
1910                      <t>                      <t>
1911                          <list>                          <list>
# Line 1884  Schoenebeck'> Line 1947  Schoenebeck'>
1947                          </list>                          </list>
1948                      </t>                      </t>
1949    
1950                      <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned                      <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
1951                      by the <xref target="LIST MIDI_INPUT_DEVICES">                      <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1952                      "LIST MIDI_INPUT_DEVICES"</xref> command, &lt;port&gt; the MIDI port number and                      or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1953                        command, &lt;port&gt; the MIDI port number and
1954                      &lt;param&gt; a specific port parameter name for which information should be                      &lt;param&gt; a specific port parameter name for which information should be
1955                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1956                      "GET MIDI_INPUT_PORT INFO"</xref> command).</t>                      "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
# Line 1989  Schoenebeck'> Line 2053  Schoenebeck'>
2053                      </t>                      </t>
2054    
2055                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
2056                      MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of                      MIDI device as returned by the
2057                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2058                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2059                        command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2060                      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
2061                      parameter.</t>                      parameter.</t>
2062    
# Line 2025  Schoenebeck'> Line 2092  Schoenebeck'>
2092              </section>              </section>
2093    
2094              <section title="Configuring sampler channels">              <section title="Configuring sampler channels">
2095                  <t>The following commands describe how to add and remove sampler channels, deploy                  <t>The following commands describe how to add and remove sampler channels, associate a
2096                  sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t>                  sampler channel with a sampler engine, load instruments and connect sampler channels to
2097                    MIDI and audio devices.</t>
2098    
2099                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2100                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>                      <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
# Line 2086  Schoenebeck'> Line 2154  Schoenebeck'>
2154                  </section>                  </section>
2155    
2156                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2157                      <t>A sample engine can be deployed and assigned to a specific sampler                      <t>A sampler engine type can be associated to a specific sampler
2158                      channel by the following command:</t>                      channel by the following command:</t>
2159                      <t>                      <t>
2160                          <list>                          <list>
# Line 2096  Schoenebeck'> Line 2164  Schoenebeck'>
2164    
2165                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2166                      <xref target="LIST AVAILABLE_ENGINES">                      <xref target="LIST AVAILABLE_ENGINES">
2167                      "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt; the sampler channel the                      "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
2168                      deployed engine should be assigned to. Even if the respective                      the sampler channel as returned by the
2169                      sampler channel has already a deployed engine with that engine                      <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
2170                      name, a new engine instance will be assigned to the sampler channel.</t>                      <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
2171                        the engine type should be assigned to. This command should be issued
2172                        after adding a new sampler channel and before any other control
2173                        commands on the new sampler channel. It can also be used to change
2174                        the engine type of a sampler channel. This command has (currently) no
2175                        way to define or force if a new engine instance should be created and
2176                        assigned to the given sampler channel or if an already existing
2177                        instance of that engine type, shared with other sampler channels,
2178                        should be used.</t>
2179    
2180                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2181                      <t>                      <t>
# Line 2205  Schoenebeck'> Line 2281  Schoenebeck'>
2281                                  <list>                                  <list>
2282                                      <t>in case a new sampler channel could be added, where                                      <t>in case a new sampler channel could be added, where
2283                                      &lt;sampler-channel&gt; reflects the channel number of the new                                      &lt;sampler-channel&gt; reflects the channel number of the new
2284                                      created sampler channel which should the be used to set up                                      created sampler channel which should be used to set up
2285                                      the sampler channel by sending subsequent intialization                                      the sampler channel by sending subsequent initialization
2286                                      commands</t>                                      commands</t>
2287                                  </list>                                  </list>
2288                              </t>                              </t>
# Line 2241  Schoenebeck'> Line 2317  Schoenebeck'>
2317                          </list>                          </list>
2318                      </t>                      </t>
2319    
2320                      <t>This will decrement the sampler channel count by one and also                      <t>Where &lt;sampler-channel&gt; should be replaced by the
2321                      decrement the channel numbers of all subsequent sampler channels by                      number of the sampler channel as given by the
2322                      one.</t>                      <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2323                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
2324                        command. The channel numbers of all subsequent sampler channels
2325                        remain the same.</t>
2326    
2327                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2328                      <t>                      <t>
# Line 2308  Schoenebeck'> Line 2387  Schoenebeck'>
2387                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2388                      <t>                      <t>
2389                          <list>                          <list>
2390                              <t>LinuxSampler will answer by sending a comma separated character                              <t>LinuxSampler will answer by sending a comma separated list
2391                              string of the engines' names. Engine names can consist of lower and                              of the engines' names encapsulated into apostrophes (').
2392                              upper cases, digits and underlines ("_" character).</t>                              Engine names can consist of lower and upper cases,
2393                                digits and underlines ("_" character).</t>
2394                          </list>                          </list>
2395                      </t>                      </t>
2396                      <t>Example:</t>                      <t>Example:</t>
2397                      <t>                      <t>
2398                          <list>                          <list>
2399                              <t>C: "LIST AVAILABLE_ENGINES"</t>                              <t>C: "LIST AVAILABLE_ENGINES"</t>
2400                              <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>                              <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
2401                          </list>                          </list>
2402                      </t>                      </t>
2403                  </section>                  </section>
# Line 2380  Schoenebeck'> Line 2460  Schoenebeck'>
2460                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
2461                          </list>                          </list>
2462                      </t>                      </t>
2463                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.</t>                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2464                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2465                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2466                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2467                      <t>                      <t>
2468                          <list>                          <list>
# Line 2394  Schoenebeck'> Line 2476  Schoenebeck'>
2476                                  <list>                                  <list>
2477                                      <t>ENGINE_NAME -                                      <t>ENGINE_NAME -
2478                                          <list>                                          <list>
2479                                              <t>name of the engine that is deployed on the sampler                                              <t>name of the engine that is associated with the sampler
2480                                              channel, "NONE" if there's no engine deployed yet for                                              channel, "NONE" if there's no engine associated yet for
2481                                              this sampler channel</t>                                              this sampler channel</t>
2482                                          </list>                                          </list>
2483                                      </t>                                      </t>
# Line 2474  Schoenebeck'> Line 2556  Schoenebeck'>
2556                                              1.0 means amplification)</t>                                              1.0 means amplification)</t>
2557                                          </list>                                          </list>
2558                                      </t>                                      </t>
2559                                        <t>MUTE -
2560                                            <list>
2561                                                <t>Determines whether the channel is muted, "true" if the
2562                                                channel is muted, "false" if the channel is not muted, and
2563                                                "MUTED_BY_SOLO" if the channel is muted because of the
2564                                                presence of a solo channel and will be unmuted when
2565                                                there are no solo channels left</t>
2566                                            </list>
2567                                        </t>
2568                                        <t>SOLO -
2569                                            <list>
2570                                                <t>Determines whether this is a solo channel, "true" if
2571                                                the channel is a solo channel; "false" otherwise</t>
2572                                            </list>
2573                                        </t>
2574                                  </list>                                  </list>
2575                              </t>                              </t>
2576                          </list>                          </list>
# Line 2509  Schoenebeck'> Line 2606  Schoenebeck'>
2606                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
2607                          </list>                          </list>
2608                      </t>                      </t>
2609                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.</t>                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2610                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2611                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2612    
2613                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2614                      <t>                      <t>
# Line 2534  Schoenebeck'> Line 2633  Schoenebeck'>
2633                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
2634                          </list>                          </list>
2635                      </t>                      </t>
2636                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in.</t>                      <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2637                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2638                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2639    
2640                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2641                      <t>                      <t>
# Line 2568  Schoenebeck'> Line 2669  Schoenebeck'>
2669                          </list>                          </list>
2670                      </t>                      </t>
2671                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
2672                      sampler channel number the front-end is interested in.</t>                      sampler channel number the front-end is interested in
2673                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2674                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2675    
2676                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2677                      <t>                      <t>
# Line 2612  Schoenebeck'> Line 2715  Schoenebeck'>
2715                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
2716                          </list>                          </list>
2717                      </t>                      </t>
2718                      <t>Where &lt;audio-device-id&gt; is the numerical ID of the audio output                      <t>Where &lt;sampler-channel&gt; is the respective sampler channel
2719                      device and &lt;sampler-channel&gt; is the respective sampler channel                      number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2720                      number.</t>                      or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
2721                        &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
2722                        <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
2723                        or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
2724                        command.</t>
2725    
2726                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2727                      <t>                      <t>
# Line 2697  Schoenebeck'> Line 2804  Schoenebeck'>
2804                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
2805                          </list>                          </list>
2806                      </t>                      </t>
2807                      <t>Where &lt;sampler-chan&gt; is the sampler channel number, &lt;audio-out&gt; is the                      <t>Where &lt;sampler-chan&gt; is the sampler channel number
2808                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2809                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
2810                      numerical ID of the sampler channel's audio output channel which should be                      numerical ID of the sampler channel's audio output channel which should be
2811                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
2812                      output device where &lt;audio-out&gt; should be routed to.</t>                      output device where &lt;audio-out&gt; should be routed to.</t>
# Line 2740  Schoenebeck'> Line 2849  Schoenebeck'>
2849                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
2850                          </list>                          </list>
2851                      </t>                      </t>
2852                      <t>Where &lt;sampler-channel&gt; is the sampler channel number and &lt;midi-device-id&gt; is the                      <t>Where &lt;sampler-channel&gt; is the sampler channel number
2853                      the numerical ID of the MIDI input device.</t>                      as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2854                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2855                        and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
2856                        <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2857                        or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
2858    
2859                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
2860                      <t>                      <t>
# Line 2845  Schoenebeck'> Line 2958  Schoenebeck'>
2958                              </t>                              </t>
2959                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2960                                  <list>                                  <list>
2961                                      <t>in case it failed, providing an appropriate error code and error messag</t>                                      <t>in case it failed, providing an appropriate error code and error message</t>
2962                                  </list>                                  </list>
2963                              </t>                              </t>
2964                          </list>                          </list>
# Line 2943  Schoenebeck'> Line 3056  Schoenebeck'>
3056                      </t>                      </t>
3057                  </section>                  </section>
3058    
3059                    <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
3060                        <t>The front-end can mute/unmute a specific sampler
3061                        channel by sending the following command:</t>
3062                        <t>
3063                            <list>
3064                                <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
3065                            </list>
3066                        </t>
3067                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3068                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3069                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3070                        &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
3071                        to unmute the channel.</t>
3072    
3073                        <t>Possible Answers:</t>
3074                        <t>
3075                            <list>
3076                                <t>"OK" -
3077                                    <list>
3078                                        <t>on success</t>
3079                                    </list>
3080                                </t>
3081                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3082                                    <list>
3083                                        <t>if the channel was muted/unmuted, but there are noteworthy
3084                                        issue(s) related, providing an appropriate warning code and
3085                                        warning message</t>
3086                                    </list>
3087                                </t>
3088                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3089                                    <list>
3090                                        <t>in case it failed, providing an appropriate error code and error message</t>
3091                                    </list>
3092                                </t>
3093                            </list>
3094                        </t>
3095                        <t>Examples:</t>
3096                        <t>
3097                            <list>
3098                                <t></t>
3099                            </list>
3100                        </t>
3101                    </section>
3102    
3103                    <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
3104                        <t>The front-end can solo/unsolo a specific sampler channel
3105                        by sending the following command:</t>
3106                        <t>
3107                            <list>
3108                                <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
3109                            </list>
3110                        </t>
3111                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3112                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3113                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3114                        &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
3115                        to unsolo the channel.</t>
3116    
3117                        <t>Possible Answers:</t>
3118                        <t>
3119                            <list>
3120                                <t>"OK" -
3121                                    <list>
3122                                        <t>on success</t>
3123                                    </list>
3124                                </t>
3125                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3126                                    <list>
3127                                        <t>if the channel was soloed/unsoloed, but there are noteworthy
3128                                        issue(s) related, providing an appropriate warning code and
3129                                        warning message</t>
3130                                    </list>
3131                                </t>
3132                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3133                                    <list>
3134                                        <t>in case it failed, providing an appropriate error code and error message</t>
3135                                    </list>
3136                                </t>
3137                            </list>
3138                        </t>
3139                        <t>Examples:</t>
3140                        <t>
3141                            <list>
3142                                <t></t>
3143                            </list>
3144                        </t>
3145                    </section>
3146    
3147                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3148                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
3149                      <t>                      <t>
# Line 3128  Schoenebeck'> Line 3329  Schoenebeck'>
3329              <section title="Global commands">              <section title="Global commands">
3330                  <t>The following commands have global impact on the sampler.</t>                  <t>The following commands have global impact on the sampler.</t>
3331    
3332                    <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3333                        <t>The front-end can ask for the current number of active voices on
3334                        the sampler by sending the following command:</t>
3335                        <t>
3336                            <list>
3337                                <t>GET TOTAL_VOICE_COUNT</t>
3338                            </list>
3339                        </t>
3340    
3341                        <t>Possible Answers:</t>
3342                        <t>
3343                            <list>
3344                                <t>LinuxSampler will answer by returning the number of all active
3345                                voices on the sampler.</t>
3346                            </list>
3347                        </t>
3348                    </section>
3349    
3350                    <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3351                        <t>The front-end can ask for the maximum number of active voices
3352                        by sending the following command:</t>
3353                        <t>
3354                            <list>
3355                                <t>GET TOTAL_VOICE_COUNT_MAX</t>
3356                            </list>
3357                        </t>
3358    
3359                        <t>Possible Answers:</t>
3360                        <t>
3361                            <list>
3362                                <t>LinuxSampler will answer by returning the maximum number
3363                                of active voices.</t>
3364                            </list>
3365                        </t>
3366                    </section>
3367    
3368                  <section title="Reset sampler" anchor="RESET">                  <section title="Reset sampler" anchor="RESET">
3369                      <t>The front-end can reset the whole sampler by sending the following command:</t>                      <t>The front-end can reset the whole sampler by sending the following command:</t>
3370                      <t>                      <t>
# Line 3153  Schoenebeck'> Line 3390  Schoenebeck'>
3390                          </list>                          </list>
3391                      </t>                      </t>
3392                  </section>                  </section>
3393    
3394                    <section title="General sampler informations" anchor="GET SERVER INFO">
3395                        <t>The client can ask for general informations about the LinuxSampler
3396                           instance by sending the following command:</t>
3397                        <t>
3398                            <list>
3399                                <t>GET SERVER INFO</t>
3400                            </list>
3401                        </t>
3402                        <t>Possible Answers:</t>
3403                        <t>
3404                            <list>
3405                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
3406                                   Each answer line begins with the information category name
3407                                   followed by a colon and then a space character &lt;SP&gt; and finally
3408                                   the info character string to that information category. At the
3409                                   moment the following categories are defined:
3410                                </t>
3411                                <t>
3412                                    <list>
3413                                        <t>DESCRIPTION -
3414                                            <list>
3415                                                <t>arbitrary textual description about the sampler</t>
3416                                            </list>
3417                                        </t>
3418                                        <t>VERSION -
3419                                            <list>
3420                                                <t>version of the sampler</t>
3421                                            </list>
3422                                        </t>
3423                                        <t>PROTOCOL_VERSION -
3424                                            <list>
3425                                                <t>version of the LSCP specification the sampler
3426                                                complies with (see <xref target="LSCP versioning" /> for details)</t>
3427                                            </list>
3428                                        </t>
3429                                    </list>
3430                                </t>
3431                            </list>
3432                        </t>
3433                        <t>The mentioned fields above don't have to be in particular order.
3434                        Other fields might be added in future.</t>
3435                    </section>
3436              </section>              </section>
3437          </section>          </section>
3438    
3439          <section title="Command Syntax" anchor="command_syntax">          <section title="Command Syntax" anchor="command_syntax">
3440              <t>TODO: will soon automatically included from src/network/lscp.y,              <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
3441              meanwhile have a look at that file to get the exact definition of              is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
3442              the command syntax.</t>              where applicable.
3443                </t>
3444                <!--
3445                    This section is automatically generated by scripts/update_grammar.pl
3446                    from src/network/lscp.y (yacc input file). Do not modify this section
3447                    manually !
3448                -->
3449                <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
3450    
3451    <t>input =
3452            <list>
3453                    <t>line LF
3454                    </t>
3455                    <t>/ line CR LF
3456                    </t>
3457            </list>
3458    </t>
3459    <t>line =
3460            <list>
3461                    <t>/* epsilon (empty line ignored) */
3462                    </t>
3463                    <t>/ comment
3464                    </t>
3465                    <t>/ command
3466                    </t>
3467                    <t>/ error
3468                    </t>
3469            </list>
3470    </t>
3471    <t>comment =
3472            <list>
3473                    <t>'#'
3474                    </t>
3475                    <t>/ comment '#'
3476                    </t>
3477                    <t>/ comment SP
3478                    </t>
3479                    <t>/ comment number
3480                    </t>
3481                    <t>/ comment string
3482                    </t>
3483            </list>
3484    </t>
3485    <t>command =
3486            <list>
3487                    <t>ADD SP CHANNEL
3488                    </t>
3489                    <t>/ GET SP get_instruction
3490                    </t>
3491                    <t>/ CREATE SP create_instruction
3492                    </t>
3493                    <t>/ DESTROY SP destroy_instruction
3494                    </t>
3495                    <t>/ LIST SP list_instruction
3496                    </t>
3497                    <t>/ LOAD SP load_instruction
3498                    </t>
3499                    <t>/ REMOVE SP CHANNEL SP sampler_channel
3500                    </t>
3501                    <t>/ SET SP set_instruction
3502                    </t>
3503                    <t>/ SUBSCRIBE SP subscribe_event
3504                    </t>
3505                    <t>/ UNSUBSCRIBE SP unsubscribe_event
3506                    </t>
3507                    <t>/ SELECT SP text
3508                    </t>
3509                    <t>/ RESET SP CHANNEL SP sampler_channel
3510                    </t>
3511                    <t>/ RESET
3512                    </t>
3513                    <t>/ QUIT
3514                    </t>
3515            </list>
3516    </t>
3517    <t>subscribe_event =
3518            <list>
3519                    <t>CHANNEL_COUNT
3520                    </t>
3521                    <t>/ VOICE_COUNT
3522                    </t>
3523                    <t>/ STREAM_COUNT
3524                    </t>
3525                    <t>/ BUFFER_FILL
3526                    </t>
3527                    <t>/ CHANNEL_INFO
3528                    </t>
3529                    <t>/ MISCELLANEOUS
3530                    </t>
3531                    <t>/ TOTAL_VOICE_COUNT
3532                    </t>
3533            </list>
3534    </t>
3535    <t>unsubscribe_event =
3536            <list>
3537                    <t>CHANNEL_COUNT
3538                    </t>
3539                    <t>/ VOICE_COUNT
3540                    </t>
3541                    <t>/ STREAM_COUNT
3542                    </t>
3543                    <t>/ BUFFER_FILL
3544                    </t>
3545                    <t>/ CHANNEL_INFO
3546                    </t>
3547                    <t>/ MISCELLANEOUS
3548                    </t>
3549                    <t>/ TOTAL_VOICE_COUNT
3550                    </t>
3551            </list>
3552    </t>
3553    <t>get_instruction =
3554            <list>
3555                    <t>AVAILABLE_ENGINES
3556                    </t>
3557                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3558                    </t>
3559                    <t>/ MIDI_INPUT_DRIVER SP INFO SP string
3560                    </t>
3561                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
3562                    </t>
3563                    <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
3564                    </t>
3565                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
3566                    </t>
3567                    <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
3568                    </t>
3569                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
3570                    </t>
3571                    <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
3572                    </t>
3573                    <t>/ AUDIO_OUTPUT_DEVICES
3574                    </t>
3575                    <t>/ MIDI_INPUT_DEVICES
3576                    </t>
3577                    <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
3578                    </t>
3579                    <t>/ MIDI_INPUT_DEVICE SP INFO SP number
3580                    </t>
3581                    <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
3582                    </t>
3583                    <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
3584                    </t>
3585                    <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
3586                    </t>
3587                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
3588                    </t>
3589                    <t>/ CHANNELS
3590                    </t>
3591                    <t>/ CHANNEL SP INFO SP sampler_channel
3592                    </t>
3593                    <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
3594                    </t>
3595                    <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
3596                    </t>
3597                    <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
3598                    </t>
3599                    <t>/ ENGINE SP INFO SP engine_name
3600                    </t>
3601                    <t>/ SERVER SP INFO
3602                    </t>
3603                    <t>/ TOTAL_VOICE_COUNT
3604                    </t>
3605                    <t>/ TOTAL_VOICE_COUNT_MAX
3606                    </t>
3607            </list>
3608    </t>
3609    <t>set_instruction =
3610            <list>
3611                    <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
3612                    </t>
3613                    <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
3614                    </t>
3615                    <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
3616                    </t>
3617                    <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
3618                    </t>
3619                    <t>/ CHANNEL SP set_chan_instruction
3620                    </t>
3621                    <t>/ ECHO SP boolean
3622                    </t>
3623            </list>
3624    </t>
3625    <t>create_instruction =
3626            <list>
3627                    <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
3628                    </t>
3629                    <t>/ AUDIO_OUTPUT_DEVICE SP string
3630                    </t>
3631                    <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
3632                    </t>
3633                    <t>/ MIDI_INPUT_DEVICE SP string
3634                    </t>
3635            </list>
3636    </t>
3637    <t>destroy_instruction =
3638            <list>
3639                    <t>AUDIO_OUTPUT_DEVICE SP number
3640                    </t>
3641                    <t>/ MIDI_INPUT_DEVICE SP number
3642                    </t>
3643            </list>
3644    </t>
3645    <t>load_instruction =
3646            <list>
3647                    <t>INSTRUMENT SP load_instr_args
3648                    </t>
3649                    <t>/ ENGINE SP load_engine_args
3650                    </t>
3651            </list>
3652    </t>
3653    <t>set_chan_instruction =
3654            <list>
3655                    <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
3656                    </t>
3657                    <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
3658                    </t>
3659                    <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
3660                    </t>
3661                    <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
3662                    </t>
3663                    <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
3664                    </t>
3665                    <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
3666                    </t>
3667                    <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
3668                    </t>
3669                    <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
3670                    </t>
3671                    <t>/ VOLUME SP sampler_channel SP volume_value
3672                    </t>
3673                    <t>/ MUTE SP sampler_channel SP boolean
3674                    </t>
3675                    <t>/ SOLO SP sampler_channel SP boolean
3676                    </t>
3677            </list>
3678    </t>
3679    <t>key_val_list =
3680            <list>
3681                    <t>string '=' param_val_list
3682                    </t>
3683                    <t>/ key_val_list SP string '=' param_val_list
3684                    </t>
3685            </list>
3686    </t>
3687    <t>buffer_size_type =
3688            <list>
3689                    <t>BYTES
3690                    </t>
3691                    <t>/ PERCENTAGE
3692                    </t>
3693            </list>
3694    </t>
3695    <t>list_instruction =
3696            <list>
3697                    <t>AUDIO_OUTPUT_DEVICES
3698                    </t>
3699                    <t>/ MIDI_INPUT_DEVICES
3700                    </t>
3701                    <t>/ CHANNELS
3702                    </t>
3703                    <t>/ AVAILABLE_ENGINES
3704                    </t>
3705                    <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
3706                    </t>
3707                    <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
3708                    </t>
3709            </list>
3710    </t>
3711    <t>load_instr_args =
3712            <list>
3713                    <t>filename SP instrument_index SP sampler_channel
3714                    </t>
3715                    <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
3716                    </t>
3717            </list>
3718    </t>
3719    <t>load_engine_args =
3720            <list>
3721                    <t>engine_name SP sampler_channel
3722                    </t>
3723            </list>
3724    </t>
3725    <t>device_index =
3726            <list>
3727                    <t>number
3728                    </t>
3729            </list>
3730    </t>
3731    <t>audio_channel_index =
3732            <list>
3733                    <t>number
3734                    </t>
3735            </list>
3736    </t>
3737    <t>audio_output_type_name =
3738            <list>
3739                    <t>string
3740                    </t>
3741            </list>
3742    </t>
3743    <t>midi_input_port_index =
3744            <list>
3745                    <t>number
3746                    </t>
3747            </list>
3748    </t>
3749    <t>midi_input_channel_index =
3750            <list>
3751                    <t>number
3752                    </t>
3753                    <t>/ ALL
3754                    </t>
3755            </list>
3756    </t>
3757    <t>midi_input_type_name =
3758            <list>
3759                    <t>string
3760                    </t>
3761            </list>
3762    </t>
3763    <t>volume_value =
3764            <list>
3765                    <t>dotnum
3766                    </t>
3767                    <t>/ number
3768                    </t>
3769            </list>
3770    </t>
3771    <t>sampler_channel =
3772            <list>
3773                    <t>number
3774                    </t>
3775            </list>
3776    </t>
3777    <t>instrument_index =
3778            <list>
3779                    <t>number
3780                    </t>
3781            </list>
3782    </t>
3783    <t>engine_name =
3784            <list>
3785                    <t>string
3786                    </t>
3787            </list>
3788    </t>
3789    <t>filename =
3790            <list>
3791                    <t>stringval
3792                    </t>
3793            </list>
3794    </t>
3795    <t>param_val_list =
3796            <list>
3797                    <t>param_val
3798                    </t>
3799                    <t>/ param_val_list','param_val
3800                    </t>
3801            </list>
3802    </t>
3803    <t>param_val =
3804            <list>
3805                    <t>string
3806                    </t>
3807                    <t>/ stringval
3808                    </t>
3809                    <t>/ number
3810                    </t>
3811                    <t>/ dotnum
3812                    </t>
3813            </list>
3814    </t>
3815    
3816                <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
3817          </section>          </section>
3818    
3819          <section title="Events" anchor="events">          <section title="Events" anchor="events">
# Line 3244  Schoenebeck'> Line 3898  Schoenebeck'>
3898    
3899              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE INFO">
3900                  <t>Client may want to be notified when changes were made to sampler channels on the                  <t>Client may want to be notified when changes were made to sampler channels on the
3901                  back-end changes by issuing the following command:</t>                  back-end by issuing the following command:</t>
3902                  <t>                  <t>
3903                      <list>                      <list>
3904                          <t>SUBSCRIBE CHANNEL_INFO</t>                          <t>SUBSCRIBE CHANNEL_INFO</t>
# Line 3264  Schoenebeck'> Line 3918  Schoenebeck'>
3918                  message is sufficient here.</t>                  message is sufficient here.</t>
3919              </section>              </section>
3920    
3921                <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
3922                    <t>Client may want to be notified when the total number of voices on the
3923                    back-end changes by issuing the following command:</t>
3924                    <t>
3925                        <list>
3926                            <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
3927                        </list>
3928                    </t>
3929                    <t>Server will start sending the following notification messages:</t>
3930                    <t>
3931                        <list>
3932                            <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>
3933                        </list>
3934                    </t>
3935                    <t>where &lt;voices&gt; will be replaced by the new number of
3936                    all currently active voices.</t>
3937                </section>
3938    
3939              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
3940                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
3941                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
# Line 3300  Schoenebeck'> Line 3972  Schoenebeck'>
3972                      <t>Rui Nuno Capela</t>                      <t>Rui Nuno Capela</t>
3973                      <t>Vladimir Senkov</t>                      <t>Vladimir Senkov</t>
3974                      <t>Mark Knecht</t>                      <t>Mark Knecht</t>
3975                        <t>Grigor Iliev</t>
3976                  </list>                  </list>
3977              </t>              </t>
3978          </section>          </section>
# Line 3307  Schoenebeck'> Line 3980  Schoenebeck'>
3980      </middle>      </middle>
3981    
3982      <back>      <back>
3983          <references>&rfc2119;</references>          <references>
3984                <reference anchor="RFC2119">
3985                    <front>
3986                        <title>Key words for use in RFCs to Indicate Requirement Levels</title>
3987                        <author initials="S." surname="Bradner" fullname="Scott Bradner">
3988                            <organization>Harvard University</organization>
3989                        </author>
3990                        <date year="1997"></date>
3991                    </front>
3992                    <seriesInfo name="RFC" value="2119" />
3993                </reference>
3994                <reference anchor="RFC793">
3995                    <front>
3996                        <title>TRANSMISSION CONTROL PROTOCOL</title>
3997                        <author>
3998                            <organization>Defense Advanced Research Projects Agency</organization>
3999                        </author>
4000                        <date year="1981"></date>
4001                    </front>
4002                    <seriesInfo name="RFC" value="793" />
4003                </reference>
4004                <reference anchor="RFC2234">
4005                    <front>
4006                        <title>Augmented BNF for Syntax Specifications</title>
4007                        <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
4008                            <organization>Internet Mail Consortium</organization>
4009                        </author>
4010                        <author initials="P." surname="Overell" fullname="Paul Overell">
4011                            <organization>Demon Internet Ltd</organization>
4012                        </author>
4013                        <date year="1997"></date>
4014                    </front>
4015                    <seriesInfo name="RFC" value="2234" />
4016                </reference>
4017             </references>
4018      </back>      </back>
4019    
4020  </rfc>  </rfc>
Legend:
Removed from v.556  
changed lines
  Added in v.828
  ViewVC Help
Powered by ViewVC