--- web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt	2005/07/21 09:36:52	709
+++ web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt	2006/11/26 16:39:49	945
@@ -3,12 +3,12 @@
 
 LinuxSampler Developers                                   C. Schoenebeck
 Internet-Draft                           Interessengemeinschaft Software
-Expires: January 22, 2006                              Engineering e. V.
-                                                           July 21, 2005
+Expires: May 30, 2007                                  Engineering e. V.
+                                                       November 26, 2006
 
 
                      LinuxSampler Control Protocol
-                                LSCP 1.1
+                                LSCP 1.2
 
 Status of this Memo
 
@@ -31,11 +31,11 @@
    The list of Internet-Draft Shadow Directories can be accessed at
    http://www.ietf.org/shadow.html.
 
-   This Internet-Draft will expire on January 22, 2006.
+   This Internet-Draft will expire on May 30, 2007.
 
 Copyright Notice
 
-   Copyright (C) The Internet Society (2005).  All Rights Reserved.
+   Copyright (C) The Internet Society (2006).  All Rights Reserved.
 
 Abstract
 
@@ -52,121 +52,177 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 1]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                  [Page 1]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 Table of Contents
 
-   1.   Requirements notation  . . . . . . . . . . . . . . . . . . .   4
-   2.   Versioning of this specification . . . . . . . . . . . . . .   5
-   3.   Introduction . . . . . . . . . . . . . . . . . . . . . . . .   6
-   4.   Focus of this protocol . . . . . . . . . . . . . . . . . . .   7
-   5.   Communication Overview . . . . . . . . . . . . . . . . . . .   8
-     5.1  Request/response communication method  . . . . . . . . . .   8
-       5.1.1  Result format  . . . . . . . . . . . . . . . . . . . .   9
-     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
-       6.2.1  Getting amount of available audio output drivers . . .  13
-       6.2.2  Getting all available audio output drivers . . . . . .  14
-       6.2.3  Getting information about a specific audio output
-              driver . . . . . . . . . . . . . . . . . . . . . . . .  14
-       6.2.4  Getting information about specific audio output
-              driver parameter . . . . . . . . . . . . . . . . . . .  15
-       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  . . . . . . . . . . . . . . . . . . . . .  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 . . . . . . . . . . . . . . . . . . . . . . . .  30
-       6.3.4  Getting information about specific MIDI input
-              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  . . . . . . . . . . . . . . . . . . . . .  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 January 22, 2006                [Page 2]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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 . . . . . . . . . . . . . . . . . . . . . . .  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
+   1.  Requirements notation  . . . . . . . . . . . . . . . . . . . .  5
+   2.  Versioning of this specification . . . . . . . . . . . . . . .  6
+   3.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  7
+   4.  Focus of this protocol . . . . . . . . . . . . . . . . . . . .  8
+   5.  Communication Overview . . . . . . . . . . . . . . . . . . . .  9
+     5.1.  Request/response communication method  . . . . . . . . . .  9
+       5.1.1.  Result format  . . . . . . . . . . . . . . . . . . . . 10
+     5.2.  Subscribe/notify communication method  . . . . . . . . . . 12
+   6.  Description for control commands . . . . . . . . . . . . . . . 14
+     6.1.  Ignored lines and comments . . . . . . . . . . . . . . . . 14
+     6.2.  Configuring audio drivers  . . . . . . . . . . . . . . . . 14
+       6.2.1.  Getting amount of available audio output drivers . . . 14
+       6.2.2.  Getting all available audio output drivers . . . . . . 15
+       6.2.3.  Getting information about a specific audio output
+               driver . . . . . . . . . . . . . . . . . . . . . . . . 15
+       6.2.4.  Getting information about specific audio output
+               driver parameter . . . . . . . . . . . . . . . . . . . 16
+       6.2.5.  Creating an audio output device  . . . . . . . . . . . 20
+       6.2.6.  Destroying an audio output device  . . . . . . . . . . 21
+       6.2.7.  Getting all created audio output device count  . . . . 22
+       6.2.8.  Getting all created audio output device list . . . . . 22
+       6.2.9.  Getting current settings of an audio output device . . 22
+       6.2.10. Changing settings of audio output devices  . . . . . . 24
+       6.2.11. Getting information about an audio channel . . . . . . 24
+       6.2.12. Getting information about specific audio channel
+               parameter  . . . . . . . . . . . . . . . . . . . . . . 26
+       6.2.13. Changing settings of audio output channels . . . . . . 28
+     6.3.  Configuring MIDI input drivers . . . . . . . . . . . . . . 29
+       6.3.1.  Getting amount of available MIDI input drivers . . . . 30
+       6.3.2.  Getting all available MIDI input drivers . . . . . . . 30
+       6.3.3.  Getting information about a specific MIDI input
+               driver . . . . . . . . . . . . . . . . . . . . . . . . 30
+       6.3.4.  Getting information about specific MIDI input
+               driver parameter . . . . . . . . . . . . . . . . . . . 31
+       6.3.5.  Creating a MIDI input device . . . . . . . . . . . . . 34
+       6.3.6.  Destroying a MIDI input device . . . . . . . . . . . . 35
+       6.3.7.  Getting all created MIDI input device count  . . . . . 36
+       6.3.8.  Getting all created MIDI input device list . . . . . . 36
+       6.3.9.  Getting current settings of a MIDI input device  . . . 36
+       6.3.10. Changing settings of MIDI input devices  . . . . . . . 38
+       6.3.11. Getting information about a MIDI port  . . . . . . . . 38
+       6.3.12. Getting information about specific MIDI port
+               parameter  . . . . . . . . . . . . . . . . . . . . . . 39
+       6.3.13. Changing settings of MIDI input ports  . . . . . . . . 41
+     6.4.  Configuring sampler channels . . . . . . . . . . . . . . . 42
+       6.4.1.  Loading an instrument  . . . . . . . . . . . . . . . . 42
+
+
+
+Schoenebeck               Expires May 30, 2007                  [Page 2]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+       6.4.2.  Loading a sampler engine . . . . . . . . . . . . . . . 43
+       6.4.3.  Getting all created sampler channel count  . . . . . . 44
+       6.4.4.  Getting all created sampler channel list . . . . . . . 44
+       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  . . . . . . . . . 46
+       6.4.8.  Getting all available engines  . . . . . . . . . . . . 46
+       6.4.9.  Getting information about an engine  . . . . . . . . . 47
+       6.4.10. Getting sampler channel information  . . . . . . . . . 48
+       6.4.11. Current number of active voices  . . . . . . . . . . . 51
+       6.4.12. Current number of active disk streams  . . . . . . . . 51
+       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 . . . . . . . . . . . . . 54
+       6.4.17. Setting MIDI input device  . . . . . . . . . . . . . . 55
+       6.4.18. Setting MIDI input type  . . . . . . . . . . . . . . . 55
+       6.4.19. Setting MIDI input port  . . . . . . . . . . . . . . . 56
+       6.4.20. Setting MIDI input channel . . . . . . . . . . . . . . 57
+       6.4.21. Setting channel volume . . . . . . . . . . . . . . . . 57
+       6.4.22. Muting a sampler channel . . . . . . . . . . . . . . . 58
+       6.4.23. Soloing a sampler channel  . . . . . . . . . . . . . . 59
+       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 . . . . . . . . . . . . . . . . . . . . . . . 61
+       6.5.3.  Enable or disable echo of commands . . . . . . . . . . 62
+       6.5.4.  Close client connection  . . . . . . . . . . . . . . . 62
+     6.6.  Global commands  . . . . . . . . . . . . . . . . . . . . . 62
+       6.6.1.  Current number of active voices  . . . . . . . . . . . 62
+       6.6.2.  Maximum amount of active voices  . . . . . . . . . . . 63
+       6.6.3.  Reset sampler  . . . . . . . . . . . . . . . . . . . . 63
+       6.6.4.  General sampler informations . . . . . . . . . . . . . 63
+     6.7.  MIDI Instrument Mapping  . . . . . . . . . . . . . . . . . 64
+       6.7.1.  Create or replace a MIDI instrument map entry  . . . . 64
+       6.7.2.  Getting ammount of MIDI instrument map entries . . . . 67
+       6.7.3.  Getting indeces of all MIDI instrument map entries . . 67
+       6.7.4.  Remove an entry from the MIDI instrument map . . . . . 68
+       6.7.5.  Get current settings of MIDI instrument map entry  . . 69
+       6.7.6.  Clear MIDI instrument map  . . . . . . . . . . . . . . 70
+   7.  Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . 72
+   8.  Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
+     8.1.  Number of sampler channels changed . . . . . . . . . . . . 81
+     8.2.  Number of active voices changed  . . . . . . . . . . . . . 81
+     8.3.  Number of active disk streams changed  . . . . . . . . . . 81
+     8.4.  Disk stream buffer fill state changed  . . . . . . . . . . 82
+     8.5.  Channel information changed  . . . . . . . . . . . . . . . 82
+
+
+
+Schoenebeck               Expires May 30, 2007                  [Page 3]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+     8.6.  Total number of active voices changed  . . . . . . . . . . 82
+     8.7.  Miscellaneous and debugging events . . . . . . . . . . . . 83
+   9.  Security Considerations  . . . . . . . . . . . . . . . . . . . 84
+   10. Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . . 85
+   11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 85
+   Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 86
+   Intellectual Property and Copyright Statements . . . . . . . . . . 87
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 3]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                  [Page 4]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 1.  Requirements notation
@@ -220,9 +276,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 4]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                  [Page 5]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 2.  Versioning of this specification
@@ -251,7 +307,7 @@
        sampler's LSCP minor version.
 
    Compatibility can only be claimed if both rules are true.  The
