--- web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt	2005/05/21 20:01:32	561
+++ web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt	2007/03/22 21:12:10	1110
@@ -1,23 +1,26 @@
 
 
+
 LinuxSampler Developers                                   C. Schoenebeck
 Internet-Draft                           Interessengemeinschaft Software
-Expires: November 19, 2005                             Engineering e. V.
-                                                            May 21, 2005
+Intended status: Standards Track                       Engineering e. V.
+Expires: September 23, 2007                               March 22, 2007
 
 
                      LinuxSampler Control Protocol
-                                lscp.txt
+                                LSCP 1.2
 
 Status of this Memo
 
-   This document is an Internet-Draft and is in full conformance with
-   all provisions of Section 10 of RFC2026.
+   By submitting this Internet-Draft, each author represents that any
+   applicable patent or other IPR claims of which he or she is aware
+   have been or will be disclosed, and any of which he or she becomes
+   aware will be disclosed, in accordance with Section 6 of BCP 79.
 
    Internet-Drafts are working documents of the Internet Engineering
    Task Force (IETF), its areas, and its working groups.  Note that
-   other groups may also distribute working documents as
-   Internet-Drafts.
+   other groups may also distribute working documents as Internet-
+   Drafts.
 
    Internet-Drafts are draft documents valid for a maximum of six months
    and may be updated, replaced, or obsoleted by other documents at any
@@ -30,19 +33,13 @@
    The list of Internet-Draft Shadow Directories can be accessed at
    http://www.ietf.org/shadow.html.
 
-   This Internet-Draft will expire on November 19, 2005.
+   This Internet-Draft will expire on September 23, 2007.
 
 Copyright Notice
 
-   Copyright (C) The Internet Society (2005).  All Rights Reserved.
+   Copyright (C) The IETF Trust (2007).
 
-Abstract
 
-   The LinuxSampler Control Protocol (LSCP) is an application-level
-   protocol primarily intended for local and remote controlling the
-   LinuxSampler main application, which is a sophisticated console
-   application essentially playing back audio samples and manipulating
-   the samples in real time to certain extent.
 
 
 
@@ -52,121 +49,180 @@
 
 
 
-Schoenebeck            Expires November 19, 2005                [Page 1]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
 
-Table of Contents
 
-   1.   Requirements notation  . . . . . . . . . . . . . . . . . . .   4
-   2.   Introduction . . . . . . . . . . . . . . . . . . . . . . . .   5
-   3.   Focus of this protocol . . . . . . . . . . . . . . . . . . .   6
-   4.   Communication Overview . . . . . . . . . . . . . . . . . . .   7
-     4.1  Request/response communication method  . . . . . . . . . .   7
-       4.1.1  Result format  . . . . . . . . . . . . . . . . . . . .   8
-     4.2  Subscribe/notify communication method  . . . . . . . . . .   9
-   5.   Description for control commands . . . . . . . . . . . . . .  12
-     5.1  Ignored lines and comments . . . . . . . . . . . . . . . .  12
-     5.2  Configuring audio drivers  . . . . . . . . . . . . . . . .  12
-       5.2.1  Getting amount of available audio output drivers . . .  12
-       5.2.2  Getting all available audio output drivers . . . . . .  13
-       5.2.3  Getting information about a specific audio output
-              driver . . . . . . . . . . . . . . . . . . . . . . . .  13
-       5.2.4  Getting information about specific audio output
-              driver parameter . . . . . . . . . . . . . . . . . . .  14
-       5.2.5  Creating an audio output device  . . . . . . . . . . .  17
-       5.2.6  Destroying an audio output device  . . . . . . . . . .  17
-       5.2.7  Getting all created audio output device count  . . . .  18
-       5.2.8  Getting all created audio output device list . . . . .  18
-       5.2.9  Getting current settings of an audio output device . .  19
-       5.2.10   Changing settings of audio output devices  . . . . .  20
-       5.2.11   Getting information about an audio channel . . . . .  20
-       5.2.12   Getting information about specific audio channel
-                parameter  . . . . . . . . . . . . . . . . . . . . .  22
-       5.2.13   Changing settings of audio output channels . . . . .  23
-     5.3  Configuring MIDI input drivers . . . . . . . . . . . . . .  24
-       5.3.1  Getting amount of available MIDI input drivers . . . .  24
-       5.3.2  Getting all available MIDI input drivers . . . . . . .  25
-       5.3.3  Getting information about a specific MIDI input
-              driver . . . . . . . . . . . . . . . . . . . . . . . .  25
-       5.3.4  Getting information about specific MIDI input
-              driver parameter . . . . . . . . . . . . . . . . . . .  26
-       5.3.5  Creating a MIDI input device . . . . . . . . . . . . .  28
-       5.3.6  Destroying a MIDI input device . . . . . . . . . . . .  29
-       5.3.7  Getting all created MIDI input device count  . . . . .  29
-       5.3.8  Getting all created MIDI input device list . . . . . .  29
-       5.3.9  Getting current settings of a MIDI input device  . . .  30
-       5.3.10   Changing settings of MIDI input devices  . . . . . .  31
-       5.3.11   Getting information about a MIDI port  . . . . . . .  31
-       5.3.12   Getting information about specific MIDI port
-                parameter  . . . . . . . . . . . . . . . . . . . . .  32
-       5.3.13   Changing settings of MIDI input ports  . . . . . . .  33
-     5.4  Configuring sampler channels . . . . . . . . . . . . . . .  34
-       5.4.1  Loading an instrument  . . . . . . . . . . . . . . . .  34
-       5.4.2  Loading a sampler engine . . . . . . . . . . . . . . .  35
-
-
-
-Schoenebeck            Expires November 19, 2005                [Page 2]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-       5.4.3  Getting all created sampler channel count  . . . . . .  36
-       5.4.4  Getting all created sampler channel list . . . . . . .  36
-       5.4.5  Adding a new sampler channel . . . . . . . . . . . . .  36
-       5.4.6  Removing a sampler channel . . . . . . . . . . . . . .  37
-       5.4.7  Getting amount of available engines  . . . . . . . . .  38
-       5.4.8  Getting all available engines  . . . . . . . . . . . .  38
-       5.4.9  Getting information about an engine  . . . . . . . . .  38
-       5.4.10   Getting sampler channel information  . . . . . . . .  39
-       5.4.11   Current number of active voices  . . . . . . . . . .  41
-       5.4.12   Current number of active disk streams  . . . . . . .  41
-       5.4.13   Current fill state of disk stream buffers  . . . . .  42
-       5.4.14   Setting audio output device  . . . . . . . . . . . .  42
-       5.4.15   Setting audio output type  . . . . . . . . . . . . .  43
-       5.4.16   Setting audio output channel . . . . . . . . . . . .  44
-       5.4.17   Setting MIDI input device  . . . . . . . . . . . . .  44
-       5.4.18   Setting MIDI input type  . . . . . . . . . . . . . .  45
-       5.4.19   Setting MIDI input port  . . . . . . . . . . . . . .  45
-       5.4.20   Setting MIDI input channel . . . . . . . . . . . . .  46
-       5.4.21   Setting channel volume . . . . . . . . . . . . . . .  46
-       5.4.22   Resetting a sampler channel  . . . . . . . . . . . .  47
-     5.5  Controlling connection . . . . . . . . . . . . . . . . . .  48
-       5.5.1  Register front-end for receiving event messages  . . .  48
-       5.5.2  Unregister front-end for not receiving event
-              messages . . . . . . . . . . . . . . . . . . . . . . .  48
-       5.5.3  Enable or disable echo of commands . . . . . . . . . .  49
-       5.5.4  Close client connection  . . . . . . . . . . . . . . .  49
-     5.6  Global commands  . . . . . . . . . . . . . . . . . . . . .  50
-       5.6.1  Reset sampler  . . . . . . . . . . . . . . . . . . . .  50
-   6.   Command Syntax . . . . . . . . . . . . . . . . . . . . . . .  51
-   7.   Events . . . . . . . . . . . . . . . . . . . . . . . . . . .  52
-     7.1  Number of sampler channels changed . . . . . . . . . . . .  52
-     7.2  Number of active voices changed  . . . . . . . . . . . . .  52
-     7.3  Number of active disk streams changed  . . . . . . . . . .  52
-     7.4  Disk stream buffer fill state changed  . . . . . . . . . .  53
-     7.5  Channel information changed  . . . . . . . . . . . . . . .  53
-     7.6  Miscellaneous and debugging events . . . . . . . . . . . .  53
-   8.   Security Considerations  . . . . . . . . . . . . . . . . . .  55
-   9.   Acknowledgments  . . . . . . . . . . . . . . . . . . . . . .  56
-   10.  References . . . . . . . . . . . . . . . . . . . . . . . . .  56
-        Author's Address . . . . . . . . . . . . . . . . . . . . . .  56
-        Intellectual Property and Copyright Statements . . . . . . .  57
+Schoenebeck            Expires September 23, 2007               [Page 1]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
+Abstract
+
+   The LinuxSampler Control Protocol (LSCP) is an application-level
+   protocol primarily intended for local and remote controlling the
+   LinuxSampler backend application, which is a sophisticated server-
+   like console application essentially playing back audio samples and
+   manipulating the samples in real time to certain extent.
 
 
+Table of Contents
 
+   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  . .  15
+       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  . . . . .  25
+       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  . . . . . . . . . . . . . . . . . . . . . . .  31
+       6.3.4.  Getting information about specific MIDI input
+               driver parameter  . . . . . . . . . . . . . . . . . .  32
+       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
+
+
+
+Schoenebeck            Expires September 23, 2007               [Page 2]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+       6.3.8.  Getting all created MIDI input device list  . . . . .  36
+       6.3.9.  Getting current settings of a MIDI input device . . .  37
+       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
+       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 . . . . . .  52
+       6.4.14. Setting audio output device . . . . . . . . . . . . .  53
+       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 . . . . . . . . . . . . . . .  56
+       6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56
+       6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57
+       6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58
+       6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58
+       6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59
+       6.4.24. Assigning a MIDI instrument map to a sampler
+               channel . . . . . . . . . . . . . . . . . . . . . . .  60
+       6.4.25. Adding an effect send to a sampler channel  . . . . .  61
+       6.4.26. Removing an effect send from a sampler channel  . . .  62
+       6.4.27. Getting amount of effect sends on a sampler channel .  63
+       6.4.28. Listing all effect sends on a sampler channel . . . .  63
+       6.4.29. Getting effect send information . . . . . . . . . . .  64
+       6.4.30. Altering effect send's audio routing  . . . . . . . .  65
+       6.4.31. Altering effect send's MIDI controller  . . . . . . .  66
+       6.4.32. Altering effect send's send level . . . . . . . . . .  67
+       6.4.33. Resetting a sampler channel . . . . . . . . . . . . .  68
+     6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  68
+       6.5.1.  Register front-end for receiving event messages . . .  68
+       6.5.2.  Unregister front-end for not receiving event
+               messages  . . . . . . . . . . . . . . . . . . . . . .  69
+       6.5.3.  Enable or disable echo of commands  . . . . . . . . .  70
+       6.5.4.  Close client connection . . . . . . . . . . . . . . .  70
+
+
+
+Schoenebeck            Expires September 23, 2007               [Page 3]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+     6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  71
+       6.6.1.  Current number of active voices . . . . . . . . . . .  71
+       6.6.2.  Maximum amount of active voices . . . . . . . . . . .  71
+       6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  71
+       6.6.4.  General sampler informations  . . . . . . . . . . . .  72
+       6.6.5.  Getting global volume attenuation . . . . . . . . . .  72
+       6.6.6.  Setting global volume attenuation . . . . . . . . . .  73
+     6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  73
+       6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  74
+       6.7.2.  Delete one particular or all MIDI instrument maps . .  75
+       6.7.3.  Get amount of existing MIDI instrument maps . . . . .  75
+       6.7.4.  Getting all created MIDI instrument maps  . . . . . .  76
+       6.7.5.  Getting MIDI instrument map information . . . . . . .  76
+       6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  77
+       6.7.7.  Create or replace a MIDI instrument map entry . . . .  77
+       6.7.8.  Getting ammount of MIDI instrument map entries  . . .  80
+       6.7.9.  Getting indeces of all entries of a MIDI
+               instrument map  . . . . . . . . . . . . . . . . . . .  81
+       6.7.10. Remove an entry from the MIDI instrument map  . . . .  82
+       6.7.11. Get current settings of MIDI instrument map entry . .  82
+       6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  84
+   7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  85
+   8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  96
+     8.1.  Number of audio output devices changed  . . . . . . . . .  96
+     8.2.  Audio output device's settings changed  . . . . . . . . .  96
+     8.3.  Number of MIDI input devices changed  . . . . . . . . . .  96
+     8.4.  MIDI input device's settings changed  . . . . . . . . . .  97
+     8.5.  Number of sampler channels changed  . . . . . . . . . . .  97
+     8.6.  Number of active voices changed . . . . . . . . . . . . .  97
+     8.7.  Number of active disk streams changed . . . . . . . . . .  98
+     8.8.  Disk stream buffer fill state changed . . . . . . . . . .  98
+     8.9.  Channel information changed . . . . . . . . . . . . . . .  98
+     8.10. Number of effect sends changed  . . . . . . . . . . . . .  99
+     8.11. Effect send information changed . . . . . . . . . . . . .  99
+     8.12. Total number of active voices changed . . . . . . . . . .  99
+     8.13. Number of MIDI instrument maps changed  . . . . . . . . . 100
+     8.14. MIDI instrument map information changed . . . . . . . . . 100
+     8.15. Number of MIDI instruments changed  . . . . . . . . . . . 100
+     8.16. MIDI instrument information changed . . . . . . . . . . . 101
+     8.17. Global settings changed . . . . . . . . . . . . . . . . . 101
+     8.18. Miscellaneous and debugging events  . . . . . . . . . . . 102
+   9.  Security Considerations . . . . . . . . . . . . . . . . . . . 103
+   10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 104
+   11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 105
+   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 106
+   Intellectual Property and Copyright Statements  . . . . . . . . . 107
 
 
 
 
 
-Schoenebeck            Expires November 19, 2005                [Page 3]
+Schoenebeck            Expires September 23, 2007               [Page 4]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
 1.  Requirements notation
@@ -178,13 +234,14 @@
    This protocol is always case-sensitive if not explicitly claimed the
    opposite.
 
-   In examples, "C:" and "S:" indicate lines sent by the client
-   (front-end) and server (LinuxSampler) respectively.  Lines in
-   examples must be interpreted as every line being CRLF terminated
-   (carriage return character followed by line feed character as defined
-   in the ASCII standard), thus the following example:
+   In examples, "C:" and "S:" indicate lines sent by the client (front-
+   end) and server (LinuxSampler) respectively.  Lines in examples must
+   be interpreted as every line being CRLF terminated (carriage return
+   character followed by line feed character as defined in the ASCII
+   standard), thus the following example:
 
       C: "some line"
+
          "another line"
 
    must actually be interpreted as client sending the following message:
@@ -203,9 +260,13 @@
    sequence scenario:
 
    o  server sending message "a"
+
    o  followed by a delay (pause) with arbitrary duration
+
    o  followed by server sending message "bcd<CR>"
+
    o  again followed by a delay (pause) with arbitrary duration
+
    o  followed by server sending the message "<LF>"
 
    where again <CR> and <LF> symbolize the carriage return and line feed
@@ -215,17 +276,68 @@
 
 
 
