--- web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt	2005/05/24 03:26:22	575
+++ web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt	2005/07/21 09:18:40	708
@@ -1,23 +1,24 @@
 
 
+
 LinuxSampler Developers                                   C. Schoenebeck
 Internet-Draft                           Interessengemeinschaft Software
-Expires: November 22, 2005                             Engineering e. V.
-                                                            May 24, 2005
+Expires: November 2, 2005                              Engineering e. V.
+                                                                May 2005
 
 
                      LinuxSampler Control Protocol
-                                LSCP 1.0
+                                LSCP 1.1
 
 Status of this Memo
 
    This document is an Internet-Draft and is in full conformance with
-   all provisions of Section 10 of RFC2026.
+   all provisions of Section 10 of RFC 2026.
 
    Internet-Drafts are working documents of the Internet Engineering
    Task Force (IETF), its areas, and its working groups.  Note that
-   other groups may also distribute working documents as
-   Internet-Drafts.
+   other groups may also distribute working documents as Internet-
+   Drafts.
 
    Internet-Drafts are draft documents valid for a maximum of six months
    and may be updated, replaced, or obsoleted by other documents at any
@@ -30,7 +31,7 @@
    The list of Internet-Draft Shadow Directories can be accessed at
    http://www.ietf.org/shadow.html.
 
-   This Internet-Draft will expire on November 22, 2005.
+   This Internet-Draft will expire on November 2, 2005.
 
 Copyright Notice
 
@@ -40,9 +41,9 @@
 
    The LinuxSampler Control Protocol (LSCP) is an application-level
    protocol primarily intended for local and remote controlling the
-   LinuxSampler backend application, which is a sophisticated
-   server-like console application essentially playing back audio
-   samples and manipulating the samples in real time to certain extent.
+   LinuxSampler backend application, which is a sophisticated server-
+   like console application essentially playing back audio samples and
+   manipulating the samples in real time to certain extent.
 
 
 
@@ -51,10 +52,9 @@
 
 
 
+Schoenebeck             Expires November 2, 2005                [Page 1]
 
-Schoenebeck            Expires November 22, 2005                [Page 1]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 Table of Contents
@@ -66,7 +66,7 @@
    5.   Communication Overview . . . . . . . . . . . . . . . . . . .   8
      5.1  Request/response communication method  . . . . . . . . . .   8
        5.1.1  Result format  . . . . . . . . . . . . . . . . . . . .   9
-     5.2  Subscribe/notify communication method  . . . . . . . . . .  10
+     5.2  Subscribe/notify communication method  . . . . . . . . . .  11
    6.   Description for control commands . . . . . . . . . . . . . .  13
      6.1  Ignored lines and comments . . . . . . . . . . . . . . . .  13
      6.2  Configuring audio drivers  . . . . . . . . . . . . . . . .  13
@@ -76,97 +76,97 @@
               driver . . . . . . . . . . . . . . . . . . . . . . . .  14
        6.2.4  Getting information about specific audio output
               driver parameter . . . . . . . . . . . . . . . . . . .  15
-       6.2.5  Creating an audio output device  . . . . . . . . . . .  18
-       6.2.6  Destroying an audio output device  . . . . . . . . . .  18
-       6.2.7  Getting all created audio output device count  . . . .  19
-       6.2.8  Getting all created audio output device list . . . . .  19
-       6.2.9  Getting current settings of an audio output device . .  20
-       6.2.10   Changing settings of audio output devices  . . . . .  21
-       6.2.11   Getting information about an audio channel . . . . .  21
+       6.2.5  Creating an audio output device  . . . . . . . . . . .  19
+       6.2.6  Destroying an audio output device  . . . . . . . . . .  20
+       6.2.7  Getting all created audio output device count  . . . .  21
+       6.2.8  Getting all created audio output device list . . . . .  21
+       6.2.9  Getting current settings of an audio output device . .  21
+       6.2.10   Changing settings of audio output devices  . . . . .  23
+       6.2.11   Getting information about an audio channel . . . . .  24
        6.2.12   Getting information about specific audio channel
-                parameter  . . . . . . . . . . . . . . . . . . . . .  23
-       6.2.13   Changing settings of audio output channels . . . . .  24
-     6.3  Configuring MIDI input drivers . . . . . . . . . . . . . .  25
-       6.3.1  Getting amount of available MIDI input drivers . . . .  26
-       6.3.2  Getting all available MIDI input drivers . . . . . . .  26
+                parameter  . . . . . . . . . . . . . . . . . . . . .  25
+       6.2.13   Changing settings of audio output channels . . . . .  27
+     6.3  Configuring MIDI input drivers . . . . . . . . . . . . . .  28
+       6.3.1  Getting amount of available MIDI input drivers . . . .  29
+       6.3.2  Getting all available MIDI input drivers . . . . . . .  29
        6.3.3  Getting information about a specific MIDI input
-              driver . . . . . . . . . . . . . . . . . . . . . . . .  26
+              driver . . . . . . . . . . . . . . . . . . . . . . . .  30
        6.3.4  Getting information about specific MIDI input
-              driver parameter . . . . . . . . . . . . . . . . . . .  27
-       6.3.5  Creating a MIDI input device . . . . . . . . . . . . .  29
-       6.3.6  Destroying a MIDI input device . . . . . . . . . . . .  30
-       6.3.7  Getting all created MIDI input device count  . . . . .  30
-       6.3.8  Getting all created MIDI input device list . . . . . .  31
-       6.3.9  Getting current settings of a MIDI input device  . . .  31
-       6.3.10   Changing settings of MIDI input devices  . . . . . .  32
-       6.3.11   Getting information about a MIDI port  . . . . . . .  33
+              driver parameter . . . . . . . . . . . . . . . . . . .  31
+       6.3.5  Creating a MIDI input device . . . . . . . . . . . . .  33
+       6.3.6  Destroying a MIDI input device . . . . . . . . . . . .  34
+       6.3.7  Getting all created MIDI input device count  . . . . .  35
+       6.3.8  Getting all created MIDI input device list . . . . . .  35
+       6.3.9  Getting current settings of a MIDI input device  . . .  36
+       6.3.10   Changing settings of MIDI input devices  . . . . . .  37
+       6.3.11   Getting information about a MIDI port  . . . . . . .  38
        6.3.12   Getting information about specific MIDI port
-                parameter  . . . . . . . . . . . . . . . . . . . . .  33
-       6.3.13   Changing settings of MIDI input ports  . . . . . . .  35
-     6.4  Configuring sampler channels . . . . . . . . . . . . . . .  35
-       6.4.1  Loading an instrument  . . . . . . . . . . . . . . . .  35
+                parameter  . . . . . . . . . . . . . . . . . . . . .  38
+       6.3.13   Changing settings of MIDI input ports  . . . . . . .  40
+     6.4  Configuring sampler channels . . . . . . . . . . . . . . .  41
+       6.4.1  Loading an instrument  . . . . . . . . . . . . . . . .  41
 
 
 
-Schoenebeck            Expires November 22, 2005                [Page 2]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-       6.4.2  Loading a sampler engine . . . . . . . . . . . . . . .  36
-       6.4.3  Getting all created sampler channel count  . . . . . .  37
-       6.4.4  Getting all created sampler channel list . . . . . . .  37
-       6.4.5  Adding a new sampler channel . . . . . . . . . . . . .  38
-       6.4.6  Removing a sampler channel . . . . . . . . . . . . . .  39
-       6.4.7  Getting amount of available engines  . . . . . . . . .  39
-       6.4.8  Getting all available engines  . . . . . . . . . . . .  39
-       6.4.9  Getting information about an engine  . . . . . . . . .  40
-       6.4.10   Getting sampler channel information  . . . . . . . .  41
-       6.4.11   Current number of active voices  . . . . . . . . . .  42
-       6.4.12   Current number of active disk streams  . . . . . . .  43
-       6.4.13   Current fill state of disk stream buffers  . . . . .  43
-       6.4.14   Setting audio output device  . . . . . . . . . . . .  44
-       6.4.15   Setting audio output type  . . . . . . . . . . . . .  45
-       6.4.16   Setting audio output channel . . . . . . . . . . . .  45
-       6.4.17   Setting MIDI input device  . . . . . . . . . . . . .  46
-       6.4.18   Setting MIDI input type  . . . . . . . . . . . . . .  46
-       6.4.19   Setting MIDI input port  . . . . . . . . . . . . . .  47
-       6.4.20   Setting MIDI input channel . . . . . . . . . . . . .  48
-       6.4.21   Setting channel volume . . . . . . . . . . . . . . .  48
-       6.4.22   Resetting a sampler channel  . . . . . . . . . . . .  49
-     6.5  Controlling connection . . . . . . . . . . . . . . . . . .  49
-       6.5.1  Register front-end for receiving event messages  . . .  49
+Schoenebeck             Expires November 2, 2005                [Page 2]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+       6.4.2  Loading a sampler engine . . . . . . . . . . . . . . .  42
+       6.4.3  Getting all created sampler channel count  . . . . . .  43
+       6.4.4  Getting all created sampler channel list . . . . . . .  43
+       6.4.5  Adding a new sampler channel . . . . . . . . . . . . .  44
+       6.4.6  Removing a sampler channel . . . . . . . . . . . . . .  45
+       6.4.7  Getting amount of available engines  . . . . . . . . .  45
+       6.4.8  Getting all available engines  . . . . . . . . . . . .  46
+       6.4.9  Getting information about an engine  . . . . . . . . .  46
+       6.4.10   Getting sampler channel information  . . . . . . . .  47
+       6.4.11   Current number of active voices  . . . . . . . . . .  50
+       6.4.12   Current number of active disk streams  . . . . . . .  50
+       6.4.13   Current fill state of disk stream buffers  . . . . .  51
+       6.4.14   Setting audio output device  . . . . . . . . . . . .  52
+       6.4.15   Setting audio output type  . . . . . . . . . . . . .  53
+       6.4.16   Setting audio output channel . . . . . . . . . . . .  53
+       6.4.17   Setting MIDI input device  . . . . . . . . . . . . .  54
+       6.4.18   Setting MIDI input type  . . . . . . . . . . . . . .  55
+       6.4.19   Setting MIDI input port  . . . . . . . . . . . . . .  56
+       6.4.20   Setting MIDI input channel . . . . . . . . . . . . .  56
+       6.4.21   Setting channel volume . . . . . . . . . . . . . . .  57
+       6.4.22   Muting a sampler channel . . . . . . . . . . . . . .  58
+       6.4.23   Soloing a sampler channel  . . . . . . . . . . . . .  58
+       6.4.24   Resetting a sampler channel  . . . . . . . . . . . .  59
+     6.5  Controlling connection . . . . . . . . . . . . . . . . . .  60
+       6.5.1  Register front-end for receiving event messages  . . .  60
        6.5.2  Unregister front-end for not receiving event