-   frontend can use the "GET SERVER INFO" (Section 6.6.2) command to get
+   frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get
    the version of the LSCP specification the sampler complies with.
 
 
@@ -276,9 +332,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 5]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                  [Page 6]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 3.  Introduction
@@ -332,9 +388,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 6]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                  [Page 7]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 4.  Focus of this protocol
@@ -388,9 +444,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 7]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                  [Page 8]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 5.  Communication Overview
@@ -405,7 +461,7 @@
    more effort to be implemented in the front-end application.  The two
    communication methods will be described next.
 
-5.1  Request/response communication method
+5.1.  Request/response communication method
 
    This simple communication method is based on TCP [RFC793].  The
    front-end application establishes a TCP connection to the
@@ -444,12 +500,12 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 8]
+Schoenebeck               Expires May 30, 2007                  [Page 9]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
 
-
-5.1.1  Result format
+5.1.1.  Result format
 
    Result set could be one of the following types:
 
@@ -500,9 +556,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006                [Page 9]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 10]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
    set has the following format:
@@ -556,9 +612,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 10]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 11]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
    Each line of the result set MUST end with <CRLF>.
@@ -573,8 +629,7 @@
 
       S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
 
-
-5.2  Subscribe/notify communication method
+5.2.  Subscribe/notify communication method
 
    This more sophisticated communication method is actually only an
    extension of the simple request/response communication method.  The
@@ -609,15 +664,15 @@
 
    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
+       middle.  Same is true about the response.  It should never be
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 11]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 12]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
-       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.
 
@@ -668,9 +723,10 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 12]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 13]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 6.  Description for control commands
@@ -682,14 +738,14 @@
    LinuxSampler signals the end of the response by a "." (single dot)
    line.
 
-6.1  Ignored lines and comments
+6.1.  Ignored lines and comments
 
    White lines, that is lines which only contain space and tabulator
    characters, and lines that start with a "#" character are ignored,
    thus it's possible for example to group commands and to place
    comments in a LSCP script file.
 
-6.2  Configuring audio drivers
+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
@@ -718,15 +774,15 @@
    retrieve what parameters drivers are offering, how to retrieve their
    possible values, etc.
 
-6.2.1  Getting amount of available audio output drivers
+6.2.1.  Getting amount of available audio output drivers
 
    Use the following command to get the number of audio output drivers
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 13]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 14]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
    currently available for the LinuxSampler instance:
@@ -744,8 +800,7 @@
 
       S: "2"
 
-
-6.2.2  Getting all available audio output drivers
+6.2.2.  Getting all available audio output drivers
 
    Use the following command to list all audio output drivers currently
    available for the LinuxSampler instance:
@@ -763,8 +818,7 @@
 
       S: "ALSA,JACK"
 
-
-6.2.3  Getting information about a specific audio output driver
+6.2.3.  Getting information about a specific audio output driver
 
    Use the following command to get detailed information about a
    specific audio output driver:
@@ -780,9 +834,11 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 14]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+
+Schoenebeck               Expires May 30, 2007                 [Page 15]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
       LinuxSampler will answer by sending a <CRLF> separated list.  Each
@@ -823,8 +879,7 @@
 
          "."
 
-
-6.2.4  Getting information about specific audio output driver parameter
+6.2.4.  Getting information about specific audio output driver parameter
 
    Use the following command to get detailed information about a
    specific audio output driver parameter:
@@ -833,15 +888,15 @@
 
    Where <audio> is the name of the audio output driver as returned by
    the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
+   <prm> a specific parameter name for which information should be
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 15]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 16]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
-   <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>
@@ -892,9 +947,10 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 16]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 17]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
       MULTIPLICITY -
@@ -948,9 +1004,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 17]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 18]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
          returned, dependent to driver parameter)
@@ -1004,9 +1060,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 18]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 19]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
          "TYPE: INT"
@@ -1027,11 +1083,10 @@
 
          "."
 
+6.2.5.  Creating an audio output device
 
-6.2.5  Creating an audio output device
-
-   Use the following command to create a new audio output device for
-   the desired audio output system:
+   Use the following command to create a new audio output device for the
+   desired audio output system:
 
       CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]
 
@@ -1057,15 +1112,15 @@
          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
+         hardware parameters and the driver is using fall-back values),
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 19]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 20]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
-         hardware parameters and the driver is using fall-back values),
          providing an appropriate warning code and warning message
 
       "ERR:<error-code>:<error-message>" -
@@ -1083,8 +1138,7 @@
 
       S: "OK[1]"
 
-
-6.2.6  Destroying an audio output device
+6.2.6.  Destroying an audio output device
 
    Use the following command to destroy a created output device:
 
@@ -1114,21 +1168,20 @@
          in case it failed, providing an appropriate error code and
          error message
 
+   Example:
 
 
-Schoenebeck             Expires January 22, 2006               [Page 20]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
 
+Schoenebeck               Expires May 30, 2007                 [Page 21]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-   Example:
 
       C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
 
       S: "OK"
 
-
-6.2.7  Getting all created audio output device count
+6.2.7.  Getting all created audio output device count
 
    Use the following command to count all created audio output devices:
 
@@ -1145,8 +1198,7 @@
 
       S: "4"
 
-
-6.2.8  Getting all created audio output device list
+6.2.8.  Getting all created audio output device list
 
    Use the following command to list all created audio output devices:
 
@@ -1163,26 +1215,24 @@
 
       S: "0,1,4,5"
 