+Schoenebeck            Expires September 23, 2007               [Page 5]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+2.  Versioning of this specification
+
+   LSCP will certainly be extended and enhanced by-and-by.  Each
+   official release of the LSCP specification will be tagged with a
+   unique version tuple.  The version tuple consists at least of a major
+   and minor version number like:
+
+      "1.2"
+
+   In this example the major version number would be "1" and the minor
+   version number would be "2".  Note that the version tuple might also
+   have more than two elements.  The major version number defines a
+   group of backward compatible versions.  That means a frontend is
+   compatible to the connected sampler if and only if the LSCP versions
+   to which each of the two parties complies to, match both of the
+   following rules:
+
+   Compatibility:
+
+   1.  The frontend's LSCP major version and the sampler's LSCP major
+       version are exactly equal.
+
+   2.  The frontend's LSCP minor version is less or equal than the
+       sampler's LSCP minor version.
+
+   Compatibility can only be claimed if both rules are true.  The
+   frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get
+   the version of the LSCP specification the sampler complies with.
+
+
+
+
+
+
+
 
 
 
 
 
-Schoenebeck            Expires November 19, 2005                [Page 4]
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007               [Page 6]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-2.  Introduction
+3.  Introduction
 
    LinuxSampler is a so called software sampler application capable to
    playback audio samples from a computer's Random Access Memory (RAM)
@@ -235,9 +347,9 @@
    virtual channels which will be referred in this document as "sampler
    channels".  The channels are in such way virtual as they can be
    connected to an arbitrary MIDI input method and arbitrary MIDI
-   channel (e.g.  sampler channel 17 could be connected to an ALSA
+   channel (e.g. sampler channel 17 could be connected to an ALSA
    sequencer device 64:0 and listening to MIDI channel 1 there).  Each
-   sampler engine will be assigned an own instance of one of the
+   sampler channel will be associated with an instance of one of the
    available sampler engines (e.g.  GigEngine, DLSEngine).  The audio
    output of each sampler channel can be routed to an arbitrary audio
    output method (ALSA / JACK) and an arbitrary audio output channel
@@ -276,12 +388,12 @@
 
 
 
-Schoenebeck            Expires November 19, 2005                [Page 5]
+Schoenebeck            Expires September 23, 2007               [Page 7]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-3.  Focus of this protocol
+4.  Focus of this protocol
 
    Main focus of this protocol is to provide a way to configure a
    running LinuxSampler instance and to retrieve information about it.
@@ -332,12 +444,12 @@
 
 
 
-Schoenebeck            Expires November 19, 2005                [Page 6]
+Schoenebeck            Expires September 23, 2007               [Page 8]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-4.  Communication Overview
+5.  Communication Overview
 
    There are two distinct methods of communication between a running
    instance of LinuxSampler and one or more control applications, so
@@ -349,29 +461,29 @@
    more effort to be implemented in the front-end application.  The two
    communication methods will be described next.
 
-4.1  Request/response communication method
+5.1.  Request/response communication method
 
-   This simple communication method is based on TCP.  The front-end
-   application establishes a TCP connection to the LinuxSampler instance
-   on a certain host system.  Then the front-end application will send
-   certain ASCII based commands as defined in this document (every
-   command line must be CRLF terminated - see "Conventions used in this
-   document" at the beginning of this document) and the LinuxSampler
-   application will response after a certain process time with an
-   appropriate ASCII based answer, also as defined in this document.  So
-   this TCP communication is simply based on query and answer paradigm.
-   That way LinuxSampler is only able to answer on queries from
-   front-ends, but not able to automatically send messages to the client
-   if it's not asked to.  The fronted should not reconnect to
-   LinuxSampler for every single command, instead it should keep the
-   connection established and simply resend message(s) for subsequent
-   commands.  To keep information in the front-end up-to-date the
-   front-end has to periodically send new requests to get the current
-   information from the LinuxSampler instance.  This is often referred
-   to as "polling".  While polling is simple to implement and may be OK
-   to use in some cases, there may be disadvantages to polling such as
-   network traffic overhead and information being out of date.  It is
-   possible for a client or several clients to open more than one
+   This simple communication method is based on TCP [RFC793].  The
+   front-end application establishes a TCP connection to the
+   LinuxSampler instance on a certain host system.  Then the front-end
+   application will send certain ASCII based commands as defined in this
+   document (every command line must be CRLF terminated - see
+   "Conventions used in this document" at the beginning of this
+   document) and the LinuxSampler application will response after a
+   certain process time with an appropriate ASCII based answer, also as
+   defined in this document.  So this TCP communication is simply based
+   on query and answer paradigm.  That way LinuxSampler is only able to
+   answer on queries from front-ends, but not able to automatically send
+   messages to the client if it's not asked to.  The fronted should not
+   reconnect to LinuxSampler for every single command, instead it should
+   keep the connection established and simply resend message(s) for
+   subsequent commands.  To keep information in the front-end up-to-date
+   the front-end has to periodically send new requests to get the
+   current information from the LinuxSampler instance.  This is often
+   referred to as "polling".  While polling is simple to implement and
+   may be OK to use in some cases, there may be disadvantages to polling
+   such as network traffic overhead and information being out of date.
+   It is possible for a client or several clients to open more than one
    connection to the server at the same time.  It is also possible to
    send more than one request to the server at the same time but if
    those requests are sent over the same connection server MUST execute
@@ -388,23 +500,26 @@
 
 
 
-Schoenebeck            Expires November 19, 2005                [Page 7]
+Schoenebeck            Expires September 23, 2007               [Page 9]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-4.1.1  Result format
+5.1.1.  Result format
 
    Result set could be one of the following types:
 
    1.  Normal
+
    2.  Warning
+
    3.  Error
 
    Warning and Error result sets MUST be single line and have the
    following format:
 
    o  "WRN:<warning-code>:<warning-message>"
+
    o  "ERR:<error-code>:<error-message>"
 
    Where <warning-code> and <error-code> are numeric unique identifiers
@@ -414,40 +529,45 @@
    Examples:
 
       C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
+
       S: "WRN:32:This is a 24 bit patch which is not supported natively
       yet."
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
+
       S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter
       'EAR'."
 
       C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
+
       S: "ERR:9:There is no audio output device with index 123456."
 
    Normal result sets could be:
 
    1.  Empty
+
    2.  Single line
+
    3.  Multi-line
 
    Empty result set is issued when the server only needed to acknowledge
    the fact that the request was received and it was processed
    successfully and no additional information is available.  This result
-   set has the following format:
 
-      "OK"
 
-   Example:
 
-      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
+Schoenebeck            Expires September 23, 2007              [Page 10]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
+   set has the following format:
 
+      "OK"
 
-Schoenebeck            Expires November 19, 2005                [Page 8]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+   Example:
 
+      C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
 
       S: "OK"
 
@@ -461,13 +581,21 @@
    Example:
 
       C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
+
       S: "DRIVER: ALSA"
+
          "CHANNELS: 2"
+
          "SAMPLERATE: 44100"
+
          "ACTIVE: true"
+
          "FRAGMENTS: 2"
+
          "FRAGMENTSIZE: 128"
+
          "CARD: '0,0'"
+
          "."
 
    In addition to above mentioned formats, warnings and empty result
@@ -475,36 +603,39 @@
    respectively:
 
    o  "WRN[<index>]:<warning-code>:<warning-message>"
+
    o  "OK[<index>]"
 
    where <index> is command specific and is used to indicate channel
    number that the result set was related to or other integer value.
 
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 11]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
    Each line of the result set MUST end with <CRLF>.
 
    Examples:
 
       C: "ADD CHANNEL"
+
       S: "OK[12]"
 
       C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
+
       S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
 
-4.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
    front-end still uses a TCP connection and sends the same commands on
    the TCP connection.  Two extra commands are SUBSCRIBE and UNSUBSCRIBE
    commands that allow a client to tell the server that it is interested
-
-
-
-Schoenebeck            Expires November 19, 2005                [Page 9]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    in receiving notifications about certain events as they happen on the
    server.  The SUBSCRIBE command has the following syntax:
 
@@ -527,11 +658,21 @@
 
    1.  Events MUST NOT be sent to any client who has not issued an
        appropriate SUBSCRIBE command.
+
    2.  Events MUST only be sent using the same connection that was used
        to subscribe to them.
+
    3.  When response is being sent to the client, event MUST be inserted
        in the stream before or after the response, but NOT in the
        middle.  Same is true about the response.  It should never be
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 12]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
        inserted in the middle of the event message as well as any other
        response.
 
@@ -542,7 +683,7 @@
 
    where <event-id> will be replace by the respective event that client
    is no longer interested in receiving.  For a list of supported events
-   see Section 7.
+   see Section 8.
 
    Example: the fill states of disk stream buffers have changed on
    sampler channel 4 and the LinuxSampler instance will react by sending
@@ -554,13 +695,6 @@
    channel 4, where the stream with ID "35" is filled by 62%, stream
    with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.
 
-
-
-Schoenebeck            Expires November 19, 2005               [Page 10]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    Clients may choose to open more than one connection to the server and
    use some connections to receive notifications while using other
    connections to issue commands to the back-end.  This is entirely
@@ -590,56 +724,35 @@
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 11]
+Schoenebeck            Expires September 23, 2007              [Page 13]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-5.  Description for control commands
+6.  Description for control commands
 
    This chapter will describe the available control commands that can be
    sent on the TCP connection in detail.  Some certain commands (e.g.
-   "GET CHANNEL INFO" (Section 5.4.10) or "GET ENGINE INFO" (Section
-   5.4.9)) lead to multiple-line responses.  In this case LinuxSampler
-   signals the end of the response by a "." (single dot) line.
+   "GET CHANNEL INFO" (Section 6.4.10) or "GET ENGINE INFO"
+   (Section 6.4.9)) lead to multiple-line responses.  In this case
+   LinuxSampler signals the end of the response by a "." (single dot)
+   line.
 
-5.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.
 
-5.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
+   multiple audio devices simultaneously, e.g. to output the sound of
    one sampler channel using the ALSA audio output driver, and on
    another sampler channel you might want to use the JACK audio output
    driver.  For particular audio output systems it's also possible to
-   create several devices of the same audio output driver, e.g.  two
+   create several devices of the same audio output driver, e.g. two
    separate ALSA audio output devices for using two different sound
    cards at the same time.  This chapter describes all commands to
    configure LinuxSampler's audio output devices and their parameters.
@@ -649,8 +762,8 @@
    values have to be obtained at runtime.  This makes the protocol a bit
    abstract, but has the advantage, that front-ends can be written
    independently of what drivers are currently implemented and what
-   parameters these drivers are actually offering.  This means
-   front-ends can even handle drivers which are implemented somewhere in
+   parameters these drivers are actually offering.  This means front-
+   ends can even handle drivers which are implemented somewhere in
    future without modifying the front-end at all.
 
    Note: examples in this chapter showing particular parameters of
@@ -661,17 +774,21 @@
    retrieve what parameters drivers are offering, how to retrieve their
    possible values, etc.
 
-5.2.1  Getting amount of available audio output drivers
 
-   Use the following command to get the number of audio output drivers
-   currently available for the LinuxSampler instance:
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 12]
+
+
+Schoenebeck            Expires September 23, 2007              [Page 14]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
 
+6.2.1.  Getting amount of available audio output drivers
+
+   Use the following command to get the number of audio output drivers
+   currently available for the LinuxSampler instance:
 
       GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
 
@@ -683,9 +800,10 @@
    Example:
 
       C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
+
       S: "2"
 
-5.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:
@@ -700,9 +818,10 @@
    Example:
 
       C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
+
       S: "ALSA,JACK"
 
-5.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:
@@ -710,11 +829,18 @@
       GET AUDIO_OUTPUT_DRIVER INFO <audio-output-driver>
 
    Where <audio-output-driver> is the name of the audio output driver,
-   returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2)
+   returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
    command.
 
    Possible Answers:
 
+
+
+Schoenebeck            Expires September 23, 2007              [Page 15]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       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
@@ -723,34 +849,37 @@
 
 
 
-
-Schoenebeck            Expires November 19, 2005               [Page 13]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-
          DESCRIPTION -
+
             character string describing the audio output driver
+
          VERSION -
+
             character string reflecting the driver's version
+
          PARAMETERS -
+
             comma separated list of all parameters available for the
             given audio output driver, at least parameters 'channels',
             'samplerate' and 'active' are offered by all audio output
             drivers
+
       The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
+
       S: "DESCRIPTION: Advanced Linux Sound Architecture"
+
          "VERSION: 1.0"
+
          "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
       FRAGMENTSIZE,CARD"
+
          "."
 
-5.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:
@@ -758,16 +887,24 @@
       GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>]
 
    Where <audio> is the name of the audio output driver as returned by
-   the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2) command,
+   the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
    <prm> a specific parameter name for which information should be
-   obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" (Section
-   5.2.3) command) and <deplist> is an optional list of parameters on
-   which the sought parameter <prm> depends on, <deplist> is a list of
-   key-value pairs in form of "key1=val1 key2=val2 ...", where character
-   string values are encapsulated into apostrophes (').  Arguments given
-   with <deplist> which are not dependency parameters of <prm> will be
-   ignored, means the front-end application can simply put all
-   parameters into <deplist> with the values already selected by the
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 16]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
+   (Section 6.2.3) command) and <deplist> is an optional list of
+   parameters on which the sought parameter <prm> depends on, <deplist>
+   is a list of key-value pairs in form of "key1=val1 key2=val2 ...",
+   where character string values are encapsulated into apostrophes (').
+   Arguments given with <deplist> which are not dependency parameters of
+   <prm> will be ignored, means the front-end application can simply put
+   all parameters into <deplist> with the values already selected by the
    user.
 
    Possible Answers:
@@ -777,42 +914,54 @@
       a colon and then a space character <SP> and finally the info
       character string to that info category.  There are information
       which is always returned, independently of the given driver
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 14]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       parameter and there are optional information which is only shown
       dependently to given driver parameter.  At the moment the
       following information categories are defined:
 
       TYPE -
+
          either "BOOL" for boolean value(s) or "INT" for integer
          value(s) or "FLOAT" for dotted number(s) or "STRING" for
          character string(s) (always returned, no matter which driver
          parameter)
+
       DESCRIPTION -
+
          arbitrary text describing the purpose of the parameter (always
          returned, no matter which driver parameter)
+
       MANDATORY -
+
          either true or false, defines if this parameter must be given
          when the device is to be created with the 'CREATE
-         AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command (always returned,
+         AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
          no matter which driver parameter)
+
       FIX -
+
          either true or false, if false then this parameter can be
          changed at any time, once the device is created by the 'CREATE
-         AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command (always returned,
+         AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
          no matter which driver parameter)
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 17]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       MULTIPLICITY -
+
          either true or false, defines if this parameter allows only one
          value or a list of values, where true means multiple values and
          false only a single value allowed (always returned, no matter
          which driver parameter)
+
       DEPENDS -
+
          comma separated list of parameters this parameter depends on,
          means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
          and 'POSSIBILITIES' might depend on these listed parameters,
@@ -822,36 +971,44 @@
          possible values for 'samplerate' depends on the sound card
          which can be chosen by the 'card' parameter (optionally
          returned, dependent to driver parameter)
+
       DEFAULT -
+
          reflects the default value for this parameter which is used
          when the device is created and not explicitly given with the