-              messages . . . . . . . . . . . . . . . . . . . . . . .  50
-       6.5.3  Enable or disable echo of commands . . . . . . . . . .  51
-       6.5.4  Close client connection  . . . . . . . . . . . . . . .  51
-     6.6  Global commands  . . . . . . . . . . . . . . . . . . . . .  51
-       6.6.1  Reset sampler  . . . . . . . . . . . . . . . . . . . .  51
-       6.6.2  General sampler informations . . . . . . . . . . . . .  52
-   7.   Command Syntax . . . . . . . . . . . . . . . . . . . . . . .  53
-   8.   Events . . . . . . . . . . . . . . . . . . . . . . . . . . .  58
-     8.1  Number of sampler channels changed . . . . . . . . . . . .  58
-     8.2  Number of active voices changed  . . . . . . . . . . . . .  58
-     8.3  Number of active disk streams changed  . . . . . . . . . .  58
-     8.4  Disk stream buffer fill state changed  . . . . . . . . . .  59
-     8.5  Channel information changed  . . . . . . . . . . . . . . .  59
-     8.6  Miscellaneous and debugging events . . . . . . . . . . . .  59
-   9.   Security Considerations  . . . . . . . . . . . . . . . . . .  61
-   10.  Acknowledgments  . . . . . . . . . . . . . . . . . . . . . .  62
-   11.  References . . . . . . . . . . . . . . . . . . . . . . . . .  62
-        Author's Address . . . . . . . . . . . . . . . . . . . . . .  62
-        Intellectual Property and Copyright Statements . . . . . . .  63
-
+              messages . . . . . . . . . . . . . . . . . . . . . . .  61
+       6.5.3  Enable or disable echo of commands . . . . . . . . . .  61
+       6.5.4  Close client connection  . . . . . . . . . . . . . . .  62
+     6.6  Global commands  . . . . . . . . . . . . . . . . . . . . .  62
+       6.6.1  Reset sampler  . . . . . . . . . . . . . . . . . . . .  62
+       6.6.2  General sampler informations . . . . . . . . . . . . .  62
+   7.   Command Syntax . . . . . . . . . . . . . . . . . . . . . . .  64
+   8.   Events . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
+     8.1  Number of sampler channels changed . . . . . . . . . . . .  71
+     8.2  Number of active voices changed  . . . . . . . . . . . . .  71
+     8.3  Number of active disk streams changed  . . . . . . . . . .  71
+     8.4  Disk stream buffer fill state changed  . . . . . . . . . .  72
+     8.5  Channel information changed  . . . . . . . . . . . . . . .  72
+     8.6  Miscellaneous and debugging events . . . . . . . . . . . .  72
+   9.   Security Considerations  . . . . . . . . . . . . . . . . . .  74
+   10.  Acknowledgments  . . . . . . . . . . . . . . . . . . . . . .  75
+   11.  References . . . . . . . . . . . . . . . . . . . . . . . . .  75
+        Author's Address . . . . . . . . . . . . . . . . . . . . . .  75
+        Intellectual Property and Copyright Statements . . . . . . .  76
 
 
 
 
 
 
+Schoenebeck             Expires November 2, 2005                [Page 3]
 
-Schoenebeck            Expires November 22, 2005                [Page 3]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 1.  Requirements notation
@@ -178,13 +178,14 @@
    This protocol is always case-sensitive if not explicitly claimed the
    opposite.
 
-   In examples, "C:" and "S:" indicate lines sent by the client
-   (front-end) and server (LinuxSampler) respectively.  Lines in
-   examples must be interpreted as every line being CRLF terminated
-   (carriage return character followed by line feed character as defined
-   in the ASCII standard), thus the following example:
+   In examples, "C:" and "S:" indicate lines sent by the client (front-
+   end) and server (LinuxSampler) respectively.  Lines in examples must
+   be interpreted as every line being CRLF terminated (carriage return
+   character followed by line feed character as defined in the ASCII
+   standard), thus the following example:
 
       C: "some line"
+
          "another line"
 
    must actually be interpreted as client sending the following message:
@@ -203,9 +204,13 @@
    sequence scenario:
 
    o  server sending message "a"
+
    o  followed by a delay (pause) with arbitrary duration
+
    o  followed by server sending message "bcd<CR>"
+
    o  again followed by a delay (pause) with arbitrary duration
+
    o  followed by server sending the message "<LF>"
 
    where again <CR> and <LF> symbolize the carriage return and line feed
@@ -215,14 +220,9 @@
 
 
 
+Schoenebeck             Expires November 2, 2005                [Page 4]
 
-
-
-
-
-Schoenebeck            Expires November 22, 2005                [Page 4]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 2.  Versioning of this specification
@@ -246,6 +246,7 @@
 
    1.  The frontend's LSCP major version and the sampler's LSCP major
        version are exactly equal.
+
    2.  The frontend's LSCP minor version is less or equal than the
        sampler's LSCP minor version.
 
@@ -275,10 +276,9 @@
 
 
 
+Schoenebeck             Expires November 2, 2005                [Page 5]
 
-Schoenebeck            Expires November 22, 2005                [Page 5]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 3.  Introduction
@@ -291,7 +291,7 @@
    virtual channels which will be referred in this document as "sampler
    channels".  The channels are in such way virtual as they can be
    connected to an arbitrary MIDI input method and arbitrary MIDI
-   channel (e.g.  sampler channel 17 could be connected to an ALSA
+   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 channel will be associated with an instance of one of the
    available sampler engines (e.g.  GigEngine, DLSEngine).  The audio
@@ -332,9 +332,9 @@
 
 
 
-Schoenebeck            Expires November 22, 2005                [Page 6]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005                [Page 6]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 4.  Focus of this protocol
@@ -388,9 +388,9 @@
 
 
 
-Schoenebeck            Expires November 22, 2005                [Page 7]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005                [Page 7]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 5.  Communication Overview
@@ -444,9 +444,9 @@
 
 
 
-Schoenebeck            Expires November 22, 2005                [Page 8]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005                [Page 8]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 5.1.1  Result format
@@ -454,13 +454,16 @@
    Result set could be one of the following types:
 
    1.  Normal
+
    2.  Warning
+
    3.  Error
 
    Warning and Error result sets MUST be single line and have the
    following format:
 
    o  "WRN:<warning-code>:<warning-message>"
+
    o  "ERR:<error-code>:<error-message>"
 
    Where <warning-code> and <error-code> are numeric unique identifiers
@@ -470,40 +473,45 @@
    Examples:
 
       C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
+
       S: "WRN:32:This is a 24 bit patch which is not supported natively
       yet."
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
+
       S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter
       'EAR'."
 
       C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
+
       S: "ERR:9:There is no audio output device with index 123456."
 
    Normal result sets could be:
 
    1.  Empty
+
    2.  Single line
+
    3.  Multi-line
 
    Empty result set is issued when the server only needed to acknowledge
    the fact that the request was received and it was processed
    successfully and no additional information is available.  This result
-   set has the following format:
 
-      "OK"
 
-   Example:
 
-      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
+Schoenebeck             Expires November 2, 2005                [Page 9]
 
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
+   set has the following format:
 
-Schoenebeck            Expires November 22, 2005                [Page 9]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+      "OK"
 
+   Example:
+
+      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
 
       S: "OK"
 
@@ -517,13 +525,21 @@
    Example:
 
       C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
+
       S: "DRIVER: ALSA"
+
          "CHANNELS: 2"
+
          "SAMPLERATE: 44100"
+
          "ACTIVE: true"
+
          "FRAGMENTS: 2"
+
          "FRAGMENTSIZE: 128"
+
          "CARD: '0,0'"
+
          "."
 
    In addition to above mentioned formats, warnings and empty result
@@ -531,21 +547,33 @@
    respectively:
 
    o  "WRN[<index>]:<warning-code>:<warning-message>"
+
    o  "OK[<index>]"
 
    where <index> is command specific and is used to indicate channel
    number that the result set was related to or other integer value.
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 10]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    Each line of the result set MUST end with <CRLF>.
 
    Examples:
 
       C: "ADD CHANNEL"
+
       S: "OK[12]"
 
       C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
+
       S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
 
+
 5.2  Subscribe/notify communication method
 
    This more sophisticated communication method is actually only an
@@ -553,14 +581,6 @@
    front-end still uses a TCP connection and sends the same commands on
    the TCP connection.  Two extra commands are SUBSCRIBE and UNSUBSCRIBE
    commands that allow a client to tell the server that it is interested
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 10]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    in receiving notifications about certain events as they happen on the
    server.  The SUBSCRIBE command has the following syntax:
 