-
-6.2.9  Getting current settings of an audio output device
+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 January 22, 2006               [Page 21]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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"
    (Section 6.2.8) command.
 
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 22]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    Possible Answers:
 
    LinuxSampler will answer by sending a <CRLF> separated list.  Each
@@ -1225,19 +1275,19 @@
 
       S: "DRIVER: ALSA"
 
+         "CHANNELS: 2"
 
+         "SAMPLERATE: 44100"
 
+         "ACTIVE: true"
 
-Schoenebeck             Expires January 22, 2006               [Page 22]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
 
 
-         "CHANNELS: 2"
 
-         "SAMPLERATE: 44100"
+Schoenebeck               Expires May 30, 2007                 [Page 23]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-         "ACTIVE: true"
 
          "FRAGMENTS: 2"
 
@@ -1247,8 +1297,7 @@
 
          "."
 
-
-6.2.10  Changing settings of audio output devices
+6.2.10.  Changing settings of audio output devices
 
    Use the following command to alter a specific setting of a created
    audio output device:
@@ -1280,23 +1329,21 @@
 
    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:
 
-Schoenebeck             Expires January 22, 2006               [Page 23]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
-      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
 
-      S: "OK"
 
 
-6.2.11  Getting information about an audio channel
+Schoenebeck               Expires May 30, 2007                 [Page 24]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-   Use the following command to get information about an audio channel:
 
       GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
 
@@ -1337,14 +1384,6 @@
             actually will be routed / added to (only returned in case
             the audio channel is mix channel)
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 24]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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
@@ -1353,6 +1392,15 @@
 
    Examples:
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 25]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
 
       S: "NAME: studio monitor left"
@@ -1389,18 +1437,9 @@
 
          "."
 
-
-6.2.12  Getting information about specific audio channel parameter
+6.2.12.  Getting information about specific audio channel parameter
 
    Use the following command to get detailed information about specific
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 25]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    audio channel parameter:
 
       GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
@@ -1410,6 +1449,14 @@
    AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
    channel number and <param> a specific channel parameter name for
    which information should be obtained (as returned by the "GET
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 26]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
 
    Possible Answers:
@@ -1448,22 +1495,23 @@
             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, usually used in conjunction with 'RANGE_MAX', but
+            may also appear without (optionally returned, dependent to
+            driver and channel parameter)
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 26]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
 
 
-         RANGE_MIN -
+Schoenebeck               Expires May 30, 2007                 [Page 27]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-            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 -
 
@@ -1498,21 +1546,11 @@
 
          "."
 
-
-6.2.13  Changing settings of audio output channels
+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 January 22, 2006               [Page 27]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
 
    Where <dev-id> should be replaced by the numerical ID of the audio
@@ -1523,6 +1561,14 @@
 
    Possible Answers:
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 28]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       "OK" -
 
          in case setting was successfully changed
@@ -1548,8 +1594,7 @@
 
       S: "OK"
 
-
-6.3  Configuring MIDI input drivers
+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
@@ -1561,14 +1606,6 @@
 
    Instead of defining commands and parameters for each driver
    individually, all possible parameters, their meanings and possible
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 28]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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
@@ -1580,6 +1617,14 @@
    as the commands for configuring audio output drivers, already
    described in the last chapter.
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 29]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    Note: examples in this chapter showing particular parameters of
    drivers are not meant as specification of the drivers' parameters.
    Driver implementations in LinuxSampler might have complete different
@@ -1588,7 +1633,7 @@
    retrieve what parameters drivers are offering, how to retrieve their
    possible values, etc.
 
-6.3.1  Getting amount of available MIDI input drivers
+6.3.1.  Getting amount of available MIDI input drivers
 
    Use the following command to get the number of MIDI input drivers
    currently available for the LinuxSampler instance:
@@ -1606,8 +1651,7 @@
 
       S: "2"
 
-
-6.3.2  Getting all available MIDI input drivers
+6.3.2.  Getting all available MIDI input drivers
 
    Use the following command to list all MIDI input drivers currently
    available for the LinuxSampler instance:
@@ -1616,15 +1660,6 @@
 
    Possible Answers:
 
-
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 29]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       LinuxSampler will answer by sending comma separated character
       strings, each symbolizing a MIDI input driver.
 
@@ -1634,12 +1669,18 @@
 
       S: "ALSA,JACK"
 
-
-6.3.3  Getting information about a specific MIDI input driver
+6.3.3.  Getting information about a specific MIDI input driver
 
    Use the following command to get detailed information about a
    specific MIDI input driver:
 
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 30]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
 
    Where <midi-input-driver> is the name of the MIDI input driver as
@@ -1673,14 +1714,6 @@
 
    Example:
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 30]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       C: "GET MIDI_INPUT_DRIVER INFO ALSA"
 
       S: "DESCRIPTION: Advanced Linux Sound Architecture"
@@ -1691,12 +1724,19 @@
 
          "."
 
-
-6.3.4  Getting information about specific MIDI input driver parameter
+6.3.4.  Getting information about specific MIDI input driver parameter
 
    Use the following command to get detailed information about a
    specific parameter of a specific MIDI input driver:
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 31]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
 
    Where <midit> is the name of the MIDI input driver as returned by the
@@ -1729,14 +1769,6 @@
          character string(s) (always returned, no matter which driver
          parameter)
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 31]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       DESCRIPTION -
 
          arbitrary text describing the purpose of the parameter (always
@@ -1753,6 +1785,14 @@
 
          either true or false, if false then this parameter can be
          changed at any time, once the device is created by the 'CREATE
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 32]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
          MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
          matter which driver parameter)
 
@@ -1784,15 +1824,6 @@
          character strings are encapsulated into apostrophes (')
          (optionally returned, dependent to driver parameter)
 
-
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 32]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       RANGE_MIN -
 
          defines lower limit of the allowed value range for this
@@ -1809,6 +1840,15 @@
          may also appear without (optionally returned, dependent to
          driver parameter)
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 33]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       POSSIBILITIES -
 
          comma separated list of possible values for this parameter,
@@ -1835,20 +1875,11 @@
 
          "."
 
+6.3.5.  Creating a MIDI input device
 
-6.3.5  Creating a MIDI input device
-
-   Use the following command to create a new MIDI input device for  the
+   Use the following command to create a new MIDI input device for the
    desired MIDI input system:
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 33]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
 
    Where <midi-input-driver> should be replaced by the desired MIDI
@@ -1867,6 +1898,13 @@
          in case the device was successfully created, where <device-id>
          is the numerical ID of the new device
 
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 34]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       "WRN[<device-id>]:<warning-code>:<warning-message>" -
 
          in case the driver was loaded successfully, where <device-id>
@@ -1885,8 +1923,7 @@
 
       S: "OK[0]"
 
-
-6.3.6  Destroying a MIDI input device
+6.3.6.  Destroying a MIDI input device
 
    Use the following command to destroy a created MIDI input device:
 
@@ -1898,13 +1935,6 @@
 
    Possible Answers:
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 34]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       "OK" -
 
          in case the device was successfully destroyed
@@ -1922,12 +1952,20 @@
 
    Example:
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 35]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       C: "DESTROY MIDI_INPUT_DEVICE 0"
 
       S: "OK"
 
-
-6.3.7  Getting all created MIDI input device count
+6.3.7.  Getting all created MIDI input device count
 
    Use the following command to count all created MIDI input devices:
 
@@ -1944,8 +1982,7 @@
 
       S: "3"
 
-
-6.3.8  Getting all created MIDI input device list
+6.3.8.  Getting all created MIDI input device list
 
    Use the following command to list all created MIDI input devices:
 