-         'CREATE AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command, in case
+         'CREATE AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command, in case
          of MULTIPLCITY=true, this is a comma separated list, that's why
          character strings are encapsulated into apostrophes (')
          (optionally returned, dependent to driver parameter)
+
       RANGE_MIN -
+
          defines lower limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MAX, but
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 15]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       RANGE_MAX -
+
          defines upper limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MIN, but
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       POSSIBILITIES -
+
          comma separated list of possible values for this parameter,
          character strings are encapsulated into apostrophes (optionally
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 18]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          returned, dependent to driver parameter)
 
    The mentioned fields above don't have to be in particular order.
@@ -859,123 +1016,172 @@
    Examples:
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
+
       S: "DESCRIPTION: sound card to be used"
+
          "TYPE: STRING"
+
          "MANDATORY: false"
+
          "FIX: true"
+
          "MULTIPLICITY: false"
+
          "DEFAULT: '0,0'"
+
          "POSSIBILITIES: '0,0','1,0','2,0'"
+
          "."
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
+
       S: "DESCRIPTION: output sample rate in Hz"
+
          "TYPE: INT"
+
          "MANDATORY: false"
+
          "FIX: false"
+
          "MULTIPLICITY: false"
+
          "DEPENDS: card"
+
          "DEFAULT: 44100"
+
          "."
 
       C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE
       CARD='0,0'"
+
       S: "DESCRIPTION: output sample rate in Hz"
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 19]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          "TYPE: INT"
+
          "MANDATORY: false"
-         "FIX: false"
-         "MULTIPLICITY: false"
-         "DEPENDS: card"
-         "DEFAULT: 44100"
-         "RANGE_MIN: 22050"
 
+         "FIX: false"
 
+         "MULTIPLICITY: false"
 
+         "DEPENDS: card"
 
-Schoenebeck            Expires November 19, 2005               [Page 16]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+         "DEFAULT: 44100"
 
+         "RANGE_MIN: 22050"
 
          "RANGE_MAX: 96000"
+
          "."
 
-5.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>]
 
    Where <audio-output-driver> should be replaced by the desired audio
-   output system and <param-list> by an optional list of driver specific
-   parameters in form of "key1=val1 key2=val2 ...", where character
-   string values should be encapsulated into apostrophes (').  Note that
-   there might be drivers which require parameter(s) to be given with
-   this command.  Use the previously described commands in this chapter
-   to get this information.
+   output system as returned by the "LIST
+   AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command and <param-
+   list> by an optional list of driver specific parameters in form of
+   "key1=val1 key2=val2 ...", where character string values should be
+   encapsulated into apostrophes (').  Note that there might be drivers
+   which require parameter(s) to be given with this command.  Use the
+   previously described commands in this chapter to get this
+   information.
 
    Possible Answers:
 
       "OK[<device-id>]" -
+
          in case the device was successfully created, where <device-id>
          is the numerical ID of the new device
+
       "WRN[<device-id>]:<warning-code>:<warning-message>" -
+
          in case the device was created successfully, where <device-id>
          is the numerical ID of the new device, but there are noteworthy
-         issue(s) related (e.g.  sound card doesn't support given
+         issue(s) related (e.g. sound card doesn't support given
          hardware parameters and the driver is using fall-back values),
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 20]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          providing an appropriate warning code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Examples:
 
       C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
+
       S: "OK[0]"
 
       C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
+
       S: "OK[1]"
 
-5.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:
 
       DESTROY AUDIO_OUTPUT_DEVICE <device-id>
 
    Where <device-id> should be replaced by the numerical ID of the audio
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 17]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section
-   5.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 5.2.8) command.
+   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
+   (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
+   command.
 
    Possible Answers:
 
       "OK" -
+
          in case the device was successfully destroyed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the device was destroyed successfully, but there are
-         noteworthy issue(s) related (e.g.  an audio over ethernet
-         driver was unloaded but the other host might not be informed
-         about this situation), providing an appropriate warning code
-         and warning message
+         noteworthy issue(s) related (e.g. an audio over ethernet driver
+         was unloaded but the other host might not be informed about
+         this situation), providing an appropriate warning code and
+         warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
+
+
+Schoenebeck            Expires September 23, 2007              [Page 21]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
+
       S: "OK"
 
-5.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:
 
@@ -989,9 +1195,10 @@
    Example:
 
       C: "GET AUDIO_OUTPUT_DEVICES"
+
       S: "4"
 
-5.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:
 
@@ -1002,19 +1209,13 @@
       LinuxSampler will answer by sending a comma separated list with
       the numerical IDs of all audio output devices.
 
-
-
-Schoenebeck            Expires November 19, 2005               [Page 18]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    Example:
 
       C: "LIST AUDIO_OUTPUT_DEVICES"
+
       S: "0,1,4,5"
 
-5.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:
@@ -1022,8 +1223,15 @@
       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 5.2.8) command.
+   output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
+   (Section 6.2.8) command.
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 22]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
 
    Possible Answers:
 
@@ -1036,14 +1244,21 @@
    (independently of device):
 
       DRIVER -
+
          identifier of the used audio output driver, as also returned by
-         the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2)
+         the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
          command
+
       CHANNELS -
+
          amount of audio output channels this device currently offers
+
       SAMPLERATE -
+
          playback sample rate the device uses
+
       ACTIVE -
+
          either true or false, if false then the audio device is
          inactive and doesn't output any sound, nor do the sampler
          channels connected to this audio device render any audio
@@ -1051,31 +1266,38 @@
    The mentioned fields above don't have to be in particular order.  The
    fields above are only those fields which are returned by all audio
    output devices.  Every audio output driver might have its own,
-   additional driver specific parameters (see Section 5.2.3) which are
+   additional driver specific parameters (see Section 6.2.3) which are
    also returned by this command.
 
    Example:
 
+      C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
 
+      S: "DRIVER: ALSA"
 
+         "CHANNELS: 2"
+
+         "SAMPLERATE: 44100"
+
+         "ACTIVE: true"
 
 
-Schoenebeck            Expires November 19, 2005               [Page 19]
+
+
+Schoenebeck            Expires September 23, 2007              [Page 23]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-      C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
-      S: "DRIVER: ALSA"
-         "CHANNELS: 2"
-         "SAMPLERATE: 44100"
-         "ACTIVE: true"
          "FRAGMENTS: 2"
+
          "FRAGMENTSIZE: 128"
+
          "CARD: '0,0'"
+
          "."
 
-5.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:
@@ -1083,43 +1305,58 @@
       SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>
 
    Where <device-id> should be replaced by the numerical ID of the audio
-   output device, <key> by the name of the parameter to change and
-   <value> by the new value for this parameter.
+   output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
+   (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
+   command, <key> by the name of the parameter to change and <value> by
+   the new value for this parameter.
 
    Possible Answers:
 
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
       C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
+
       S: "OK"
 
-5.2.11  Getting information about an audio channel
 
-   Use the following command to get information about an audio channel:
 
-      GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
 
-   Where <device-id> is the numerical ID of the audio output device and
-   <audio-chan> the audio channel number.
 
-   Possible Answers:
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 20]
+Schoenebeck            Expires September 23, 2007              [Page 24]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+6.2.11.  Getting information about an audio channel
+
+   Use the following command to get information about an audio channel:
+
+      GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
+
+   Where <device-id> is the numerical ID of the audio output device as
+   given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
+   AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command and <audio-chan> the
+   audio channel number.
 
+   Possible Answers:
 
       LinuxSampler will answer by sending a <CRLF> separated list.  Each
       answer line begins with the information category name followed by
@@ -1127,17 +1364,24 @@
       character string to that info category.  At the moment the
       following information categories are defined:
 
+
+
          NAME -
+
             arbitrary character string naming the channel, which doesn't
             have to be unique (always returned by all audio channels)
+
          IS_MIX_CHANNEL -
+
             either true or false, a mix-channel is not a real,
             independent audio channel, but a virtual channel which is
             mixed to another real channel, this mechanism is needed for
             sampler engines which need more audio channels than the used
             audio system might be able to offer (always returned by all
             audio channels)
+
          MIX_CHANNEL_DESTINATION -
+
             numerical ID (positive integer including 0) which reflects
             the real audio channel (of the same audio output device)
             this mix channel refers to, means where the audio signal
@@ -1150,40 +1394,52 @@
    driver.  Every audio channel might have its own, additional driver
    and channel specific parameters.
 
+
+
+Schoenebeck            Expires September 23, 2007              [Page 25]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
    Examples:
 
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
+
       S: "NAME: studio monitor left"
+
          "IS_MIX_CHANNEL: false"
+
          "."
 
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
+
       S: "NAME: studio monitor right"
+
          "IS_MIX_CHANNEL: false"
-         "."
 
-      C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
-      S: "NAME: studio monitor left"
-         "IS_MIX_CHANNEL: true"
-         "MIX_CHANNEL_DESTINATION: 1"
          "."
 
+      C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
 
+      S: "NAME: studio monitor left"
 
+         "IS_MIX_CHANNEL: true"
 
+         "MIX_CHANNEL_DESTINATION: 1"
 
-Schoenebeck            Expires November 19, 2005               [Page 21]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
+         "."
 
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
+
       S: "NAME: 'ardour (left)'"
+
          "IS_MIX_CHANNEL: false"
+
          "JACK_BINDINGS: 'ardour:0'"
+
          "."
 
-5.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
    audio channel parameter:
@@ -1191,10 +1447,19 @@
       GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
 
    Where <dev-id> is the numerical ID of the audio output device as
-   returned by the "LIST AUDIO_OUTPUT_DEVICES" (Section 5.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 AUDIO_OUTPUT_CHANNEL INFO" (Section 5.2.11) command).
+   returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
+   AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 26]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   channel number and <param> a specific channel parameter name for
+   which information should be obtained (as returned by the "GET
+   AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
 
    Possible Answers:
 
@@ -1207,59 +1472,81 @@
       dependently to the given audio channel.  At the moment the
       following information categories are defined:
 
+
+
          TYPE -
+
             either "BOOL" for boolean value(s) or "INT" for integer
             value(s) or "FLOAT" for dotted number(s) or "STRING" for
             character string(s) (always returned)
+
          DESCRIPTION -
+
             arbitrary text describing the purpose of the parameter
             (always returned)
+
          FIX -
+
             either true or false, if true then this parameter is read
             only, thus cannot be altered (always returned)
+
          MULTIPLICITY -
+
             either true or false, defines if this parameter allows only
             one value or a list of values, where true means multiple
             values and false only a single value allowed (always
             returned)
+
          RANGE_MIN -
+
             defines lower limit of the allowed value range for this
             parameter, can be an integer value as well as a dotted
+            number, usually used in conjunction with 'RANGE_MAX', but
+            may also appear without (optionally returned, dependent to
+            driver and channel parameter)
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 22]
+
+Schoenebeck            Expires September 23, 2007              [Page 27]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-            number, usually used in conjunction with 'RANGE_MAX', but
-            may also appear without (optionally returned, dependent to
-            driver and channel parameter)
          RANGE_MAX -
+
             defines upper limit of the allowed value range for this
             parameter, can be an integer value as well as a dotted
             number, usually used in conjunction with 'RANGE_MIN', but
             may also appear without (optionally returned, dependent to
             driver and channel parameter)
+
          POSSIBILITIES -
+
             comma separated list of possible values for this parameter,
             character strings are encapsulated into apostrophes
             (optionally returned, dependent to driver and channel
             parameter)
+
       The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
+
       S: "DESCRIPTION: bindings to other JACK clients"
+
          "TYPE: STRING"
+
          "FIX: false"
+
          "MULTIPLICITY: true"
+
          "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
+
          "."
 
-5.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:
@@ -1267,40 +1554,50 @@
       SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
 
    Where <dev-id> should be replaced by the numerical ID of the audio
-   device, <chn> by the audio channel number, <key> by the name of the
+   output device as returned by the "CREATE AUDIO_OUTPUT_DEVICE"
+   (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
+   command, <chn> by the audio channel number, <key> by the name of the
    parameter to change and <value> by the new value for this parameter.
 
    Possible Answers:
 
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 28]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
-
-
-Schoenebeck            Expires November 19, 2005               [Page 23]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    Example:
 
       C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
+
       S: "OK"
 
       C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
+
       S: "OK"
 
-5.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
+   multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet
    as MIDI input on one sampler channel and ALSA as MIDI input on
    another sampler channel.  For particular MIDI input systems it's also
    possible to create several devices of the same MIDI input type.  This
@@ -1312,14 +1609,22 @@
    values have to be obtained at runtime.  This makes the protocol a bit
    abstract, but has the advantage, that front-ends can be written
    independently of what drivers are currently implemented and what
-   parameters these drivers are actually offering.  This means
-   front-ends can even handle drivers which are implemented somewhere in
+   parameters these drivers are actually offering.  This means front-
+   ends can even handle drivers which are implemented somewhere in
    future without modifying the front-end at all.
 
    Commands for configuring MIDI input devices are pretty much the same
    as the commands for configuring audio output drivers, already
    described in the last chapter.
 
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 29]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
    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
@@ -1328,7 +1633,7 @@
    retrieve what parameters drivers are offering, how to retrieve their
    possible values, etc.
 
-5.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:
@@ -1337,23 +1642,16 @@
 
    Possible Answers:
 
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 24]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LinuxSampler will answer by sending the number of available MIDI
       input drivers.
 
    Example:
 
       C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
+
       S: "2"
 
-5.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:
@@ -1368,16 +1666,31 @@
    Example:
 
       C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
+
       S: "ALSA,JACK"
 
-5.3.3  Getting information about a specific MIDI input driver
+
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 30]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+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:
 
       GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
 
-   Where <midi-input-driver> is the name of the MIDI input driver.
+   Where <midi-input-driver> is the name of the MIDI input driver as
+   returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
+   command.
 
    Possible Answers:
 
@@ -1387,33 +1700,44 @@
       character string to that info category.  At the moment the
       following information categories are defined:
 
-         DESCRIPTION -
-            arbitrary description text about the MIDI input driver
-         VERSION -
-            arbitrary character string regarding the driver's version
-         PARAMETERS -
 
 
+         DESCRIPTION -
+
+            arbitrary description text about the MIDI input driver
 
+         VERSION -
 
-Schoenebeck            Expires November 19, 2005               [Page 25]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+            arbitrary character string regarding the driver's version
 
+         PARAMETERS -
 
             comma separated list of all parameters available for the
             given MIDI input driver
+
       The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET MIDI_INPUT_DRIVER INFO ALSA"
+
       S: "DESCRIPTION: Advanced Linux Sound Architecture"
+
          "VERSION: 1.0"
+
          "PARAMETERS: DRIVER,ACTIVE"
+
          "."
 
-5.3.4  Getting information about specific MIDI input driver parameter
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 31]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+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:
@@ -1421,9 +1745,9 @@
       GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
 
    Where <midit> is the name of the MIDI input driver as returned by the
-   "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2) command, <param>
+   "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2) command, <param>
    a specific parameter name for which information should be obtained
-   (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 5.3.3)
+   (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 6.3.3)
    command) and <deplist> is an optional list of parameters on which the
    sought parameter <param> depends on, <deplist> is a key-value pair
    list in form of "key1=val1 key2=val2 ...", where character string
@@ -1444,38 +1768,47 @@
    defined:
 
       TYPE -
+
          either "BOOL" for boolean value(s) or "INT" for integer
          value(s) or "FLOAT" for dotted number(s) or "STRING" for
          character string(s) (always returned, no matter which driver
          parameter)
 
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 26]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       DESCRIPTION -
+
          arbitrary text describing the purpose of the parameter (always
          returned, no matter which driver parameter)
+
       MANDATORY -
+
          either true or false, defines if this parameter must be given
          when the device is to be created with the 'CREATE