@@ -583,10 +603,20 @@
 
    1.  Events MUST NOT be sent to any client who has not issued an
        appropriate SUBSCRIBE command.
+
    2.  Events MUST only be sent using the same connection that was used
        to subscribe to them.
+
    3.  When response is being sent to the client, event MUST be inserted
        in the stream before or after the response, but NOT in the
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 11]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
        middle.  Same is true about the response.  It should never be
        inserted in the middle of the event message as well as any other
        response.
@@ -610,13 +640,6 @@
    channel 4, where the stream with ID "35" is filled by 62%, stream
    with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 11]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    Clients may choose to open more than one connection to the server and
    use some connections to receive notifications while using other
    connections to issue commands to the back-end.  This is entirely
@@ -645,41 +668,19 @@
 
 
 
+Schoenebeck             Expires November 2, 2005               [Page 12]
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 12]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 6.  Description for control commands
 
    This chapter will describe the available control commands that can be
    sent on the TCP connection in detail.  Some certain commands (e.g.
-   "GET CHANNEL INFO" (Section 6.4.10) or "GET ENGINE INFO" (Section
-   6.4.9)) lead to multiple-line responses.  In this case LinuxSampler
-   signals the end of the response by a "." (single dot) line.
+   "GET CHANNEL INFO" (Section 6.4.10) or "GET ENGINE INFO"
+   (Section 6.4.9)) lead to multiple-line responses.  In this case
+   LinuxSampler signals the end of the response by a "." (single dot)
+   line.
 
 6.1  Ignored lines and comments
 
@@ -691,11 +692,11 @@
 6.2  Configuring audio drivers
 
    Instances of drivers in LinuxSampler are called devices.  You can use
-   multiple audio devices simultaneously, e.g.  to output the sound of
+   multiple audio devices simultaneously, e.g. to output the sound of
    one sampler channel using the ALSA audio output driver, and on
    another sampler channel you might want to use the JACK audio output
    driver.  For particular audio output systems it's also possible to
-   create several devices of the same audio output driver, e.g.  two
+   create several devices of the same audio output driver, e.g. two
    separate ALSA audio output devices for using two different sound
    cards at the same time.  This chapter describes all commands to
    configure LinuxSampler's audio output devices and their parameters.
@@ -705,8 +706,8 @@
    values have to be obtained at runtime.  This makes the protocol a bit
    abstract, but has the advantage, that front-ends can be written
    independently of what drivers are currently implemented and what
-   parameters these drivers are actually offering.  This means
-   front-ends can even handle drivers which are implemented somewhere in
+   parameters these drivers are actually offering.  This means front-
+   ends can even handle drivers which are implemented somewhere in
    future without modifying the front-end at all.
 
    Note: examples in this chapter showing particular parameters of
@@ -720,14 +721,15 @@
 6.2.1  Getting amount of available audio output drivers
 
    Use the following command to get the number of audio output drivers
-   currently available for the LinuxSampler instance:
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 13]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 13]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
 
+   currently available for the LinuxSampler instance:
 
       GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
 
@@ -739,8 +741,10 @@
    Example:
 
       C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
+
       S: "2"
 
+
 6.2.2  Getting all available audio output drivers
 
    Use the following command to list all audio output drivers currently
@@ -756,8 +760,10 @@
    Example:
 
       C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
+
       S: "ALSA,JACK"
 
+
 6.2.3  Getting information about a specific audio output driver
 
    Use the following command to get detailed information about a
@@ -771,6 +777,14 @@
 
    Possible Answers:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 14]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       LinuxSampler will answer by sending a <CRLF> separated list.  Each
       answer line begins with the information category name followed by
       a colon and then a space character <SP> and finally the info
@@ -779,33 +793,37 @@
 
 
 
-
-Schoenebeck            Expires November 22, 2005               [Page 14]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-
          DESCRIPTION -
+
             character string describing the audio output driver
+
          VERSION -
+
             character string reflecting the driver's version
+
          PARAMETERS -
+
             comma separated list of all parameters available for the
             given audio output driver, at least parameters 'channels',
             'samplerate' and 'active' are offered by all audio output
             drivers
+
       The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
+
       S: "DESCRIPTION: Advanced Linux Sound Architecture"
+
          "VERSION: 1.0"
+
          "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
       FRAGMENTSIZE,CARD"
+
          "."
 
+
 6.2.4  Getting information about specific audio output driver parameter
 
    Use the following command to get detailed information about a
@@ -815,15 +833,23 @@
 
    Where <audio> is the name of the audio output driver as returned by
    the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 15]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    <prm> a specific parameter name for which information should be
-   obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" (Section
-   6.2.3) command) and <deplist> is an optional list of parameters on
-   which the sought parameter <prm> depends on, <deplist> is a list of
-   key-value pairs in form of "key1=val1 key2=val2 ...", where character
-   string values are encapsulated into apostrophes (').  Arguments given
-   with <deplist> which are not dependency parameters of <prm> will be
-   ignored, means the front-end application can simply put all
-   parameters into <deplist> with the values already selected by the
+   obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
+   (Section 6.2.3) command) and <deplist> is an optional list of
+   parameters on which the sought parameter <prm> depends on, <deplist>
+   is a list of key-value pairs in form of "key1=val1 key2=val2 ...",
+   where character string values are encapsulated into apostrophes (').
+   Arguments given with <deplist> which are not dependency parameters of
+   <prm> will be ignored, means the front-end application can simply put
+   all parameters into <deplist> with the values already selected by the
    user.
 
    Possible Answers:
@@ -833,42 +859,53 @@
       a colon and then a space character <SP> and finally the info
       character string to that info category.  There are information
       which is always returned, independently of the given driver
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 15]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       parameter and there are optional information which is only shown
       dependently to given driver parameter.  At the moment the
       following information categories are defined:
 
       TYPE -
+
          either "BOOL" for boolean value(s) or "INT" for integer
          value(s) or "FLOAT" for dotted number(s) or "STRING" for
          character string(s) (always returned, no matter which driver
          parameter)
+
       DESCRIPTION -
+
          arbitrary text describing the purpose of the parameter (always
          returned, no matter which driver parameter)
+
       MANDATORY -
+
          either true or false, defines if this parameter must be given
          when the device is to be created with the 'CREATE
          AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
          no matter which driver parameter)
+
       FIX -
+
          either true or false, if false then this parameter can be
          changed at any time, once the device is created by the 'CREATE
          AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
          no matter which driver parameter)
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 16]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       MULTIPLICITY -
+
          either true or false, defines if this parameter allows only one
          value or a list of values, where true means multiple values and
          false only a single value allowed (always returned, no matter
          which driver parameter)
+
       DEPENDS -
+
          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,
@@ -878,36 +915,44 @@
          possible values for 'samplerate' depends on the sound card
          which can be chosen by the 'card' parameter (optionally
          returned, dependent to driver parameter)
+
       DEFAULT -
+
          reflects the default value for this parameter which is used
          when the device is created and not explicitly given with the
          'CREATE AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command, in case
          of MULTIPLCITY=true, this is a comma separated list, that's why
          character strings are encapsulated into apostrophes (')
          (optionally returned, dependent to driver parameter)
+
       RANGE_MIN -
+
          defines lower limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MAX, but
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 16]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       RANGE_MAX -
+
          defines upper limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MIN, but
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       POSSIBILITIES -
+
          comma separated list of possible values for this parameter,
          character strings are encapsulated into apostrophes (optionally
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 17]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          returned, dependent to driver parameter)
 
    The mentioned fields above don't have to be in particular order.
@@ -915,47 +960,74 @@
    Examples:
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
+
       S: "DESCRIPTION: sound card to be used"
+
          "TYPE: STRING"
+
          "MANDATORY: false"
+
          "FIX: true"
+
          "MULTIPLICITY: false"
+
          "DEFAULT: '0,0'"
+
          "POSSIBILITIES: '0,0','1,0','2,0'"
+
          "."
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
+
       S: "DESCRIPTION: output sample rate in Hz"
+
          "TYPE: INT"
+
          "MANDATORY: false"
+
          "FIX: false"
+
          "MULTIPLICITY: false"
+
          "DEPENDS: card"
+
          "DEFAULT: 44100"
+
          "."
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE
       CARD='0,0'"
+
       S: "DESCRIPTION: output sample rate in Hz"
+
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 18]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          "TYPE: INT"
+
          "MANDATORY: false"
-         "FIX: false"
-         "MULTIPLICITY: false"
-         "DEPENDS: card"
-         "DEFAULT: 44100"
-         "RANGE_MIN: 22050"
 
+         "FIX: false"
 
+         "MULTIPLICITY: false"
 
+         "DEPENDS: card"
 
-Schoenebeck            Expires November 22, 2005               [Page 17]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+         "DEFAULT: 44100"
 
+         "RANGE_MIN: 22050"
 
          "RANGE_MAX: 96000"
+
          "."
 
+
 6.2.5  Creating an audio output device
 
    Use the following command to create a new audio output device for
@@ -965,75 +1037,97 @@
 
    Where <audio-output-driver> should be replaced by the desired audio
    output system as returned by the "LIST
-   AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command and
-   <param-list> 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 given with this command.
-   Use the previously described commands in this chapter to get this
+   AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command and <param-
+   list> 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 given with this command.  Use the
+   previously described commands in this chapter to get this
    information.
 
    Possible Answers:
 
       "OK[<device-id>]" -
+
          in case the device was successfully created, where <device-id>
          is the numerical ID of the new device