@@ -1953,14 +1990,6 @@
 
    Possible Answers:
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 35]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       LinuxSampler will answer by sending a comma separated list with
       the numerical Ids of all created MIDI input devices.
 
@@ -1974,12 +2003,20 @@
 
       S: "1,3"
 
-
-6.3.9  Getting current settings of a MIDI input device
+6.3.9.  Getting current settings of a MIDI input device
 
    Use the following command to get current settings of a specific,
    created MIDI input device:
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 36]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       GET MIDI_INPUT_DEVICE INFO <device-id>
 
    Where <device-id> is the numerical ID of the MIDI input device as
@@ -2010,13 +2047,6 @@
             inactive and doesn't listen to any incoming MIDI events and
             thus doesn't forward them to connected sampler channels
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 36]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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,
@@ -2035,7 +2065,15 @@
          "."
 
 
-6.3.10  Changing settings of MIDI input devices
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 37]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+6.3.10.  Changing settings of MIDI input devices
 
    Use the following command to alter a specific setting of a created
    MIDI input device:
@@ -2065,22 +2103,13 @@
          in case it failed, providing an appropriate error code and
          error message
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 37]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    Example:
 
       C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
 
       S: "OK"
 
-
-6.3.11  Getting information about a MIDI port
+6.3.11.  Getting information about a MIDI port
 
    Use the following command to get information about a MIDI port:
 
@@ -2093,6 +2122,13 @@
 
    Possible Answers:
 
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 38]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       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
@@ -2117,18 +2153,9 @@
 
          "."
 
-
-6.3.12  Getting information about specific MIDI port parameter
+6.3.12.  Getting information about specific MIDI port parameter
 
    Use the following command to get detailed information about specific
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 38]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    MIDI port parameter:
 
       GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
@@ -2151,6 +2178,13 @@
       dependently to the given MIDI port.  At the moment the following
       information categories are defined:
 
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 39]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       TYPE -
 
          either "BOOL" for boolean value(s) or "INT" for integer
@@ -2177,14 +2211,6 @@
 
          defines lower limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 39]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
          this parameter is usually used in conjunction with 'RANGE_MAX'
          but may also appear without (optionally returned, dependent to
          driver and port parameter)
@@ -2207,6 +2233,14 @@
 
    Example:
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 40]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
 
       S: "DESCRIPTION: bindings to other ALSA sequencer clients"
@@ -2221,8 +2255,7 @@
 
          "."
 
-
-6.3.13  Changing settings of MIDI input ports
+6.3.13.  Changing settings of MIDI input ports
 
    Use the following command to alter a specific setting of a MIDI input
    port:
@@ -2233,14 +2266,6 @@
    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 January 22, 2006               [Page 40]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    <value> by the new value for this parameter.
 
    Possible Answers:
@@ -2265,13 +2290,22 @@
 
 
 
-6.4  Configuring sampler channels
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 41]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+
+
+6.4.  Configuring sampler channels
 
    The following commands describe how to add and remove sampler
    channels, associate a sampler channel with a sampler engine, load
    instruments and connect sampler channels to MIDI and audio devices.
 
-6.4.1  Loading an instrument
+6.4.1.  Loading an instrument
 
    An instrument file can be loaded and assigned to a sampler channel by
    one of the following commands:
@@ -2289,14 +2323,6 @@
    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
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 41]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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
@@ -2318,6 +2344,15 @@
          file), providing an appropriate warning code and warning
          message
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 42]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       "ERR:<error-code>:<error-message>" -
 
          in case it failed, providing an appropriate error code and
@@ -2327,8 +2362,7 @@
 
 
 
-
-6.4.2  Loading a sampler engine
+6.4.2.  Loading a sampler engine
 
    A sampler engine type can be associated to a specific sampler channel
    by the following command:
@@ -2345,14 +2379,6 @@
    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 January 22, 2006               [Page 42]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    engine type, shared with other sampler channels, should be used.
 
    Possible Answers:
@@ -2377,7 +2403,15 @@
 
 
 
-6.4.3  Getting all created sampler channel count
+
+Schoenebeck               Expires May 30, 2007                 [Page 43]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+
+
+6.4.3.  Getting all created sampler channel count
 
    The number of sampler channels can change on runtime.  To get the
    current amount of sampler channels, the front-end can send the
@@ -2396,19 +2430,10 @@
 
       S: "12"
 
-
-6.4.4  Getting all created sampler channel list
+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
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 43]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    following command:
 
       LIST CHANNELS
@@ -2424,8 +2449,7 @@
 
       S: "0,1,2,3,4,5,6,9,10,11,15,20"
 
-
-6.4.5  Adding a new sampler channel
+6.4.5.  Adding a new sampler channel
 
    A new sampler channel can be added to the end of the sampler channel
    list by sending the following command:
@@ -2433,6 +2457,14 @@
       ADD CHANNEL
 
    This will increment the sampler channel count by one and the new
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 44]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    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
@@ -2457,14 +2489,6 @@
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 44]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       "ERR:<error-code>:<error-message>" -
 
          in case it failed, providing an appropriate error code and
@@ -2474,8 +2498,7 @@
 
 
 
-
-6.4.6  Removing a sampler channel
+6.4.6.  Removing a sampler channel
 
    A sampler channel can be removed by sending the following command:
 
@@ -2488,6 +2511,16 @@
 
    Possible Answers:
 
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 45]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       "OK" -
 
          in case the given sampler channel could be removed
@@ -2507,20 +2540,11 @@
 
 
 
-
-6.4.7  Getting amount of available engines
+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 January 22, 2006               [Page 45]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       GET AVAILABLE_ENGINES
 
    Possible Answers:
@@ -2534,8 +2558,7 @@
 
       S: "4"
 
-
-6.4.8  Getting all available engines
+6.4.8.  Getting all available engines
 
    The front-end can ask for a list of all available engines by sending
    the following command:
@@ -2544,6 +2567,16 @@
 
    Possible Answers:
 
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 46]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       LinuxSampler will answer by sending a comma separated list of the
       engines' names encapsulated into apostrophes (').  Engine names
       can consist of lower and upper cases, digits and underlines ("_"
@@ -2555,8 +2588,7 @@
 
       S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
 
-
-6.4.9  Getting information about an engine
+6.4.9.  Getting information about an engine
 
    The front-end can ask for information about a specific engine by
    sending the following command:
@@ -2568,15 +2600,6 @@
 
    Possible Answers:
 
-
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 46]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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
@@ -2601,12 +2624,20 @@
 
       S: "DESCRIPTION: this is Joe's custom sampler engine"
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 47]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
          "VERSION: testing-1.0"
 
          "."
 
-
-6.4.10  Getting sampler channel information
+6.4.10.  Getting sampler channel information
 
    The front-end can ask for the current settings of a sampler channel
    by sending the following command:
@@ -2627,14 +2658,6 @@
 
 
 
-
-Schoenebeck             Expires January 22, 2006               [Page 47]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
-
-
          ENGINE_NAME -
 
             name of the engine that is associated with the sampler
@@ -2658,6 +2681,14 @@
             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
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 48]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
             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
@@ -2682,13 +2713,6 @@
             loading exception.  Value of 100 indicates that the
             instrument is fully loaded.
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 48]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
          MIDI_INPUT_DEVICE -
 
             numerical ID of the MIDI input device which is currently
@@ -2711,6 +2735,16 @@
             (where a value < 1.0 means attenuation and a value > 1.0
             means amplification)
 
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 49]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
          MUTE -
 
             Determines whether the channel is muted, "true" if the