-         MIDI_INPUT_DEVICE' (Section 5.3.5) command (always returned, no
+         MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
          matter which driver parameter)
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 32]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       FIX -
+
          either true or false, if false then this parameter can be
          changed at any time, once the device is created by the 'CREATE
-         MIDI_INPUT_DEVICE' (Section 5.3.5) command (always returned, no
+         MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
          matter which driver parameter)
+
       MULTIPLICITY -
+
          either true or false, defines if this parameter allows only one
          value or a list of values, where true means multiple values and
          false only a single value allowed (always returned, no matter
          which driver parameter)
+
       DEPENDS -
+
          comma separated list of parameters this parameter depends on,
          means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
          and 'POSSIBILITIES' might depend on these listed parameters,
@@ -1485,35 +1818,42 @@
          possible values for 'samplerate' depends on the sound card
          which can be chosen by the 'card' parameter (optionally
          returned, dependent to driver parameter)
+
       DEFAULT -
+
          reflects the default value for this parameter which is used
          when the device is created and not explicitly given with the
-         'CREATE MIDI_INPUT_DEVICE' (Section 5.3.5) command, in case of
+         'CREATE MIDI_INPUT_DEVICE' (Section 6.3.5) command, in case of
          MULTIPLCITY=true, this is a comma separated list, that's why
          character strings are encapsulated into apostrophes (')
          (optionally returned, dependent to driver parameter)
+
       RANGE_MIN -
+
          defines lower limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MAX, but
          may also appear without (optionally returned, dependent to
          driver parameter)
+
       RANGE_MAX -
+
          defines upper limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is often used in conjunction with RANGE_MIN, but
-         may also appear without (optionally returned, dependent to
-         driver parameter)
-
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 27]
+Schoenebeck            Expires September 23, 2007              [Page 33]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
+         may also appear without (optionally returned, dependent to
+         driver parameter)
+
       POSSIBILITIES -
+
          comma separated list of possible values for this parameter,
          character strings are encapsulated into apostrophes (optionally
          returned, dependent to driver parameter)
@@ -1523,81 +1863,114 @@
    Example:
 
       C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
+
       S: "DESCRIPTION: Whether device is enabled"
+
          "TYPE: BOOL"
+
          "MANDATORY: false"
+
          "FIX: false"
+
          "MULTIPLICITY: false"
+
          "DEFAULT: true"
+
          "."
 
-5.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:
 
       CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
 
    Where <midi-input-driver> should be replaced by the desired MIDI
-   input system and <param-list> by an optional list of driver specific
-   parameters in form of "key1=val1 key2=val2 ...", where character
-   string values should be encapsulated into apostrophes (').  Note that
-   there might be drivers which require parameter(s) to be given with
-   this command.  Use the previously described commands in this chapter
-   to get that information.
+   input system as returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
+   (Section 6.3.2) command and <param-list> by an optional list of
+   driver specific parameters in form of "key1=val1 key2=val2 ...",
+   where character string values should be encapsulated into apostrophes
+   (').  Note that there might be drivers which require parameter(s) to
+   be given with this command.  Use the previously described commands in
+   this chapter to get that information.
 
    Possible Answers:
 
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 34]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       "OK[<device-id>]" -
+
          in case the device was successfully created, where <device-id>
          is the numerical ID of the new device
+
       "WRN[<device-id>]:<warning-code>:<warning-message>" -
+
          in case the driver was loaded successfully, where <device-id>
          is the numerical ID of the new device, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
-
-
-Schoenebeck            Expires November 19, 2005               [Page 28]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       C: "CREATE MIDI_INPUT_DEVICE ALSA"
+
       S: "OK[0]"
 
-5.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:
 
       DESTROY MIDI_INPUT_DEVICE <device-id>
 
-   Where <device-id> should be replaced by the device's numerical ID.
+   Where <device-id> should be replaced by the device's numerical ID as
+   returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
+   MIDI_INPUT_DEVICES" (Section 6.3.8) command.
 
    Possible Answers:
 
       "OK" -
+
          in case the device was successfully destroyed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the device was destroyed, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 35]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
       C: "DESTROY MIDI_INPUT_DEVICE 0"
+
       S: "OK"
 
-5.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:
 
@@ -1611,20 +1984,13 @@
    Example:
 
       C: "GET MIDI_INPUT_DEVICES"
+
       S: "3"
 
-5.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:
 
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 29]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       LIST MIDI_INPUT_DEVICES
 
    Possible Answers:
@@ -1635,19 +2001,32 @@
    Examples:
 
       C: "LIST MIDI_INPUT_DEVICES"
+
       S: "0,1,2"
 
       C: "LIST MIDI_INPUT_DEVICES"
+
       S: "1,3"
 
-5.3.9  Getting current settings of a MIDI input device
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 36]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+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:
 
       GET MIDI_INPUT_DEVICE INFO <device-id>
 
-   Where <device-id> is the numerical ID of the MIDI input device.
+   Where <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.
 
    Possible Answers:
 
@@ -1659,11 +2038,16 @@
       apostrophes (').  At the moment the following information
       categories are defined (independent of driver):
 
+
+
          DRIVER -
-            identifier of the used MIDI input driver, as e.g.  returned
-            by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2)
+
+            identifier of the used MIDI input driver, as e.g. returned
+            by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
             command
+
          ACTIVE -
+
             either true or false, if false then the MIDI device is
             inactive and doesn't listen to any incoming MIDI events and
             thus doesn't forward them to connected sampler channels
@@ -1672,25 +2056,28 @@
    fields above are only those fields which are returned by all MIDI
    input devices.  Every MIDI input driver might have its own,
    additional driver specific parameters (see "GET MIDI_INPUT_DRIVER
-   INFO" (Section 5.3.3) command) which are also returned by this
+   INFO" (Section 6.3.3) command) which are also returned by this
+   command.
 
+   Example:
 
+      C: "GET MIDI_INPUT_DEVICE INFO 0"
 
-Schoenebeck            Expires November 19, 2005               [Page 30]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+      S: "DRIVER: ALSA"
 
 
-   command.
 
-   Example:
 
-      C: "GET MIDI_INPUT_DEVICE INFO 0"
-      S: "DRIVER: ALSA"
+Schoenebeck            Expires September 23, 2007              [Page 37]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          "ACTIVE: true"
+
          "."
 
-5.3.10  Changing settings of MIDI input devices
+6.3.10.  Changing settings of MIDI input devices
 
    Use the following command to alter a specific setting of a created
    MIDI input device:
@@ -1698,51 +2085,63 @@
       SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>
 
    Where <device-id> should be replaced by the numerical ID of the MIDI
-   input device, <key> by the name of the parameter to change and
-   <value> by the new value for this parameter.
+   input device as returned by the "CREATE MIDI_INPUT_DEVICE"
+   (Section 6.3.5) or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command,
+   <key> by the name of the parameter to change and <value> by the new
+   value for this parameter.
 
    Possible Answers:
 
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
    Example:
 
       C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
+
       S: "OK"
 
-5.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:
 
       GET MIDI_INPUT_PORT INFO <device-id> <midi-port>
 
-   Where <device-id> is the numerical ID of the MIDI input device and
-   <midi-port> the MIDI input port number.
+   Where <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
 
-   Possible Answers:
 
 
+Schoenebeck            Expires September 23, 2007              [Page 38]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-Schoenebeck            Expires November 19, 2005               [Page 31]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+   MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
+   input port number.
 
+   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 information categories are defined:
+
       NAME -
+
          arbitrary character string naming the port
 
    The field above is only the one which is returned by all MIDI ports
@@ -1752,11 +2151,14 @@
    Example:
 
       C: "GET MIDI_INPUT_PORT INFO 0 0"
+
       S: "NAME: 'Masterkeyboard'"
+
          "ALSA_SEQ_BINDINGS: '64:0'"
+
          "."
 
-5.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
    MIDI port parameter:
@@ -1764,59 +2166,81 @@
       GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
 
    Where <dev-id> is the numerical ID of the MIDI input device as
-   returned by the "LIST MIDI_INPUT_DEVICES" (Section 5.3.8) command,
-   <port> the MIDI port number and <param> a specific port parameter
-   name for which information should be obtained (as returned by the
-   "GET MIDI_INPUT_PORT INFO" (Section 5.3.11) command).
+   returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
+   MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> the MIDI port
+   number and <param> a specific port parameter name for which
+   information should be obtained (as returned by the "GET
+   MIDI_INPUT_PORT INFO" (Section 6.3.11) command).
 
    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
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 39]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       character string to that info category.  There is information
       which is always returned, independently of the given channel
       parameter and there is optional information which are only shown
       dependently to the given MIDI port.  At the moment the following
       information categories are defined:
+
       TYPE -
+
          either "BOOL" for boolean value(s) or "INT" for integer
          value(s) or "FLOAT" for dotted number(s) or "STRING" for
          character string(s) (always returned)
-      DESCRIPTION -
-
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 32]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
+      DESCRIPTION -
 
          arbitrary text describing the purpose of the parameter (always
          returned)
+
       FIX -
+
          either true or false, if true then this parameter is read only,
          thus cannot be altered (always returned)
+
       MULTIPLICITY -
+
          either true or false, defines if this parameter allows only one
          value or a list of values, where true means multiple values and
          false only a single value allowed (always returned)
+
       RANGE_MIN -
+
          defines lower limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is usually used in conjunction with 'RANGE_MAX'
          but may also appear without (optionally returned, dependent to
          driver and port parameter)
+
       RANGE_MAX -
+
          defines upper limit of the allowed value range for this
          parameter, can be an integer value as well as a dotted number,
          this parameter is usually used in conjunction with 'RANGE_MIN'
          but may also appear without (optionally returned, dependent to
          driver and port parameter)
+
       POSSIBILITIES -
+
          comma separated list of possible values for this parameter,
          character strings are encapsulated into apostrophes (optionally
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 40]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          returned, dependent to device and port parameter)
 
    The mentioned fields above don't have to be in particular order.
@@ -1824,14 +2248,20 @@
    Example:
 
       C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
+
       S: "DESCRIPTION: bindings to other ALSA sequencer clients"
+
          "TYPE: STRING"
+
          "FIX: false"
+
          "MULTIPLICITY: true"
+
          "POSSIBILITIES: '64:0','68:0','68:1'"
+
          "."
 
-5.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:
@@ -1839,25 +2269,34 @@
       SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value>
 
    Where <device-id> should be replaced by the numerical ID of the MIDI
-   device, <port> by the MIDI port number, <key> by the name of the
-   parameter to change and <value> by the new value for this parameter.
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 33]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
+   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
+   <value> by the new value for this parameter.
 
    Possible Answers:
 
       "OK" -
+
          in case setting was successfully changed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case setting was changed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 41]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -1865,19 +2304,19 @@
 
 
 
-5.4  Configuring sampler channels
+6.4.  Configuring sampler channels
 
    The following commands describe how to add and remove sampler
-   channels, deploy sampler engines, load instruments and connect
-   sampler channels to MIDI and audio devices.
+   channels, associate a sampler channel with a sampler engine, load
+   instruments and connect sampler channels to MIDI and audio devices.
 
-5.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:
 
-      LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index>
-      <sampler-channel>
+      LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-
+      channel>
 
    Where <filename> is the name of the instrument file on the
    LinuxSampler instance's host system, <instr-index> the index of the
@@ -1889,8 +2328,8 @@
    is that the regular command returns OK only after the instrument has
    been fully loaded and the channel is ready to be used while NON_MODAL
    version returns immediately and a background process is launched to
-   load the instrument on the channel.  The GET CHANNEL INFO (Section
-   5.4.10) command can be used to obtain loading progress from
+   load the instrument on the channel.  The GET CHANNEL INFO
+   (Section 6.4.10) command can be used to obtain loading progress from
    INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
    such as making sure that the file could be read and it is of a proper
    format and SHOULD return ERR and SHOULD not launch the background
@@ -1898,22 +2337,28 @@
 
    Possible Answers:
 
-
-
-Schoenebeck            Expires November 19, 2005               [Page 34]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       "OK" -
+
          in case the instrument was successfully loaded
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the instrument was loaded successfully, but there are
          noteworthy issue(s) related (e.g.  Engine doesn't support one
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 42]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          or more patch parameters provided by the loaded instrument
          file), providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -1921,47 +2366,54 @@
 
 
 
-5.4.2  Loading a sampler engine
+6.4.2.  Loading a sampler engine
 
-   A sample engine can be deployed and assigned to a specific sampler
-   channel by the following command:
+   A sampler engine type can be associated to a specific sampler channel
+   by the following command:
 
       LOAD ENGINE <engine-name> <sampler-channel>
 
    Where <engine-name> is an engine name as obtained by the "LIST
-   AVAILABLE_ENGINES" (Section 5.4.8) command and <sampler-channel> the
-   sampler channel the deployed engine should be assigned to.  Even if
-   the respective sampler channel has already a deployed engine with
-   that engine name, a new engine instance will be assigned to the
-   sampler channel.
+   AVAILABLE_ENGINES" (Section 6.4.8) command and <sampler-channel> the
+   sampler channel as returned by the "ADD CHANNEL" (Section 6.4.5) or
+   "LIST CHANNELS" (Section 6.4.4) command where the engine type should
+   be assigned to.  This command should be issued after adding a new
+   sampler channel and before any other control commands on the new
+   sampler channel.  It can also be used to change the engine type of a
+   sampler channel.  This command has (currently) no way to define or
+   force if a new engine instance should be created and assigned to the
+   given sampler channel or if an already existing instance of that
+   engine type, shared with other sampler channels, should be used.
 
    Possible Answers:
 
       "OK" -
+
          in case the engine was successfully deployed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the engine was deployed successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
-   Example:
-
-
-
 
 
+Schoenebeck            Expires September 23, 2007              [Page 43]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
+   Example:
 
-Schoenebeck            Expires November 19, 2005               [Page 35]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
 
 
-5.4.3  Getting all created sampler channel count
+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
@@ -1977,9 +2429,10 @@
    Example:
 
       C: "GET CHANNELS"
+
       S: "12"
 
-5.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
@@ -1995,45 +2448,52 @@
    Example:
 
       C: "LIST CHANNELS"
+
       S: "0,1,2,3,4,5,6,9,10,11,15,20"
 
-5.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:
 
-      ADD CHANNEL
 
-   This will increment the sampler channel count by one and the new
-   sampler channel will be appended to the end of the sampler channel
-   list.  The front-end should send the respective, related commands
-   right after to e.g.  load an engine, load an instrument and setting
-   input, output method and eventually other commands to initialize the
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 36]
+Schoenebeck            Expires September 23, 2007              [Page 44]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
 
+      ADD CHANNEL
 
+   This will increment the sampler channel count by one and the new
+   sampler channel will be appended to the end of the sampler channel
+   list.  The front-end should send the respective, related commands
+   right after to e.g. load an engine, load an instrument and setting
+   input, output method and eventually other commands to initialize the
    new channel.  The front-end should use the sampler channel returned
    by the answer of this command to perform the previously recommended
-   commands, to avoid race conditions e.g.  with other front-ends that
+   commands, to avoid race conditions e.g. with other front-ends that
    might also have sent an "ADD CHANNEL" command.
 
    Possible Answers:
 
       "OK[<sampler-channel>]" -