+
       "WRN[<device-id>]:<warning-code>:<warning-message>" -
+
          in case the device was created successfully, where <device-id>
          is the numerical ID of the new device, but there are noteworthy
-         issue(s) related (e.g.  sound card doesn't support given
+         issue(s) related (e.g. sound card doesn't support given
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 19]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          hardware parameters and the driver is using fall-back values),
          providing an appropriate warning code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Examples:
 
       C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
+
       S: "OK[0]"
 
       C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
+
       S: "OK[1]"
 
+
 6.2.6  Destroying an audio output device
 
    Use the following command to destroy a created output device:
 
-
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 18]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       DESTROY AUDIO_OUTPUT_DEVICE <device-id>
 
    Where <device-id> should be replaced by the numerical ID of the audio
-   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section
-   6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command.
+   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
+   (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
+   command.
 
    Possible Answers:
 
       "OK" -
+
          in case the device was successfully destroyed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the device was destroyed successfully, but there are
-         noteworthy issue(s) related (e.g.  an audio over ethernet
-         driver was unloaded but the other host might not be informed
-         about this situation), providing an appropriate warning code
-         and warning message
+         noteworthy issue(s) related (e.g. an audio over ethernet driver
+         was unloaded but the other host might not be informed about
+         this situation), providing an appropriate warning code and
+         warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
+
+
+Schoenebeck             Expires November 2, 2005               [Page 20]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    Example:
 
       C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
+
       S: "OK"
 
+
 6.2.7  Getting all created audio output device count
 
    Use the following command to count all created audio output devices:
@@ -1048,8 +1142,10 @@
    Example:
 
       C: "GET AUDIO_OUTPUT_DEVICES"
+
       S: "4"
 
+
 6.2.8  Getting all created audio output device list
 
    Use the following command to list all created audio output devices:
@@ -1058,30 +1154,33 @@
 
    Possible Answers:
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 19]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LinuxSampler will answer by sending a comma separated list with
       the numerical IDs of all audio output devices.
 
    Example:
 
       C: "LIST AUDIO_OUTPUT_DEVICES"
+
       S: "0,1,4,5"
 
+
 6.2.9  Getting current settings of an audio output device
 
    Use the following command to get current settings of a specific,
    created audio output device:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 21]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       GET AUDIO_OUTPUT_DEVICE INFO <device-id>
 
    Where <device-id> should be replaced by numerical ID of the audio
-   output device as e.g.  returned by the "LIST AUDIO_OUTPUT_DEVICES"
+   output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
    (Section 6.2.8) command.
 
    Possible Answers:
@@ -1095,14 +1194,21 @@
    (independently of device):
 
       DRIVER -
+
          identifier of the used audio output driver, as also returned by
          the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
          command
+
       CHANNELS -
+
          amount of audio output channels this device currently offers
+
       SAMPLERATE -
+
          playback sample rate the device uses
+
       ACTIVE -
+
          either true or false, if false then the audio device is
          inactive and doesn't output any sound, nor do the sampler
          channels connected to this audio device render any audio
@@ -1113,26 +1219,35 @@
    additional driver specific parameters (see Section 6.2.3) which are
    also returned by this command.
 
+   Example:
 
+      C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
 
+      S: "DRIVER: ALSA"
 
-Schoenebeck            Expires November 22, 2005               [Page 20]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
 
-   Example:
 
-      C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
-      S: "DRIVER: ALSA"
+Schoenebeck             Expires November 2, 2005               [Page 22]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          "CHANNELS: 2"
+
          "SAMPLERATE: 44100"
+
          "ACTIVE: true"
+
          "FRAGMENTS: 2"
+
          "FRAGMENTSIZE: 128"
+
          "CARD: '0,0'"
+
          "."
 
+
 6.2.10  Changing settings of audio output devices
 
    Use the following command to alter a specific setting of a created
@@ -1141,41 +1256,49 @@
       SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>
 
    Where <device-id> should be replaced by the numerical ID of the audio
-   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section
-   6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <key>
-   by the name of the parameter to change and <value> by the new value
-   for this parameter.
+   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
+   (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
+   command, <key> by the name of the parameter to change and <value> by
+   the new value for this parameter.
 
    Possible Answers:
 
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
-      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
-      S: "OK"
 
-6.2.11  Getting information about an audio channel
 
-   Use the following command to get information about an audio channel:
 
-      GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
+
+Schoenebeck             Expires November 2, 2005               [Page 23]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
+      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
+
+      S: "OK"
 
 
-Schoenebeck            Expires November 22, 2005               [Page 21]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+6.2.11  Getting information about an audio channel
+
+   Use the following command to get information about an audio channel:
 
+      GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
 
    Where <device-id> is the numerical ID of the audio output device as
    given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
@@ -1190,23 +1313,38 @@
       character string to that info category.  At the moment the
       following information categories are defined:
 
+
+
          NAME -
+
             arbitrary character string naming the channel, which doesn't
             have to be unique (always returned by all audio channels)
+
          IS_MIX_CHANNEL -
+
             either true or false, a mix-channel is not a real,
             independent audio channel, but a virtual channel which is
             mixed to another real channel, this mechanism is needed for
             sampler engines which need more audio channels than the used
             audio system might be able to offer (always returned by all
             audio channels)
+
          MIX_CHANNEL_DESTINATION -
+
             numerical ID (positive integer including 0) which reflects
             the real audio channel (of the same audio output device)
             this mix channel refers to, means where the audio signal
             actually will be routed / added to (only returned in case
             the audio channel is mix channel)
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 24]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    The mentioned fields above don't have to be in particular order.  The
    fields above are only those fields which are generally returned for
    the described cases by all audio channels regardless of the audio
@@ -1216,38 +1354,53 @@
    Examples:
 
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
+
       S: "NAME: studio monitor left"
-         "IS_MIX_CHANNEL: false"
-         "."
 
-      C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
-      S: "NAME: studio monitor right"
          "IS_MIX_CHANNEL: false"
-         "."
 
+         "."
 
+      C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
 
+      S: "NAME: studio monitor right"
 
-Schoenebeck            Expires November 22, 2005               [Page 22]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+         "IS_MIX_CHANNEL: false"
 
+         "."
 
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
+
       S: "NAME: studio monitor left"
+
          "IS_MIX_CHANNEL: true"
+
          "MIX_CHANNEL_DESTINATION: 1"
+
          "."
 
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
+
       S: "NAME: 'ardour (left)'"
+
          "IS_MIX_CHANNEL: false"
+
          "JACK_BINDINGS: 'ardour:0'"
+
          "."
 
+
 6.2.12  Getting information about specific audio channel parameter
 
    Use the following command to get detailed information about specific
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 25]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    audio channel parameter:
 
       GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
@@ -1270,64 +1423,96 @@
       dependently to the given audio channel.  At the moment the
       following information categories are defined:
 
+
+
          TYPE -
+
             either "BOOL" for boolean value(s) or "INT" for integer
             value(s) or "FLOAT" for dotted number(s) or "STRING" for
             character string(s) (always returned)
+
          DESCRIPTION -
+
             arbitrary text describing the purpose of the parameter
             (always returned)
+
          FIX -
+
             either true or false, if true then this parameter is read
             only, thus cannot be altered (always returned)
 
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 23]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
          MULTIPLICITY -
+
             either true or false, defines if this parameter allows only
             one value or a list of values, where true means multiple
             values and false only a single value allowed (always
             returned)
+
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 26]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          RANGE_MIN -
+
             defines lower limit of the allowed value range for this
             parameter, can be an integer value as well as a dotted
             number, usually used in conjunction with 'RANGE_MAX', but
             may also appear without (optionally returned, dependent to
             driver and channel parameter)
+
          RANGE_MAX -
+
             defines upper limit of the allowed value range for this
             parameter, can be an integer value as well as a dotted
             number, usually used in conjunction with 'RANGE_MIN', but
             may also appear without (optionally returned, dependent to
             driver and channel parameter)
+
          POSSIBILITIES -
+
             comma separated list of possible values for this parameter,
             character strings are encapsulated into apostrophes
             (optionally returned, dependent to driver and channel
             parameter)
+
       The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
+
       S: "DESCRIPTION: bindings to other JACK clients"
+
          "TYPE: STRING"
+
          "FIX: false"
+
          "MULTIPLICITY: true"
+
          "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
+
          "."
 
+
 6.2.13  Changing settings of audio output channels
 
    Use the following command to alter a specific setting of an audio
    output channel:
 
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 27]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
 
    Where <dev-id> should be replaced by the numerical ID of the audio
@@ -1338,35 +1523,36 @@
 
    Possible Answers:
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 24]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
       C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
+
       S: "OK"
 
       C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
+
       S: "OK"
 
+
 6.3  Configuring MIDI input drivers
 
    Instances of drivers in LinuxSampler are called devices.  You can use
-   multiple MIDI devices simultaneously, e.g.  to use MIDI over ethernet
+   multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet
    as MIDI input on one sampler channel and ALSA as MIDI input on
    another sampler channel.  For particular MIDI input systems it's also
    possible to create several devices of the same MIDI input type.  This
@@ -1375,11 +1561,19 @@
 
    Instead of defining commands and parameters for each driver
    individually, all possible parameters, their meanings and possible
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 28]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    values have to be obtained at runtime.  This makes the protocol a bit
    abstract, but has the advantage, that front-ends can be written
    independently of what drivers are currently implemented and what
-   parameters these drivers are actually offering.  This means
-   front-ends can even handle drivers which are implemented somewhere in
+   parameters these drivers are actually offering.  This means front-
+   ends can even handle drivers which are implemented somewhere in
    future without modifying the front-end at all.
 
    Commands for configuring MIDI input devices are pretty much the same