@@ -2736,15 +2770,6 @@
 
          "AUDIO_OUTPUT_DEVICE: 0"
 
-
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 49]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
          "AUDIO_OUTPUT_CHANNELS: 2"
 
          "AUDIO_OUTPUT_ROUTING: 0,1"
@@ -2766,7 +2791,17 @@
          "."
 
 
-6.4.11  Current number of active voices
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 50]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+6.4.11.  Current number of active voices
 
    The front-end can ask for the current number of active voices on a
    sampler channel by sending the following command:
@@ -2786,21 +2821,11 @@
 
 
 
-
-6.4.12  Current number of active disk streams
+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 January 22, 2006               [Page 50]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       GET CHANNEL STREAM_COUNT <sampler-channel>
 
    Where <sampler-channel> is the sampler channel number the front-end
@@ -2818,12 +2843,20 @@
 
 
 
-
-6.4.13  Current fill state of disk stream buffers
+6.4.13.  Current fill state of disk stream buffers
 
    The front-end can ask for the current fill state of all disk streams
    on a sampler channel by sending the following command:
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 51]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       GET CHANNEL BUFFER_FILL BYTES <sampler-channel>
 
    to get the fill state in bytes or
@@ -2850,13 +2883,6 @@
 
    Examples:
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 51]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       C: "GET CHANNEL BUFFER_FILL BYTES 4"
 
       S: "[115]420500,[116]510300,[75]110000,[120]230700"
@@ -2869,8 +2895,7 @@
 
       S: ""
 
-
-6.4.14  Setting audio output device
+6.4.14.  Setting audio output device
 
    The front-end can set the audio output device on a specific sampler
    channel by sending the following command:
@@ -2880,6 +2905,14 @@
 
    Where <sampler-channel> is the respective sampler channel number as
    returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 52]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    (Section 6.4.4) command and <audio-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 AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
@@ -2906,17 +2939,7 @@
 
 
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 52]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
-
-
-
-6.4.15  Setting audio output type
+6.4.15.  Setting audio output type
 
    DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
 
@@ -2937,6 +2960,15 @@
 
       "WRN:<warning-code>:<warning-message>" -
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 53]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
          if audio output type was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
@@ -2950,8 +2982,7 @@
 
 
 
-
-6.4.16  Setting audio output channel
+6.4.16.  Setting audio output channel
 
    The front-end can alter the audio output channel on a specific
    sampler channel by sending the following command:
@@ -2961,14 +2992,6 @@
 
    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)
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 53]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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
@@ -2996,7 +3019,15 @@
 
 
 
-6.4.17  Setting MIDI input device
+
+Schoenebeck               Expires May 30, 2007                 [Page 54]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+
+
+6.4.17.  Setting MIDI input device
 
    The front-end can set the MIDI input device on a specific sampler
    channel by sending the following command:
@@ -3005,7 +3036,7 @@
 
    Where <sampler-channel> is the sampler channel number as returned by
    the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
-   command and <midi-device-id> is  the numerical ID of the MIDI input
+   command and <midi-device-id> is 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.
 
@@ -3015,16 +3046,6 @@
 
          on success
 
-
-
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 54]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       "WRN:<warning-code>:<warning-message>" -
 
          if MIDI input device was set, but there are noteworthy issue(s)
@@ -3040,8 +3061,7 @@
 
 
 
-
-6.4.18  Setting MIDI input type
+6.4.18.  Setting MIDI input type
 
    DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
 
@@ -3053,6 +3073,14 @@
    Where <midi-input-type> is currently only "ALSA" and <sampler-
    channel> is the respective sampler channel number.
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 55]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    Possible Answers:
 
       "OK" -
@@ -3074,17 +3102,7 @@
 
 
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 55]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
-
-
-
-6.4.19  Setting MIDI input port
+6.4.19.  Setting MIDI input port
 
    The front-end can alter the MIDI input port on a specific sampler
    channel by sending the following command:
@@ -3111,12 +3129,19 @@
          in case it failed, providing an appropriate error code and
          error message
 
-   Examples:
 
 
 
+Schoenebeck               Expires May 30, 2007                 [Page 56]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+   Examples:
+
 
-6.4.20  Setting MIDI input channel
+
+6.4.20.  Setting MIDI input channel
 
    The front-end can alter the MIDI channel a sampler channel should
    listen to by sending the following command:
@@ -3129,14 +3154,6 @@
 
    Possible Answers:
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 56]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       "OK" -
 
          on success
@@ -3156,8 +3173,7 @@
 
 
 
-
-6.4.21  Setting channel volume
+6.4.21.  Setting channel volume
 
    The front-end can alter the volume of a sampler channel by sending
    the following command:
@@ -3169,6 +3185,14 @@
    means amplification) and <sampler-channel> defines the sampler
    channel where this volume factor should be set.
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 57]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    Possible Answers:
 
       "OK" -
@@ -3186,19 +3210,11 @@
          in case it failed, providing an appropriate error code and
          error message
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 57]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    Examples:
 
 
 
-
-6.4.22  Muting a sampler channel
+6.4.22.  Muting a sampler channel
 
    The front-end can mute/unmute a specific sampler channel by sending
    the following command:
@@ -3224,6 +3240,15 @@
 
       "ERR:<error-code>:<error-message>" -
 
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 58]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -3231,8 +3256,7 @@
 
 
 
-
-6.4.23  Soloing a sampler channel
+6.4.23.  Soloing a sampler channel
 
    The front-end can solo/unsolo a specific sampler channel by sending
    the following command:
@@ -3241,14 +3265,6 @@
 
    Where <sampler-channel> is the respective sampler channel number as
    returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 58]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
    (Section 6.4.4) command and <solo> should be replaced either by "1"
    to solo the channel or "0" to unsolo the channel.
 
@@ -3273,8 +3289,7 @@
 
 
 
-
-6.4.24  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:
@@ -3282,6 +3297,14 @@
       RESET CHANNEL <sampler-channel>
 
    Where <sampler-channel> defines the sampler channel to be reset.
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 59]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
    This will cause the engine on that sampler channel, its voices and
    eventually disk streams and all control and status variables to be
    reset.
@@ -3298,13 +3321,6 @@
          related, providing an appropriate warning code and warning
          message
 
-
-
-Schoenebeck             Expires January 22, 2006               [Page 59]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       "ERR:<error-code>:<error-message>" -
 
          in case it failed, providing an appropriate error code and
@@ -3314,13 +3330,12 @@
 
 
 
-
-6.5  Controlling connection
+6.5.  Controlling connection
 
    The following commands are used to control the connection to
    LinuxSampler.
 
-6.5.1  Register front-end for receiving event messages
+6.5.1.  Register front-end for receiving event messages
 
    The front-end can register itself to the LinuxSampler application to
    be informed about noteworthy events by sending this command:
@@ -3336,6 +3351,16 @@
 
          on success
 
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 60]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       "WRN:<warning-code>:<warning-message>" -
 
          if registration succeeded, but there are noteworthy issue(s)
@@ -3351,17 +3376,7 @@
 
 
 
-
-
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 60]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
-6.5.2  Unregister front-end for not receiving event messages
+6.5.2.  Unregister front-end for not receiving event messages
 
    The front-end can unregister itself if it doesn't want to receive
    event messages anymore by sending the following command:
@@ -3393,7 +3408,16 @@
 
 
 
-6.5.3  Enable or disable echo of commands
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 61]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+6.5.3.  Enable or disable echo of commands
 
    To enable or disable back sending of commands to the client the
    following command can be used:
@@ -3409,14 +3433,6 @@
 
    Possible Answers:
 
