/[svn]/linuxsampler/trunk/Documentation/lscp.xml

Diff of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory | Revision Log | View Patch Patch

-revision 534 by schoenebeck,
Mon May  9 17:40:33 2005 UTC
+revision 944 by schoenebeck,
Sun Nov 26 16:29:57 2006 UTC
 Line 13
  <?rfc iprnotified="no" ?>
  <?rfc strict="yes" ?>
- <rfc category="std" ipr="full2026" docName="lscp.txt">
+ <rfc category="std" ipr="full2026" docName="LSCP 1.2">
      <front>
          <title>LinuxSampler Control Protocol</title>
          <author initials='C.S.' surname="Schoenebeck" fullname='C.
 Line 31 
 Schoenebeck'>
                  <email>schoenebeck at software minus engineering dot org</email>
              </address>
          </author>
-         <date month="May" year="2005"/>
+         <date month="November" year="2006"/>
          <workgroup>LinuxSampler Developers</workgroup>
          <keyword>LSCP</keyword>
          <abstract>
              <t>The LinuxSampler Control Protocol (LSCP) is an
              application-level protocol primarily intended for local and
-             remote controlling the LinuxSampler main application, which is a
+             remote controlling the LinuxSampler backend application, which is a
-             sophisticated console application essentially playing back audio
+             sophisticated server-like console application essentially playing
-             samples and manipulating the samples in real time to certain
+             back audio samples and manipulating the samples in real time to
-             extent.</t>
+             certain extent.</t>
          </abstract>
      </front>
 Line 112 
 Schoenebeck'>
              return and line feed characters respectively.</t>
          </section>
+         <section title="Versioning of this specification" anchor="LSCP versioning">
+             <t>LSCP will certainly be extended and enhanced by-and-by. Each official
+             release of the LSCP specification will be tagged with a unique version
+             tuple. The version tuple consists at least of a major and minor version
+             number like:
+             </t>
+             <t>
+                 <list>
+                     <t>"1.2"</t>
+                 </list>
+             </t>
+             <t>
+             In this example the major version number would be "1" and the minor
+             version number would be "2". Note that the version tuple might also
+             have more than two elements. The major version number defines a
+             group of backward compatible versions. That means a frontend is
+             compatible to the connected sampler if and only if the LSCP versions
+             to which each of the two parties complies to, match both of the
+             following rules:
+             </t>
+             <t>Compatibility:</t>
+             <t>
+                 <list style="numbers">
+                     <t>The frontend's LSCP major version and the sampler's LSCP
+                     major version are exactly equal.</t>
+                     <t>The frontend's LSCP minor version is less or equal than
+                     the sampler's LSCP minor version.</t>
+                 </list>
+             </t>
+             <t>
+             Compatibility can only be claimed if both rules are true.
+             The frontend can use the
+             <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
+             get the version of the LSCP specification the sampler complies with.
+             </t>
+         </section>
          <section title="Introduction">
              <t>LinuxSampler is a so called software sampler application
              capable to playback audio samples from a computer's Random
-Line 124 
 Schoenebeck'>
+Line 161 
 Schoenebeck'>
              arbitrary MIDI input method and arbitrary MIDI channel (e.g.
              sampler channel 17 could be connected to an ALSA sequencer
              device 64:0 and listening to MIDI channel 1 there). Each sampler
-             engine will be assigned an own instance of one of the available
+             channel will be associated with an instance of one of the available
              sampler engines (e.g. GigEngine, DLSEngine). The audio output of
              each sampler channel can be routed to an arbitrary audio output
              method (ALSA / JACK) and an arbitrary audio output channel
-Line 154 
 Schoenebeck'>
+Line 191 
 Schoenebeck'>
              methods will be described next.</t>
              <section title="Request/response communication method">
-                 <t>This simple communication method is based on TCP. The
+                 <t>This simple communication method is based on
+                 <xref target="RFC793">TCP</xref>. The
                  front-end application establishes a TCP connection to the
                  LinuxSampler instance on a certain host system. Then the
                  front-end application will send certain ASCII based commands
-Line 425 
 Schoenebeck'>
+Line 463 
 Schoenebeck'>
              </section>
          </section>
-         <section title="Description for control commands">
+         <section title="Description for control commands" anchor="control_commands">
              <t>This chapter will describe the available control commands
              that can be sent on the TCP connection in detail. Some certain
              commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
-Line 683 
 Schoenebeck'>
+Line 721 
 Schoenebeck'>
                              <t>DEPENDS -
                                <list>
-                                 <t>comma separated list of paramters this parameter depends
+                                 <t>comma separated list of parameters this parameter depends
                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
                                  listed parameters, for example assuming that an audio
-Line 796 
 Schoenebeck'>