@@ -1394,13 +1588,6 @@
    retrieve what parameters drivers are offering, how to retrieve their
    possible values, etc.
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 25]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
 6.3.1  Getting amount of available MIDI input drivers
 
    Use the following command to get the number of MIDI input drivers
@@ -1416,8 +1603,10 @@
    Example:
 
       C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
+
       S: "2"
 
+
 6.3.2  Getting all available MIDI input drivers
 
    Use the following command to list all MIDI input drivers currently
@@ -1427,14 +1616,25 @@
 
    Possible Answers:
 
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 29]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       LinuxSampler will answer by sending comma separated character
       strings, each symbolizing a MIDI input driver.
 
    Example:
 
       C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
+
       S: "ALSA,JACK"
 
+
 6.3.3  Getting information about a specific MIDI input driver
 
    Use the following command to get detailed information about a
@@ -1448,38 +1648,50 @@
 
    Possible Answers:
 
-
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 26]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LinuxSampler will answer by sending a <CRLF> separated list.  Each
       answer line begins with the information category name followed by
       a colon and then a space character <SP> and finally the info
       character string to that info category.  At the moment the
       following information categories are defined:
 
+
+
          DESCRIPTION -
+
             arbitrary description text about the MIDI input driver
+
          VERSION -
+
             arbitrary character string regarding the driver's version
+
          PARAMETERS -
+
             comma separated list of all parameters available for the
             given MIDI input driver
+
       The mentioned fields above don't have to be in particular order.
 
    Example:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 30]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       C: "GET MIDI_INPUT_DRIVER INFO ALSA"
+
       S: "DESCRIPTION: Advanced Linux Sound Architecture"
+
          "VERSION: 1.0"
+
          "PARAMETERS: DRIVER,ACTIVE"
+
          "."
 
+
 6.3.4  Getting information about specific MIDI input driver parameter
 
    Use the following command to get detailed information about a
@@ -1505,43 +1717,54 @@
    answer line begins with the information category name followed by a
    colon and then a space character <SP> and finally the info character
    string to that info category.  There is information which is always
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 27]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    returned, independent of the given driver parameter and there is
    optional information which is only shown dependent to given driver
    parameter.  At the moment the following information categories are
    defined:
 
       TYPE -
+
          either "BOOL" for boolean value(s) or "INT" for integer
          value(s) or "FLOAT" for dotted number(s) or "STRING" for
          character string(s) (always returned, no matter which driver
          parameter)
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 31]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       DESCRIPTION -
+
          arbitrary text describing the purpose of the parameter (always
          returned, no matter which driver parameter)
+
       MANDATORY -
+
          either true or false, defines if this parameter must be given
          when the device is to be created with the 'CREATE
          MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
          matter which driver parameter)
+
       FIX -
+
          either true or false, if false then this parameter can be
          changed at any time, once the device is created by the 'CREATE
          MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
          matter which driver parameter)
+
       MULTIPLICITY -
+
          either true or false, defines if this parameter allows only one
          value or a list of values, where true means multiple values and
          false only a single value allowed (always returned, no matter
          which driver parameter)
+
       DEPENDS -
+
          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,
@@ -1551,34 +1774,43 @@
          possible values for 'samplerate' depends on the sound card
          which can be chosen by the 'card' parameter (optionally
          returned, dependent to driver parameter)
+
       DEFAULT -
+
          reflects the default value for this parameter which is used
          when the device is created and not explicitly given with the
          'CREATE MIDI_INPUT_DEVICE' (Section 6.3.5) command, in case of
          MULTIPLCITY=true, this is a comma separated list, that's why
          character strings are encapsulated into apostrophes (')
          (optionally returned, dependent to driver parameter)
-      RANGE_MIN -
-         defines lower limit of the allowed value range for this
-         parameter, can be an integer value as well as a dotted number,
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 28]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
 
+Schoenebeck             Expires November 2, 2005               [Page 32]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+      RANGE_MIN -
+
+         defines lower limit of the allowed value range for this
+         parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MAX, but
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       RANGE_MAX -
+
          defines upper limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MIN, but
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       POSSIBILITIES -
+
          comma separated list of possible values for this parameter,
          character strings are encapsulated into apostrophes (optionally
          returned, dependent to driver parameter)
@@ -1588,19 +1820,35 @@
    Example:
 
       C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
+
       S: "DESCRIPTION: Whether device is enabled"
+
          "TYPE: BOOL"
+
          "MANDATORY: false"
+
          "FIX: false"
+
          "MULTIPLICITY: false"
+
          "DEFAULT: true"
+
          "."
 
+
 6.3.5  Creating a MIDI input device
 
    Use the following command to create a new MIDI input device for  the
    desired MIDI input system:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 33]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
 
    Where <midi-input-driver> should be replaced by the desired MIDI
@@ -1615,30 +1863,29 @@
    Possible Answers:
 
       "OK[<device-id>]" -
+
          in case the device was successfully created, where <device-id>
          is the numerical ID of the new device
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 29]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       "WRN[<device-id>]:<warning-code>:<warning-message>" -
+
          in case the driver was loaded successfully, where <device-id>
          is the numerical ID of the new device, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
       C: "CREATE MIDI_INPUT_DEVICE ALSA"
+
       S: "OK[0]"
 
+
 6.3.6  Destroying a MIDI input device
 
    Use the following command to destroy a created MIDI input device:
@@ -1651,21 +1898,35 @@
 
    Possible Answers:
 
+
+
+Schoenebeck             Expires November 2, 2005               [Page 34]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       "OK" -
+
          in case the device was successfully destroyed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the device was destroyed, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
       C: "DESTROY MIDI_INPUT_DEVICE 0"
+
       S: "OK"
 
+
 6.3.7  Getting all created MIDI input device count
 
    Use the following command to count all created MIDI input devices:
@@ -1674,21 +1935,16 @@
 
    Possible Answers:
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 30]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LinuxSampler will answer by sending the current number of all MIDI
       input devices.
 
    Example:
 
       C: "GET MIDI_INPUT_DEVICES"
+
       S: "3"
 
+
 6.3.8  Getting all created MIDI input device list
 
    Use the following command to list all created MIDI input devices:
@@ -1697,17 +1953,28 @@
 
    Possible Answers:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 35]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       LinuxSampler will answer by sending a comma separated list with
       the numerical Ids of all created MIDI input devices.
 
    Examples:
 
       C: "LIST MIDI_INPUT_DEVICES"
+
       S: "0,1,2"
 
       C: "LIST MIDI_INPUT_DEVICES"
+
       S: "1,3"
 
+
 6.3.9  Getting current settings of a MIDI input device
 
    Use the following command to get current settings of a specific,
@@ -1731,22 +1998,25 @@
 
 
 
-
-Schoenebeck            Expires November 22, 2005               [Page 31]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-
          DRIVER -
-            identifier of the used MIDI input driver, as e.g.  returned
+
+            identifier of the used MIDI input driver, as e.g. returned
             by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
             command
+
          ACTIVE -
+
             either true or false, if false then the MIDI device is
             inactive and doesn't listen to any incoming MIDI events and
             thus doesn't forward them to connected sampler channels
 
+
+
+Schoenebeck             Expires November 2, 2005               [Page 36]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    The mentioned fields above don't have to be in particular order.  The
    fields above are only those fields which are returned by all MIDI
    input devices.  Every MIDI input driver might have its own,
@@ -1757,10 +2027,14 @@
    Example:
 
       C: "GET MIDI_INPUT_DEVICE INFO 0"
+
       S: "DRIVER: ALSA"
+
          "ACTIVE: true"
+
          "."
 
+
 6.3.10  Changing settings of MIDI input devices
 
    Use the following command to alter a specific setting of a created
@@ -1769,35 +2043,43 @@
       SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>
 
    Where <device-id> should be replaced by the numerical ID of the MIDI
-   input device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section
-   6.3.5) or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <key> by
-   the name of the parameter to change and <value> by the new value for
-   this parameter.
+   input device as returned by the "CREATE MIDI_INPUT_DEVICE"
+   (Section 6.3.5) or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command,
+   <key> by the name of the parameter to change and <value> by the new
+   value for this parameter.
 
    Possible Answers:
 
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 32]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+
+Schoenebeck             Expires November 2, 2005               [Page 37]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
    Example:
 
       C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
+
       S: "OK"
 
+
 6.3.11  Getting information about a MIDI port
 
    Use the following command to get information about a MIDI port:
@@ -1816,7 +2098,9 @@
       a colon and then a space character <SP> and finally the info
       character string to that info category.  At the moment the
       following information categories are defined:
+
       NAME -
+
          arbitrary character string naming the port
 
    The field above is only the one which is returned by all MIDI ports
@@ -1826,13 +2110,25 @@
    Example:
 
       C: "GET MIDI_INPUT_PORT INFO 0 0"
+
       S: "NAME: 'Masterkeyboard'"
+
          "ALSA_SEQ_BINDINGS: '64:0'"
+
          "."
 
+
 6.3.12  Getting information about specific MIDI port parameter
 
    Use the following command to get detailed information about specific
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 38]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    MIDI port parameter:
 
       GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