-
-
-
-Schoenebeck             Expires January 22, 2006               [Page 61]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
-
-
       "OK" -
 
          usually
@@ -3429,8 +3445,7 @@
 
 
 
-
-6.5.4  Close client connection
+6.5.4.  Close client connection
 
    The client can close its network connection to LinuxSampler by
    sending the following command:
@@ -3440,39 +3455,63 @@
    This is probably more interesting for manual telnet connections to
    LinuxSampler than really useful for a front-end implementation.
 
-6.6  Global commands
+6.6.  Global commands
 
    The following commands have global impact on the sampler.
 
-6.6.1  Reset sampler
+6.6.1.  Current number of active voices
 
-   The front-end can reset the whole sampler by sending the following
-   command:
+   The front-end can ask for the current number of active voices on the
+   sampler by sending the following command:
 
-      RESET
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 62]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      GET TOTAL_VOICE_COUNT
 
    Possible Answers:
 
-      "OK" -
+      LinuxSampler will answer by returning the number of all active
+      voices on the sampler.
 
-         always
+6.6.2.  Maximum amount of active voices
 
-   Examples:
+   The front-end can ask for the maximum number of active voices by
+   sending the following command:
 
+      GET TOTAL_VOICE_COUNT_MAX
 
+   Possible Answers:
 
+      LinuxSampler will answer by returning the maximum number of active
+      voices.
 
-6.6.2  General sampler informations
+6.6.3.  Reset sampler
 
-   The client can ask for general informations about the LinuxSampler
+   The front-end can reset the whole sampler by sending the following
+   command:
 
+      RESET
 
+   Possible Answers:
+
+      "OK" -
+
+         always
+
+   Examples:
 
-Schoenebeck             Expires January 22, 2006               [Page 62]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
 
+6.6.4.  General sampler informations
 
+   The client can ask for general informations about the LinuxSampler
    instance by sending the following command:
 
       GET SERVER INFO
@@ -3482,6 +3521,14 @@
       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
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 63]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       character string to that information category.  At the moment the
       following categories are defined:
 
@@ -3503,30 +3550,431 @@
    The mentioned fields above don't have to be in particular order.
    Other fields might be added in future.
 