-         in case a new sampler channel could be added, where
-         <sampler-channel> reflects the channel number of the new
-         created sampler channel which should be used to set up the
-         sampler channel by sending subsequent initialization commands
+
+         in case a new sampler channel could be added, where <sampler-
+         channel> reflects the channel number of the new created sampler
+         channel which should be used to set up the sampler channel by
+         sending subsequent initialization commands
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case a new channel was added successfully, but there are
          noteworthy issue(s) related, providing an appropriate warning
          code and warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2041,26 +2501,38 @@
 
 
 
-5.4.6  Removing a sampler channel
+6.4.6.  Removing a sampler channel
 
    A sampler channel can be removed by sending the following command:
 
       REMOVE CHANNEL <sampler-channel>
 
    Where <sampler-channel> should be replaced by the number of the
-   sampler channel as given by the "ADD CHANNEL" (Section 5.4.5) or
-   "LIST CHANNELS" (Section 5.4.4) command.  The channel numbers of all
+   sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
+   "LIST CHANNELS" (Section 6.4.4) command.  The channel numbers of all
    subsequent sampler channels remain the same.
 
    Possible Answers:
 
+
+
+Schoenebeck            Expires September 23, 2007              [Page 45]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       "OK" -
+
          in case the given sampler channel could be removed
+
       "WRN:<warning-code>:<warning-message>" -
+
          in case the given channel was removed, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2068,14 +2540,7 @@
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 37]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-
-
-5.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:
@@ -2090,9 +2555,10 @@
    Example:
 
       C: "GET AVAILABLE_ENGINES"
+
       S: "4"
 
-5.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:
@@ -2101,6 +2567,16 @@
 
    Possible Answers:
 
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 46]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       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 ("_"
@@ -2109,9 +2585,10 @@
    Example:
 
       C: "LIST AVAILABLE_ENGINES"
+
       S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
 
-5.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:
@@ -2119,15 +2596,7 @@
       GET ENGINE INFO <engine-name>
 
    Where <engine-name> is an engine name as obtained by the "LIST
-   AVAILABLE_ENGINES" (Section 5.4.8) command.
-
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 38]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
+   AVAILABLE_ENGINES" (Section 6.4.8) command.
 
    Possible Answers:
 
@@ -2137,9 +2606,14 @@
       character string to that info category.  At the moment the
       following categories are defined:
 
+
+
          DESCRIPTION -
+
             arbitrary description text about the engine
+
          VERSION -
+
             arbitrary character string regarding the engine's version
 
    The mentioned fields above don't have to be in particular order.
@@ -2147,11 +2621,23 @@
    Example:
 
       C: "GET ENGINE INFO JoesCustomEngine"
+
       S: "DESCRIPTION: this is Joe's custom sampler engine"
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 47]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          "VERSION: testing-1.0"
+
          "."
 
-5.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:
@@ -2159,7 +2645,8 @@
       GET CHANNEL INFO <sampler-channel>
 
    Where <sampler-channel> is the sampler channel number the front-end
-   is interested in.
+   is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
+   "LIST CHANNELS" (Section 6.4.4) command.
 
    Possible Answers:
 
@@ -2169,89 +2656,164 @@
       character string to that setting category.  At the moment the
       following categories are defined:
 
-         ENGINE_NAME -
-            name of the engine that is deployed on the sampler channel,
-            "NONE" if there's no engine deployed yet for this sampler
-            channel
-         AUDIO_OUTPUT_DEVICE -
-            numerical ID of the audio output device which is currently
-            connected to this sampler channel to output the audio
-            signal, "NONE" if there's no device connected to this
 
 
+         ENGINE_NAME -
 
-Schoenebeck            Expires November 19, 2005               [Page 39]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+            name of the engine that is associated with the sampler
+            channel, "NONE" if there's no engine associated yet for this
+            sampler channel
 
+         AUDIO_OUTPUT_DEVICE -
 
+            numerical ID of the audio output device which is currently
+            connected to this sampler channel to output the audio
+            signal, "NONE" if there's no device connected to this
             sampler channel
+
          AUDIO_OUTPUT_CHANNELS -
+
             number of output channels the sampler channel offers
             (dependent to used sampler engine and loaded instrument)
+
          AUDIO_OUTPUT_ROUTING -
+
             comma separated list which reflects to which audio channel
             of the selected audio output device each sampler output
-            channel is routed to, e.g.  "0,3" would mean the engine's
+            channel is routed to, e.g. "0,3" would mean the engine's
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 48]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
             output channel 0 is routed to channel 0 of the audio output
             device and the engine's output channel 1 is routed to the
             channel 3 of the audio output device
+
          INSTRUMENT_FILE -
+
             the file name of the loaded instrument, "NONE" if there's no
             instrument yet loaded for this sampler channel
+
          INSTRUMENT_NR -
+
             the instrument index number of the loaded instrument
+
          INSTRUMENT_NAME -
+
             the instrument name of the loaded instrument
+
          INSTRUMENT_STATUS -
+
             integer values 0 to 100 indicating loading progress
             percentage for the instrument.  Negative value indicates a
             loading exception.  Value of 100 indicates that the
             instrument is fully loaded.
+
          MIDI_INPUT_DEVICE -
+
             numerical ID of the MIDI input device which is currently
             connected to this sampler channel to deliver MIDI input
             commands, "NONE" if there's no device connected to this
             sampler channel
+
          MIDI_INPUT_PORT -
+
             port number of the MIDI input device
+
          MIDI_INPUT_CHANNEL -
+
             the MIDI input channel number this sampler channel should
             listen to or "ALL" to listen on all MIDI channels
+
          VOLUME -
+
             optionally dotted number for the channel volume factor
             (where a value < 1.0 means attenuation and a value > 1.0
             means amplification)
 
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 49]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+         MUTE -
+
+            Determines whether the channel is muted, "true" if the
+            channel is muted, "false" if the channel is not muted, and
+            "MUTED_BY_SOLO" if the channel is muted because of the
+            presence of a solo channel and will be unmuted when there
+            are no solo channels left
+
+         SOLO -
+
+            Determines whether this is a solo channel, "true" if the
+            channel is a solo channel; "false" otherwise
+
+         MIDI_INSTRUMENT_MAP -
+
+            Determines to which MIDI instrument map this sampler channel
+            is assigned to.  Read chapter "SET CHANNEL
+            MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
+            values.
+
    The mentioned fields above don't have to be in particular order.
 
    Example:
 
       C: "GET CHANNEL INFO 34"
-      S: "ENGINE_NAME: GigEngine"
-         "VOLUME: 1.0"
-         "AUDIO_OUTPUT_DEVICE: 0"
-         "AUDIO_OUTPUT_CHANNELS: 2"
-
 
+      S: "ENGINE_NAME: GigEngine"
 
+         "VOLUME: 1.0"
 
-Schoenebeck            Expires November 19, 2005               [Page 40]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+         "AUDIO_OUTPUT_DEVICE: 0"
 
+         "AUDIO_OUTPUT_CHANNELS: 2"
 
          "AUDIO_OUTPUT_ROUTING: 0,1"
+
          "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
+
          "INSTRUMENT_NR: 0"
+
          "INSTRUMENT_NAME: Fazioli Piano"
+
          "INSTRUMENT_STATUS: 100"
+
          "MIDI_INPUT_DEVICE: 0"
+
          "MIDI_INPUT_PORT: 0"
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 50]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          "MIDI_INPUT_CHANNEL: 5"
+
+         "VOLUME: 1.0"
+
+         "MUTE: false"
+
+         "SOLO: false"
+
+         "MIDI_INSTRUMENT_MAP: NONE"
+
          "."
 
-5.4.11  Current number of active voices
+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:
@@ -2259,7 +2821,8 @@
       GET CHANNEL VOICE_COUNT <sampler-channel>
 
    Where <sampler-channel> is the sampler channel number the front-end
-   is interested in.
+   is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
+   "LIST CHANNELS" (Section 6.4.4) command.
 
    Possible Answers:
 
@@ -2270,7 +2833,7 @@
 
 
 
-5.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:
@@ -2278,28 +2841,29 @@
       GET CHANNEL STREAM_COUNT <sampler-channel>
 
    Where <sampler-channel> is the sampler channel number the front-end
-   is interested in.
+   is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
+   "LIST CHANNELS" (Section 6.4.4) command.
 
    Possible Answers:
 
       LinuxSampler will answer by returning the number of active disk
       streams on that channel in case the engine supports disk
       streaming, if the engine doesn't support disk streaming it will
-      return "NA" for not available.
 
-   Example:
 
 
+Schoenebeck            Expires September 23, 2007              [Page 51]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-Schoenebeck            Expires November 19, 2005               [Page 41]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+      return "NA" for not available.
 
+   Example:
 
 
 
-5.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:
@@ -2311,7 +2875,9 @@
       GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
 
    to get the fill state in percent, where <sampler-channel> is the
-   sampler channel number the front-end is interested in.
+   sampler channel number the front-end is interested in as returned by
+   the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
+   command.
 
    Possible Answers:
 
@@ -2329,41 +2895,55 @@
    Examples:
 
       C: "GET CHANNEL BUFFER_FILL BYTES 4"
+
       S: "[115]420500,[116]510300,[75]110000,[120]230700"
+
       C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
+
       S: "[115]90%,[116]98%,[75]40%,[120]62%"
+
       C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
-      S: ""
 
-5.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:
 
-      SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>
-      <audio-device-id>
 
-   Where <audio-device-id> is the numerical ID of the audio output
-   device and <sampler-channel> is the respective sampler channel
 
+Schoenebeck            Expires September 23, 2007              [Page 52]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      S: ""
 
+6.4.14.  Setting audio output device
 
-Schoenebeck            Expires November 19, 2005               [Page 42]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+   The front-end can set the audio output device on a specific sampler
+   channel by sending the following command:
 
+      SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>
+      <audio-device-id>
 
-   number.
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command and <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)
+   command.
 
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if audio output device was set, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2371,15 +2951,23 @@
 
 
 
-5.4.15  Setting audio output type
+6.4.15.  Setting audio output type
 
    DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
 
    The front-end can alter the audio output type on a specific sampler
    channel by sending the following command:
 
-      SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel>
-      <audio-output-type>
+      SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
+      type>
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 53]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
 
    Where <audio-output-type> is currently either "ALSA" or "JACK" and
    <sampler-channel> is the respective sampler channel number.
@@ -2387,12 +2975,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if audio output type was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2400,16 +2993,7 @@
 
 
 
-
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 43]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
-5.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:
@@ -2417,21 +3001,36 @@
       SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
       <audio-in>
 
-   Where <sampler-chan> is the sampler channel number, <audio-out> is
-   the numerical ID of the sampler channel's audio output channel which
-   should be rerouted and <audio-in> is the numerical ID of the audio
-   channel of the selected audio output device where <audio-out> should
-   be routed to.
+   Where <sampler-chan> is the sampler channel number as returned by the
+   "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
+   command, <audio-out> is the numerical ID of the sampler channel's
+   audio output channel which should be rerouted and <audio-in> is the
+   numerical ID of the audio channel of the selected audio output device
+   where <audio-out> should be routed to.
 
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 54]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
          if audio output channel was set, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2439,33 +3038,33 @@
 
 
 
-5.4.17  Setting MIDI input device
+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:
 
       SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
 
-   Where <sampler-channel> is the sampler channel number and
-   <midi-device-id> is the the numerical ID of the MIDI input device.
+   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
+   device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
+   or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
 
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input device was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
 
-
-
-Schoenebeck            Expires November 19, 2005               [Page 44]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2473,7 +3072,16 @@
 
 
 
-5.4.18  Setting MIDI input type
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 55]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+6.4.18.  Setting MIDI input type
 
    DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
 
@@ -2482,18 +3090,23 @@
 
       SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
 
-   Where <midi-input-type> is currently only "ALSA" and
-   <sampler-channel> is the respective sampler channel number.
+   Where <midi-input-type> is currently only "ALSA" and <sampler-
+   channel> is the respective sampler channel number.
 
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input type was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2501,7 +3114,7 @@
 
 
 
-5.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:
@@ -2513,21 +3126,27 @@
 
    Possible Answers:
 
+      "OK" -
+
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 45]
+
+Schoenebeck            Expires September 23, 2007              [Page 56]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-      "OK" -
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input port was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2535,7 +3154,7 @@
 
 
 
-5.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:
@@ -2549,12 +3168,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if MIDI input channel was set, but there are noteworthy
          issue(s) related, providing an appropriate warning code and
          warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2562,20 +3186,21 @@
 
 
 
-5.4.21  Setting channel volume
 
-   The front-end can alter the volume of a sampler channel by sending
-   the following command:
 
-      SET CHANNEL VOLUME <sampler-channel> <volume>
+Schoenebeck            Expires September 23, 2007              [Page 57]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 46]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+6.4.21.  Setting channel volume
+
+   The front-end can alter the volume of a sampler channel by sending
+   the following command:
 
+      SET CHANNEL VOLUME <sampler-channel> <volume>
 
    Where <volume> is an optionally dotted positive number (a value
    smaller than 1.0 means attenuation, whereas a value greater than 1.0
@@ -2585,12 +3210,57 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if channel volume was set, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Examples:
+
+
+
+6.4.22.  Muting a sampler channel
+
+   The front-end can mute/unmute a specific sampler channel by sending
+   the following command:
+
+      SET CHANNEL MUTE <sampler-channel> <mute>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command and <mute> should be replaced either by "1"
+   to mute the channel or "0" to unmute the channel.
+
+   Possible Answers:
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 58]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if the channel was muted/unmuted, but there are noteworthy
+         issue(s) related, providing an appropriate warning code and
+         warning message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2598,7 +3268,496 @@
 
 
 