@@ -1841,14 +2137,6 @@
    returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
    MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> the MIDI port
    number and <param> a specific port parameter name for which
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 33]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    information should be obtained (as returned by the "GET
    MIDI_INPUT_PORT INFO" (Section 6.3.11) command).
 
@@ -1862,33 +2150,55 @@
       parameter and there is optional information which are only shown
       dependently to the given MIDI port.  At the moment the following
       information categories are defined:
+
       TYPE -
+
          either "BOOL" for boolean value(s) or "INT" for integer
          value(s) or "FLOAT" for dotted number(s) or "STRING" for
          character string(s) (always returned)
+
       DESCRIPTION -
+
          arbitrary text describing the purpose of the parameter (always
          returned)
+
       FIX -
+
          either true or false, if true then this parameter is read only,
          thus cannot be altered (always returned)
+
       MULTIPLICITY -
+
          either true or false, defines if this parameter allows only one
          value or a list of values, where true means multiple values and
          false only a single value allowed (always returned)
+
       RANGE_MIN -
+
          defines lower limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 39]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          this parameter is usually used in conjunction with 'RANGE_MAX'
          but may also appear without (optionally returned, dependent to
          driver and port parameter)
+
       RANGE_MAX -
+
          defines upper limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is usually used in conjunction with 'RANGE_MIN'
          but may also appear without (optionally returned, dependent to
          driver and port parameter)
+
       POSSIBILITIES -
+
          comma separated list of possible values for this parameter,
          character strings are encapsulated into apostrophes (optionally
          returned, dependent to device and port parameter)
@@ -1897,22 +2207,21 @@
 
    Example:
 
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 34]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
+
       S: "DESCRIPTION: bindings to other ALSA sequencer clients"
+
          "TYPE: STRING"
+
          "FIX: false"
+
          "MULTIPLICITY: true"
+
          "POSSIBILITIES: '64:0','68:0','68:1'"
+
          "."
 
+
 6.3.13  Changing settings of MIDI input ports
 
    Use the following command to alter a specific setting of a MIDI input
@@ -1924,17 +2233,30 @@
    device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
    or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
    MIDI port number, <key> by the name of the parameter to change and
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 40]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    <value> by the new value for this parameter.
 
    Possible Answers:
 
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -1942,6 +2264,7 @@
 
 
 
+
 6.4  Configuring sampler channels
 
    The following commands describe how to add and remove sampler
@@ -1953,16 +2276,8 @@
    An instrument file can be loaded and assigned to a sampler channel by
    one of the following commands:
 
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 35]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-      LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index>
-      <sampler-channel>
+      LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-
+      channel>
 
    Where <filename> is the name of the instrument file on the
    LinuxSampler instance's host system, <instr-index> the index of the
@@ -1974,8 +2289,16 @@
    is that the regular command returns OK only after the instrument has
    been fully loaded and the channel is ready to be used while NON_MODAL
    version returns immediately and a background process is launched to
-   load the instrument on the channel.  The GET CHANNEL INFO (Section
-   6.4.10) command can be used to obtain loading progress from
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 41]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+   load the instrument on the channel.  The GET CHANNEL INFO
+   (Section 6.4.10) command can be used to obtain loading progress from
    INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
    such as making sure that the file could be read and it is of a proper
    format and SHOULD return ERR and SHOULD not launch the background
@@ -1984,14 +2307,19 @@
    Possible Answers:
 
       "OK" -
+
          in case the instrument was successfully loaded
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the instrument was loaded successfully, but there are
          noteworthy issue(s) related (e.g.  Engine doesn't support one
          or more patch parameters provided by the loaded instrument
          file), providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -1999,6 +2327,7 @@
 
 
 
+
 6.4.2  Loading a sampler engine
 
    A sampler engine type can be associated to a specific sampler channel
@@ -2009,14 +2338,6 @@
    Where <engine-name> is an engine name as obtained by the "LIST
    AVAILABLE_ENGINES" (Section 6.4.8) command and <sampler-channel> the
    sampler channel as returned by the "ADD CHANNEL" (Section 6.4.5) or
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 36]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    "LIST CHANNELS" (Section 6.4.4) 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
@@ -2024,17 +2345,30 @@
    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
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 42]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    engine type, shared with other sampler channels, should be used.
 
    Possible Answers:
 
       "OK" -
+
          in case the engine was successfully deployed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the engine was deployed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2042,6 +2376,7 @@
 
 
 
+
 6.4.3  Getting all created sampler channel count
 
    The number of sampler channels can change on runtime.  To get the
@@ -2058,20 +2393,23 @@
    Example:
 
       C: "GET CHANNELS"
+
       S: "12"
 
+
 6.4.4  Getting all created sampler channel list
 
    The number of sampler channels can change on runtime.  To get the
    current list of sampler channels, the front-end can send the
-   following command:
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 37]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 43]
 
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+   following command:
 
       LIST CHANNELS
 
@@ -2083,8 +2421,10 @@
    Example:
 
       C: "LIST CHANNELS"
+
       S: "0,1,2,3,4,5,6,9,10,11,15,20"
 
+
 6.4.5  Adding a new sampler channel
 
    A new sampler channel can be added to the end of the sampler channel
@@ -2095,38 +2435,44 @@
    This will increment the sampler channel count by one and the new
    sampler channel will be appended to the end of the sampler channel
    list.  The front-end should send the respective, related commands
-   right after to e.g.  load an engine, load an instrument and setting
+   right after to e.g. load an engine, load an instrument and setting
    input, output method and eventually other commands to initialize the
    new channel.  The front-end should use the sampler channel returned
    by the answer of this command to perform the previously recommended
-   commands, to avoid race conditions e.g.  with other front-ends that
+   commands, to avoid race conditions e.g. with other front-ends that
    might also have sent an "ADD CHANNEL" command.
 
    Possible Answers:
 
       "OK[<sampler-channel>]" -
-         in case a new sampler channel could be added, where
-         <sampler-channel> reflects the channel number of the new
-         created sampler channel which should be used to set up the
-         sampler channel by sending subsequent initialization commands
+
+         in case a new sampler channel could be added, where <sampler-
+         channel> reflects the channel number of the new created sampler
+         channel which should be used to set up the sampler channel by
+         sending subsequent initialization commands
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case a new channel was added successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
-      "ERR:<error-code>:<error-message>" -
-         in case it failed, providing an appropriate error code and
-         error message
 
-   Example:
 
 
 
+Schoenebeck             Expires November 2, 2005               [Page 44]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
 
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Example:
 
 
-Schoenebeck            Expires November 22, 2005               [Page 38]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
 
 6.4.6  Removing a sampler channel
@@ -2143,12 +2489,17 @@
    Possible Answers:
 
       "OK" -
+
          in case the given sampler channel could be removed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the given channel was removed, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2156,11 +2507,20 @@
 
 
 
+
 6.4.7  Getting amount of available engines
 
    The front-end can ask for the number of available engines by sending
    the following command:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 45]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       GET AVAILABLE_ENGINES
 
    Possible Answers:
@@ -2171,20 +2531,15 @@
    Example:
 
       C: "GET AVAILABLE_ENGINES"
+
       S: "4"
 
+
 6.4.8  Getting all available engines
 
    The front-end can ask for a list of all available engines by sending
    the following command:
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 39]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LIST AVAILABLE_ENGINES
 
    Possible Answers:
@@ -2197,8 +2552,10 @@
    Example:
 
       C: "LIST AVAILABLE_ENGINES"
+
       S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
 
+
 6.4.9  Getting information about an engine
 
    The front-end can ask for information about a specific engine by
@@ -2211,15 +2568,29 @@
 
    Possible Answers:
 
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 46]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       LinuxSampler will answer by sending a <CRLF> separated list.  Each
       answer line begins with the information category name followed by
       a colon and then a space character <SP> and finally the info
       character string to that info category.  At the moment the
       following categories are defined:
 
+
+
          DESCRIPTION -
+
             arbitrary description text about the engine
+
          VERSION -
+
             arbitrary character string regarding the engine's version
 
    The mentioned fields above don't have to be in particular order.
@@ -2227,18 +2598,12 @@
    Example:
 
       C: "GET ENGINE INFO JoesCustomEngine"
-      S: "DESCRIPTION: this is Joe's custom sampler engine"
-         "VERSION: testing-1.0"
-         "."
-
-
-
 
+      S: "DESCRIPTION: this is Joe's custom sampler engine"
 
+         "VERSION: testing-1.0"
 
-Schoenebeck            Expires November 22, 2005               [Page 40]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+         "."
 
 
 6.4.10  Getting sampler channel information
@@ -2260,79 +2625,147 @@
       character string to that setting category.  At the moment the
       following categories are defined:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 47]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+
+
          ENGINE_NAME -
+
             name of the engine that is associated with the sampler
             channel, "NONE" if there's no engine associated yet for this
             sampler channel
+
          AUDIO_OUTPUT_DEVICE -
+
             numerical ID of the audio output device which is currently
             connected to this sampler channel to output the audio
             signal, "NONE" if there's no device connected to this
             sampler channel
+
          AUDIO_OUTPUT_CHANNELS -
+
             number of output channels the sampler channel offers
             (dependent to used sampler engine and loaded instrument)
+
          AUDIO_OUTPUT_ROUTING -
+
             comma separated list which reflects to which audio channel
             of the selected audio output device each sampler output
-            channel is routed to, e.g.  "0,3" would mean the engine's
+            channel is routed to, e.g. "0,3" would mean the engine's
             output channel 0 is routed to channel 0 of the audio output
             device and the engine's output channel 1 is routed to the
             channel 3 of the audio output device
+
          INSTRUMENT_FILE -
+
             the file name of the loaded instrument, "NONE" if there's no
             instrument yet loaded for this sampler channel
+
          INSTRUMENT_NR -
+
             the instrument index number of the loaded instrument
+
          INSTRUMENT_NAME -
+
             the instrument name of the loaded instrument
+
          INSTRUMENT_STATUS -
+
             integer values 0 to 100 indicating loading progress
             percentage for the instrument.  Negative value indicates a