+6.7.  MIDI Instrument Mapping
+
+   The MIDI protocol provides a way to switch between instruments by
+   sending so called MIDI bank select and MIDI program change messages
+   which are essentially just numbers.  The following commands allow to
+   actually map arbitrary MIDI bank select / program change numbers with
+   real instruments.
+
+   By default, that is when the sampler is launched, this map will be
+   empty, thus the sampler will simply ignore all program change
+   messages.  The front-end has to explicitly add entries to the map so
+   the sampler knows how to react on a given program change message,
+   that is by switching to the respectively defined engine type and
+   loading the respective instrument.
+
+   Also note per MIDI specification a bank select message does not cause
+   to switch to another instrument.  Instead when receiving a bank
+   select message the bank value will be stored and a subsequent program
+   change message (which may occur at any time) will finally cause the
+   sampler to switch to the respective instrument as reflected by the
+   current MIDI instrument map.
+
+6.7.1.  Create or replace a MIDI instrument map entry
+
+   The front-end can create a new or replace an existing entry in the
+   sampler's MIDI instrument map by sending the following command:
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 64]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      MAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>
+      <engine_name> <filename> <instrument_index> <volume_value>
+      [<instr_load_mode>] [<name>]
+
+   Where <midi_bank_msb> is an integer value between 0..127 reflecting
+   the MIDI bank select MSB (coarse) index, <midi_bank_lsb> an integer
+   value between 0..127 reflecting the MIDI bank select LSB (fine)
+   index, <midi_prog> an integer value between 0..127 reflecting the
+   MIDI program change index, <engine_name> a sampler engine name as
+   returned by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
+   encapsulated into apostrophes), <filename> the name of the
+   instrument's file to be deployed (encapsulated into apostrophes),
+   <instrument_index> the index (integer value) of the instrument within
+   the given file, <volume_value> reflects the master volume of the
+   instrument as optionally dotted number (where a value < 1.0 means
+   attenuation and a value > 1.0 means amplification).  This parameter
+   easily allows to adjust the volume of all intruments within a custom
+   instrument map without having to adjust their instrument files.  The
+   OPTIONAL <instr_load_mode> argument defines the life time of the
+   instrument, that is when the instrument should be loaded, when freed
+   and has exactly the following possibilities:
+
+      "ON_DEMAND" -
+
+         The instrument will be loaded when needed, that is when
+         demanded by at least one sampler channel.  It will immediately
+         be freed from memory when not needed by any sampler channel
+         anymore.
+
+      "ON_DEMAND_HOLD" -
+
+         The instrument will be loaded when needed, that is when
+         demanded by at least one sampler channel.  It will be kept in
+         memory even when not needed by any sampler channel anymore.
+         Instruments with this mode are only freed when the sampler is
+         reset or all mapping entries with this mode (and respective
+         instrument) are explicitly changed to "ON_DEMAND" and no
+         sampler channel is using the instrument anymore.
+
+      "PERSISTENT" -
+
+         The instrument will immediately be loaded into memory in the
+         background when this mapping command is sent and the instrument
+         is kept all the time.  Instruments with this mode are only
+         freed when the sampler is reset or all mapping entries with
+         this mode (and respective instrument) are explicitly changed to
+         "ON_DEMAND" and no sampler channel is using the instrument
+         anymore.
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 65]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      not supplied -
+
+         In case there is no <instr_load_mode> argument given, it will
+         be up to the InstrumentManager to decide which mode to use.
+         Usually it will use "ON_DEMAND" if an entry for the given
+         instrument does not exist in the InstrumentManager's list yet,
+         otherwise if an entry already exists, it will simply stick with
+         the mode currently reflected by the already existing entry,
+         that is it will not change the mode.
+
+   The <instr_load_mode> argument thus allows to define an appropriate
+   strategy (low memory consumption vs. fast instrument switching) for
+   each instrument individually.  Note, the following restrictions apply
+   to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
+   supported by the respective sampler engine (which is technically the
+   case when the engine provides an InstrumentManager for its format).
+   If this is not the case the argument will automatically fall back to
+   the default value "ON_DEMAND".  Also the load mode of one instrument
+   may automatically change the laod mode of other instrument(s), i.e.
+   because the instruments are part of the same file and the engine does
+   not allow a way to manage load modes for them individually.  Due to
+   this, in case the frontend shows the load modes of entries, the
+   frontend should retrieve the actual mode by i.e. sending "GET
+   MIDI_INSTRUMENT INFO" (Section 6.7.5) command(s).  Finally the
+   OPTIONAL <name> argument allows to set a custom name (encapsulated
+   into apostrophes) for the mapping entry, useful for frontends for
+   displaying an appropriate name for mapped instruments (using "GET
+   MIDI_INSTRUMENT INFO" (Section 6.7.5)).
+
+   The "MAP MIDI_INSTRUMENT" command will immediately return, thus it
+   will not block when an instrument is to be loaded due to a
+   "PERSISTENT" type entry as instruments are loaded in the background.
+   As a consequence this command may not necessarily return an error
+   i.e. when the given instrument file does not exist or may turn out to
+   be corrupt.
+
+   Possible Answers:
+
+      "OK" -
 
+         usually
 
+      "ERR:<error-code>:<error-message>" -
 
+         when the given engine does not exist or a value is out of range
 
+   Examples:
 
 
 
 
+Schoenebeck               Expires May 30, 2007                 [Page 66]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
+      C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0
+      0.8 PERSISTENT"
 
+      S: "OK"
 
+      C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7
+      1.0"
 
+      S: "OK"
 
+      C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
+      'Normal Piano'"
 
+      S: "OK"
+
+      C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25
+      'Silent Piano'"
+
+      S: "OK"
+
+      C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0
+      1.0 PERSISTENT 'Foo Drumkit'"
+
+      S: "OK"
+
+6.7.2.  Getting ammount of MIDI instrument map entries
+
+   The front-end can query the amount of currently existing MIDI
+   instrument map entries by sending the following command:
+
+      GET MIDI_INSTRUMENTS
+
+   Possible Answers:
+
+      LinuxSampler will answer by sending the current number of entries
+      in the sampler's MIDI instrument map.
+
+   Example:
 
+      C: "GET MIDI_INSTRUMENTS"
 
+      S: "634"
 
+6.7.3.  Getting indeces of all MIDI instrument map entries
 
+   The front-end can query a list of all currently existing MIDI
+   instrument map entries by sending the following command:
 
 
-Schoenebeck             Expires January 22, 2006               [Page 63]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+
+Schoenebeck               Expires May 30, 2007                 [Page 67]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      LIST MIDI_INSTRUMENTS
+
+   Possible Answers:
+
+      LinuxSampler will answer by sending a comma separated list of MIDI
+      bank MSB (coarse) - MIDI bank LSB (fine) - MIDI program triples,
+      where each triple is encapsulated into curly braces.  The list is
+      returned in one single line.  Each triple just reflects the key of
+      the respective map entry, thus subsequent "GET MIDI_INSTRUMENT
+      INFO" (Section 6.7.5) command(s) are necessary to retrieve
+      detailed informations about each entry.
+
+   Example:
+
+      C: "LIST MIDI_INSTRUMENTS"
+
+      S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"
+
+6.7.4.  Remove an entry from the MIDI instrument map
+
+   The front-end can delete an entry from the MIDI instrument map by
+   sending the following command:
+
+      UNMAP MIDI_INSTRUMENT <midi_bank_msb> <midi_bank_lsb> <midi_prog>
+
+   Where <midi_bank_msb> is an integer value between 0..127 reflecting
+   the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value
+   between 0..127 reflecting the MIDI bank LSB (fine) value and
+   <midi_prog> an integer value between 0..127 reflecting the MIDI
+   program value of the map entrie's key index triple.
+
+   Possible Answers:
+
+      "OK" -
+
+         usually
+
+      "ERR:<error-code>:<error-message>" -
+
+         when index out of bounds
+
+   Example:
+
+      C: "UNMAP MIDI_INSTRUMENT 2 40 127"
+
+      S: "OK"
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 68]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+6.7.5.  Get current settings of MIDI instrument map entry
+
+   The front-end can retrieve the current settings of a certain
+   instrument map entry by sending the following command:
+
+      GET MIDI_INSTRUMENT INFO <midi_bank_msb> <midi_bank_lsb>
+      <midi_prog>
+
+   Where <midi_bank_msb> is an integer value between 0..127 reflecting
+   the MIDI bank MSB (coarse) value, <midi_bank_lsb> an integer value
+   between 0..127 reflecting the MIDI bank LSB (fine) value and
+   <midi_prog> an integer value between 0..127 reflecting the MIDI
+   program value of the map entrie's key index triple.
+
+   Possible Answers:
+
+      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:
+
+      "NAME" -
+
+         Name for this MIDI instrument map entry (if defined).  This
+         name shall be used by frontends for displaying a name for this
+         mapped instrument.  It can be set and changed with the "MAP
+         MIDI_INSTRUMENT" (Section 6.7.1) command and does not have to
+         be unique.
+
+      "ENGINE_NAME" -
+
+         Name of the engine to be deployed for this instrument.
+
+      "INSTRUMENT_FILE" -
+
+         File name of the instrument.
+
+      "INSTRUMENT_NR" -
+
+         Index of the instrument within the file.
+
+      "INSTRUMENT_NAME" -
+
+         Name of the loaded instrument as reflected by its file.  In
+         contrast to the "NAME" field, the "INSTRUMENT_NAME" field
+         cannot be changed.
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 69]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      "LOAD_MODE" -
+
+         Life time of instrument (see "MAP MIDI_INSTRUMENT"
+         (Section 6.7.1) for details about this setting).
+
+      "VOLUME" -
+
+         master volume of the instrument as optionally dotted number
+         (where a value < 1.0 means attenuation and a value > 1.0 means
+         amplification)
+
+      The mentioned fields above don't have to be in particular order.
+
+   Example:
+
+      C: "GET MIDI_INSTRUMENT INFO 3 45 120"
+
+      S: "NAME: Drums for Foo Song"
+
+         "ENGINE_NAME: GigEngine"
+
+         "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
+
+         "INSTRUMENT_NR: 0"
+
+         "INSTRUMENT_NAME: Joe's Drumkit"
+
+         "LOAD_MODE: PERSISTENT"
+
+         "VOLUME: 1.0"
+
+         "."
+
+6.7.6.  Clear MIDI instrument map
+
+   The front-end can clear the whole MIDI instrument map, that is delete
+   all entries by sending the following command:
+
+      CLEAR MIDI_INSTRUMENTS
+
+   Possible Answers:
+
+      "OK" -
+
+         always
+
+   Example:
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 70]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      C: "CLEAR MIDI_INSTRUMENTS"
+
+      S: "OK"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 71]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 7.  Command Syntax
@@ -3567,25 +4015,29 @@
 
       ADD SP CHANNEL
 
+      / MAP SP map_instruction
+
+      / UNMAP SP unmap_instruction
+
       / GET SP get_instruction
 
       / CREATE SP create_instruction
 
       / DESTROY SP destroy_instruction
 
-      / LIST SP list_instruction
-
-      / LOAD SP load_instruction
 
 
 
+Schoenebeck               Expires May 30, 2007                 [Page 72]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-Schoenebeck             Expires January 22, 2006               [Page 64]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+      / LIST SP list_instruction
 
+      / LOAD SP load_instruction
 
-      / REMOVE SP CHANNEL SP sampler_channel
+      / REMOVE SP remove_instruction
 
       / SET SP set_instruction
 
@@ -3595,7 +4047,9 @@
 
       / SELECT SP text
 
-      / RESET SP CHANNEL SP sampler_channel
+      / RESET SP reset_instruction
+
+      / CLEAR SP clear_instruction
 
       / RESET
 
@@ -3615,6 +4069,8 @@
 
       / MISCELLANEOUS
 
+      / TOTAL_VOICE_COUNT
+
    unsubscribe_event =
 
       CHANNEL_COUNT
@@ -3625,21 +4081,48 @@
 
       / BUFFER_FILL
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 73]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       / CHANNEL_INFO
 
       / MISCELLANEOUS
 
-   get_instruction =
+      / TOTAL_VOICE_COUNT
 
-      AVAILABLE_ENGINES
+   map_instruction =
+
+      MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP
+      engine_name SP filename SP instrument_index SP volume_value
 
+      / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog
+      SP engine_name SP filename SP instrument_index SP volume_value SP
+      instr_load_mode
 
+      / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog
+      SP engine_name SP filename SP instrument_index SP volume_value SP
+      entry_name
 
+      / MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog
+      SP engine_name SP filename SP instrument_index SP volume_value SP
+      instr_load_mode SP entry_name
 
-Schoenebeck             Expires January 22, 2006               [Page 65]
+   unmap_instruction =
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+      MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog
 