-5.4.22  Resetting 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:
+
+      SET CHANNEL SOLO <sampler-channel> <solo>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command and <solo> should be replaced either by "1"
+   to solo the channel or "0" to unsolo the channel.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if the channel was soloed/unsoloed, but there are noteworthy
+         issue(s) related, providing an appropriate warning code and
+         warning message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 59]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   Examples:
+
+
+
+6.4.24.  Assigning a MIDI instrument map to a sampler channel
+
+   The front-end can assign a MIDI instrument map to a specific sampler
+   channel by sending the following command:
+
+      SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command and <map> can have the following
+   possibilites:
+
+      "NONE" -
+
+         This is the default setting.  In this case the sampler channel
+         is not assigned any MIDI instrument map and thus will ignore
+         all MIDI program change messages.
+
+      "DEFAULT" -
+
+         The sampler channel will always use the default MIDI instrument
+         map to handle MIDI program change messages.
+
+      numeric ID -
+
+         You can assign a specific MIDI instrument map by replacing
+         <map> with the respective numeric ID of the MIDI instrument map
+         as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
+         command.  Once that map will be deleted, the sampler channel
+         would fall back to "NONE".
+
+   Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
+   regarding MIDI instrument mapping.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 60]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   Examples:
+
+
+
+6.4.25.  Adding an effect send to a sampler channel
+
+   The front-end can create an additional effect send on a specific
+   sampler channel by sending the following command:
+
+      CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command, that is the sampler channel on which the
+   effect send should be created on, <midi-ctrl> is a number between
+   0..127 defining the MIDI controller which can alter the effect send
+   level and <name> is an optional argument defining a name for the
+   effect send entity.  The name does not have to be unique.
+
+   By default, that is as initial routing, the effect send's audio
+   channels are automatically routed to the last audio channels of the
+   sampler channel's audio output device, that way you can i.e. first
+   increase the amount of audio channels on the audio output device for
+   having dedicated effect send output channels and when "CREATE
+   FX_SEND" is called, those channels will automatically be picked.  You
+   can alter the destination channels however with "SET FX_SEND
+   AUDIO_OUTPUT_CHANNEL" (Section 6.4.30).
+
+   Note: Create effect sends on a sampler channel only when needed,
+   because having effect sends on a sampler channel will decrease
+   runtime performance, because for implementing channel effect sends,
+   separate (sampler channel local) audio buffers are needed to render
+   and mix the voices and route the audio signal afterwards to the
+   master outputs and effect send outputs (along with their respective
+   effect send levels).  A sampler channel without effect sends however
+   can mix its voices directly into the audio output devices's audio
+   buffers and is thus faster.
+
+   Possible Answers:
+
+      "OK[<fx-send-id>]" -
+
+         in case a new effect send could be added to the sampler
+         channel, where <fx-send-id> reflects the unique ID of the newly
+         created effect send entity
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 61]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "ERR:<error-code>:<error-message>" -
+
+         when a new effect send could not be added, i.e. due to invalid
+         parameters
+
+   Examples:
+
+      C: "CREATE FX_SEND 0 91 'Reverb Send'"
+
+      S: "OK[0]"
+
+      C: "CREATE FX_SEND 0 93"
+
+      S: "OK[1]"
+
+6.4.26.  Removing an effect send from a sampler channel
+
+   The front-end can remove an existing effect send on a specific
+   sampler channel by sending the following command:
+
+      DESTROY FX_SEND <sampler-channel> <fx-send-id>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command, that is the sampler channel from which the
+   effect send should be removed from and <fx-send-id> is the respective
+   effect send number as returned by the "CREATE FX_SEND"
+   (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Example:
+
+      C: "DESTROY FX_SEND 0 0"
+
+      S: "OK"
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 62]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+6.4.27.  Getting amount of effect sends on a sampler channel
+
+   The front-end can ask for the amount of effect sends on a specific
+   sampler channel by sending the following command:
+
+      GET FX_SENDS <sampler-channel>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command.
+
+   Possible Answers:
+
+      The sampler will answer by returning the number of effect sends on
+      the given sampler channel.
+
+   Example:
+
+      C: "GET FX_SENDS 0"
+
+      S: "2"
+
+6.4.28.  Listing all effect sends on a sampler channel
+
+   The front-end can ask for a list of effect sends on a specific
+   sampler channel by sending the following command:
+
+      LIST FX_SENDS <sampler-channel>
+
+   Where <sampler-channel> is the respective sampler channel number as
+   returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
+   (Section 6.4.4) command.
+
+   Possible Answers:
+
+      The sampler will answer by returning a comma separated list with
+      all effect sends' numerical IDs on the given sampler channel.
+
+   Examples:
+
+      C: "LIST FX_SENDS 0"
+
+      S: "0,1"
+
+      C: "LIST FX_SENDS 1"
+
+      S: ""
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 63]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+6.4.29.  Getting effect send information
+
+   The front-end can ask for the current settings of an effect send
+   entity by sending the following command:
+
+      GET FX_SEND INFO <sampler-channel> <fx-send-id>
+
+   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 <fx-send-id> reflects the numerical ID of the effect send
+   entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
+   FX_SENDS" (Section 6.4.28) command.
+
+   Possible Answers:
+
+      The sampler will answer by sending a <CRLF> separated list.  Each
+      answer line begins with the settings category name followed by a
+      colon and then a space character <SP> and finally the info
+      character string to that setting category.  At the moment the
+      following categories are defined:
+
+
+
+         NAME -
+
+            name of the effect send entity
+
+         MIDI_CONTROLLER -
+
+            a value between 0 and 127 reflecting the MIDI controller
+            which is able to modify the effect send's send level
+
+         LEVEL -
+
+            optionally dotted number reflecting the effect send's
+            current send level (where a value < 1.0 means attenuation
+            and a value > 1.0 means amplification)
+
+         AUDIO_OUTPUT_ROUTING -
+
+            comma separated list which reflects to which audio channel
+            of the selected audio output device each effect send output
+            channel is routed to, e.g. "0,3" would mean the effect
+            send's output channel 0 is routed to channel 0 of the audio
+            output device and the effect send's output channel 1 is
+            routed to the channel 3 of the audio output device (see "SET
+            FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.30) for details)
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 64]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   The mentioned fields above don't have to be in particular order.
+
+   Example:
+
+      C: "GET FX_SEND INFO 0 0"
+
+      S: "NAME: Reverb Send"
+
+         "MIDI_CONTROLLER: 91"
+
+         "LEVEL: 0.3"
+
+         "AUDIO_OUTPUT_ROUTING: 2,3"
+
+         "."
+
+6.4.30.  Altering effect send's audio routing
+
+   The front-end can alter the destination of an effect send's audio
+   channel on a specific sampler channel by sending the following
+   command:
+
+      SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
+      <audio-src> <audio-dst>
+
+   Where <sampler-chan> is the sampler channel number as returned by the
+   "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
+   command, <fx-send-id> reflects the numerical ID of the effect send
+   entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
+   FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
+   of the effect send's audio channel which should be rerouted and
+   <audio-dst> is the numerical ID of the audio channel of the selected
+   audio output device where <audio-src> should be routed to.
+
+   Note that effect sends can only route audio to the same audio output
+   device as assigned to the effect send's sampler channel.  Also note
+   that an effect send entity does always have exactly as much audio
+   channels as its sampler channel.  So if the sampler channel is
+   stereo, the effect send does have two audio channels as well.  Also
+   keep in mind that the amount of audio channels on a sampler channel
+   might be dependant not only to the deployed sampler engine on the
+   sampler channel, but also dependant to the instrument currently
+   loaded.  However you can (effectively) turn an i.e. stereo effect
+   send into a mono one by simply altering its audio routing
+   appropriately.
+
+   Possible Answers:
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 65]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if audio output channel was set, but there are noteworthy
+         issue(s) related, providing an appropriate warning code and
+         warning message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Example:
+
+      C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
+
+      S: "OK"
+
+6.4.31.  Altering effect send's MIDI controller
+
+   The front-end can alter the MIDI controller of an effect send entity
+   by sending the following command:
+
+      SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
+      ctrl>
+
+   Where <sampler-chan> is the sampler channel number as returned by the
+   "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
+   command, <fx-send-id> reflects the numerical ID of the effect send
+   entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
+   FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
+   controller which shall be able to modify the effect send's send
+   level.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if MIDI controller was set, but there are noteworthy issue(s)
+         related, providing an appropriate warning code and warning
+         message
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 66]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Example:
+
+      C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
+
+      S: "OK"
+
+6.4.32.  Altering effect send's send level
+
+   The front-end can alter the current send level of an effect send
+   entity by sending the following command:
+
+      SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
+
+   Where <sampler-chan> is the sampler channel number as returned by the
+   "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
+   command, <fx-send-id> reflects the numerical ID of the effect send
+   entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
+   FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
+   dotted positive number (a value smaller than 1.0 means attenuation,
+   whereas a value greater than 1.0 means amplification) reflecting the
+   new send level.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if new send level was set, but there are noteworthy issue(s)
+         related, providing an appropriate warning code and warning
+         message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+   Example:
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 67]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      C: "SET FX_SEND LEVEL 0 0 0.15"
+
+      S: "OK"
+
+6.4.33.  Resetting a sampler channel
 
    The front-end can reset a particular sampler channel by sending the
    following command:
@@ -2613,12 +3772,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if channel was reset, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2626,24 +3790,24 @@
 
 
 
+6.5.  Controlling connection
 
+   The following commands are used to control the connection to
+   LinuxSampler.
 
-Schoenebeck            Expires November 19, 2005               [Page 47]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+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:
 
 
 
-5.5  Controlling connection
 
-   The following commands are used to control the connection to
-   LinuxSampler.
 
-5.5.1  Register front-end for receiving event messages
+Schoenebeck            Expires September 23, 2007              [Page 68]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
-   The front-end can register itself to the LinuxSampler application to
-   be informed about noteworthy events by sending this command:
 
       SUBSCRIBE <event-id>
 
@@ -2653,12 +3817,17 @@
    Possible Answers:
 
       "OK" -
+
          on success
+
       "WRN:<warning-code>:<warning-message>" -
+
          if registration succeeded, but there are noteworthy issue(s)
          related, providing an appropriate warning code and warning
          message
+
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2666,7 +3835,7 @@
 
 
 
-5.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:
@@ -2679,21 +3848,25 @@
    Possible Answers:
 
       "OK" -
+
          on success
 
+      "WRN:<warning-code>:<warning-message>" -
+
+         if unregistration succeeded, but there are noteworthy issue(s)
+         related, providing an appropriate warning code and warning
+         message
+
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 48]
+Schoenebeck            Expires September 23, 2007              [Page 69]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-      "WRN:<warning-code>:<warning-message>" -
-         if unregistration succeeded, but there are noteworthy issue(s)
-         related, providing an appropriate warning code and warning
-         message
       "ERR:<error-code>:<error-message>" -
+
          in case it failed, providing an appropriate error code and
          error message
 
@@ -2701,7 +3874,7 @@
 
 
 
-5.5.3  Enable or disable echo of commands
+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:
@@ -2718,15 +3891,18 @@
    Possible Answers:
 
       "OK" -
+
          usually
+
       "ERR:<error-code>:<error-message>" -
-         on syntax error, e.g.  non boolean value
+
+         on syntax error, e.g. non boolean value
 
    Examples:
 
 
 
-5.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:
@@ -2740,16 +3916,40 @@
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 49]
+Schoenebeck            Expires September 23, 2007              [Page 70]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-5.6  Global commands
+6.6.  Global commands
 
    The following commands have global impact on the sampler.
 
-5.6.1  Reset sampler
+6.6.1.  Current number of active voices
+
+   The front-end can ask for the current number of active voices on the
+   sampler by sending the following command:
+
+      GET TOTAL_VOICE_COUNT
+
+   Possible Answers:
+
+      LinuxSampler will answer by returning the number of all active
+      voices on the sampler.
+
+6.6.2.  Maximum amount of active voices
+
+   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.3.  Reset sampler
 
    The front-end can reset the whole sampler by sending the following
    command:
@@ -2759,83 +3959,1347 @@
    Possible Answers:
 
       "OK" -