+            loading exception.  Value of 100 indicates that the
+            instrument is fully loaded.
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 41]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 48]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
-            loading exception.  Value of 100 indicates that the
-            instrument is fully loaded.
          MIDI_INPUT_DEVICE -
+
             numerical ID of the MIDI input device which is currently
             connected to this sampler channel to deliver MIDI input
             commands, "NONE" if there's no device connected to this
             sampler channel
+
          MIDI_INPUT_PORT -
+
             port number of the MIDI input device
+
          MIDI_INPUT_CHANNEL -
+
             the MIDI input channel number this sampler channel should
             listen to or "ALL" to listen on all MIDI channels
+
          VOLUME -
+
             optionally dotted number for the channel volume factor
             (where a value < 1.0 means attenuation and a value > 1.0
             means amplification)
 
+         MUTE -
+
+            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
+
+         SOLO -
+
+            Determines whether this is a solo channel, "true" if the
+            channel is a solo channel; "false" otherwise
+
    The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET CHANNEL INFO 34"
+
       S: "ENGINE_NAME: GigEngine"
+
          "VOLUME: 1.0"
+
          "AUDIO_OUTPUT_DEVICE: 0"
+
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 49]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
          "AUDIO_OUTPUT_CHANNELS: 2"
+
          "AUDIO_OUTPUT_ROUTING: 0,1"
+
          "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
+
          "INSTRUMENT_NR: 0"
+
          "INSTRUMENT_NAME: Fazioli Piano"
+
          "INSTRUMENT_STATUS: 100"
+
          "MIDI_INPUT_DEVICE: 0"
+
          "MIDI_INPUT_PORT: 0"
+
          "MIDI_INPUT_CHANNEL: 5"
+
          "."
 
+
 6.4.11  Current number of active voices
 
    The front-end can ask for the current number of active voices on a
@@ -2346,13 +2779,6 @@
 
    Possible Answers:
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 42]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LinuxSampler will answer by returning the number of active voices
       on that channel.
 
@@ -2360,11 +2786,21 @@
 
 
 
+
 6.4.12  Current number of active disk streams
 
    The front-end can ask for the current number of active disk streams
    on a sampler channel by sending the following command:
 
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 50]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       GET CHANNEL STREAM_COUNT <sampler-channel>
 
    Where <sampler-channel> is the sampler channel number the front-end
@@ -2382,6 +2818,7 @@
 
 
 
+
 6.4.13  Current fill state of disk stream buffers
 
    The front-end can ask for the current fill state of all disk streams
@@ -2400,15 +2837,6 @@
 
    Possible Answers:
 
-
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 43]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LinuxSampler will either answer by returning a comma separated
       string with the fill state of all disk stream buffers on that
       channel or an empty line if there are no active disk streams or
@@ -2422,13 +2850,26 @@
 
    Examples:
 
+
+
+Schoenebeck             Expires November 2, 2005               [Page 51]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       C: "GET CHANNEL BUFFER_FILL BYTES 4"
+
       S: "[115]420500,[116]510300,[75]110000,[120]230700"
+
       C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
+
       S: "[115]90%,[116]98%,[75]40%,[120]62%"
+
       C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
+
       S: ""
 
+
 6.4.14  Setting audio output device
 
    The front-end can set the audio output device on a specific sampler
@@ -2447,12 +2888,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if audio output device was set, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2460,9 +2906,12 @@
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 44]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+
+
+Schoenebeck             Expires November 2, 2005               [Page 52]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
 
 
 
@@ -2474,8 +2923,8 @@
    The front-end can alter the audio output type on a specific sampler
    channel by sending the following command:
 
-      SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel>
-      <audio-output-type>
+      SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
+      type>
 
    Where <audio-output-type> is currently either "ALSA" or "JACK" and
    <sampler-channel> is the respective sampler channel number.
@@ -2483,12 +2932,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if audio output type was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2496,6 +2950,7 @@
 
 
 
+
 6.4.16  Setting audio output channel
 
    The front-end can alter the audio output channel on a specific
@@ -2506,28 +2961,33 @@
 
    Where <sampler-chan> is the sampler channel number as returned by the
    "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
-   command, <audio-out> is the numerical ID of the sampler channel's
-   audio output channel which should be rerouted and <audio-in> is the
-   numerical ID of the audio channel of the selected audio output device
-   where <audio-out> should be routed to.
 
-   Possible Answers:
 
 
+Schoenebeck             Expires November 2, 2005               [Page 53]
 
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
-Schoenebeck            Expires November 22, 2005               [Page 45]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
+   command, <audio-out> is the numerical ID of the sampler channel's
+   audio output channel which should be rerouted and <audio-in> is the
+   numerical ID of the audio channel of the selected audio output device
+   where <audio-out> should be routed to.
+
+   Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if audio output channel was set, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2535,6 +2995,7 @@
 
 
 
+
 6.4.17  Setting MIDI input device
 
    The front-end can set the MIDI input device on a specific sampler
@@ -2551,12 +3012,27 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
+
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 54]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input device was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2564,35 +3040,33 @@
 
 
 
+
 6.4.18  Setting MIDI input type
 
    DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
 
    The front-end can alter the MIDI input type on a specific sampler
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 46]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    channel by sending the following command:
 
       SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
 
-   Where <midi-input-type> is currently only "ALSA" and
-   <sampler-channel> is the respective sampler channel number.
+   Where <midi-input-type> is currently only "ALSA" and <sampler-
+   channel> is the respective sampler channel number.
 
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input type was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2600,6 +3074,16 @@
 
 
 
+
+
+Schoenebeck             Expires November 2, 2005               [Page 55]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+
+
+
 6.4.19  Setting MIDI input port
 
    The front-end can alter the MIDI input port on a specific sampler
@@ -2613,12 +3097,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input port was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2627,14 +3116,6 @@
 
 
 
-
-Schoenebeck            Expires November 22, 2005               [Page 47]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-
-
 6.4.20  Setting MIDI input channel
 
    The front-end can alter the MIDI channel a sampler channel should
@@ -2648,13 +3129,26 @@
 
    Possible Answers:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 56]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input channel was set, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2662,6 +3156,7 @@
 
 
 
+
 6.4.21  Setting channel volume
 
    The front-end can alter the volume of a sampler channel by sending
@@ -2677,20 +3172,100 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if channel volume was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
+         message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 48]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 57]
 
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+   Examples:
+
+
+
+
+6.4.22  Muting a sampler channel
+
+   The front-end can mute/unmute a specific sampler channel by sending
+   the following command:
+
+      SET CHANNEL MUTE <sampler-channel> <mute>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command and <mute> should be replaced either by "1"
+   to mute the channel or "0" to unmute the channel.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if the channel was muted/unmuted, but there are noteworthy
+         issue(s) related, providing an appropriate warning code and
+         warning message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Examples:
+
+
+
+
+6.4.23  Soloing a sampler channel
+
+   The front-end can solo/unsolo a specific sampler channel by sending
+   the following command:
+
+      SET CHANNEL SOLO <sampler-channel> <solo>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 58]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+   (Section 6.4.4) command and <solo> should be replaced either by "1"
+   to solo the channel or "0" to unsolo the channel.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if the channel was soloed/unsoloed, but there are noteworthy
+         issue(s) related, providing an appropriate warning code and
+         warning message
 
-         message
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2698,7 +3273,8 @@
 
 
 
-6.4.22  Resetting a sampler channel
+
+6.4.24  Resetting a sampler channel
 
    The front-end can reset a particular sampler channel by sending the
    following command:
@@ -2713,12 +3289,24 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if channel was reset, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 59]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2726,6 +3314,7 @@
 
 
 
+
 6.5  Controlling connection
 
    The following commands are used to control the connection to
@@ -2736,15 +3325,6 @@
    The front-end can register itself to the LinuxSampler application to
    be informed about noteworthy events by sending this command:
 
-
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 49]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       SUBSCRIBE <event-id>
 
    where <event-id> will be replaced by the respective event that client
@@ -2753,12 +3333,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if registration succeeded, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2766,6 +3351,16 @@
 
 
 
+
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 60]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
 6.5.2  Unregister front-end for not receiving event messages
 
    The front-end can unregister itself if it doesn't want to receive
@@ -2779,12 +3374,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if unregistration succeeded, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2793,14 +3393,6 @@
 
 
 
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 50]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
 6.5.3  Enable or disable echo of commands
 
    To enable or disable back sending of commands to the client the
@@ -2817,15 +3409,27 @@
 
    Possible Answers:
 
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 61]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       "OK" -
+
          usually
+
       "ERR:<error-code>:<error-message>" -
-         on syntax error, e.g.  non boolean value
+
+         on syntax error, e.g. non boolean value
 
    Examples:
 
 
 
+
 6.5.4  Close client connection
 
    The client can close its network connection to LinuxSampler by
@@ -2849,24 +3453,26 @@
 
    Possible Answers:
 
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 51]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       "OK" -
+
          always
 
    Examples:
 
 
 
+
 6.6.2  General sampler informations
 
    The client can ask for general informations about the LinuxSampler
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 62]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
    instance by sending the following command:
 
       GET SERVER INFO
@@ -2879,11 +3485,18 @@
       character string to that information category.  At the moment the
       following categories are defined:
 
+
+
          DESCRIPTION -
+
             arbitrary textual description about the sampler
+
          VERSION -
+
             version of the sampler
+
          PROTOCOL_VERSION -
+
             version of the LSCP specification the sampler complies with
             (see Section 2 for details)
 
@@ -2908,9 +3521,12 @@
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 52]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 63]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 7.  Command Syntax
@@ -2920,247 +3536,360 @@
    where applicable.
 
    input =
+
       line LF
+
       / line CR LF
 
    line =