+   remove_instruction =
+
+      CHANNEL SP sampler_channel
+
+   get_instruction =
+
+      AVAILABLE_ENGINES
 
       / AVAILABLE_MIDI_INPUT_DRIVERS
 
@@ -3654,6 +4137,14 @@
 
       / AUDIO_OUTPUT_DRIVER SP INFO SP string
 
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 74]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
       / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
 
       / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
@@ -3688,18 +4179,27 @@
 
       / ENGINE SP INFO SP engine_name
 
+      / SERVER SP INFO
 
+      / TOTAL_VOICE_COUNT
 
+      / TOTAL_VOICE_COUNT_MAX
 
+      / MIDI_INSTRUMENTS
 
-Schoenebeck             Expires January 22, 2006               [Page 66]
+      / MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP
+      midi_prog
+
+   set_instruction =
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
 
 
-      / SERVER SP INFO
 
-   set_instruction =
+
+Schoenebeck               Expires May 30, 2007                 [Page 75]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
 
       AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
       param_val_list
@@ -3727,6 +4227,14 @@
 
       / MIDI_INPUT_DEVICE SP string
 
+   reset_instruction =
+
+      CHANNEL SP sampler_channel
+
+   clear_instruction =
+
+      MIDI_INSTRUMENTS
+
    destroy_instruction =
 
       AUDIO_OUTPUT_DEVICE SP number
@@ -3741,17 +4249,18 @@
 
    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 May 30, 2007                 [Page 76]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-Schoenebeck             Expires January 22, 2006               [Page 67]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+      AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
 
+      / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
+      SP audio_channel_index
 
       / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
 
@@ -3795,19 +4304,22 @@
 
       / AVAILABLE_ENGINES
 
-      / AVAILABLE_MIDI_INPUT_DRIVERS
 
-      / AVAILABLE_AUDIO_OUTPUT_DRIVERS
 
-   load_instr_args =
 
 
+Schoenebeck               Expires May 30, 2007                 [Page 77]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
-Schoenebeck             Expires January 22, 2006               [Page 68]
+      / AVAILABLE_MIDI_INPUT_DRIVERS
+
+      / AVAILABLE_AUDIO_OUTPUT_DRIVERS
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+      / MIDI_INSTRUMENTS
 
+   load_instr_args =
 
       filename SP instrument_index SP sampler_channel
 
@@ -3817,6 +4329,14 @@
 
       engine_name SP sampler_channel
 
+   instr_load_mode =
+
+      ON_DEMAND
+
+      / ON_DEMAND_HOLD
+
+      / PERSISTENT
+
    device_index =
 
       number
@@ -3841,29 +4361,41 @@
 
    midi_input_type_name =
 
-      string
 
-   volume_value =
 
-      dotnum
 
-      / number
+Schoenebeck               Expires May 30, 2007                 [Page 78]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
-   sampler_channel =
+
+      string
+
+   midi_bank_msb =
 
       number
 
-   instrument_index =
+   midi_bank_lsb =
 
       number
 
+   midi_prog =
 
+      number
 
+   volume_value =
 
-Schoenebeck             Expires January 22, 2006               [Page 69]
+      dotnum
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+      / number
 
+   sampler_channel =
+
+      number
+
+   instrument_index =
+
+      number
 
    engine_name =
 
@@ -3873,6 +4405,10 @@
 
       stringval
 
+   entry_name =
+
+      stringval
+
    param_val_list =
 
       param_val
@@ -3881,11 +4417,17 @@
 
    param_val =
 
-      string
 
-      / '\'' string '\''
 
-      / '\"' string '\"'
+
+Schoenebeck               Expires May 30, 2007                 [Page 79]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
+      string
+
+      / stringval
 
       / number
 
@@ -3916,9 +4458,27 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 70]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 80]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 8.  Events
@@ -3926,7 +4486,7 @@
    This chapter will describe all currently defined events supported by
    LinuxSampler.
 
-8.1  Number of sampler channels changed
+8.1.  Number of sampler channels changed
 
    Client may want to be notified when the total number of channels on
    the back-end changes by issuing the following command:
@@ -3940,7 +4500,7 @@
    where <channels> will be replaced by the new number of sampler
    channels.
 
-8.2  Number of active voices changed
+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:
@@ -3955,7 +4515,7 @@
    voice count change occurred and <voices> by the new number of active
    voices on that channel.
 
-8.3  Number of active disk streams changed
+8.3.  Number of active disk streams changed
 
    Client may want to be notified when the number of streams on the
    back-end changes by issuing the following command: SUBSCRIBE
@@ -3972,14 +4532,14 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 71]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 81]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
    active disk streams on that channel.
 
-8.4  Disk stream buffer fill state changed
+8.4.  Disk stream buffer fill state changed
 
    Client may want to be notified when the buffer fill state of a disk
    stream on the back-end changes by issuing the following command:
@@ -3996,7 +4556,7 @@
    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
+8.5.  Channel information changed
 
    Client may want to be notified when changes were made to sampler
    channels on the back-end by issuing the following command:
@@ -4014,12 +4574,12 @@
    rather than real time events happening on the server, it is believed
    that an empty notification message is sufficient here.
 
-8.6  Miscellaneous and debugging events
+8.6.  Total number of active voices changed
 
-   Client may want to be notified of miscellaneous and debugging events
-   occurring at the server by issuing the following command:
+   Client may want to be notified when the total number of voices on the
+   back-end changes by issuing the following command:
 
-      SUBSCRIBE MISCELLANEOUS
+      SUBSCRIBE TOTAL_VOICE_COUNT
 
    Server will start sending the following notification messages:
 
@@ -4028,31 +4588,30 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 72]
-
-Internet-Draft        LinuxSampler Control Protocol            July 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
-   facilitate debugging.
-
-
-
-
-
-
+Schoenebeck               Expires May 30, 2007                 [Page 82]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
+      "NOTIFY:TOTAL_VOICE_COUNT:<voices>
 
+   where <voices> will be replaced by the new number of all currently
+   active voices.
 
+8.7.  Miscellaneous and debugging events
 
+   Client may want to be notified of miscellaneous and debugging events
+   occurring at the server by issuing the following command:
 
+      SUBSCRIBE MISCELLANEOUS
 
+   Server will start sending the following notification messages:
 
+      "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
+   facilitate debugging.
 
 
 
@@ -4084,9 +4643,10 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 73]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 83]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 9.  Security Considerations
@@ -4140,9 +4700,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 74]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 84]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 10.  Acknowledgments
@@ -4172,6 +4732,35 @@
               CONTROL PROTOCOL", RFC 793, 1981.
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 85]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
+
+
 Author's Address
 
    C. Schoenebeck
@@ -4196,9 +4785,36 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 75]
 
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck               Expires May 30, 2007                 [Page 86]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
 Intellectual Property Statement
@@ -4226,7 +4842,7 @@
 
 Full Copyright Statement
 
-   Copyright (C) The Internet Society (2005).  All Rights Reserved.
+   Copyright (C) The Internet Society (2006).  All Rights Reserved.
 
    This document and translations of it may be copied and furnished to
    others, and derivative works that comment on or otherwise explain it
@@ -4252,9 +4868,9 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 76]
-
-Internet-Draft        LinuxSampler Control Protocol            July 2005
+Schoenebeck               Expires May 30, 2007                 [Page 87]
+
+Internet-Draft        LinuxSampler Control Protocol        November 2006
 
 
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
@@ -4308,5 +4924,5 @@
 
 
 
-Schoenebeck             Expires January 22, 2006               [Page 77]
-
+Schoenebeck               Expires May 30, 2007                 [Page 88]
+