+
+         always
+
+   Examples:
+
+
+
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 71]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+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
+
+   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 information category.  At the moment the
+      following categories are defined:
+
+
+
+         DESCRIPTION -
+
+            arbitrary textual description about the sampler
+
+         VERSION -
+
+            version of the sampler
+
+         PROTOCOL_VERSION -
+
+            version of the LSCP specification the sampler complies with
+            (see Section 2 for details)
+
+   The mentioned fields above don't have to be in particular order.
+   Other fields might be added in future.
+
+6.6.5.  Getting global volume attenuation
+
+   The client can ask for the current global sampler-wide volume
+   attenuation by sending the following command:
+
+      GET VOLUME
+
+   Possible Answers:
+
+      The sampler will always answer by returning the optional dotted
+      floating point coefficient, reflecting the current global volume
+      attenuation.
+
+   Note: it is up to the respective sampler engine whether to obey that
+   global volume parameter or not, but in general all engines SHOULD use
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 72]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   this parameter.
+
+6.6.6.  Setting global volume attenuation
+
+   The client can alter the current global sampler-wide volume
+   attenuation by sending the following command:
+
+      SET VOLUME <volume>
+
+   Where <volume> should be replaced by the optional dotted floating
+   point value, reflecting the new global volume parameter.  This value
+   might usually be in the range between 0.0 and 1.0, that is for
+   attenuating the overall volume.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "WRN:<warning-code>:<warning-message>" -
+
+         if the global volume was set, but there are noteworthy issue(s)
+         related, providing an appropriate warning code and warning
+         message
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case it failed, providing an appropriate error code and
+         error message
+
+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.
+
+   The sampler allows to manage an arbitrary amount of MIDI instrument
+   maps which define which instrument to load on which MIDI program
+   change message.
+
+   By default, that is when the sampler is launched, there is no map,
+   thus the sampler will simply ignore all program change messages.  The
+   front-end has to explicitly create at least one map, add entries to
+   the map and tell the respective sampler channel(s) which MIDI
+   instrument map to use, so the sampler knows how to react on a given
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 73]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   program change message on the respective sampler channel, that is by
+   switching to the respectively defined engine type and loading the
+   respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
+   (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
+   channel.
+
+   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 a new MIDI instrument map
+
+   The front-end can add a new MIDI instrument map by sending the
+   following command:
+
+      ADD MIDI_INSTRUMENT_MAP [<name>]
+
+   Where <name> is an optional argument allowing to assign a custom name
+   to the new map.  MIDI instrument Map names do not have to be unique.
+
+   Possible Answers:
+
+      "OK[<map>]" -
+
+         in case a new MIDI instrument map could be added, where <map>
+         reflects the unique ID of the newly created MIDI instrument map
+
+      "ERR:<error-code>:<error-message>" -
+
+         when a new map could not be created, which might never occur in
+         practice
+
+   Examples:
+
+      C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
+
+      S: "OK[0]"
+
+      C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
+
+      S: "OK[1]"
+
+      C: "ADD MIDI_INSTRUMENT_MAP"
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 74]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      S: "OK[5]"
+
+6.7.2.  Delete one particular or all MIDI instrument maps
+
+   The front-end can delete a particular MIDI instrument map by sending
+   the following command:
+
+      REMOVE MIDI_INSTRUMENT_MAP <map>
+
+   Where <map> reflects the unique ID of the map to delete as returned
+   by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
+
+   The front-end can delete all MIDI instrument maps by sending the
+   following command:
+
+      REMOVE MIDI_INSTRUMENT_MAP ALL
+
+   Possible Answers:
+
+      "OK" -
+
+         in case the map(s) could be deleted
+
+      "ERR:<error-code>:<error-message>" -
+
+         when the given map does not exist
+
+   Examples:
+
+      C: "REMOVE MIDI_INSTRUMENT_MAP 0"
+
+      S: "OK"
+
+      C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
+
+      S: "OK"
+
+6.7.3.  Get amount of existing MIDI instrument maps
+
+   The front-end can retrieve the current amount of MIDI instrument maps
+   by sending the following command:
+
+      GET MIDI_INSTRUMENT_MAPS
+
+   Possible Answers:
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 75]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      The sampler will answer by returning the current number of MIDI
+      instrument maps.
+
+   Example:
+
+      C: "GET MIDI_INSTRUMENT_MAPS"
+
+      S: "2"
+
+6.7.4.  Getting all created MIDI instrument maps
+
+   The number of MIDI instrument maps can change on runtime.  To get the
+   current list of MIDI instrument maps, the front-end can send the
+   following command:
+
+      LIST MIDI_INSTRUMENT_MAPS
+
+   Possible Answers:
+
+      The sampler will answer by returning a comma separated list with
+      all MIDI instrument maps' numerical IDs.
+
+   Example:
+
+      C: "LIST MIDI_INSTRUMENT_MAPS"
+
+      S: "0,1,5,12"
+
+6.7.5.  Getting MIDI instrument map information
+
+   The front-end can ask for the current settings of a MIDI instrument
+   map by sending the following command:
+
+      GET MIDI_INSTRUMENT_MAP INFO <map>
+
+   Where <map> is the numerical ID of the map the front-end is
+   interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
+   (Section 6.7.4) command.
+
+   Possible Answers:
+
+      LinuxSampler will answer by sending a <CRLF> separated list.  Each
+      answer line begins with the settings category name followed by a
+      colon and then a space character <SP> and finally the info
+      character string to that setting category.  At the moment the
+      following categories are defined:
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 76]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+
+
+         NAME -
+
+            custom name of the given map, which does not have to be
+            unique
+
+   The mentioned fields above don't have to be in particular order.
+
+   Example:
+
+      C: "GET MIDI_INSTRUMENT_MAP INFO 0"
+
+      S: "NAME: Standard Map"
+
+         "."
+
+6.7.6.  Renaming a MIDI instrument map
+
+   The front-end can alter the custom name of a MIDI instrument map by
+   sending the following command:
+
+      SET MIDI_INSTRUMENT_MAP NAME <map> <name>
+
+   Where <map> is the numerical ID of the map and <name> the new custom
+   name of the map, which does not have to be unique.
+
+   Possible Answers:
+
+      "OK" -
+
+         on success
+
+      "ERR:<error-code>:<error-message>" -
+
+         in case the given map does not exist
+
+   Example:
+
+      C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
+
+      S: "OK"
+
+6.7.7.  Create or replace a MIDI instrument map entry
+
+   The front-end can create a new or replace an existing entry in a
+   sampler's MIDI instrument map by sending the following command:
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 77]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
+      <engine_name> <filename> <instrument_index> <volume_value>
+      [<instr_load_mode>] [<name>]
+
+   Where <map> is the numeric ID of the map to alter, <midi_bank> is an
+   integer value between 0..16383 reflecting the MIDI bank select 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 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 September 23, 2007              [Page 78]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      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.11) 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.11)).
+
+   By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
+   completely established in the sampler.  The OPTIONAL "NON_MODAL"
+   argument however causes the respective "MAP MIDI_INSTRUMENT" command
+   to return immediately, that is to let the sampler establish the
+   mapping in the background.  So this argument might be especially
+   useful for mappings with a "PERSISTENT" type, because these have to
+   load the respective instruments immediately and might thus block for
+   a very long time.  It is recommended however to use the OPTIONAL
+   "NON_MODAL" argument only if really necessary, because it has the
+   following drawbacks: as "NON_MODAL" instructions return immediately,
+   they may not necessarily return an error i.e. when the given
+   instrument file turns out to be corrupt, beside that subsequent
+   commands in a LSCP instruction sequence might fail, because mandatory
+   mappings are not yet completed.
+
+   Possible Answers:
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 79]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "OK" -
+
+         usually
+
+      "ERR:<error-code>:<error-message>" -
+
+         when the given map or engine does not exist or a value is out
+         of range
+
+   Examples:
+
+      C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
+      0.8 PERSISTENT"
+
+      S: "OK"
+
+      C: "MAP MIDI_INSTRUMENT 0 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 0 1 0 gig '/usr/share/piano.gig' 0 0.25
+      'Silent Piano'"
+
+      S: "OK"
+
+      C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
+      foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
+
+      S: "OK"
+
+6.7.8.  Getting ammount of MIDI instrument map entries
+
+   The front-end can query the amount of currently existing entries in a
+   MIDI instrument map by sending the following command:
+
+      GET MIDI_INSTRUMENTS <map>
+
+   The front-end can query the amount of currently existing entries in
+   all MIDI instrument maps by sending the following command:
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 80]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      GET MIDI_INSTRUMENTS ALL
+
+   Possible Answers:
+
+      The sampler will answer by sending the current number of entries
+      in the MIDI instrument map(s).
+
+   Example:
+
+      C: "GET MIDI_INSTRUMENTS 0"
+
+      S: "234"
+
+      C: "GET MIDI_INSTRUMENTS ALL"
+
+      S: "954"
+
+6.7.9.  Getting indeces of all entries of a MIDI instrument map
+
+   The front-end can query a list of all currently existing entries in a
+   certain MIDI instrument map by sending the following command:
+
+      LIST MIDI_INSTRUMENTS <map>
+
+   Where <map> is the numeric ID of the MIDI instrument map.
+
+   The front-end can query a list of all currently existing entries of
+   all MIDI instrument maps by sending the following command:
+
+      LIST MIDI_INSTRUMENTS ALL
+
+   Possible Answers:
+
+      The sampler will answer by sending a comma separated list of map
+      ID - MIDI bank - 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.11) command(s) are necessary to retrieve detailed
+      informations about each entry.
+
+   Example:
+
+      C: "LIST MIDI_INSTRUMENTS 0"
+
+      S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 81]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+6.7.10.  Remove an entry from the MIDI instrument map
+
+   The front-end can delete an entry from a MIDI instrument map by
+   sending the following command:
+
+      UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
+
+   Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
+   is an integer value between 0..16383 reflecting the MIDI bank value
+   and <midi_prog> an integer value between 0..127 reflecting the MIDI
+   program value of the map's entrie's key index triple.
+
+   Possible Answers:
+
+      "OK" -
+
+         usually
+
+      "ERR:<error-code>:<error-message>" -
+
+         when index out of bounds
+
+   Example:
+
+      C: "UNMAP MIDI_INSTRUMENT 0 2 127"
+
+      S: "OK"
+
+6.7.11.  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 <map> <midi_bank> <midi_prog>
+
+   Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
+   is an integer value between 0..16383 reflecting the MIDI bank value,
+   <midi_bank> and <midi_prog> an integer value between 0..127
+   reflecting the MIDI program value of the map's 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:
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 82]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "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.7) 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.
+
+      "LOAD_MODE" -
+
+         Life time of instrument (see "MAP MIDI_INSTRUMENT"
+         (Section 6.7.7) 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 1 45 120"
+
+      S: "NAME: Drums for Foo Song"
+
+         "ENGINE_NAME: GigEngine"
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 83]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+         "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
+
+         "INSTRUMENT_NR: 0"
+
+         "INSTRUMENT_NAME: Joe's Drumkit"
+
+         "LOAD_MODE: PERSISTENT"
+
+         "VOLUME: 1.0"
+
+         "."
+
+6.7.12.  Clear MIDI instrument map
+
+   The front-end can clear a whole MIDI instrument map, that is delete
+   all its entries by sending the following command:
+
+      CLEAR MIDI_INSTRUMENTS <map>
+
+   Where <map> is the numeric ID of the map to clear.
+
+   The front-end can clear all MIDI instrument maps, that is delete all
+   entries of all maps by sending the following command:
+
+      CLEAR MIDI_INSTRUMENTS ALL
+
+   The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
+   only their entries, thus the map's settings like custom name will be
+   preservevd.
+
+   Possible Answers:
+
+      "OK" -
+
          always
 
    Examples:
 
+      C: "CLEAR MIDI_INSTRUMENTS 0"
+
+      S: "OK"
+
+      C: "CLEAR MIDI_INSTRUMENTS ALL"
+
+      S: "OK"
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 84]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+7.  Command Syntax
+
+   The grammar of the control protocol as descibed in Section 6 is
+   defined below using Backus-Naur Form (BNF as described in [RFC2234])
+   where applicable.
+
+   input =
+
+      line LF
+
+      / line CR LF
+
+   line =
+
+      /* epsilon (empty line ignored) */
+
+      / comment
+
+      / command
+
+      / error
+
+   comment =
+
+      '#'
+
+      / comment '#'
+
+      / comment SP
+
+      / comment number
+
+      / comment string
+
+   command =
+
+      ADD SP add_instruction
+
+      / MAP SP map_instruction
+
+      / UNMAP SP unmap_instruction
+
+      / GET SP get_instruction
+
+      / CREATE SP create_instruction
+
+      / DESTROY SP destroy_instruction
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 85]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / LIST SP list_instruction
+
+      / LOAD SP load_instruction
+
+      / REMOVE SP remove_instruction
+
+      / SET SP set_instruction
+
+      / SUBSCRIBE SP subscribe_event
+
+      / UNSUBSCRIBE SP unsubscribe_event
+
+      / SELECT SP text
+
+      / RESET SP reset_instruction
+
+      / CLEAR SP clear_instruction
+
+      / RESET
+
+      / QUIT
+
+   add_instruction =
+
+      CHANNEL
+
+      / MIDI_INSTRUMENT_MAP
+
+      / MIDI_INSTRUMENT_MAP SP map_name
+
+   subscribe_event =
+
+      AUDIO_OUTPUT_DEVICE_COUNT
+
+      / AUDIO_OUTPUT_DEVICE_INFO
+
+      / MIDI_INPUT_DEVICE_COUNT
+
+      / MIDI_INPUT_DEVICE_INFO
+
+      / CHANNEL_COUNT
+
+      / VOICE_COUNT
+
+      / STREAM_COUNT
+
+      / BUFFER_FILL
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 86]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / CHANNEL_INFO
+
+      / FX_SEND_COUNT
+
+      / FX_SEND_INFO
+
+      / MIDI_INSTRUMENT_MAP_COUNT
+
+      / MIDI_INSTRUMENT_MAP_INFO
+
+      / MIDI_INSTRUMENT_COUNT
+
+      / MIDI_INSTRUMENT_INFO
+
+      / MISCELLANEOUS
+
+      / TOTAL_VOICE_COUNT
+
+      / GLOBAL_INFO
+
+   unsubscribe_event =
+
+      AUDIO_OUTPUT_DEVICE_COUNT
+
+      / AUDIO_OUTPUT_DEVICE_INFO
+
+      / MIDI_INPUT_DEVICE_COUNT
+
+      / MIDI_INPUT_DEVICE_INFO
+
+      / CHANNEL_COUNT
+
+      / VOICE_COUNT
+
+      / STREAM_COUNT
+
+      / BUFFER_FILL
+
+      / CHANNEL_INFO
+
+      / FX_SEND_COUNT
+
+      / FX_SEND_INFO
+
+      / MIDI_INSTRUMENT_MAP_COUNT
+
+      / MIDI_INSTRUMENT_MAP_INFO
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 87]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / MIDI_INSTRUMENT_COUNT
+
+      / MIDI_INSTRUMENT_INFO
+
+      / MISCELLANEOUS
+
+      / TOTAL_VOICE_COUNT
+
+      / GLOBAL_INFO
+
+   map_instruction =
+
+      MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
+      engine_name SP filename SP instrument_index SP volume_value
+
+      / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
+      SP engine_name SP filename SP instrument_index SP volume_value SP
+      instr_load_mode
+
+      / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
+      SP engine_name SP filename SP instrument_index SP volume_value SP
+      entry_name
+
+      / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
+      SP engine_name SP filename SP instrument_index SP volume_value SP
+      instr_load_mode SP entry_name
+
+   unmap_instruction =
+
+      MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
+
+   remove_instruction =
+
+      CHANNEL SP sampler_channel
+
+      / MIDI_INSTRUMENT_MAP SP midi_map
+
+      / MIDI_INSTRUMENT_MAP SP ALL
+
+   get_instruction =
+
+      AVAILABLE_ENGINES
+
+      / AVAILABLE_MIDI_INPUT_DRIVERS
+
+      / MIDI_INPUT_DRIVER SP INFO SP string
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 88]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
+
+      / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
+      key_val_list
+
+      / AVAILABLE_AUDIO_OUTPUT_DRIVERS
+
+      / AUDIO_OUTPUT_DRIVER SP INFO SP string
+
+      / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
+
+      / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
+      key_val_list
+
+      / AUDIO_OUTPUT_DEVICES
+
+      / MIDI_INPUT_DEVICES
+
+      / AUDIO_OUTPUT_DEVICE SP INFO SP number
+
+      / MIDI_INPUT_DEVICE SP INFO SP number
+
+      / MIDI_INPUT_PORT SP INFO SP number SP number
+
+      / MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
+
+      / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
+
+      / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
+      string
+
+      / CHANNELS
+
+      / CHANNEL SP INFO SP sampler_channel
+
+      / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
+
+      / CHANNEL SP STREAM_COUNT SP sampler_channel
+
+      / CHANNEL SP VOICE_COUNT SP sampler_channel
+
+      / ENGINE SP INFO SP engine_name
+
+      / SERVER SP INFO
+
+      / TOTAL_VOICE_COUNT
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 89]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / TOTAL_VOICE_COUNT_MAX
+
+      / MIDI_INSTRUMENTS SP midi_map
+
+      / MIDI_INSTRUMENTS SP ALL
+
+      / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
+
+      / MIDI_INSTRUMENT_MAPS
+
+      / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
+
+      / FX_SENDS SP sampler_channel
+
+      / FX_SEND SP INFO SP sampler_channel SP fx_send_id
+
+      / VOLUME
+
+   set_instruction =
+
+      AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
+      param_val_list
+
+      / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
+      param_val_list
+
+      / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
+      param_val_list
+
+      / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
+      param_val_list
+
+      / CHANNEL SP set_chan_instruction
+
+      / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
+
+      / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
+      SP audio_channel_index SP audio_channel_index
+
+      / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
+      midi_ctrl
+
+      / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
+      volume_value
+
+      / ECHO SP boolean
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 90]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / VOLUME SP volume_value
+
+   create_instruction =
+
+      AUDIO_OUTPUT_DEVICE SP string SP key_val_list
+
+      / AUDIO_OUTPUT_DEVICE SP string
+
+      / MIDI_INPUT_DEVICE SP string SP key_val_list
+
+      / MIDI_INPUT_DEVICE SP string
+
+      / FX_SEND SP sampler_channel SP midi_ctrl
+
+      / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
+
+   reset_instruction =
+
+      CHANNEL SP sampler_channel
+
+   clear_instruction =
+
+      MIDI_INSTRUMENTS SP midi_map
+
+      / MIDI_INSTRUMENTS SP ALL
+
+   destroy_instruction =
+
+      AUDIO_OUTPUT_DEVICE SP number
+
+      / MIDI_INPUT_DEVICE SP number
 
+      / FX_SEND SP sampler_channel SP fx_send_id
 
+   load_instruction =
 
+      INSTRUMENT SP load_instr_args
 
+      / ENGINE SP load_engine_args
 
+   set_chan_instruction =
 
+      AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
 
+      / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
+      SP audio_channel_index
 
 
 
 
 
+Schoenebeck            Expires September 23, 2007              [Page 91]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
+
+      / MIDI_INPUT SP sampler_channel SP device_index SP
+      midi_input_port_index SP midi_input_channel_index
+
+      / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
+
+      / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
+
+      / MIDI_INPUT_CHANNEL SP sampler_channel SP
+      midi_input_channel_index
+
+      / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
+
+      / VOLUME SP sampler_channel SP volume_value
+
+      / MUTE SP sampler_channel SP boolean
+
+      / SOLO SP sampler_channel SP boolean
+
+      / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
+
+      / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
+
+      / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
+
+   modal_arg =
+
+      /* epsilon (empty argument) */
+
+      / NON_MODAL SP
+
+   key_val_list =
+
+      string '=' param_val_list
+
+      / key_val_list SP string '=' param_val_list
+
+   buffer_size_type =
+
+      BYTES
+
+      / PERCENTAGE
+
+   list_instruction =
+
+      AUDIO_OUTPUT_DEVICES
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 92]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      / MIDI_INPUT_DEVICES
+
+      / CHANNELS
+
+      / AVAILABLE_ENGINES
 
+      / AVAILABLE_MIDI_INPUT_DRIVERS
 
+      / AVAILABLE_AUDIO_OUTPUT_DRIVERS
 
+      / MIDI_INSTRUMENTS SP midi_map
 
+      / MIDI_INSTRUMENTS SP ALL
 
+      / MIDI_INSTRUMENT_MAPS
 
+      / FX_SENDS SP sampler_channel
 
+   load_instr_args =
 
+      filename SP instrument_index SP sampler_channel
 
+      / NON_MODAL SP filename SP instrument_index SP sampler_channel
 
+   load_engine_args =
 
+      engine_name SP sampler_channel
 