+
       /* epsilon (empty line ignored) */
+
       / comment
+
       / command
+
       / error
 
    comment =
+
       '#'
+
       / comment '#'
+
       / comment SP
+
       / comment number
+
       / comment string
 
    command =
+
       ADD SP CHANNEL
+
       / GET SP get_instruction
+
       / CREATE SP create_instruction
+
       / DESTROY SP destroy_instruction
+
       / LIST SP list_instruction
+
       / LOAD SP load_instruction
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 64]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       / REMOVE SP CHANNEL SP sampler_channel
+
       / SET SP set_instruction
+
       / SUBSCRIBE SP subscribe_event
+
       / UNSUBSCRIBE SP unsubscribe_event
+
       / SELECT SP text
+
       / RESET SP CHANNEL SP sampler_channel
+
       / RESET
+
       / QUIT
 
    subscribe_event =
+
       CHANNEL_COUNT
+
       / VOICE_COUNT
+
       / STREAM_COUNT
+
       / BUFFER_FILL
+
       / CHANNEL_INFO
+
       / MISCELLANEOUS
 
    unsubscribe_event =
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 53]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       CHANNEL_COUNT
+
       / VOICE_COUNT
+
       / STREAM_COUNT
+
       / BUFFER_FILL
+
       / CHANNEL_INFO
+
       / MISCELLANEOUS
 
    get_instruction =
+
       AVAILABLE_ENGINES
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 65]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       / AVAILABLE_MIDI_INPUT_DRIVERS
+
       / MIDI_INPUT_DRIVER SP INFO SP string
+
       / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
+
       / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
       key_val_list
+
       / AVAILABLE_AUDIO_OUTPUT_DRIVERS
+
       / AUDIO_OUTPUT_DRIVER SP INFO SP string
+
       / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
+
       / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
       key_val_list
+
       / AUDIO_OUTPUT_DEVICES
+
       / MIDI_INPUT_DEVICES
+
       / AUDIO_OUTPUT_DEVICE SP INFO SP number
+
       / MIDI_INPUT_DEVICE SP INFO SP number
+
       / MIDI_INPUT_PORT SP INFO SP number SP number
+
       / MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
+
       / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
+
       / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
       string
+
       / CHANNELS
+
       / CHANNEL SP INFO SP sampler_channel
+
       / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
+
       / CHANNEL SP STREAM_COUNT SP sampler_channel
+
       / CHANNEL SP VOICE_COUNT SP sampler_channel
+
       / ENGINE SP INFO SP engine_name
+
+
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 66]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       / SERVER SP INFO
 
    set_instruction =
+
       AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
       param_val_list
+
       / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
       param_val_list
+
       / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
       param_val_list
+
       / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
       param_val_list
-      / CHANNEL SP set_chan_instruction
-      / ECHO SP boolean
 
+      / CHANNEL SP set_chan_instruction
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 54]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
+      / ECHO SP boolean
 
    create_instruction =
+
       AUDIO_OUTPUT_DEVICE SP string SP key_val_list
+
       / AUDIO_OUTPUT_DEVICE SP string
+
       / MIDI_INPUT_DEVICE SP string SP key_val_list
+
       / MIDI_INPUT_DEVICE SP string
 
    destroy_instruction =
+
       AUDIO_OUTPUT_DEVICE SP number
+
       / MIDI_INPUT_DEVICE SP number
 
    load_instruction =
+
       INSTRUMENT SP load_instr_args
+
       / ENGINE SP load_engine_args
 
    set_chan_instruction =
+
       AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
+
       / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
       SP audio_channel_index
+
+
+
+Schoenebeck             Expires November 2, 2005               [Page 67]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
       / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
+
       / MIDI_INPUT SP sampler_channel SP device_index SP
       midi_input_port_index SP midi_input_channel_index
+
       / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
+
       / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
+
       / MIDI_INPUT_CHANNEL SP sampler_channel SP
       midi_input_channel_index
+
       / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
+
       / VOLUME SP sampler_channel SP volume_value
 
+      / MUTE SP sampler_channel SP boolean
+
+      / SOLO SP sampler_channel SP boolean
+
    key_val_list =
+
       string '=' param_val_list
+
       / key_val_list SP string '=' param_val_list
 
    buffer_size_type =
+
       BYTES
+
       / PERCENTAGE
 
    list_instruction =
+
       AUDIO_OUTPUT_DEVICES
+
       / MIDI_INPUT_DEVICES
+
       / CHANNELS
+
       / AVAILABLE_ENGINES
+
       / AVAILABLE_MIDI_INPUT_DRIVERS
+
       / AVAILABLE_AUDIO_OUTPUT_DRIVERS
 
    load_instr_args =
-      filename SP instrument_index SP sampler_channel
-      / NON_MODAL SP filename SP instrument_index SP sampler_channel
 
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 55]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 68]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
 
+      filename SP instrument_index SP sampler_channel
+
+      / NON_MODAL SP filename SP instrument_index SP sampler_channel
 
    load_engine_args =
+
       engine_name SP sampler_channel
 
    device_index =
+
       number
 
    audio_channel_index =
+
       number
 
    audio_output_type_name =
+
       string
 
    midi_input_port_index =
+
       number
 
    midi_input_channel_index =
+
       number
+
       / ALL
 
    midi_input_type_name =
+
       string
 
    volume_value =
+
       dotnum
+
       / number
 
    sampler_channel =
-      number
 
-   instrument_index =
       number
 
-   engine_name =
-      string
-
-   filename =
-      stringval
-
-   param_val_list =
-      param_val
-      / param_val_list','param_val
-
-   param_val =
-      string
-      / '\'' string '\''
-      / '\"' string '\"'
-      / number
-
-
-
-
-Schoenebeck            Expires November 22, 2005               [Page 56]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-      / dotnum
-
-
-
+   instrument_index =
 
+      number
 
 
 
 
+Schoenebeck             Expires November 2, 2005               [Page 69]
 
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
+   engine_name =
 
+      string
 
+   filename =
 
+      stringval
 
+   param_val_list =
 
+      param_val
 
+      / param_val_list','param_val
 
+   param_val =
 
+      string
 
+      / '\'' string '\''
 
+      / '\"' string '\"'
 
+      / number
 
+      / dotnum
 
 
 
@@ -3187,10 +3916,9 @@
 
 
 
+Schoenebeck             Expires November 2, 2005               [Page 70]
 
-Schoenebeck            Expires November 22, 2005               [Page 57]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 8.  Events
@@ -3214,8 +3942,8 @@
 
 8.2  Number of active voices changed
 
-   Client may want to be notified when the number of voices on the
-   back-end changes by issuing the following command:
+   Client may want to be notified when the number of voices on the back-
+   end changes by issuing the following command:
 
       SUBSCRIBE VOICE_COUNT
 
@@ -3244,9 +3972,9 @@
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 58]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 71]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
    active disk streams on that channel.
@@ -3264,9 +3992,9 @@
 
    where <sampler-channel> will be replaced by the sampler channel the
    buffer fill state change occurred on and <fill-data> will be replaced
-   by the buffer fill data for this channel as described in Section
-   6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" (Section
-   6.4.13) command was issued on this channel.
+   by the buffer fill data for this channel as described in
+   Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
+   (Section 6.4.13) command was issued on this channel.
 
 8.5  Channel information changed
 
@@ -3295,15 +4023,17 @@
 
    Server will start sending the following notification messages:
 
-      "NOTIFY:MISCELLANEOUS:<string>"
 
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 59]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
+Schoenebeck             Expires November 2, 2005               [Page 72]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
+
+
+      "NOTIFY:MISCELLANEOUS:<string>"
 
    where <string> will be replaced by whatever data server wants to send
    to the client.  Client MAY display this data to the user AS IS to
@@ -3354,11 +4084,9 @@
 
 
 
+Schoenebeck             Expires November 2, 2005               [Page 73]
 
-
-Schoenebeck            Expires November 22, 2005               [Page 60]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 9.  Security Considerations
@@ -3412,9 +4140,9 @@
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 61]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 74]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 10.  Acknowledgments
@@ -3424,11 +4152,15 @@
    list:
 
       Rui Nuno Capela
+
       Vladimir Senkov
+
       Mark Knecht
+
       Grigor Iliev
 
-11  References
+
+11.  References
 
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
               Requirement Levels", RFC 2119, 1997.
@@ -3448,8 +4180,7 @@
    74081 Heilbronn
    Germany
 
-   EMail: schoenebeck at software minus engineering dot org
-
+   Email: schoenebeck at software minus engineering dot org
 
 
 
@@ -3465,12 +4196,9 @@
 
 
 
+Schoenebeck             Expires November 2, 2005               [Page 75]
 
-
-
-Schoenebeck            Expires November 22, 2005               [Page 62]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
 Intellectual Property Statement
@@ -3482,7 +4210,7 @@
    might or might not be available; neither does it represent that it
    has made any effort to identify any such rights.  Information on the
    IETF's procedures with respect to rights in standards-track and
-   standards-related documentation can be found in BCP-11.  Copies of
+   standards-related documentation can be found in BCP 11.  Copies of
    claims of rights made available for publication and any assurances of
    licenses to be made available, or the result of an attempt made to
    obtain a general license or permission for the use of such
@@ -3524,9 +4252,9 @@
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 63]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Schoenebeck             Expires November 2, 2005               [Page 76]
+
+Internet-Draft        LinuxSampler Control Protocol             May 2005
 
 
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
@@ -3580,5 +4308,5 @@
 
 
 
-Schoenebeck            Expires November 22, 2005               [Page 64]
-
+Schoenebeck             Expires November 2, 2005               [Page 77]
+