+Line 834 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
-                     output system and &lt;param-list&gt; by an optional list of driver
+                     output system as returned by the
+                     <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
+                     command and &lt;param-list&gt; by an optional list of driver
                      specific parameters in form of "key1=val1 key2=val2 ...", where
                      character string values should be encapsulated into apostrophes (').
                      Note that there might be drivers which require parameter(s) to be
-Line 1017 
 Schoenebeck'>
+Line 1057 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     audio output device, &lt;key&gt; by the name of the parameter to change
+                     audio output device as given by the
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command, &lt;key&gt; by the name of the parameter to change
                      and &lt;value&gt; by the new value for this parameter.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 1058 
 Schoenebeck'>
+Line 1101 
 Schoenebeck'>
                              <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
                          </list>
                      </t>
-                     <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
-                     and &lt;audio-chan&gt; the audio channel number.</t>
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command and &lt;audio-chan&gt; the audio channel number.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1158 
 Schoenebeck'>
+Line 1203 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
-                     by the <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
                      command, &lt;chan&gt; the audio channel number
                      and &lt;param&gt; a specific channel parameter name for which information should
                      be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
-Line 1261 
 Schoenebeck'>
+Line 1307 
 Schoenebeck'>
                              <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
                          </list>
                      </t>
-                     <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
-                     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>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
                      parameter to change and &lt;value&gt; by the new value for this parameter.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 1386 
 Schoenebeck'>
+Line 1434 
 Schoenebeck'>
                              <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
                          </list>
                      </t>
-                     <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
+                     by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
+                     "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1441 
 Schoenebeck'>
+Line 1491 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
                      by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
                      "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
                      parameter name for which information should be obtained (as returned by the
-Line 1514 
 Schoenebeck'>
+Line 1564 
 Schoenebeck'>
                              <t>DEPENDS -
                                <list>
-                                 <t>comma separated list of paramters this parameter depends
+                                 <t>comma separated list of parameters this parameter depends
                                  on, means the values for fields 'DEFAULT', 'RANGE_MIN',
                                  'RANGE_MAX' and 'POSSIBILITIES' might depend on these
                                  listed parameters, for example assuming that an audio
-Line 1596 
 Schoenebeck'>
+Line 1646 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
+                     by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
+                     "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
                      optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
                      character string values should be encapsulated into apostrophes (').
                      Note that there might be drivers which require parameter(s) to be
-Line 1643 
 Schoenebeck'>
+Line 1695 
 Schoenebeck'>
                              <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
                          </list>
                      </t>
-                     <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
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1735 
 Schoenebeck'>
+Line 1790 
 Schoenebeck'>
                              <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
                          </list>
                      </t>
-                     <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
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1800 
 Schoenebeck'>
+Line 1858 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     MIDI input device, &lt;key&gt; by the name of the parameter to change and
+                     MIDI input device as returned by the
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command, &lt;key&gt; by the name of the parameter to change and
                      &lt;value&gt; by the new value for this parameter.</t>
                      <t>Possible Answers:</t>
-Line 1841 
 Schoenebeck'>
+Line 1902 
 Schoenebeck'>
                              <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
                          </list>
                      </t>
-                     <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
-                     and &lt;midi-port&gt; the MIDI input port number.</t>
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command and &lt;midi-port&gt; the MIDI input port number.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 1884 
 Schoenebeck'>
+Line 1947 
 Schoenebeck'>
                          </list>
                      </t>
-                     <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
-                     by the <xref target="LIST MIDI_INPUT_DEVICES">
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
-                     "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>
+                     command, &lt;port&gt; the MIDI port number and
                      &lt;param&gt; a specific port parameter name for which information should be
                      obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
                      "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
-Line 1989 
 Schoenebeck'>
+Line 2053 
 Schoenebeck'>
                      </t>
                      <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
-                     MIDI device, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
+                     MIDI device as returned by the
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
+                     command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
                      the parameter to change and &lt;value&gt; by the new value for this
                      parameter.</t>
-Line 2025 
 Schoenebeck'>
+Line 2092 
 Schoenebeck'>
              </section>
              <section title="Configuring sampler channels">
-                 <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
-                 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
+                 MIDI and audio devices.</t>
                  <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
                      <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'>
                  </section>
                  <section title="Loading a sampler engine" anchor="LOAD ENGINE">
-                     <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
                      channel by the following command:</t>
                      <t>
                          <list>
-Line 2096 
 Schoenebeck'>
+Line 2164 
 Schoenebeck'>
                      <t>Where &lt;engine-name&gt; is an engine name as obtained by the
                      <xref target="LIST AVAILABLE_ENGINES">
-                     "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt; the sampler channel the
+                     "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
-                     deployed engine should be assigned to. Even if the respective
+                     the sampler channel as returned by the
-                     sampler channel has already a deployed engine with that engine
+                     <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
-                     name, a new engine instance will be assigned to the sampler channel.</t>
+                     <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
+                     the engine type should be assigned to. This command should be issued
+                     after adding a new sampler channel and before any other control
+                     commands on the new sampler channel. It can also be used to change
+                     the engine type of a sampler channel. This command has (currently) no
+                     way to define or force if a new engine instance should be created and
+                     assigned to the given sampler channel or if an already existing
+                     instance of that engine type, shared with other sampler channels,
+                     should be used.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2205 
 Schoenebeck'>
+Line 2281 
 Schoenebeck'>
                                  <list>
                                      <t>in case a new sampler channel could be added, where
                                      &lt;sampler-channel&gt; reflects the channel number of the new
-                                     created sampler channel which should the be used to set up
+                                     created sampler channel which should be used to set up
-                                     the sampler channel by sending subsequent intialization
+                                     the sampler channel by sending subsequent initialization
                                      commands</t>
                                  </list>
                              </t>
-Line 2241 
 Schoenebeck'>
+Line 2317 
 Schoenebeck'>
                          </list>
                      </t>
-                     <t>This will decrement the sampler channel count by one and also
+                     <t>Where &lt;sampler-channel&gt; should be replaced by the
-                     decrement the channel numbers of all subsequent sampler channels by
+                     number of the sampler channel as given by the
-                     one.</t>
+                     <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
+                     command. The channel numbers of all subsequent sampler channels
+                     remain the same.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2308 
 Schoenebeck'>
+Line 2387 
 Schoenebeck'>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-                             <t>LinuxSampler will answer by sending a comma separated character
+                             <t>LinuxSampler will answer by sending a comma separated list
-                             string of the engines' names. Engine names can consist of lower and
+                             of the engines' names encapsulated into apostrophes (').
-                             upper cases, digits and underlines ("_" character).</t>
+                             Engine names can consist of lower and upper cases,
+                             digits and underlines ("_" character).</t>
                          </list>
                      </t>
                      <t>Example:</t>
                      <t>
                          <list>
                              <t>C: "LIST AVAILABLE_ENGINES"</t>
-                             <t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t>
+                             <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
                          </list>
                      </t>
                  </section>
-Line 2380 
 Schoenebeck'>
+Line 2460 
 Schoenebeck'>
                              <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
                          <list>
-Line 2394 
 Schoenebeck'>
+Line 2476 
 Schoenebeck'>
                                  <list>
                                      <t>ENGINE_NAME -
                                          <list>
-                                             <t>name of the engine that is deployed on the sampler
+                                             <t>name of the engine that is associated with the sampler
-                                             channel, "NONE" if there's no engine deployed yet for
+                                             channel, "NONE" if there's no engine associated yet for
                                              this sampler channel</t>
                                          </list>
                                      </t>
-Line 2474 
 Schoenebeck'>
+Line 2556 
 Schoenebeck'>
 .0 means amplification)</t>
                                          </list>
                                      </t>
+                                     <t>MUTE -
+                                         <list>
+                                             <t>Determines whether the channel is muted, "true" if the
+                                             channel is muted, "false" if the channel is not muted, and
+                                             "MUTED_BY_SOLO" if the channel is muted because of the
+                                             presence of a solo channel and will be unmuted when
+                                             there are no solo channels left</t>
+                                         </list>
+                                     </t>
+                                     <t>SOLO -
+                                         <list>
+                                             <t>Determines whether this is a solo channel, "true" if
+                                             the channel is a solo channel; "false" otherwise</t>
+                                         </list>
+                                     </t>
                                  </list>
                              </t>
                          </list>
-Line 2509 
 Schoenebeck'>
+Line 2606 
 Schoenebeck'>
                              <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2534 
 Schoenebeck'>
+Line 2633 
 Schoenebeck'>
                              <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2568 
 Schoenebeck'>
+Line 2669 
 Schoenebeck'>
                          </list>
                      </t>
                      <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
-                     sampler channel number the front-end is interested in.</t>
+                     sampler channel number the front-end is interested in
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2612 
 Schoenebeck'>
+Line 2715 
 Schoenebeck'>
                              <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
                          </list>
                      </t>
-                     <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
-                     device and &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
-                     number.</t>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
+                     <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
+                     or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
+                     command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2697 
 Schoenebeck'>
+Line 2804 
 Schoenebeck'>
                              <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
                          </list>
                      </t>
-                     <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
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
                      numerical ID of the sampler channel's audio output channel which should be
                      rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
                      output device where &lt;audio-out&gt; should be routed to.</t>
-Line 2740 
 Schoenebeck'>
+Line 2849 
 Schoenebeck'>
                              <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
                          </list>
                      </t>
-                     <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
-                     the numerical ID of the MIDI input device.</t>
+                     as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
+                     and &lt;midi-device-id&gt; is  the numerical ID of the MIDI input device as returned by the
+                     <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
+                     or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
                      <t>Possible Answers:</t>
                      <t>
-Line 2845 
 Schoenebeck'>
+Line 2958 
 Schoenebeck'>
                              </t>
                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
                                  <list>
-                                     <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>
                                  </list>
                              </t>
                          </list>
-Line 2943 
 Schoenebeck'>
+Line 3056 
 Schoenebeck'>
                      </t>
                  </section>
+                 <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
+                     <t>The front-end can mute/unmute a specific sampler
+                     channel by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
+                     to unmute the channel.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if the channel was muted/unmuted, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t></t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
+                     <t>The front-end can solo/unsolo a specific sampler channel
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;sampler-channel&gt; is the respective sampler channel
+                     number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
+                     or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
+                     &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
+                     to unsolo the channel.</t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>on success</t>
+                                 </list>
+                             </t>
+                             <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
+                                 <list>
+                                     <t>if the channel was soloed/unsoloed, but there are noteworthy
+                                     issue(s) related, providing an appropriate warning code and
+                                     warning message</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>in case it failed, providing an appropriate error code and error message</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t></t>
+                         </list>
+                     </t>
+                 </section>
                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
                      <t>
-Line 3128 
 Schoenebeck'>
+Line 3329 
 Schoenebeck'>
              <section title="Global commands">
                  <t>The following commands have global impact on the sampler.</t>
+                 <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
+                     <t>The front-end can ask for the current number of active voices on
+                     the sampler by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET TOTAL_VOICE_COUNT</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by returning the number of all active
+                             voices on the sampler.</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
+                     <t>The front-end can ask for the maximum number of active voices
+                     by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET TOTAL_VOICE_COUNT_MAX</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by returning the maximum number
+                             of active voices.</t>
+                         </list>
+                     </t>
+                 </section>
                  <section title="Reset sampler" anchor="RESET">
                      <t>The front-end can reset the whole sampler by sending the following command:</t>
                      <t>
-Line 3153 
 Schoenebeck'>
+Line 3390 
 Schoenebeck'>
                          </list>
                      </t>
                  </section>
+                 <section title="General sampler informations" anchor="GET SERVER INFO">
+                     <t>The client can ask for general informations about the LinuxSampler
+                        instance by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET SERVER INFO</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
+                                Each answer line begins with the information category name
+                                followed by a colon and then a space character &lt;SP&gt; and finally
+                                the info character string to that information category. At the
+                                moment the following categories are defined:
+                             </t>
+                             <t>
+                                 <list>
+                                     <t>DESCRIPTION -
+                                         <list>
+                                             <t>arbitrary textual description about the sampler</t>
+                                         </list>
+                                     </t>
+                                     <t>VERSION -
+                                         <list>
+                                             <t>version of the sampler</t>
+                                         </list>
+                                     </t>
+                                     <t>PROTOCOL_VERSION -
+                                         <list>
+                                             <t>version of the LSCP specification the sampler
+                                             complies with (see <xref target="LSCP versioning" /> for details)</t>
+                                         </list>
+                                     </t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>The mentioned fields above don't have to be in particular order.
+                     Other fields might be added in future.</t>
+                 </section>
+             </section>
+             <section title="MIDI Instrument Mapping">
+                 <t>The MIDI protocol provides a way to switch between instruments
+                 by sending so called MIDI bank select and MIDI program change
+                 messages which are essentially just numbers. The following commands
+                 allow to actually map arbitrary MIDI bank select / program change
+                 numbers with real instruments.</t>
+                 <t>By default, that is when the sampler is launched, this map will
+                 be empty, thus the sampler will simply ignore all program change
+                 messages. The front-end has to explicitly add entries to the map
+                 so the sampler knows how to react on a given program change
+                 message, that is by switching to the respectively defined engine
+                 type and loading the respective instrument.</t>
+                 <t>Also note per MIDI specification a bank select message does not
+                 cause to switch to another instrument. Instead when receiving a
+                 bank select message the bank value will be stored and a subsequent
+                 program change message (which may occur at any time) will finally
+                 cause the sampler to switch to the respective instrument as
+                 reflected by the current MIDI instrument map.</t>
+                 <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
+                     <t>The front-end can create a new or replace an existing entry
+                     in the sampler's MIDI instrument map by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>MAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt;
+                             &lt;midi_bank_lsb&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
+                             &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
+                             [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
+                         </list>
+                     </t>
+                     <t>Where &lt;midi_bank_msb&gt; is an integer value between
+..127 reflecting the MIDI bank select MSB (coarse) index,
+                     &lt;midi_bank_lsb&gt; an integer value between 0..127 reflecting
+                     the MIDI bank select LSB (fine) index, &lt;midi_prog&gt; an
+                     integer value between 0..127 reflecting the MIDI program change
+                     index, &lt;engine_name&gt; a sampler engine name as returned by
+                     the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
+                     command (not encapsulated into apostrophes), &lt;filename&gt; the name
+                     of the instrument's file to be deployed (encapsulated into apostrophes), &lt;instrument_index&gt; the index (integer value) of the instrument
+                     within the given file, &lt;volume_value&gt; reflects the master
+                     volume of the instrument as optionally dotted number (where a
+                     value < 1.0 means attenuation and a value > 1.0 means
+                     amplification). This parameter easily allows to adjust the
+                     volume of all intruments within a custom instrument map
+                     without having to adjust their instrument files. The
+                     OPTIONAL &lt;instr_load_mode&gt; argument defines the life
+                     time of the instrument, that is when the instrument should
+                     be loaded, when freed and has exactly the following
+                     possibilities:</t>
+                     <t>
+                         <list>
+                             <t>"ON_DEMAND" -
+                                 <list>
+                                     <t>The instrument will be loaded when needed,
+                                     that is when demanded by at least one sampler
+                                     channel. It will immediately be freed from memory
+                                     when not needed by any sampler channel anymore.</t>
+                                 </list>
+                             </t>
+                             <t>"ON_DEMAND_HOLD" -
+                                 <list>
+                                     <t>The instrument will be loaded when needed,
+                                     that is when demanded by at least one sampler
+                                     channel. It will be kept in memory even when
+                                     not needed by any sampler channel anymore.
+                                     Instruments with this mode are only freed
+                                     when the sampler is reset or all mapping
+                                     entries with this mode (and respective
+                                     instrument) are explicitly changed to
+                                     "ON_DEMAND" and no sampler channel is using
+                                     the instrument anymore.</t>
+                                 </list>
+                             </t>
+                             <t>"PERSISTENT" -
+                                 <list>
+                                     <t>The instrument will immediately be loaded
+                                     into memory in the background when this mapping
+                                     command is sent and the instrument is kept all
+                                     the time. Instruments with this mode are
+                                     only freed when the sampler is reset or all
+                                     mapping entries with this mode (and
+                                     respective instrument) are explicitly
+                                     changed to "ON_DEMAND" and no sampler
+                                     channel is using the instrument anymore.</t>
+                                 </list>
+                             </t>
+                             <t>not supplied -
+                                 <list>
+                                     <t>In case there is no &lt;instr_load_mode&gt;
+                                     argument given, it will be up to the
+                                     InstrumentManager to decide which mode to use.
+                                     Usually it will use "ON_DEMAND" if an entry
+                                     for the given instrument does not exist in
+                                     the InstrumentManager's list yet, otherwise
+                                     if an entry already exists, it will simply
+                                     stick with the mode currently reflected by
+                                     the already existing entry, that is it will
+                                     not change the mode.</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>
+                     The &lt;instr_load_mode&gt; argument thus allows to define an
+                     appropriate strategy (low memory consumption vs. fast
+                     instrument switching) for each instrument individually. Note, the
+                     following restrictions apply to this argument: "ON_DEMAND_HOLD" and
+                     "PERSISTENT" have to be supported by the respective sampler engine
+                     (which is technically the case when the engine provides an
+                     InstrumentManager for its format). If this is not the case the
+                     argument will automatically fall back to the default value
+                     "ON_DEMAND". Also the load mode of one instrument may
+                     automatically change the laod mode of other instrument(s), i.e.
+                     because the instruments are part of the same file and the
+                     engine does not allow a way to manage load modes for them
+                     individually. Due to this, in case the frontend shows the
+                     load modes of entries, the frontend should retrieve the actual
+                     mode by i.e. sending
+                     <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
+                     command(s). Finally the OPTIONAL &lt;name&gt; argument allows to
+                     set a custom name (encapsulated into apostrophes) for the mapping
+                     entry, useful for frontends for displaying an appropriate name for
+                     mapped instruments (using
+                     <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
+                     </t>
+                     <t>
+                     The "MAP MIDI_INSTRUMENT" command
+                     will immediately return, thus it will not block when an
+                     instrument is to be loaded due to a "PERSISTENT" type
+                     entry as instruments are loaded in the background. As a
+                     consequence this command may not necessarily return an error
+                     i.e. when the given instrument file does not exist or may
+                     turn out to be corrupt.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>usually</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when the given engine does not exist or a value
+                                     is out of range</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Examples:</t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
+                             <t>S: "OK"</t>
+                             <t>C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                     <t>
+                         <list>
+                             <t>C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
+                     <t>The front-end can query the amount of currently existing MIDI
+                     instrument map entries by sending the following
+                     command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENTS</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending the current number of
+                             entries in the sampler's MIDI instrument map.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENTS"</t>
+                             <t>S: "634"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Getting indeces of all MIDI instrument map entries" anchor="LIST MIDI_INSTRUMENTS">
+                     <t>The front-end can query a list of all currently existing MIDI
+                     instrument map entries by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>LIST MIDI_INSTRUMENTS</t>
+                         </list>
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a comma separated
+                             list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) -
+                             MIDI program triples, where each triple is encapsulated
+                             into curly braces. The list is returned in one single
+                             line. Each triple just reflects the key of the respective
+                             map entry, thus subsequent
+                             <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
+                             command(s) are necessary to retrieve detailed informations
+                             about each entry.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "LIST MIDI_INSTRUMENTS"</t>
+                             <t>S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
+                     <t>The front-end can delete an entry from the MIDI instrument
+                     map by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>UNMAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>
+                         </list>
+                     </t>
+                     <t>
+                     Where &lt;midi_bank_msb&gt; is an integer value between 0..127
+                     reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;
+                     an integer value between 0..127 reflecting the MIDI bank LSB
+                     (fine) value and &lt;midi_prog&gt; an integer value between
+..127 reflecting the MIDI program value of the map entrie's key
+                     index triple.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>usually</t>
+                                 </list>
+                             </t>
+                             <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
+                                 <list>
+                                     <t>when index out of bounds</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "UNMAP MIDI_INSTRUMENT 2 40 127"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
+                     <t>The front-end can retrieve the current settings of a certain
+                     instrument map entry by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>GET MIDI_INSTRUMENT INFO &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>
+                         </list>
+                     </t>
+                     <t>
+                     Where &lt;midi_bank_msb&gt; is an integer value between 0..127
+                     reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;
+                     an integer value between 0..127 reflecting the MIDI bank LSB
+                     (fine) value and &lt;midi_prog&gt; an integer value between
+..127 reflecting the MIDI program value of the map entrie's key
+                     index triple.
+                     </t>
+                     <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
+                             separated list. Each answer line begins with the
+                             information category name followed by a colon and then
+                             a space character &lt;SP&gt; and finally the info
+                             character string to that info category. At the moment
+                             the following categories are defined:</t>
+                             <t>"NAME" -
+                                 <list>
+                                     <t>Name for this MIDI instrument map entry (if defined).
+                                     This name shall be used by frontends for displaying a
+                                     name for this mapped instrument. It can be set and
+                                     changed with the
+                                     <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
+                                     command and does not have to be unique.</t>
+                                 </list>
+                             </t>
+                             <t>"ENGINE_NAME" -
+                                 <list>
+                                     <t>Name of the engine to be deployed for this
+                                     instrument.</t>
+                                 </list>
+                             </t>
+                             <t>"INSTRUMENT_FILE" -
+                                 <list>
+                                     <t>File name of the instrument.</t>
+                                 </list>
+                             </t>
+                             <t>"INSTRUMENT_NR" -
+                                 <list>
+                                     <t>Index of the instrument within the file.</t>
+                                 </list>
+                             </t>
+                             <t>"INSTRUMENT_NAME" -
+                                 <list>
+                                     <t>Name of the loaded instrument as reflected by its file.
+                                     In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
+                                     cannot be changed.</t>
+                                 </list>
+                             </t>
+                             <t>"LOAD_MODE" -
+                                 <list>
+                                     <t>Life time of instrument
+                                     (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
+                                 </list>
+                             </t>
+                             <t>"VOLUME" -
+                                 <list>
+                                     <t>master volume of the instrument as optionally
+                                     dotted number (where a value < 1.0 means attenuation
+                                     and a value > 1.0 means amplification)</t>
+                                 </list>
+                             </t>
+                             <t>The mentioned fields above don't have to be in particular order.</t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                         <list>
+                             <t>C: "GET MIDI_INSTRUMENT INFO 3 45 120"</t>
+                             <t>S: "NAME: Drums for Foo Song"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
+                             <t>&nbsp;&nbsp;&nbsp;"."</t>
+                         </list>
+                     </t>
+                 </section>
+                 <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
+                     <t>The front-end can clear the whole MIDI instrument map, that
+                     is delete all entries by sending the following command:</t>
+                     <t>
+                         <list>
+                             <t>CLEAR MIDI_INSTRUMENTS</t>
+                         </list>
+                     </t>
+                    <t>Possible Answers:</t>
+                     <t>
+                         <list>
+                             <t>"OK" -
+                                 <list>
+                                     <t>always</t>
+                                 </list>
+                             </t>
+                         </list>
+                     </t>
+                     <t>Example:</t>
+                     <t>
+                        <list>
+                             <t>C: "CLEAR MIDI_INSTRUMENTS"</t>
+                             <t>S: "OK"</t>
+                         </list>
+                     </t>
+                 </section>
              </section>
          </section>
          <section title="Command Syntax" anchor="command_syntax">
-             <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"/>
-             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"/>)
-             the command syntax.</t>
+             where applicable.
+             </t>
+             <!--
+                 This section is automatically generated by scripts/update_grammar.pl
+                 from src/network/lscp.y (yacc input file). Do not modify this section
+                 manually !
+             -->
+             <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
+ <t>input =
+         <list>
+                 <t>line LF
+                 </t>
+                 <t>/ line CR LF
+                 </t>
+         </list>
+ </t>
+ <t>line =
+         <list>
+                 <t>/* epsilon (empty line ignored) */
+                 </t>
+                 <t>/ comment
+                 </t>
+                 <t>/ command
+                 </t>
+                 <t>/ error
+                 </t>
+         </list>
+ </t>
+ <t>comment =
+         <list>
+                 <t>'#'
+                 </t>
+                 <t>/ comment '#'
+                 </t>
+                 <t>/ comment SP
+                 </t>
+                 <t>/ comment number
+                 </t>
+                 <t>/ comment string
+                 </t>
+         </list>
+ </t>
+ <t>command =
+         <list>
+                 <t>ADD SP CHANNEL
+                 </t>
+                 <t>/ MAP SP map_instruction
+                 </t>
+                 <t>/ UNMAP SP unmap_instruction
+                 </t>
+                 <t>/ GET SP get_instruction
+                 </t>
+                 <t>/ CREATE SP create_instruction
+                 </t>
+                 <t>/ DESTROY SP destroy_instruction
+                 </t>
+                 <t>/ LIST SP list_instruction
+                 </t>
+                 <t>/ LOAD SP load_instruction
+                 </t>
+                 <t>/ REMOVE SP remove_instruction
+                 </t>
+                 <t>/ SET SP set_instruction
+                 </t>
+                 <t>/ SUBSCRIBE SP subscribe_event
+                 </t>
+                 <t>/ UNSUBSCRIBE SP unsubscribe_event
+                 </t>
+                 <t>/ SELECT SP text
+                 </t>
+                 <t>/ RESET SP reset_instruction
+                 </t>
+                 <t>/ CLEAR SP clear_instruction
+                 </t>
+                 <t>/ RESET
+                 </t>
+                 <t>/ QUIT
+                 </t>
+         </list>
+ </t>
+ <t>subscribe_event =
+         <list>
+                 <t>CHANNEL_COUNT
+                 </t>
+                 <t>/ VOICE_COUNT
+                 </t>
+                 <t>/ STREAM_COUNT
+                 </t>
+                 <t>/ BUFFER_FILL
+                 </t>
+                 <t>/ CHANNEL_INFO
+                 </t>
+                 <t>/ MISCELLANEOUS
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+         </list>
+ </t>
+ <t>unsubscribe_event =
+         <list>
+                 <t>CHANNEL_COUNT
+                 </t>
+                 <t>/ VOICE_COUNT
+                 </t>
+                 <t>/ STREAM_COUNT
+                 </t>
+                 <t>/ BUFFER_FILL
+                 </t>
+                 <t>/ CHANNEL_INFO
+                 </t>
+                 <t>/ MISCELLANEOUS
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+         </list>
+ </t>
+ <t>map_instruction =
+         <list>
+                 <t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
+                 </t>
+                 <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
+                 </t>
+                 <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
+                 </t>
+                 <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
+                 </t>
+         </list>
+ </t>
+ <t>unmap_instruction =
+         <list>
+                 <t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog
+                 </t>
+         </list>
+ </t>
+ <t>remove_instruction =
+         <list>
+                 <t>CHANNEL SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>get_instruction =
+         <list>
+                 <t>AVAILABLE_ENGINES
+                 </t>
+                 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
+                 </t>
+                 <t>/ MIDI_INPUT_DRIVER SP INFO SP string
+                 </t>
+                 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
+                 </t>
+                 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
+                 </t>
+                 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICES
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICES
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP INFO SP number
+                 </t>
+                 <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
+                 </t>
+                 <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
+                 </t>
+                 <t>/ CHANNELS
+                 </t>
+                 <t>/ CHANNEL SP INFO SP sampler_channel
+                 </t>
+                 <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
+                 </t>
+                 <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
+                 </t>
+                 <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
+                 </t>
+                 <t>/ ENGINE SP INFO SP engine_name
+                 </t>
+                 <t>/ SERVER SP INFO
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT
+                 </t>
+                 <t>/ TOTAL_VOICE_COUNT_MAX
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS
+                 </t>
+                 <t>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog
+                 </t>
+         </list>
+ </t>
+ <t>set_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
+                 </t>
+                 <t>/ CHANNEL SP set_chan_instruction
+                 </t>
+                 <t>/ ECHO SP boolean
+                 </t>
+         </list>
+ </t>
+ <t>create_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
+                 </t>
+                 <t>/ AUDIO_OUTPUT_DEVICE SP string
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP string
+                 </t>
+         </list>
+ </t>
+ <t>reset_instruction =
+         <list>
+                 <t>CHANNEL SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>clear_instruction =
+         <list>
+                 <t>MIDI_INSTRUMENTS
+                 </t>
+         </list>
+ </t>
+ <t>destroy_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP number
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP number
+                 </t>
+         </list>
+ </t>
+ <t>load_instruction =
+         <list>
+                 <t>INSTRUMENT SP load_instr_args
+                 </t>
+                 <t>/ ENGINE SP load_engine_args
+                 </t>
+         </list>
+ </t>
+ <t>set_chan_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
+                 </t>
+                 <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
+                 </t>
+                 <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
+                 </t>
+                 <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
+                 </t>
+                 <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
+                 </t>
+                 <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
+                 </t>
+                 <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
+                 </t>
+                 <t>/ VOLUME SP sampler_channel SP volume_value
+                 </t>
+                 <t>/ MUTE SP sampler_channel SP boolean
+                 </t>
+                 <t>/ SOLO SP sampler_channel SP boolean
+                 </t>
+         </list>
+ </t>
+ <t>key_val_list =
+         <list>
+                 <t>string '=' param_val_list
+                 </t>
+                 <t>/ key_val_list SP string '=' param_val_list
+                 </t>
+         </list>
+ </t>
+ <t>buffer_size_type =
+         <list>
+                 <t>BYTES
+                 </t>
+                 <t>/ PERCENTAGE
+                 </t>
+         </list>
+ </t>
+ <t>list_instruction =
+         <list>
+                 <t>AUDIO_OUTPUT_DEVICES
+                 </t>
+                 <t>/ MIDI_INPUT_DEVICES
+                 </t>
+                 <t>/ CHANNELS
+                 </t>
+                 <t>/ AVAILABLE_ENGINES
+                 </t>
+                 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
+                 </t>
+                 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
+                 </t>
+                 <t>/ MIDI_INSTRUMENTS
+                 </t>
+         </list>
+ </t>
+ <t>load_instr_args =
+         <list>
+                 <t>filename SP instrument_index SP sampler_channel
+                 </t>
+                 <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>load_engine_args =
+         <list>
+                 <t>engine_name SP sampler_channel
+                 </t>
+         </list>
+ </t>
+ <t>instr_load_mode =
+         <list>
+                 <t>ON_DEMAND
+                 </t>
+                 <t>/ ON_DEMAND_HOLD
+                 </t>
+                 <t>/ PERSISTENT
+                 </t>
+         </list>
+ </t>
+ <t>device_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>audio_channel_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>audio_output_type_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>midi_input_port_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_input_channel_index =
+         <list>
+                 <t>number
+                 </t>
+                 <t>/ ALL
+                 </t>
+         </list>
+ </t>
+ <t>midi_input_type_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>midi_bank_msb =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_bank_lsb =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>midi_prog =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>volume_value =
+         <list>
+                 <t>dotnum
+                 </t>
+                 <t>/ number
+                 </t>
+         </list>
+ </t>
+ <t>sampler_channel =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>instrument_index =
+         <list>
+                 <t>number
+                 </t>
+         </list>
+ </t>
+ <t>engine_name =
+         <list>
+                 <t>string
+                 </t>
+         </list>
+ </t>
+ <t>filename =
+         <list>
+                 <t>stringval
+                 </t>
+         </list>
+ </t>
+ <t>entry_name =
+         <list>
+                 <t>stringval
+                 </t>
+         </list>
+ </t>
+ <t>param_val_list =
+         <list>
+                 <t>param_val
+                 </t>
+                 <t>/ param_val_list','param_val
+                 </t>
+         </list>
+ </t>
+ <t>param_val =
+         <list>
+                 <t>string
+                 </t>
+                 <t>/ stringval
+                 </t>
+                 <t>/ number
+                 </t>
+                 <t>/ dotnum
+                 </t>
+         </list>
+ </t>
+             <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
          </section>
          <section title="Events" anchor="events">
-Line 3170 
 Schoenebeck'>
+Line 4314 
 Schoenebeck'>
                  back-end changes by issuing the following command:</t>
                  <t>
                      <list>
-                         <t>SUBSCRIBE CHANNELS</t>
+                         <t>SUBSCRIBE CHANNEL_COUNT</t>
                      </list>
                  </t>
                  <t>Server will start sending the following notification messages:</t>
                  <t>
                      <list>
-                         <t>"NOTIFY:CHANNELS:&lt;channels&gt;"</t>
+                         <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
                      </list>
                  </t>
                  <t>where &lt;channels&gt; will be replaced by the new number
-Line 3244 
 Schoenebeck'>
+Line 4388 
 Schoenebeck'>
              <section title="Channel information changed" anchor="SUBSCRIBE INFO">
                  <t>Client may want to be notified when changes were made to sampler channels on the
-                 back-end changes by issuing the following command:</t>
+                 back-end by issuing the following command:</t>
                  <t>
                      <list>
-                         <t>SUBSCRIBE INFO</t>
+                         <t>SUBSCRIBE CHANNEL_INFO</t>
                      </list>
                  </t>
                  <t>Server will start sending the following notification messages:</t>
                  <t>
                      <list>
-                         <t>"NOTIFY:INFO:&lt;sampler-channel&gt;"</t>
+                         <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
                      </list>
                  </t>
                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
-Line 3264 
 Schoenebeck'>
+Line 4408 
 Schoenebeck'>
                  message is sufficient here.</t>
              </section>
+             <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
+                 <t>Client may want to be notified when the total number of voices on the
+                 back-end changes by issuing the following command:</t>
+                 <t>
+                     <list>
+                         <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
+                     </list>
+                 </t>
+                 <t>Server will start sending the following notification messages:</t>
+                 <t>
+                     <list>
+                         <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>
+                     </list>
+                 </t>
+                 <t>where &lt;voices&gt; will be replaced by the new number of
+                 all currently active voices.</t>
+             </section>
              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
                  the server by issuing the following command:</t>
-Line 3300 
 Schoenebeck'>
+Line 4462 
 Schoenebeck'>
                      <t>Rui Nuno Capela</t>
                      <t>Vladimir Senkov</t>
                      <t>Mark Knecht</t>
+                     <t>Grigor Iliev</t>
                  </list>
              </t>
          </section>
-Line 3307 
 Schoenebeck'>
+Line 4470 
 Schoenebeck'>
      </middle>
      <back>
-         <references>&rfc2119;</references>
+         <references>
+             <reference anchor="RFC2119">
+                 <front>
+                     <title>Key words for use in RFCs to Indicate Requirement Levels</title>
+                     <author initials="S." surname="Bradner" fullname="Scott Bradner">
+                         <organization>Harvard University</organization>
+                     </author>
+                     <date year="1997"></date>
+                 </front>
+                 <seriesInfo name="RFC" value="2119" />
+             </reference>
+             <reference anchor="RFC793">
+                 <front>
+                     <title>TRANSMISSION CONTROL PROTOCOL</title>
+                     <author>
+                         <organization>Defense Advanced Research Projects Agency</organization>
+                     </author>
+                     <date year="1981"></date>
+                 </front>
+                 <seriesInfo name="RFC" value="793" />
+             </reference>
+             <reference anchor="RFC2234">
+                 <front>
+                     <title>Augmented BNF for Syntax Specifications</title>
+                     <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
+                         <organization>Internet Mail Consortium</organization>
+                     </author>
+                     <author initials="P." surname="Overell" fullname="Paul Overell">
+                         <organization>Demon Internet Ltd</organization>
+                     </author>
+                     <date year="1997"></date>
+                 </front>
+                 <seriesInfo name="RFC" value="2234" />
+             </reference>
+          </references>
      </back>
  </rfc>

 Legend:



Removed from v.534
 


changed lines


 
Added in v.944
 Legend:



Removed from v.534
 


changed lines


 
Added in v.944
-Removed from v.534
+Added in v.944

	ViewVC Help
Powered by ViewVC