+   instr_load_mode =
 
+      ON_DEMAND
 
+      / ON_DEMAND_HOLD
 
+      / PERSISTENT
 
+   device_index =
 
+      number
 
+   audio_channel_index =
 
+      number
 
+   audio_output_type_name =
 
-Schoenebeck            Expires November 19, 2005               [Page 50]
+      string
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 93]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   midi_input_port_index =
+
+      number
+
+   midi_input_channel_index =
+
+      number
+
+      / ALL
+
+   midi_input_type_name =
+
+      string
+
+   midi_map =
+
+      number
+
+   midi_bank =
+
+      number
+
+   midi_prog =
 
+      number
 
-6.  Command Syntax
+   midi_ctrl =
 
-   TODO: will soon automatically included from src/network/lscp.y,
-   meanwhile have a look at that file to get the exact definition of the
-   command syntax.
+      number
 
+   volume_value =
 
+      dotnum
 
+      / number
 
+   sampler_channel =
 
+      number
 
+   instrument_index =
 
+      number
 
+   fx_send_id =
 
+      number
 
 
 
 
+Schoenebeck            Expires September 23, 2007              [Page 94]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+   engine_name =
 
+      string
 
+   filename =
 
+      stringval
 
+   map_name =
 
+      stringval
 
+   entry_name =
 
+      stringval
 
+   fx_send_name =
 
+      stringval
 
+   param_val_list =
 
+      param_val
 
+      / param_val_list','param_val
 
+   param_val =
 
+      string
 
+      / stringval
 
+      / number
 
+      / dotnum
 
 
 
@@ -2852,17 +5316,92 @@
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 51]
+Schoenebeck            Expires September 23, 2007              [Page 95]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-7.  Events
+8.  Events
 
    This chapter will describe all currently defined events supported by
    LinuxSampler.
 
-7.1  Number of sampler channels changed
+8.1.  Number of audio output devices changed
+
+   Client may want to be notified when the total number of audio output
+   devices on the back-end changes by issuing the following command:
+
+      SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
+
+   Server will start sending the following notification messages:
+
+      "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
+
+   where <devices> will be replaced by the new number of audio output
+   devices.
+
+8.2.  Audio output device's settings changed
+
+   Client may want to be notified when changes were made to audio output
+   devices on the back-end by issuing the following command:
+
+      SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
+
+   Server will start sending the following notification messages:
+
+      "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
+
+   where <device-id> will be replaced by the numerical ID of the audio
+   output device, which settings has been changed.  The front-end will
+   have to send the respective command to actually get the audio output
+   device info.  Because these messages will be triggered by LSCP
+   commands issued by other clients rather than real time events
+   happening on the server, it is believed that an empty notification
+   message is sufficient here.
+
+8.3.  Number of MIDI input devices changed
+
+   Client may want to be notified when the total number of MIDI input
+   devices on the back-end changes by issuing the following command:
+
+      SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
+
+   Server will start sending the following notification messages:
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 96]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
+
+   where <devices> will be replaced by the new number of MIDI input
+   devices.
+
+8.4.  MIDI input device's settings changed
+
+   Client may want to be notified when changes were made to MIDI input
+   devices on the back-end by issuing the following command:
+
+      SUBSCRIBE MIDI_INPUT_DEVICE_INFO
+
+   Server will start sending the following notification messages:
+
+      "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
+
+   where <device-id> will be replaced by the numerical ID of the MIDI
+   input device, which settings has been changed.  The front-end will
+   have to send the respective command to actually get the MIDI input
+   device info.  Because these messages will be triggered by LSCP
+   commands issued by other clients rather than real time events
+   happening on the server, it is believed that an empty notification
+   message is sufficient here.
+
+8.5.  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:
@@ -2876,22 +5415,31 @@
    where <channels> will be replaced by the new number of sampler
    channels.
 
-7.2  Number of active voices changed
+8.6.  Number of active voices changed
 
-   Client may want to be notified when the number of voices on the
-   back-end changes by issuing the following command:
+   Client may want to be notified when the number of voices on the back-
+   end changes by issuing the following command:
 
       SUBSCRIBE VOICE_COUNT
 
    Server will start sending the following notification messages:
 
-      "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>
+
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 97]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+      "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
 
    where <sampler-channel> will be replaced by the sampler channel the
    voice count change occurred and <voices> by the new number of active
    voices on that channel.
 
-7.3  Number of active disk streams changed
+8.7.  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
@@ -2905,17 +5453,9 @@
 
    where <sampler-channel> will be replaced by the sampler channel the
    stream count change occurred and <streams> by the new number of
-
-
-
-Schoenebeck            Expires November 19, 2005               [Page 52]
-
-Internet-Draft       LinuxSampler Control Protocol              May 2005
-
-
    active disk streams on that channel.
 
-7.4  Disk stream buffer fill state changed
+8.8.  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:
@@ -2928,11 +5468,11 @@
 
    where <sampler-channel> will be replaced by the sampler channel the
    buffer fill state change occurred on and <fill-data> will be replaced
-   by the buffer fill data for this channel as described in Section
-   5.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" (Section
-   5.4.13) command was issued on this channel.
+   by the buffer fill data for this channel as described in
+   Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
+   (Section 6.4.13) command was issued on this channel.
 
-7.5  Channel information changed
+8.9.  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:
@@ -2941,6 +5481,14 @@
 
    Server will start sending the following notification messages:
 
+
+
+
+Schoenebeck            Expires September 23, 2007              [Page 98]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
       "NOTIFY:CHANNEL_INFO:<sampler-channel>"
 
    where <sampler-channel> will be replaced by the sampler channel the
@@ -2950,66 +5498,153 @@
    rather than real time events happening on the server, it is believed
    that an empty notification message is sufficient here.
 
-7.6  Miscellaneous and debugging events
+8.10.  Number of effect sends 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 number of effect sends on a
+   particular sampler channel is changed by issuing the following
+   command:
 
-      SUBSCRIBE MISCELLANEOUS
+      SUBSCRIBE FX_SEND_COUNT
 
    Server will start sending the following notification messages:
 
-      "NOTIFY:MISCELLANEOUS:<string>"
+      "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
+
+   where <channel-id> will be replaced by the numerical ID of the
+   sampler channel, on which the effect sends number is changed and <fx-
+   sends> will be replaced by the new number of effect sends on that
+   channel.
+
+8.11.  Effect send information changed
+
+   Client may want to be notified when changes were made to effect sends
+   on a a particular sampler channel by issuing the following command:
+
+      SUBSCRIBE FX_SEND_INFO
+
+   Server will start sending the following notification messages:
+
+      "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
+
+   where <channel-id> will be replaced by the numerical ID of the
+   sampler channel, on which an effect send entity is changed and <fx-
+   send-id> will be replaced by the numerical ID of the changed effect
+   send.
 
+8.12.  Total number of active voices changed
+
+   Client may want to be notified when the total number of voices on the
+   back-end changes by issuing the following command:
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 53]
+
+
+Schoenebeck            Expires September 23, 2007              [Page 99]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-   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.
+      SUBSCRIBE TOTAL_VOICE_COUNT
 
+   Server will start sending the following notification messages:
 
+      "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
 
+   where <voices> will be replaced by the new number of all currently
+   active voices.
 
+8.13.  Number of MIDI instrument maps changed
 
+   Client may want to be notified when the number of MIDI instrument
+   maps on the back-end changes by issuing the following command:
 
+      SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
 
+   Server will start sending the following notification messages:
 
+      "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
 
+   where <maps> will be replaced by the new number of MIDI instrument
+   maps.
 
+8.14.  MIDI instrument map information changed
 
+   Client may want to be notified when changes were made to MIDI
+   instrument maps on the back-end by issuing the following command:
 
+      SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
 
+   Server will start sending the following notification messages:
 
+      "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
 
+   where <map-id> will be replaced by the numerical ID of the MIDI
+   instrument map, for which information changes occurred.  The front-
+   end will have to send the respective command to actually get the MIDI
+   instrument map info.  Because these messages will be triggered by
+   LSCP commands issued by other clients rather than real time events
+   happening on the server, it is believed that an empty notification
+   message is sufficient here.
 
+8.15.  Number of MIDI instruments changed
 
+   Client may want to be notified when the number of MIDI instrument
+   maps on the back-end changes by issuing the following command:
 
 
 
 
 
+Schoenebeck            Expires September 23, 2007             [Page 100]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
+      SUBSCRIBE MIDI_INSTRUMENT_COUNT
 
+   Server will start sending the following notification messages:
 
+      "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
 
+   where <map-id> is the numerical ID of the MIDI instrument map, in
+   which the nuber of instruments has changed and <instruments> will be
+   replaced by the new number of MIDI instruments in the specified map.
 
+8.16.  MIDI instrument information changed
 
+   Client may want to be notified when changes were made to MIDI
+   instruments on the back-end by issuing the following command:
 
+      SUBSCRIBE MIDI_INSTRUMENT_INFO
 
+   Server will start sending the following notification messages:
 
+      "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
 
+   where <map-id> will be replaced by the numerical ID of the MIDI
+   instrument map, in which a MIDI instrument is changed. <bank> and
+   <program> specifies the location of the changed MIDI instrument in
+   the map.  The front-end will have to send the respective command to
+   actually get the MIDI instrument info.  Because these messages will
+   be triggered by LSCP commands issued by other clients rather than
+   real time events happening on the server, it is believed that an
+   empty notification message is sufficient here.
 
+8.17.  Global settings changed
 
+   Client may want to be notified when changes to the global settings of
+   the sampler were made by issuing the following command:
 
+      SUBSCRIBE GLOBAL_INFO
 
+   Server will start sending the following types of notification
+   messages:
 
+      "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
+      volume of the sampler is changed, where <volume> will be replaced
+      by the optional dotted floating point value, reflecting the new
+      global volume parameter.
 
 
 
@@ -3017,15 +5652,68 @@
 
 
 
+Schoenebeck            Expires September 23, 2007             [Page 101]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
+8.18.  Miscellaneous and debugging events
 
-Schoenebeck            Expires November 19, 2005               [Page 54]
+   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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007             [Page 102]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-8.  Security Considerations
+9.  Security Considerations
 
    As there is so far no method of authentication and authorization
    defined and so not required for a client applications to succeed to
@@ -3076,37 +5764,30 @@
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 55]
+Schoenebeck            Expires September 23, 2007             [Page 103]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-9.  Acknowledgments
+10.  Acknowledgments
 
    This document has benefited greatly from the comments of the
    following people, discussed on the LinuxSampler developer's mailing
    list:
 
       Rui Nuno Capela
+
       Vladimir Senkov
+
       Mark Knecht
+
       Grigor Iliev
 
-10  References
 
-   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
-              Requirement Levels", BCP 14, RFC 2119, March 1997.
 
 
-Author's Address
 
-   C. Schoenebeck
-   Interessengemeinschaft Software Engineering e. V.
-   Max-Planck-Str. 39
-   74081 Heilbronn
-   Germany
 
-   EMail: schoenebeck at software minus engineering dot org
 
 
 
@@ -3132,75 +5813,86 @@
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 56]
+
+
+
+
+
+
+
+Schoenebeck            Expires September 23, 2007             [Page 104]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+11.  References
+
+   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
+              Requirement Levels", RFC 2119, 1997.
+
+   [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
+              Specifications", RFC 2234, 1997.
+
+   [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
+              CONTROL PROTOCOL", RFC 793, 1981.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
-Intellectual Property Statement
 
-   The IETF takes no position regarding the validity or scope of any
-   intellectual property or other rights that might be claimed to
-   pertain to the implementation or use of the technology described in
-   this document or the extent to which any license under such rights
-   might or might not be available; neither does it represent that it
-   has made any effort to identify any such rights.  Information on the
-   IETF's procedures with respect to rights in standards-track and
-   standards-related documentation can be found in BCP-11.  Copies of
-   claims of rights made available for publication and any assurances of
-   licenses to be made available, or the result of an attempt made to
-   obtain a general license or permission for the use of such
-   proprietary rights by implementors or users of this specification can
-   be obtained from the IETF Secretariat.
 
-   The IETF invites any interested party to bring to its attention any
-   copyrights, patents or patent applications, or other proprietary
-   rights which may cover technology that may be required to practice
-   this standard.  Please address the information to the IETF Executive
-   Director.
 
 
-Full Copyright Statement
 
-   Copyright (C) The Internet Society (2005).  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
-   or assist in its implementation may be prepared, copied, published
-   and distributed, in whole or in part, without restriction of any
-   kind, provided that the above copyright notice and this paragraph are
-   included on all such copies and derivative works.  However, this
-   document itself may not be modified in any way, such as by removing
-   the copyright notice or references to the Internet Society or other
-   Internet organizations, except as needed for the purpose of
-   developing Internet standards in which case the procedures for
-   copyrights defined in the Internet Standards process must be
-   followed, or as required to translate it into languages other than
-   English.
 
-   The limited permissions granted above are perpetual and will not be
-   revoked by the Internet Society or its successors or assignees.
 
-   This document and the information contained herein is provided on an
-   "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
-   TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
-   BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 57]
+
+
+
+
+Schoenebeck            Expires September 23, 2007             [Page 105]
 
-Internet-Draft       LinuxSampler Control Protocol              May 2005
+Internet-Draft        LinuxSampler Control Protocol           March 2007
 
 
-   HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
-   MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+Author's Address
+
+   C. Schoenebeck
+   Interessengemeinschaft Software Engineering e. V.
+   Max-Planck-Str. 39
+   74081 Heilbronn
+   Germany
+
+   Email: schoenebeck at software minus engineering dot org
 
 
-Acknowledgment
 
-   Funding for the RFC Editor function is currently provided by the
-   Internet Society.
 
 
 
@@ -3240,9 +5932,61 @@
 
 
 
+Schoenebeck            Expires September 23, 2007             [Page 106]
+
+Internet-Draft        LinuxSampler Control Protocol           March 2007
+
+
+Full Copyright Statement
+
+   Copyright (C) The IETF Trust (2007).
+
+   This document is subject to the rights, licenses and restrictions
+   contained in BCP 78, and except as set forth therein, the authors
+   retain all their rights.
+
+   This document and the information contained herein are provided on an
+   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
+   OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
+   THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
+   OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
+   THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
+   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+
+
+Intellectual Property
+
+   The IETF takes no position regarding the validity or scope of any
+   Intellectual Property Rights or other rights that might be claimed to
+   pertain to the implementation or use of the technology described in
+   this document or the extent to which any license under such rights
+   might or might not be available; nor does it represent that it has
+   made any independent effort to identify any such rights.  Information
+   on the procedures with respect to rights in RFC documents can be
+   found in BCP 78 and BCP 79.
+
+   Copies of IPR disclosures made to the IETF Secretariat and any
+   assurances of licenses to be made available, or the result of an
+   attempt made to obtain a general license or permission for the use of
+   such proprietary rights by implementers or users of this
+   specification can be obtained from the IETF on-line IPR repository at
+   http://www.ietf.org/ipr.
+
+   The IETF invites any interested party to bring to its attention any
+   copyrights, patents or patent applications, or other proprietary
+   rights that may cover technology that may be required to implement
+   this standard.  Please address the information to the IETF at
+   ietf-ipr@ietf.org.
+
+
+Acknowledgment
+
+   Funding for the RFC Editor function is provided by the IETF
+   Administrative Support Activity (IASA).
+
 
 
 
 
-Schoenebeck            Expires November 19, 2005               [Page 58]
+Schoenebeck            Expires September 23, 2007             [Page 107]