/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 542 by senoner, Sun May 15 15:31:45 2005 UTC revision 1137 by iliev, Thu Mar 29 10:06:37 2007 UTC
# Line 1  Line 1 
1    
2    
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                           Interessengemeinschaft Software
6  Expires: November 7, 2005                              Engineering e. V.  Intended status: Standards Track                       Engineering e. V.
7                                                               May 9, 2005  Expires: September 30, 2007                               March 29, 2007
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  lscp.txt                                  LSCP 1.2
12    
13  Status of this Memo  Status of this Memo
14    
15     This document is an Internet-Draft and is in full conformance with     By submitting this Internet-Draft, each author represents that any
16     all provisions of Section 10 of RFC2026.     applicable patent or other IPR claims of which he or she is aware
17       have been or will be disclosed, and any of which he or she becomes
18       aware will be disclosed, in accordance with Section 6 of BCP 79.
19    
20     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF), its areas, and its working groups.  Note that
22     other groups may also distribute working documents as     other groups may also distribute working documents as Internet-
23     Internet-Drafts.     Drafts.
24    
25     Internet-Drafts are draft documents valid for a maximum of six months     Internet-Drafts are draft documents valid for a maximum of six months
26     and may be updated, replaced, or obsoleted by other documents at any     and may be updated, replaced, or obsoleted by other documents at any
# Line 30  Status of this Memo Line 33  Status of this Memo
33     The list of Internet-Draft Shadow Directories can be accessed at     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.     http://www.ietf.org/shadow.html.
35    
36     This Internet-Draft will expire on November 7, 2005.     This Internet-Draft will expire on September 30, 2007.
37    
38  Copyright Notice  Copyright Notice
39    
40     Copyright (C) The Internet Society (2005).  All Rights Reserved.     Copyright (C) The IETF Trust (2007).
41    
 Abstract  
42    
    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.  
43    
44    
45    
# Line 52  Abstract Line 49  Abstract
49    
50    
51    
 Schoenebeck             Expires November 7, 2005                [Page 1]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
52    
53    
 Table of Contents  
54    
55     1.   Requirements notation  . . . . . . . . . . . . . . . . . . .   4  Schoenebeck            Expires September 30, 2007               [Page 1]
56     2.   Introduction . . . . . . . . . . . . . . . . . . . . . . . .   5  
57     3.   Focus of this protocol . . . . . . . . . . . . . . . . . . .   6  Internet-Draft        LinuxSampler Control Protocol           March 2007
    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 7, 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  
58    
59    
60    Abstract
61    
62       The LinuxSampler Control Protocol (LSCP) is an application-level
63       protocol primarily intended for local and remote controlling the
64       LinuxSampler backend application, which is a sophisticated server-
65       like console application essentially playing back audio samples and
66       manipulating the samples in real time to certain extent.
67    
68    
69    Table of Contents
70    
71       1.  Requirements notation . . . . . . . . . . . . . . . . . . . .   5
72       2.  Versioning of this specification  . . . . . . . . . . . . . .   6
73       3.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   7
74       4.  Focus of this protocol  . . . . . . . . . . . . . . . . . . .   8
75       5.  Communication Overview  . . . . . . . . . . . . . . . . . . .   9
76         5.1.  Request/response communication method . . . . . . . . . .   9
77           5.1.1.  Result format . . . . . . . . . . . . . . . . . . . .  10
78         5.2.  Subscribe/notify communication method . . . . . . . . . .  12
79       6.  Description for control commands  . . . . . . . . . . . . . .  14
80         6.1.  Ignored lines and comments  . . . . . . . . . . . . . . .  14
81         6.2.  Configuring audio drivers . . . . . . . . . . . . . . . .  14
82           6.2.1.  Getting amount of available audio output drivers  . .  15
83           6.2.2.  Getting all available audio output drivers  . . . . .  15
84           6.2.3.  Getting information about a specific audio output
85                   driver  . . . . . . . . . . . . . . . . . . . . . . .  15
86           6.2.4.  Getting information about specific audio output
87                   driver parameter  . . . . . . . . . . . . . . . . . .  16
88           6.2.5.  Creating an audio output device . . . . . . . . . . .  20
89           6.2.6.  Destroying an audio output device . . . . . . . . . .  21
90           6.2.7.  Getting all created audio output device count . . . .  22
91           6.2.8.  Getting all created audio output device list  . . . .  22
92           6.2.9.  Getting current settings of an audio output device  .  22
93           6.2.10. Changing settings of audio output devices . . . . . .  24
94           6.2.11. Getting information about an audio channel  . . . . .  25
95           6.2.12. Getting information about specific audio channel
96                   parameter . . . . . . . . . . . . . . . . . . . . . .  26
97           6.2.13. Changing settings of audio output channels  . . . . .  28
98         6.3.  Configuring MIDI input drivers  . . . . . . . . . . . . .  29
99           6.3.1.  Getting amount of available MIDI input drivers  . . .  30
100           6.3.2.  Getting all available MIDI input drivers  . . . . . .  30
101           6.3.3.  Getting information about a specific MIDI input
102                   driver  . . . . . . . . . . . . . . . . . . . . . . .  31
103           6.3.4.  Getting information about specific MIDI input
104                   driver parameter  . . . . . . . . . . . . . . . . . .  32
105           6.3.5.  Creating a MIDI input device  . . . . . . . . . . . .  34
106           6.3.6.  Destroying a MIDI input device  . . . . . . . . . . .  35
107           6.3.7.  Getting all created MIDI input device count . . . . .  36
108    
109    
110    
111    Schoenebeck            Expires September 30, 2007               [Page 2]
112    
113    Internet-Draft        LinuxSampler Control Protocol           March 2007
114    
115    
116           6.3.8.  Getting all created MIDI input device list  . . . . .  36
117           6.3.9.  Getting current settings of a MIDI input device . . .  37
118           6.3.10. Changing settings of MIDI input devices . . . . . . .  38
119           6.3.11. Getting information about a MIDI port . . . . . . . .  38
120           6.3.12. Getting information about specific MIDI port
121                   parameter . . . . . . . . . . . . . . . . . . . . . .  39
122           6.3.13. Changing settings of MIDI input ports . . . . . . . .  41
123         6.4.  Configuring sampler channels  . . . . . . . . . . . . . .  42
124           6.4.1.  Loading an instrument . . . . . . . . . . . . . . . .  42
125           6.4.2.  Loading a sampler engine  . . . . . . . . . . . . . .  43
126           6.4.3.  Getting all created sampler channel count . . . . . .  44
127           6.4.4.  Getting all created sampler channel list  . . . . . .  44
128           6.4.5.  Adding a new sampler channel  . . . . . . . . . . . .  44
129           6.4.6.  Removing a sampler channel  . . . . . . . . . . . . .  45
130           6.4.7.  Getting amount of available engines . . . . . . . . .  46
131           6.4.8.  Getting all available engines . . . . . . . . . . . .  46
132           6.4.9.  Getting information about an engine . . . . . . . . .  47
133           6.4.10. Getting sampler channel information . . . . . . . . .  48
134           6.4.11. Current number of active voices . . . . . . . . . . .  51
135           6.4.12. Current number of active disk streams . . . . . . . .  51
136           6.4.13. Current fill state of disk stream buffers . . . . . .  52
137           6.4.14. Setting audio output device . . . . . . . . . . . . .  53
138           6.4.15. Setting audio output type . . . . . . . . . . . . . .  53
139           6.4.16. Setting audio output channel  . . . . . . . . . . . .  54
140           6.4.17. Setting MIDI input device . . . . . . . . . . . . . .  55
141           6.4.18. Setting MIDI input type . . . . . . . . . . . . . . .  56
142           6.4.19. Setting MIDI input port . . . . . . . . . . . . . . .  56
143           6.4.20. Setting MIDI input channel  . . . . . . . . . . . . .  57
144           6.4.21. Setting channel volume  . . . . . . . . . . . . . . .  58
145           6.4.22. Muting a sampler channel  . . . . . . . . . . . . . .  58
146           6.4.23. Soloing a sampler channel . . . . . . . . . . . . . .  59
147           6.4.24. Assigning a MIDI instrument map to a sampler
148                   channel . . . . . . . . . . . . . . . . . . . . . . .  60
149           6.4.25. Adding an effect send to a sampler channel  . . . . .  61
150           6.4.26. Removing an effect send from a sampler channel  . . .  62
151           6.4.27. Getting amount of effect sends on a sampler channel .  63
152           6.4.28. Listing all effect sends on a sampler channel . . . .  63
153           6.4.29. Getting effect send information . . . . . . . . . . .  64
154           6.4.30. Changing effect send's name . . . . . . . . . . . . .  65
155           6.4.31. Altering effect send's audio routing  . . . . . . . .  66
156           6.4.32. Altering effect send's MIDI controller  . . . . . . .  67
157           6.4.33. Altering effect send's send level . . . . . . . . . .  67
158           6.4.34. Resetting a sampler channel . . . . . . . . . . . . .  68
159         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  69
160           6.5.1.  Register front-end for receiving event messages . . .  69
161           6.5.2.  Unregister front-end for not receiving event
162                   messages  . . . . . . . . . . . . . . . . . . . . . .  70
163           6.5.3.  Enable or disable echo of commands  . . . . . . . . .  70
164    
165    
166    
167    Schoenebeck            Expires September 30, 2007               [Page 3]
168    
169    Internet-Draft        LinuxSampler Control Protocol           March 2007
170    
171    
172           6.5.4.  Close client connection . . . . . . . . . . . . . . .  71
173         6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  71
174           6.6.1.  Current number of active voices . . . . . . . . . . .  71
175           6.6.2.  Maximum amount of active voices . . . . . . . . . . .  72
176           6.6.3.  Reset sampler . . . . . . . . . . . . . . . . . . . .  72
177           6.6.4.  General sampler informations  . . . . . . . . . . . .  72
178           6.6.5.  Getting global volume attenuation . . . . . . . . . .  73
179           6.6.6.  Setting global volume attenuation . . . . . . . . . .  73
180         6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  74
181           6.7.1.  Create a new MIDI instrument map  . . . . . . . . . .  74
182           6.7.2.  Delete one particular or all MIDI instrument maps . .  75
183           6.7.3.  Get amount of existing MIDI instrument maps . . . . .  76
184           6.7.4.  Getting all created MIDI instrument maps  . . . . . .  76
185           6.7.5.  Getting MIDI instrument map information . . . . . . .  77
186           6.7.6.  Renaming a MIDI instrument map  . . . . . . . . . . .  78
187           6.7.7.  Create or replace a MIDI instrument map entry . . . .  78
188           6.7.8.  Getting ammount of MIDI instrument map entries  . . .  81
189           6.7.9.  Getting indeces of all entries of a MIDI
190                   instrument map  . . . . . . . . . . . . . . . . . . .  82
191           6.7.10. Remove an entry from the MIDI instrument map  . . . .  82
192           6.7.11. Get current settings of MIDI instrument map entry . .  83
193           6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . .  84
194       7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . .  86
195       8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . .  97
196         8.1.  Number of audio output devices changed  . . . . . . . . .  97
197         8.2.  Audio output device's settings changed  . . . . . . . . .  97
198         8.3.  Number of MIDI input devices changed  . . . . . . . . . .  97
199         8.4.  MIDI input device's settings changed  . . . . . . . . . .  98
200         8.5.  Number of sampler channels changed  . . . . . . . . . . .  98
201         8.6.  Number of active voices changed . . . . . . . . . . . . .  98
202         8.7.  Number of active disk streams changed . . . . . . . . . .  99
203         8.8.  Disk stream buffer fill state changed . . . . . . . . . .  99
204         8.9.  Channel information changed . . . . . . . . . . . . . . .  99
205         8.10. Number of effect sends changed  . . . . . . . . . . . . . 100
206         8.11. Effect send information changed . . . . . . . . . . . . . 100
207         8.12. Total number of active voices changed . . . . . . . . . . 100
208         8.13. Number of MIDI instrument maps changed  . . . . . . . . . 101
209         8.14. MIDI instrument map information changed . . . . . . . . . 101
210         8.15. Number of MIDI instruments changed  . . . . . . . . . . . 101
211         8.16. MIDI instrument information changed . . . . . . . . . . . 102
212         8.17. Global settings changed . . . . . . . . . . . . . . . . . 102
213         8.18. Miscellaneous and debugging events  . . . . . . . . . . . 103
214       9.  Security Considerations . . . . . . . . . . . . . . . . . . . 104
215       10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 105
216       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 106
217       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 107
218       Intellectual Property and Copyright Statements  . . . . . . . . . 108
219    
220    
221    
222    
223  Schoenebeck             Expires November 7, 2005                [Page 3]  Schoenebeck            Expires September 30, 2007               [Page 4]
224    
225  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
226    
227    
228  1.  Requirements notation  1.  Requirements notation
# Line 178  Internet-Draft       LinuxSampler Contro Line 234  Internet-Draft       LinuxSampler Contro
234     This protocol is always case-sensitive if not explicitly claimed the     This protocol is always case-sensitive if not explicitly claimed the
235     opposite.     opposite.
236    
237     In examples, "C:" and "S:" indicate lines sent by the client     In examples, "C:" and "S:" indicate lines sent by the client (front-
238     (front-end) and server (LinuxSampler) respectively.  Lines in     end) and server (LinuxSampler) respectively.  Lines in examples must
239     examples must be interpreted as every line being CRLF terminated     be interpreted as every line being CRLF terminated (carriage return
240     (carriage return character followed by line feed character as defined     character followed by line feed character as defined in the ASCII
241     in the ASCII standard), thus the following example:     standard), thus the following example:
242    
243        C: "some line"        C: "some line"
244    
245           "another line"           "another line"
246    
247     must actually be interpreted as client sending the following message:     must actually be interpreted as client sending the following message:
# Line 203  Internet-Draft       LinuxSampler Contro Line 260  Internet-Draft       LinuxSampler Contro
260     sequence scenario:     sequence scenario:
261    
262     o  server sending message "a"     o  server sending message "a"
263    
264     o  followed by a delay (pause) with arbitrary duration     o  followed by a delay (pause) with arbitrary duration
265    
266     o  followed by server sending message "bcd<CR>"     o  followed by server sending message "bcd<CR>"
267    
268     o  again followed by a delay (pause) with arbitrary duration     o  again followed by a delay (pause) with arbitrary duration
269    
270     o  followed by server sending the message "<LF>"     o  followed by server sending the message "<LF>"
271    
272     where again <CR> and <LF> symbolize the carriage return and line feed     where again <CR> and <LF> symbolize the carriage return and line feed
# Line 215  Internet-Draft       LinuxSampler Contro Line 276  Internet-Draft       LinuxSampler Contro
276    
277    
278    
279    Schoenebeck            Expires September 30, 2007               [Page 5]
280    
281    Internet-Draft        LinuxSampler Control Protocol           March 2007
282    
283    
284    2.  Versioning of this specification
285    
286       LSCP will certainly be extended and enhanced by-and-by.  Each
287       official release of the LSCP specification will be tagged with a
288       unique version tuple.  The version tuple consists at least of a major
289       and minor version number like:
290    
291          "1.2"
292    
293       In this example the major version number would be "1" and the minor
294       version number would be "2".  Note that the version tuple might also
295       have more than two elements.  The major version number defines a
296       group of backward compatible versions.  That means a frontend is
297       compatible to the connected sampler if and only if the LSCP versions
298       to which each of the two parties complies to, match both of the
299       following rules:
300    
301       Compatibility:
302    
303       1.  The frontend's LSCP major version and the sampler's LSCP major
304           version are exactly equal.
305    
306       2.  The frontend's LSCP minor version is less or equal than the
307           sampler's LSCP minor version.
308    
309       Compatibility can only be claimed if both rules are true.  The
310       frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get
311       the version of the LSCP specification the sampler complies with.
312    
313    
314    
315    
316    
317    
318    
319    
320    
321    
322    
323    
324    
325    
326  Schoenebeck             Expires November 7, 2005                [Page 4]  
327    
328    
329    
330    
331    
332    
333    
334    
335    Schoenebeck            Expires September 30, 2007               [Page 6]
336    
337  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
338    
339    
340  2.  Introduction  3.  Introduction
341    
342     LinuxSampler is a so called software sampler application capable to     LinuxSampler is a so called software sampler application capable to
343     playback audio samples from a computer's Random Access Memory (RAM)     playback audio samples from a computer's Random Access Memory (RAM)
# Line 235  Internet-Draft       LinuxSampler Contro Line 347  Internet-Draft       LinuxSampler Contro
347     virtual channels which will be referred in this document as "sampler     virtual channels which will be referred in this document as "sampler
348     channels".  The channels are in such way virtual as they can be     channels".  The channels are in such way virtual as they can be
349     connected to an arbitrary MIDI input method and arbitrary MIDI     connected to an arbitrary MIDI input method and arbitrary MIDI
350     channel (e.g.  sampler channel 17 could be connected to an ALSA     channel (e.g. sampler channel 17 could be connected to an ALSA
351     sequencer device 64:0 and listening to MIDI channel 1 there).  Each     sequencer device 64:0 and listening to MIDI channel 1 there).  Each
352     sampler engine will be assigned an own instance of one of the     sampler channel will be associated with an instance of one of the
353     available sampler engines (e.g.  GigEngine, DLSEngine).  The audio     available sampler engines (e.g.  GigEngine, DLSEngine).  The audio
354     output of each sampler channel can be routed to an arbitrary audio     output of each sampler channel can be routed to an arbitrary audio
355     output method (ALSA / JACK) and an arbitrary audio output channel     output method (ALSA / JACK) and an arbitrary audio output channel
# Line 276  Internet-Draft       LinuxSampler Contro Line 388  Internet-Draft       LinuxSampler Contro
388    
389    
390    
391  Schoenebeck             Expires November 7, 2005                [Page 5]  Schoenebeck            Expires September 30, 2007               [Page 7]
392    
393  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
394    
395    
396  3.  Focus of this protocol  4.  Focus of this protocol
397    
398     Main focus of this protocol is to provide a way to configure a     Main focus of this protocol is to provide a way to configure a
399     running LinuxSampler instance and to retrieve information about it.     running LinuxSampler instance and to retrieve information about it.
# Line 332  Internet-Draft       LinuxSampler Contro Line 444  Internet-Draft       LinuxSampler Contro
444    
445    
446    
447  Schoenebeck             Expires November 7, 2005                [Page 6]  Schoenebeck            Expires September 30, 2007               [Page 8]
448    
449  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
450    
451    
452  4.  Communication Overview  5.  Communication Overview
453    
454     There are two distinct methods of communication between a running     There are two distinct methods of communication between a running
455     instance of LinuxSampler and one or more control applications, so     instance of LinuxSampler and one or more control applications, so
# Line 349  Internet-Draft       LinuxSampler Contro Line 461  Internet-Draft       LinuxSampler Contro
461     more effort to be implemented in the front-end application.  The two     more effort to be implemented in the front-end application.  The two
462     communication methods will be described next.     communication methods will be described next.
463    
464  4.1  Request/response communication method  5.1.  Request/response communication method
465    
466     This simple communication method is based on TCP.  The front-end     This simple communication method is based on TCP [RFC793].  The
467     application establishes a TCP connection to the LinuxSampler instance     front-end application establishes a TCP connection to the
468     on a certain host system.  Then the front-end application will send     LinuxSampler instance on a certain host system.  Then the front-end
469     certain ASCII based commands as defined in this document (every     application will send certain ASCII based commands as defined in this
470     command line must be CRLF terminated - see "Conventions used in this     document (every command line must be CRLF terminated - see
471     document" at the beginning of this document) and the LinuxSampler     "Conventions used in this document" at the beginning of this
472     application will response after a certain process time with an     document) and the LinuxSampler application will response after a
473     appropriate ASCII based answer, also as defined in this document.  So     certain process time with an appropriate ASCII based answer, also as
474     this TCP communication is simply based on query and answer paradigm.     defined in this document.  So this TCP communication is simply based
475     That way LinuxSampler is only able to answer on queries from     on query and answer paradigm.  That way LinuxSampler is only able to
476     front-ends, but not able to automatically send messages to the client     answer on queries from front-ends, but not able to automatically send
477     if it's not asked to.  The fronted should not reconnect to     messages to the client if it's not asked to.  The fronted should not
478     LinuxSampler for every single command, instead it should keep the     reconnect to LinuxSampler for every single command, instead it should
479     connection established and simply resend message(s) for subsequent     keep the connection established and simply resend message(s) for
480     commands.  To keep information in the front-end up-to-date the     subsequent commands.  To keep information in the front-end up-to-date
481     front-end has to periodically send new requests to get the current     the front-end has to periodically send new requests to get the
482     information from the LinuxSampler instance.  This is often referred     current information from the LinuxSampler instance.  This is often
483     to as "polling".  While polling is simple to implement and may be OK     referred to as "polling".  While polling is simple to implement and
484     to use in some cases, there may be disadvantages to polling such as     may be OK to use in some cases, there may be disadvantages to polling
485     network traffic overhead and information being out of date.  It is     such as network traffic overhead and information being out of date.
486     possible for a client or several clients to open more than one     It is possible for a client or several clients to open more than one
487     connection to the server at the same time.  It is also possible to     connection to the server at the same time.  It is also possible to
488     send more than one request to the server at the same time but if     send more than one request to the server at the same time but if
489     those requests are sent over the same connection server MUST execute     those requests are sent over the same connection server MUST execute
# Line 388  Internet-Draft       LinuxSampler Contro Line 500  Internet-Draft       LinuxSampler Contro
500    
501    
502    
503  Schoenebeck             Expires November 7, 2005                [Page 7]  Schoenebeck            Expires September 30, 2007               [Page 9]
504    
505  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
506    
507    
508  4.1.1  Result format  5.1.1.  Result format
509    
510     Result set could be one of the following types:     Result set could be one of the following types:
511    
512     1.  Normal     1.  Normal
513    
514     2.  Warning     2.  Warning
515    
516     3.  Error     3.  Error
517    
518     Warning and Error result sets MUST be single line and have the     Warning and Error result sets MUST be single line and have the
519     following format:     following format:
520    
521     o  "WRN:<warning-code>:<warning-message>"     o  "WRN:<warning-code>:<warning-message>"
522    
523     o  "ERR:<error-code>:<error-message>"     o  "ERR:<error-code>:<error-message>"
524    
525     Where <warning-code> and <error-code> are numeric unique identifiers     Where <warning-code> and <error-code> are numeric unique identifiers
# Line 414  Internet-Draft       LinuxSampler Contro Line 529  Internet-Draft       LinuxSampler Contro
529     Examples:     Examples:
530    
531        C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0        C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
532    
533        S: "WRN:32:This is a 24 bit patch which is not supported natively        S: "WRN:32:This is a 24 bit patch which is not supported natively
534        yet."        yet."
535    
536        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
537    
538        S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter        S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter
539        'EAR'."        'EAR'."
540    
541        C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"        C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
542    
543        S: "ERR:9:There is no audio output device with index 123456."        S: "ERR:9:There is no audio output device with index 123456."
544    
545     Normal result sets could be:     Normal result sets could be:
546    
547     1.  Empty     1.  Empty
548    
549     2.  Single line     2.  Single line
550    
551     3.  Multi-line     3.  Multi-line
552    
553     Empty result set is issued when the server only needed to acknowledge     Empty result set is issued when the server only needed to acknowledge
554     the fact that the request was received and it was processed     the fact that the request was received and it was processed
555     successfully and no additional information is available.  This result     successfully and no additional information is available.  This result
    set has the following format:  
556    
       "OK"  
557    
    Example:  
558    
559        C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"  Schoenebeck            Expires September 30, 2007              [Page 10]
560    
561    Internet-Draft        LinuxSampler Control Protocol           March 2007
562    
563    
564       set has the following format:
565    
566          "OK"
567    
568  Schoenebeck             Expires November 7, 2005                [Page 8]     Example:
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
569    
570          C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
571    
572        S: "OK"        S: "OK"
573    
# Line 461  Internet-Draft       LinuxSampler Contro Line 581  Internet-Draft       LinuxSampler Contro
581     Example:     Example:
582    
583        C: "GET AUDIO_OUTPUT_DEVICE INFO 0"        C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
584    
585        S: "DRIVER: ALSA"        S: "DRIVER: ALSA"
586    
587           "CHANNELS: 2"           "CHANNELS: 2"
588    
589           "SAMPLERATE: 44100"           "SAMPLERATE: 44100"
590    
591           "ACTIVE: true"           "ACTIVE: true"
592    
593           "FRAGMENTS: 2"           "FRAGMENTS: 2"
594    
595           "FRAGMENTSIZE: 128"           "FRAGMENTSIZE: 128"
596    
597           "CARD: '0,0'"           "CARD: '0,0'"
598    
599           "."           "."
600    
601     In addition to above mentioned formats, warnings and empty result     In addition to above mentioned formats, warnings and empty result
# Line 475  Internet-Draft       LinuxSampler Contro Line 603  Internet-Draft       LinuxSampler Contro
603     respectively:     respectively:
604    
605     o  "WRN[<index>]:<warning-code>:<warning-message>"     o  "WRN[<index>]:<warning-code>:<warning-message>"
606    
607     o  "OK[<index>]"     o  "OK[<index>]"
608    
609     where <index> is command specific and is used to indicate channel     where <index> is command specific and is used to indicate channel
610     number that the result set was related to or other integer value.     number that the result set was related to or other integer value.
611    
612    
613    
614    
615    Schoenebeck            Expires September 30, 2007              [Page 11]
616    
617    Internet-Draft        LinuxSampler Control Protocol           March 2007
618    
619    
620     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
621    
622     Examples:     Examples:
623    
624        C: "ADD CHANNEL"        C: "ADD CHANNEL"
625    
626        S: "OK[12]"        S: "OK[12]"
627    
628        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
629    
630        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."        S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
631    
632  4.2  Subscribe/notify communication method  5.2.  Subscribe/notify communication method
633    
634     This more sophisticated communication method is actually only an     This more sophisticated communication method is actually only an
635     extension of the simple request/response communication method.  The     extension of the simple request/response communication method.  The
636     front-end still uses a TCP connection and sends the same commands on     front-end still uses a TCP connection and sends the same commands on
637     the TCP connection.  Two extra commands are SUBSCRIBE and UNSUBSCRIBE     the TCP connection.  Two extra commands are SUBSCRIBE and UNSUBSCRIBE
638     commands that allow a client to tell the server that it is interested     commands that allow a client to tell the server that it is interested
   
   
   
 Schoenebeck             Expires November 7, 2005                [Page 9]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
639     in receiving notifications about certain events as they happen on the     in receiving notifications about certain events as they happen on the
640     server.  The SUBSCRIBE command has the following syntax:     server.  The SUBSCRIBE command has the following syntax:
641    
# Line 527  Internet-Draft       LinuxSampler Contro Line 658  Internet-Draft       LinuxSampler Contro
658    
659     1.  Events MUST NOT be sent to any client who has not issued an     1.  Events MUST NOT be sent to any client who has not issued an
660         appropriate SUBSCRIBE command.         appropriate SUBSCRIBE command.
661    
662     2.  Events MUST only be sent using the same connection that was used     2.  Events MUST only be sent using the same connection that was used
663         to subscribe to them.         to subscribe to them.
664    
665     3.  When response is being sent to the client, event MUST be inserted     3.  When response is being sent to the client, event MUST be inserted
666         in the stream before or after the response, but NOT in the         in the stream before or after the response, but NOT in the
667         middle.  Same is true about the response.  It should never be         middle.  Same is true about the response.  It should never be
668    
669    
670    
671    Schoenebeck            Expires September 30, 2007              [Page 12]
672    
673    Internet-Draft        LinuxSampler Control Protocol           March 2007
674    
675    
676         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
677         response.         response.
678    
# Line 542  Internet-Draft       LinuxSampler Contro Line 683  Internet-Draft       LinuxSampler Contro
683    
684     where <event-id> will be replace by the respective event that client     where <event-id> will be replace by the respective event that client
685     is no longer interested in receiving.  For a list of supported events     is no longer interested in receiving.  For a list of supported events
686     see Section 7.     see Section 8.
687    
688     Example: the fill states of disk stream buffers have changed on     Example: the fill states of disk stream buffers have changed on
689     sampler channel 4 and the LinuxSampler instance will react by sending     sampler channel 4 and the LinuxSampler instance will react by sending
# Line 554  Internet-Draft       LinuxSampler Contro Line 695  Internet-Draft       LinuxSampler Contro
695     channel 4, where the stream with ID "35" is filled by 62%, stream     channel 4, where the stream with ID "35" is filled by 62%, stream
696     with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.     with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.
697    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 10]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
698     Clients may choose to open more than one connection to the server and     Clients may choose to open more than one connection to the server and
699     use some connections to receive notifications while using other     use some connections to receive notifications while using other
700     connections to issue commands to the back-end.  This is entirely     connections to issue commands to the back-end.  This is entirely
# Line 590  Internet-Draft       LinuxSampler Contro Line 724  Internet-Draft       LinuxSampler Contro
724    
725    
726    
727    Schoenebeck            Expires September 30, 2007              [Page 13]
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 11]  
728    
729  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
730    
731    
732  5.  Description for control commands  6.  Description for control commands
733    
734     This chapter will describe the available control commands that can be     This chapter will describe the available control commands that can be
735     sent on the TCP connection in detail.  Some certain commands (e.g.     sent on the TCP connection in detail.  Some certain commands (e.g.
736     "GET CHANNEL INFO" (Section 5.4.10) or "GET ENGINE INFO" (Section     "GET CHANNEL INFO" (Section 6.4.10) or "GET ENGINE INFO"
737     5.4.9)) lead to multiple-line responses.  In this case LinuxSampler     (Section 6.4.9)) lead to multiple-line responses.  In this case
738     signals the end of the response by a "." (single dot) line.     LinuxSampler signals the end of the response by a "." (single dot)
739       line.
740    
741  5.1  Ignored lines and comments  6.1.  Ignored lines and comments
742    
743     White lines, that is lines which only contain space and tabulator     White lines, that is lines which only contain space and tabulator
744     characters, and lines that start with a "#" character are ignored,     characters, and lines that start with a "#" character are ignored,
745     thus it's possible for example to group commands and to place     thus it's possible for example to group commands and to place
746     comments in a LSCP script file.     comments in a LSCP script file.
747    
748  5.2  Configuring audio drivers  6.2.  Configuring audio drivers
749    
750     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
751     multiple audio devices simultaneously, e.g.  to output the sound of     multiple audio devices simultaneously, e.g. to output the sound of
752     one sampler channel using the ALSA audio output driver, and on     one sampler channel using the ALSA audio output driver, and on
753     another sampler channel you might want to use the JACK audio output     another sampler channel you might want to use the JACK audio output
754     driver.  For particular audio output systems it's also possible to     driver.  For particular audio output systems it's also possible to
755     create several devices of the same audio output driver, e.g.  two     create several devices of the same audio output driver, e.g. two
756     separate ALSA audio output devices for using two different sound     separate ALSA audio output devices for using two different sound
757     cards at the same time.  This chapter describes all commands to     cards at the same time.  This chapter describes all commands to
758     configure LinuxSampler's audio output devices and their parameters.     configure LinuxSampler's audio output devices and their parameters.
# Line 649  Internet-Draft       LinuxSampler Contro Line 762  Internet-Draft       LinuxSampler Contro
762     values have to be obtained at runtime.  This makes the protocol a bit     values have to be obtained at runtime.  This makes the protocol a bit
763     abstract, but has the advantage, that front-ends can be written     abstract, but has the advantage, that front-ends can be written
764     independently of what drivers are currently implemented and what     independently of what drivers are currently implemented and what
765     parameters these drivers are actually offering.  This means     parameters these drivers are actually offering.  This means front-
766     front-ends can even handle drivers which are implemented somewhere in     ends can even handle drivers which are implemented somewhere in
767     future without modifying the front-end at all.     future without modifying the front-end at all.
768    
769     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 661  Internet-Draft       LinuxSampler Contro Line 774  Internet-Draft       LinuxSampler Contro
774     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
775     possible values, etc.     possible values, etc.
776    
 5.2.1  Getting amount of available audio output drivers  
777    
    Use the following command to get the number of audio output drivers  
    currently available for the LinuxSampler instance:  
778    
779    
780    
781  Schoenebeck             Expires November 7, 2005               [Page 12]  
782    
783    Schoenebeck            Expires September 30, 2007              [Page 14]
784    
785  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
786    
787    
788    6.2.1.  Getting amount of available audio output drivers
789    
790       Use the following command to get the number of audio output drivers
791       currently available for the LinuxSampler instance:
792    
793        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS        GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
794    
795     Possible Answers:     Possible Answers:
# Line 683  Internet-Draft       LinuxSampler Contro Line 800  Internet-Draft       LinuxSampler Contro
800     Example:     Example:
801    
802        C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"        C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
803    
804        S: "2"        S: "2"
805    
806  5.2.2  Getting all available audio output drivers  6.2.2.  Getting all available audio output drivers
807    
808     Use the following command to list all audio output drivers currently     Use the following command to list all audio output drivers currently
809     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 700  Internet-Draft       LinuxSampler Contro Line 818  Internet-Draft       LinuxSampler Contro
818     Example:     Example:
819    
820        C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"        C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
821    
822        S: "ALSA,JACK"        S: "ALSA,JACK"
823    
824  5.2.3  Getting information about a specific audio output driver  6.2.3.  Getting information about a specific audio output driver
825    
826     Use the following command to get detailed information about a     Use the following command to get detailed information about a
827     specific audio output driver:     specific audio output driver:
# Line 710  Internet-Draft       LinuxSampler Contro Line 829  Internet-Draft       LinuxSampler Contro
829        GET AUDIO_OUTPUT_DRIVER INFO <audio-output-driver>        GET AUDIO_OUTPUT_DRIVER INFO <audio-output-driver>
830    
831     Where <audio-output-driver> is the name of the audio output driver,     Where <audio-output-driver> is the name of the audio output driver,
832     returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2)     returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
833     command.     command.
834    
835     Possible Answers:     Possible Answers:
836    
837    
838    
839    Schoenebeck            Expires September 30, 2007              [Page 15]
840    
841    Internet-Draft        LinuxSampler Control Protocol           March 2007
842    
843    
844        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
845        answer line begins with the information category name followed by        answer line begins with the information category name followed by
846        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
# Line 723  Internet-Draft       LinuxSampler Contro Line 849  Internet-Draft       LinuxSampler Contro
849    
850    
851    
   
 Schoenebeck             Expires November 7, 2005               [Page 13]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
852           DESCRIPTION -           DESCRIPTION -
853    
854              character string describing the audio output driver              character string describing the audio output driver
855    
856           VERSION -           VERSION -
857    
858              character string reflecting the driver's version              character string reflecting the driver's version
859    
860           PARAMETERS -           PARAMETERS -
861    
862              comma separated list of all parameters available for the              comma separated list of all parameters available for the
863              given audio output driver, at least parameters 'channels',              given audio output driver, at least parameters 'channels',
864              'samplerate' and 'active' are offered by all audio output              'samplerate' and 'active' are offered by all audio output
865              drivers              drivers
866    
867        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
868    
869     Example:     Example:
870    
871        C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"        C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
872    
873        S: "DESCRIPTION: Advanced Linux Sound Architecture"        S: "DESCRIPTION: Advanced Linux Sound Architecture"
874    
875           "VERSION: 1.0"           "VERSION: 1.0"
876    
877           "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,           "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
878        FRAGMENTSIZE,CARD"        FRAGMENTSIZE,CARD"
879    
880           "."           "."
881    
882  5.2.4  Getting information about specific audio output driver parameter  6.2.4.  Getting information about specific audio output driver parameter
883    
884     Use the following command to get detailed information about a     Use the following command to get detailed information about a
885     specific audio output driver parameter:     specific audio output driver parameter:
# Line 758  Internet-Draft       LinuxSampler Contro Line 887  Internet-Draft       LinuxSampler Contro
887        GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>]        GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>]
888    
889     Where <audio> is the name of the audio output driver as returned by     Where <audio> is the name of the audio output driver as returned by
890     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2) command,     the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
891     <prm> a specific parameter name for which information should be     <prm> a specific parameter name for which information should be
892     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" (Section  
893     5.2.3) command) and <deplist> is an optional list of parameters on  
894     which the sought parameter <prm> depends on, <deplist> is a list of  
895     key-value pairs in form of "key1=val1 key2=val2 ...", where character  Schoenebeck            Expires September 30, 2007              [Page 16]
896     string values are encapsulated into apostrophes (').  Arguments given  
897     with <deplist> which are not dependency parameters of <prm> will be  Internet-Draft        LinuxSampler Control Protocol           March 2007
898     ignored, means the front-end application can simply put all  
899     parameters into <deplist> with the values already selected by the  
900       obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
901       (Section 6.2.3) command) and <deplist> is an optional list of
902       parameters on which the sought parameter <prm> depends on, <deplist>
903       is a list of key-value pairs in form of "key1=val1 key2=val2 ...",
904       where character string values are encapsulated into apostrophes (').
905       Arguments given with <deplist> which are not dependency parameters of
906       <prm> will be ignored, means the front-end application can simply put
907       all parameters into <deplist> with the values already selected by the
908     user.     user.
909    
910     Possible Answers:     Possible Answers:
# Line 777  Internet-Draft       LinuxSampler Contro Line 914  Internet-Draft       LinuxSampler Contro
914        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
915        character string to that info category.  There are information        character string to that info category.  There are information
916        which is always returned, independently of the given driver        which is always returned, independently of the given driver
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 14]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
917        parameter and there are optional information which is only shown        parameter and there are optional information which is only shown
918        dependently to given driver parameter.  At the moment the        dependently to given driver parameter.  At the moment the
919        following information categories are defined:        following information categories are defined:
920    
921        TYPE -        TYPE -
922    
923           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
924           value(s) or "FLOAT" for dotted number(s) or "STRING" for           value(s) or "FLOAT" for dotted number(s) or "STRING" for
925           character string(s) (always returned, no matter which driver           character string(s) (always returned, no matter which driver
926           parameter)           parameter)
927    
928        DESCRIPTION -        DESCRIPTION -
929    
930           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
931           returned, no matter which driver parameter)           returned, no matter which driver parameter)
932    
933        MANDATORY -        MANDATORY -
934    
935           either true or false, defines if this parameter must be given           either true or false, defines if this parameter must be given
936           when the device is to be created with the 'CREATE           when the device is to be created with the 'CREATE
937           AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command (always returned,           AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
938           no matter which driver parameter)           no matter which driver parameter)
939    
940        FIX -        FIX -
941    
942           either true or false, if false then this parameter can be           either true or false, if false then this parameter can be
943           changed at any time, once the device is created by the 'CREATE           changed at any time, once the device is created by the 'CREATE
944           AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command (always returned,           AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
945           no matter which driver parameter)           no matter which driver parameter)
946    
947    
948    
949    
950    
951    Schoenebeck            Expires September 30, 2007              [Page 17]
952    
953    Internet-Draft        LinuxSampler Control Protocol           March 2007
954    
955    
956        MULTIPLICITY -        MULTIPLICITY -
957    
958           either true or false, defines if this parameter allows only one           either true or false, defines if this parameter allows only one
959           value or a list of values, where true means multiple values and           value or a list of values, where true means multiple values and
960           false only a single value allowed (always returned, no matter           false only a single value allowed (always returned, no matter
961           which driver parameter)           which driver parameter)
962    
963        DEPENDS -        DEPENDS -
964           comma separated list of paramters this parameter depends on,  
965             comma separated list of parameters this parameter depends on,
966           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
967           and 'POSSIBILITIES' might depend on these listed parameters,           and 'POSSIBILITIES' might depend on these listed parameters,
968           for example assuming that an audio driver (like the ALSA           for example assuming that an audio driver (like the ALSA
# Line 822  Internet-Draft       LinuxSampler Contro Line 971  Internet-Draft       LinuxSampler Contro
971           possible values for 'samplerate' depends on the sound card           possible values for 'samplerate' depends on the sound card
972           which can be chosen by the 'card' parameter (optionally           which can be chosen by the 'card' parameter (optionally
973           returned, dependent to driver parameter)           returned, dependent to driver parameter)
974    
975        DEFAULT -        DEFAULT -
976    
977           reflects the default value for this parameter which is used           reflects the default value for this parameter which is used
978           when the device is created and not explicitly given with the           when the device is created and not explicitly given with the
979           'CREATE AUDIO_OUTPUT_DEVICE' (Section 5.2.5) command, in case           'CREATE AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command, in case
980           of MULTIPLCITY=true, this is a comma separated list, that's why           of MULTIPLCITY=true, this is a comma separated list, that's why
981           character strings are encapsulated into apostrophes (')           character strings are encapsulated into apostrophes (')
982           (optionally returned, dependent to driver parameter)           (optionally returned, dependent to driver parameter)
983    
984        RANGE_MIN -        RANGE_MIN -
985    
986           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
987           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
988           this parameter is often used in conjunction with RANGE_MAX, but           this parameter is often used in conjunction with RANGE_MAX, but
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 15]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
989           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
990           driver parameter)           driver parameter)
991    
992        RANGE_MAX -        RANGE_MAX -
993    
994           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
995           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
996           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
997           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
998           driver parameter)           driver parameter)
999    
1000        POSSIBILITIES -        POSSIBILITIES -
1001    
1002           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
1003           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
1004    
1005    
1006    
1007    Schoenebeck            Expires September 30, 2007              [Page 18]
1008    
1009    Internet-Draft        LinuxSampler Control Protocol           March 2007
1010    
1011    
1012           returned, dependent to driver parameter)           returned, dependent to driver parameter)
1013    
1014     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 859  Internet-Draft       LinuxSampler Contro Line 1016  Internet-Draft       LinuxSampler Contro
1016     Examples:     Examples:
1017    
1018        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
1019    
1020        S: "DESCRIPTION: sound card to be used"        S: "DESCRIPTION: sound card to be used"
1021    
1022           "TYPE: STRING"           "TYPE: STRING"
1023    
1024           "MANDATORY: false"           "MANDATORY: false"
1025    
1026           "FIX: true"           "FIX: true"
1027    
1028           "MULTIPLICITY: false"           "MULTIPLICITY: false"
1029    
1030           "DEFAULT: '0,0'"           "DEFAULT: '0,0'"
1031    
1032           "POSSIBILITIES: '0,0','1,0','2,0'"           "POSSIBILITIES: '0,0','1,0','2,0'"
1033    
1034           "."           "."
1035    
1036        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
1037    
1038        S: "DESCRIPTION: output sample rate in Hz"        S: "DESCRIPTION: output sample rate in Hz"
1039    
1040           "TYPE: INT"           "TYPE: INT"
1041    
1042           "MANDATORY: false"           "MANDATORY: false"
1043    
1044           "FIX: false"           "FIX: false"
1045    
1046           "MULTIPLICITY: false"           "MULTIPLICITY: false"
1047    
1048           "DEPENDS: card"           "DEPENDS: card"
1049    
1050           "DEFAULT: 44100"           "DEFAULT: 44100"
1051    
1052           "."           "."
1053    
1054        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE        C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE
1055        CARD='0,0'"        CARD='0,0'"
1056    
1057        S: "DESCRIPTION: output sample rate in Hz"        S: "DESCRIPTION: output sample rate in Hz"
1058    
1059    
1060    
1061    
1062    
1063    Schoenebeck            Expires September 30, 2007              [Page 19]
1064    
1065    Internet-Draft        LinuxSampler Control Protocol           March 2007
1066    
1067    
1068           "TYPE: INT"           "TYPE: INT"
1069    
1070           "MANDATORY: false"           "MANDATORY: false"
          "FIX: false"  
          "MULTIPLICITY: false"  
          "DEPENDS: card"  
          "DEFAULT: 44100"  
          "RANGE_MIN: 22050"  
1071    
1072             "FIX: false"
1073    
1074             "MULTIPLICITY: false"
1075    
1076             "DEPENDS: card"
1077    
1078  Schoenebeck             Expires November 7, 2005               [Page 16]           "DEFAULT: 44100"
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
1079    
1080             "RANGE_MIN: 22050"
1081    
1082           "RANGE_MAX: 96000"           "RANGE_MAX: 96000"
1083    
1084           "."           "."
1085    
1086  5.2.5  Creating an audio output device  6.2.5.  Creating an audio output device
1087    
1088     Use the following command to create a new audio output device for     Use the following command to create a new audio output device for the
1089     the desired audio output system:     desired audio output system:
1090    
1091        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]        CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]
1092    
1093     Where <audio-output-driver> should be replaced by the desired audio     Where <audio-output-driver> should be replaced by the desired audio
1094     output system and <param-list> by an optional list of driver specific     output system as returned by the "LIST
1095     parameters in form of "key1=val1 key2=val2 ...", where character     AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command and <param-
1096     string values should be encapsulated into apostrophes (').  Note that     list> by an optional list of driver specific parameters in form of
1097     there might be drivers which require parameter(s) to be given with     "key1=val1 key2=val2 ...", where character string values should be
1098     this command.  Use the previously described commands in this chapter     encapsulated into apostrophes (').  Note that there might be drivers
1099     to get this information.     which require parameter(s) to be given with this command.  Use the
1100       previously described commands in this chapter to get this
1101       information.
1102    
1103     Possible Answers:     Possible Answers:
1104    
1105        "OK[<device-id>]" -        "OK[<device-id>]" -
1106    
1107           in case the device was successfully created, where <device-id>           in case the device was successfully created, where <device-id>
1108           is the numerical ID of the new device           is the numerical ID of the new device
1109    
1110        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1111    
1112           in case the device was created successfully, where <device-id>           in case the device was created successfully, where <device-id>
1113           is the numerical ID of the new device, but there are noteworthy           is the numerical ID of the new device, but there are noteworthy
1114           issue(s) related (e.g.  sound card doesn't support given           issue(s) related (e.g. sound card doesn't support given
1115           hardware parameters and the driver is using fall-back values),           hardware parameters and the driver is using fall-back values),
1116    
1117    
1118    
1119    Schoenebeck            Expires September 30, 2007              [Page 20]
1120    
1121    Internet-Draft        LinuxSampler Control Protocol           March 2007
1122    
1123    
1124           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
1125    
1126        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1127    
1128           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1129           error message           error message
1130    
1131     Examples:     Examples:
1132    
1133        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
1134    
1135        S: "OK[0]"        S: "OK[0]"
1136    
1137        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"        C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
1138    
1139        S: "OK[1]"        S: "OK[1]"
1140    
1141  5.2.6  Destroying an audio output device  6.2.6.  Destroying an audio output device
1142    
1143     Use the following command to destroy a created output device:     Use the following command to destroy a created output device:
1144    
1145        DESTROY AUDIO_OUTPUT_DEVICE <device-id>        DESTROY AUDIO_OUTPUT_DEVICE <device-id>
1146    
1147     Where <device-id> should be replaced by the numerical ID of the audio     Where <device-id> should be replaced by the numerical ID of the audio
1148       output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
1149       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1150       command.
 Schoenebeck             Expires November 7, 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.  
1151    
1152     Possible Answers:     Possible Answers:
1153    
1154        "OK" -        "OK" -
1155    
1156           in case the device was successfully destroyed           in case the device was successfully destroyed
1157    
1158        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1159    
1160           in case the device was destroyed successfully, but there are           in case the device was destroyed successfully, but there are
1161           noteworthy issue(s) related (e.g.  an audio over ethernet           noteworthy issue(s) related (e.g. an audio over ethernet driver
1162           driver was unloaded but the other host might not be informed           was unloaded but the other host might not be informed about
1163           about this situation), providing an appropriate warning code           this situation), providing an appropriate warning code and
1164           and warning message           warning message
1165    
1166        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1167    
1168           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1169           error message           error message
1170    
1171     Example:     Example:
1172    
1173    
1174    
1175    Schoenebeck            Expires September 30, 2007              [Page 21]
1176    
1177    Internet-Draft        LinuxSampler Control Protocol           March 2007
1178    
1179    
1180        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1181    
1182        S: "OK"        S: "OK"
1183    
1184  5.2.7  Getting all created audio output device count  6.2.7.  Getting all created audio output device count
1185    
1186     Use the following command to count all created audio output devices:     Use the following command to count all created audio output devices:
1187    
# Line 989  Internet-Draft       LinuxSampler Contro Line 1195  Internet-Draft       LinuxSampler Contro
1195     Example:     Example:
1196    
1197        C: "GET AUDIO_OUTPUT_DEVICES"        C: "GET AUDIO_OUTPUT_DEVICES"
1198    
1199        S: "4"        S: "4"
1200    
1201  5.2.8  Getting all created audio output device list  6.2.8.  Getting all created audio output device list
1202    
1203     Use the following command to list all created audio output devices:     Use the following command to list all created audio output devices:
1204    
# Line 1002  Internet-Draft       LinuxSampler Contro Line 1209  Internet-Draft       LinuxSampler Contro
1209        LinuxSampler will answer by sending a comma separated list with        LinuxSampler will answer by sending a comma separated list with
1210        the numerical IDs of all audio output devices.        the numerical IDs of all audio output devices.
1211    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 18]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1212     Example:     Example:
1213    
1214        C: "LIST AUDIO_OUTPUT_DEVICES"        C: "LIST AUDIO_OUTPUT_DEVICES"
1215    
1216        S: "0,1,4,5"        S: "0,1,4,5"
1217    
1218  5.2.9  Getting current settings of an audio output device  6.2.9.  Getting current settings of an audio output device
1219    
1220     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
1221     created audio output device:     created audio output device:
# Line 1022  Internet-Draft       LinuxSampler Contro Line 1223  Internet-Draft       LinuxSampler Contro
1223        GET AUDIO_OUTPUT_DEVICE INFO <device-id>        GET AUDIO_OUTPUT_DEVICE INFO <device-id>
1224    
1225     Where <device-id> should be replaced by numerical ID of the audio     Where <device-id> should be replaced by numerical ID of the audio
1226     output device as e.g.  returned by the "LIST AUDIO_OUTPUT_DEVICES"     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
1227     (Section 5.2.8) command.     (Section 6.2.8) command.
1228    
1229    
1230    
1231    Schoenebeck            Expires September 30, 2007              [Page 22]
1232    
1233    Internet-Draft        LinuxSampler Control Protocol           March 2007
1234    
1235    
1236     Possible Answers:     Possible Answers:
1237    
# Line 1036  Internet-Draft       LinuxSampler Contro Line 1244  Internet-Draft       LinuxSampler Contro
1244     (independently of device):     (independently of device):
1245    
1246        DRIVER -        DRIVER -
1247    
1248           identifier of the used audio output driver, as also returned by           identifier of the used audio output driver, as also returned by
1249           the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 5.2.2)           the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
1250           command           command
1251    
1252        CHANNELS -        CHANNELS -
1253    
1254           amount of audio output channels this device currently offers           amount of audio output channels this device currently offers
1255    
1256        SAMPLERATE -        SAMPLERATE -
1257    
1258           playback sample rate the device uses           playback sample rate the device uses
1259    
1260        ACTIVE -        ACTIVE -
1261    
1262           either true or false, if false then the audio device is           either true or false, if false then the audio device is
1263           inactive and doesn't output any sound, nor do the sampler           inactive and doesn't output any sound, nor do the sampler
1264           channels connected to this audio device render any audio           channels connected to this audio device render any audio
# Line 1051  Internet-Draft       LinuxSampler Contro Line 1266  Internet-Draft       LinuxSampler Contro
1266     The mentioned fields above don't have to be in particular order.  The     The mentioned fields above don't have to be in particular order.  The
1267     fields above are only those fields which are returned by all audio     fields above are only those fields which are returned by all audio
1268     output devices.  Every audio output driver might have its own,     output devices.  Every audio output driver might have its own,
1269     additional driver specific parameters (see Section 5.2.3) which are     additional driver specific parameters (see Section 6.2.3) which are
1270     also returned by this command.     also returned by this command.
1271    
1272     Example:     Example:
1273    
1274          C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
1275    
1276          S: "DRIVER: ALSA"
1277    
1278             "CHANNELS: 2"
1279    
1280             "SAMPLERATE: 44100"
1281    
1282             "ACTIVE: true"
1283    
1284    
1285  Schoenebeck             Expires November 7, 2005               [Page 19]  
1286    
1287    Schoenebeck            Expires September 30, 2007              [Page 23]
1288    
1289  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
1290    
1291    
       C: "GET AUDIO_OUTPUT_DEVICE INFO 0"  
       S: "DRIVER: ALSA"  
          "CHANNELS: 2"  
          "SAMPLERATE: 44100"  
          "ACTIVE: true"  
1292           "FRAGMENTS: 2"           "FRAGMENTS: 2"
1293    
1294           "FRAGMENTSIZE: 128"           "FRAGMENTSIZE: 128"
1295    
1296           "CARD: '0,0'"           "CARD: '0,0'"
1297    
1298           "."           "."
1299    
1300  5.2.10  Changing settings of audio output devices  6.2.10.  Changing settings of audio output devices
1301    
1302     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
1303     audio output device:     audio output device:
# Line 1083  Internet-Draft       LinuxSampler Contro Line 1305  Internet-Draft       LinuxSampler Contro
1305        SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>        SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>
1306    
1307     Where <device-id> should be replaced by the numerical ID of the audio     Where <device-id> should be replaced by the numerical ID of the audio
1308     output device, <key> by the name of the parameter to change and     output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
1309     <value> by the new value for this parameter.     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1310       command, <key> by the name of the parameter to change and <value> by
1311       the new value for this parameter.
1312    
1313     Possible Answers:     Possible Answers:
1314    
1315        "OK" -        "OK" -
1316    
1317           in case setting was successfully changed           in case setting was successfully changed
1318    
1319        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1320    
1321           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
1322           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
1323           code and warning message           code and warning message
1324    
1325        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1326    
1327           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1328           error message           error message
1329    
1330     Example:     Example:
1331    
1332        C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"        C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1333    
1334        S: "OK"        S: "OK"
1335    
 5.2.11  Getting information about an audio channel  
1336    
    Use the following command to get information about an audio channel:  
1337    
       GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>  
1338    
    Where <device-id> is the numerical ID of the audio output device and  
    <audio-chan> the audio channel number.  
1339    
    Possible Answers:  
1340    
1341    
1342    
1343  Schoenebeck             Expires November 7, 2005               [Page 20]  Schoenebeck            Expires September 30, 2007              [Page 24]
1344    
1345  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
1346    
1347    
1348    6.2.11.  Getting information about an audio channel
1349    
1350       Use the following command to get information about an audio channel:
1351    
1352          GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1353    
1354       Where <device-id> is the numerical ID of the audio output device as
1355       given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1356       AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command and <audio-chan> the
1357       audio channel number.
1358    
1359       Possible Answers:
1360    
1361        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
1362        answer line begins with the information category name followed by        answer line begins with the information category name followed by
# Line 1127  Internet-Draft       LinuxSampler Contro Line 1364  Internet-Draft       LinuxSampler Contro
1364        character string to that info category.  At the moment the        character string to that info category.  At the moment the
1365        following information categories are defined:        following information categories are defined:
1366    
1367    
1368    
1369           NAME -           NAME -
1370    
1371              arbitrary character string naming the channel, which doesn't              arbitrary character string naming the channel, which doesn't
1372              have to be unique (always returned by all audio channels)              have to be unique (always returned by all audio channels)
1373    
1374           IS_MIX_CHANNEL -           IS_MIX_CHANNEL -
1375    
1376              either true or false, a mix-channel is not a real,              either true or false, a mix-channel is not a real,
1377              independent audio channel, but a virtual channel which is              independent audio channel, but a virtual channel which is
1378              mixed to another real channel, this mechanism is needed for              mixed to another real channel, this mechanism is needed for
1379              sampler engines which need more audio channels than the used              sampler engines which need more audio channels than the used
1380              audio system might be able to offer (always returned by all              audio system might be able to offer (always returned by all
1381              audio channels)              audio channels)
1382    
1383           MIX_CHANNEL_DESTINATION -           MIX_CHANNEL_DESTINATION -
1384    
1385              numerical ID (positive integer including 0) which reflects              numerical ID (positive integer including 0) which reflects
1386              the real audio channel (of the same audio output device)              the real audio channel (of the same audio output device)
1387              this mix channel refers to, means where the audio signal              this mix channel refers to, means where the audio signal
# Line 1150  Internet-Draft       LinuxSampler Contro Line 1394  Internet-Draft       LinuxSampler Contro
1394     driver.  Every audio channel might have its own, additional driver     driver.  Every audio channel might have its own, additional driver
1395     and channel specific parameters.     and channel specific parameters.
1396    
1397    
1398    
1399    Schoenebeck            Expires September 30, 2007              [Page 25]
1400    
1401    Internet-Draft        LinuxSampler Control Protocol           March 2007
1402    
1403    
1404     Examples:     Examples:
1405    
1406        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1407    
1408        S: "NAME: studio monitor left"        S: "NAME: studio monitor left"
1409    
1410           "IS_MIX_CHANNEL: false"           "IS_MIX_CHANNEL: false"
1411    
1412           "."           "."
1413    
1414        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
1415    
1416        S: "NAME: studio monitor right"        S: "NAME: studio monitor right"
1417    
1418           "IS_MIX_CHANNEL: false"           "IS_MIX_CHANNEL: false"
          "."  
1419    
       C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"  
       S: "NAME: studio monitor left"  
          "IS_MIX_CHANNEL: true"  
          "MIX_CHANNEL_DESTINATION: 1"  
1420           "."           "."
1421    
1422          C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
1423    
1424          S: "NAME: studio monitor left"
1425    
1426             "IS_MIX_CHANNEL: true"
1427    
1428             "MIX_CHANNEL_DESTINATION: 1"
1429    
1430  Schoenebeck             Expires November 7, 2005               [Page 21]           "."
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
1431    
1432        C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"        C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
1433    
1434        S: "NAME: 'ardour (left)'"        S: "NAME: 'ardour (left)'"
1435    
1436           "IS_MIX_CHANNEL: false"           "IS_MIX_CHANNEL: false"
1437    
1438           "JACK_BINDINGS: 'ardour:0'"           "JACK_BINDINGS: 'ardour:0'"
1439    
1440           "."           "."
1441    
1442  5.2.12  Getting information about specific audio channel parameter  6.2.12.  Getting information about specific audio channel parameter
1443    
1444     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
1445     audio channel parameter:     audio channel parameter:
# Line 1191  Internet-Draft       LinuxSampler Contro Line 1447  Internet-Draft       LinuxSampler Contro
1447        GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>        GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
1448    
1449     Where <dev-id> is the numerical ID of the audio output device as     Where <dev-id> is the numerical ID of the audio output device as
1450     returned by the "LIST AUDIO_OUTPUT_DEVICES" (Section 5.2.8) command,     returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1451     <chan> the audio channel number and <param> a specific channel     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
1452     parameter name for which information should be obtained (as returned  
1453     by the "GET AUDIO_OUTPUT_CHANNEL INFO" (Section 5.2.11) command).  
1454    
1455    Schoenebeck            Expires September 30, 2007              [Page 26]
1456    
1457    Internet-Draft        LinuxSampler Control Protocol           March 2007
1458    
1459    
1460       channel number and <param> a specific channel parameter name for
1461       which information should be obtained (as returned by the "GET
1462       AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
1463    
1464     Possible Answers:     Possible Answers:
1465    
# Line 1207  Internet-Draft       LinuxSampler Contro Line 1472  Internet-Draft       LinuxSampler Contro
1472        dependently to the given audio channel.  At the moment the        dependently to the given audio channel.  At the moment the
1473        following information categories are defined:        following information categories are defined:
1474    
1475    
1476    
1477           TYPE -           TYPE -
1478    
1479              either "BOOL" for boolean value(s) or "INT" for integer              either "BOOL" for boolean value(s) or "INT" for integer
1480              value(s) or "FLOAT" for dotted number(s) or "STRING" for              value(s) or "FLOAT" for dotted number(s) or "STRING" for
1481              character string(s) (always returned)              character string(s) (always returned)
1482    
1483           DESCRIPTION -           DESCRIPTION -
1484    
1485              arbitrary text describing the purpose of the parameter              arbitrary text describing the purpose of the parameter
1486              (always returned)              (always returned)
1487    
1488           FIX -           FIX -
1489    
1490              either true or false, if true then this parameter is read              either true or false, if true then this parameter is read
1491              only, thus cannot be altered (always returned)              only, thus cannot be altered (always returned)
1492    
1493           MULTIPLICITY -           MULTIPLICITY -
1494    
1495              either true or false, defines if this parameter allows only              either true or false, defines if this parameter allows only
1496              one value or a list of values, where true means multiple              one value or a list of values, where true means multiple
1497              values and false only a single value allowed (always              values and false only a single value allowed (always
1498              returned)              returned)
1499    
1500           RANGE_MIN -           RANGE_MIN -
1501    
1502              defines lower limit of the allowed value range for this              defines lower limit of the allowed value range for this
1503              parameter, can be an integer value as well as a dotted              parameter, can be an integer value as well as a dotted
1504                number, usually used in conjunction with 'RANGE_MAX', but
1505                may also appear without (optionally returned, dependent to
1506                driver and channel parameter)
1507    
1508    
1509    
1510    
1511  Schoenebeck             Expires November 7, 2005               [Page 22]  Schoenebeck            Expires September 30, 2007              [Page 27]
1512    
1513  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
1514    
1515    
             number, usually used in conjunction with 'RANGE_MAX', but  
             may also appear without (optionally returned, dependent to  
             driver and channel parameter)  
1516           RANGE_MAX -           RANGE_MAX -
1517    
1518              defines upper limit of the allowed value range for this              defines upper limit of the allowed value range for this
1519              parameter, can be an integer value as well as a dotted              parameter, can be an integer value as well as a dotted
1520              number, usually used in conjunction with 'RANGE_MIN', but              number, usually used in conjunction with 'RANGE_MIN', but
1521              may also appear without (optionally returned, dependent to              may also appear without (optionally returned, dependent to
1522              driver and channel parameter)              driver and channel parameter)
1523    
1524           POSSIBILITIES -           POSSIBILITIES -
1525    
1526              comma separated list of possible values for this parameter,              comma separated list of possible values for this parameter,
1527              character strings are encapsulated into apostrophes              character strings are encapsulated into apostrophes
1528              (optionally returned, dependent to driver and channel              (optionally returned, dependent to driver and channel
1529              parameter)              parameter)
1530    
1531        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
1532    
1533     Example:     Example:
1534    
1535        C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"        C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
1536    
1537        S: "DESCRIPTION: bindings to other JACK clients"        S: "DESCRIPTION: bindings to other JACK clients"
1538    
1539           "TYPE: STRING"           "TYPE: STRING"
1540    
1541           "FIX: false"           "FIX: false"
1542    
1543           "MULTIPLICITY: true"           "MULTIPLICITY: true"
1544    
1545           "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"           "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
1546    
1547           "."           "."
1548    
1549  5.2.13  Changing settings of audio output channels  6.2.13.  Changing settings of audio output channels
1550    
1551     Use the following command to alter a specific setting of an audio     Use the following command to alter a specific setting of an audio
1552     output channel:     output channel:
# Line 1267  Internet-Draft       LinuxSampler Contro Line 1554  Internet-Draft       LinuxSampler Contro
1554        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>        SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
1555    
1556     Where <dev-id> should be replaced by the numerical ID of the audio     Where <dev-id> should be replaced by the numerical ID of the audio
1557     device, <chn> by the audio channel number, <key> by the name of the     output device as returned by the "CREATE AUDIO_OUTPUT_DEVICE"
1558       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1559       command, <chn> by the audio channel number, <key> by the name of the
1560     parameter to change and <value> by the new value for this parameter.     parameter to change and <value> by the new value for this parameter.
1561    
1562     Possible Answers:     Possible Answers:
1563    
1564    
1565    
1566    
1567    Schoenebeck            Expires September 30, 2007              [Page 28]
1568    
1569    Internet-Draft        LinuxSampler Control Protocol           March 2007
1570    
1571    
1572        "OK" -        "OK" -
1573    
1574           in case setting was successfully changed           in case setting was successfully changed
1575    
1576        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1577    
1578           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
1579           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
1580           code and warning message           code and warning message
1581    
1582        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1583    
1584           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1585           error message           error message
1586    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 23]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1587     Example:     Example:
1588    
1589        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
1590    
1591        S: "OK"        S: "OK"
1592    
1593        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"        C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
1594    
1595        S: "OK"        S: "OK"
1596    
1597  5.3  Configuring MIDI input drivers  6.3.  Configuring MIDI input drivers
1598    
1599     Instances of drivers in LinuxSampler are called devices.  You can use     Instances of drivers in LinuxSampler are called devices.  You can use
1600     multiple MIDI devices simultaneously, e.g.  to use MIDI over ethernet     multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet
1601     as MIDI input on one sampler channel and ALSA as MIDI input on     as MIDI input on one sampler channel and ALSA as MIDI input on
1602     another sampler channel.  For particular MIDI input systems it's also     another sampler channel.  For particular MIDI input systems it's also
1603     possible to create several devices of the same MIDI input type.  This     possible to create several devices of the same MIDI input type.  This
# Line 1312  Internet-Draft       LinuxSampler Contro Line 1609  Internet-Draft       LinuxSampler Contro
1609     values have to be obtained at runtime.  This makes the protocol a bit     values have to be obtained at runtime.  This makes the protocol a bit
1610     abstract, but has the advantage, that front-ends can be written     abstract, but has the advantage, that front-ends can be written
1611     independently of what drivers are currently implemented and what     independently of what drivers are currently implemented and what
1612     parameters these drivers are actually offering.  This means     parameters these drivers are actually offering.  This means front-
1613     front-ends can even handle drivers which are implemented somewhere in     ends can even handle drivers which are implemented somewhere in
1614     future without modifying the front-end at all.     future without modifying the front-end at all.
1615    
1616     Commands for configuring MIDI input devices are pretty much the same     Commands for configuring MIDI input devices are pretty much the same
1617     as the commands for configuring audio output drivers, already     as the commands for configuring audio output drivers, already
1618     described in the last chapter.     described in the last chapter.
1619    
1620    
1621    
1622    
1623    Schoenebeck            Expires September 30, 2007              [Page 29]
1624    
1625    Internet-Draft        LinuxSampler Control Protocol           March 2007
1626    
1627    
1628     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
1629     drivers are not meant as specification of the drivers' parameters.     drivers are not meant as specification of the drivers' parameters.
1630     Driver implementations in LinuxSampler might have complete different     Driver implementations in LinuxSampler might have complete different
# Line 1328  Internet-Draft       LinuxSampler Contro Line 1633  Internet-Draft       LinuxSampler Contro
1633     retrieve what parameters drivers are offering, how to retrieve their     retrieve what parameters drivers are offering, how to retrieve their
1634     possible values, etc.     possible values, etc.
1635    
1636  5.3.1  Getting amount of available MIDI input drivers  6.3.1.  Getting amount of available MIDI input drivers
1637    
1638     Use the following command to get the number of MIDI input drivers     Use the following command to get the number of MIDI input drivers
1639     currently available for the LinuxSampler instance:     currently available for the LinuxSampler instance:
# Line 1337  Internet-Draft       LinuxSampler Contro Line 1642  Internet-Draft       LinuxSampler Contro
1642    
1643     Possible Answers:     Possible Answers:
1644    
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 24]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1645        LinuxSampler will answer by sending the number of available MIDI        LinuxSampler will answer by sending the number of available MIDI
1646        input drivers.        input drivers.
1647    
1648     Example:     Example:
1649    
1650        C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"        C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
1651    
1652        S: "2"        S: "2"
1653    
1654  5.3.2  Getting all available MIDI input drivers  6.3.2.  Getting all available MIDI input drivers
1655    
1656     Use the following command to list all MIDI input drivers currently     Use the following command to list all MIDI input drivers currently
1657     available for the LinuxSampler instance:     available for the LinuxSampler instance:
# Line 1368  Internet-Draft       LinuxSampler Contro Line 1666  Internet-Draft       LinuxSampler Contro
1666     Example:     Example:
1667    
1668        C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"        C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1669    
1670        S: "ALSA,JACK"        S: "ALSA,JACK"
1671    
1672  5.3.3  Getting information about a specific MIDI input driver  
1673    
1674    
1675    
1676    
1677    
1678    
1679    Schoenebeck            Expires September 30, 2007              [Page 30]
1680    
1681    Internet-Draft        LinuxSampler Control Protocol           March 2007
1682    
1683    
1684    6.3.3.  Getting information about a specific MIDI input driver
1685    
1686     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1687     specific MIDI input driver:     specific MIDI input driver:
1688    
1689        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>        GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
1690    
1691     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
1692       returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
1693       command.
1694    
1695     Possible Answers:     Possible Answers:
1696    
# Line 1387  Internet-Draft       LinuxSampler Contro Line 1700  Internet-Draft       LinuxSampler Contro
1700        character string to that info category.  At the moment the        character string to that info category.  At the moment the
1701        following information categories are defined:        following information categories are defined:
1702    
          DESCRIPTION -  
             arbitrary description text about the MIDI input driver  
          VERSION -  
             arbitrary character string regarding the driver's version  
          PARAMETERS -  
1703    
1704    
1705             DESCRIPTION -
1706    
1707                arbitrary description text about the MIDI input driver
1708    
1709  Schoenebeck             Expires November 7, 2005               [Page 25]           VERSION -
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
1710    
1711                arbitrary character string regarding the driver's version
1712    
1713             PARAMETERS -
1714    
1715              comma separated list of all parameters available for the              comma separated list of all parameters available for the
1716              given MIDI input driver              given MIDI input driver
1717    
1718        The mentioned fields above don't have to be in particular order.        The mentioned fields above don't have to be in particular order.
1719    
1720     Example:     Example:
1721    
1722        C: "GET MIDI_INPUT_DRIVER INFO ALSA"        C: "GET MIDI_INPUT_DRIVER INFO ALSA"
1723    
1724        S: "DESCRIPTION: Advanced Linux Sound Architecture"        S: "DESCRIPTION: Advanced Linux Sound Architecture"
1725    
1726           "VERSION: 1.0"           "VERSION: 1.0"
1727    
1728           "PARAMETERS: DRIVER,ACTIVE"           "PARAMETERS: DRIVER,ACTIVE"
1729    
1730           "."           "."
1731    
1732  5.3.4  Getting information about specific MIDI input driver parameter  
1733    
1734    
1735    Schoenebeck            Expires September 30, 2007              [Page 31]
1736    
1737    Internet-Draft        LinuxSampler Control Protocol           March 2007
1738    
1739    
1740    6.3.4.  Getting information about specific MIDI input driver parameter
1741    
1742     Use the following command to get detailed information about a     Use the following command to get detailed information about a
1743     specific parameter of a specific MIDI input driver:     specific parameter of a specific MIDI input driver:
1744    
1745        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]        GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1746    
1747     Where <midi-t> is the name of the MIDI input driver as returned by     Where <midit> is the name of the MIDI input driver as returned by the
1748     the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2) command,     "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2) command, <param>
1749     <param> a specific parameter name for which information should be     a specific parameter name for which information should be obtained
1750     obtained (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section     (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 6.3.3)
1751     5.3.3) command) and <deplist> is an optional list of parameters on     command) and <deplist> is an optional list of parameters on which the
1752     which the sought parameter <param> depends on, <deplist> is a     sought parameter <param> depends on, <deplist> is a key-value pair
1753     key-value pair list in form of "key1=val1 key2=val2 ...", where     list in form of "key1=val1 key2=val2 ...", where character string
1754     character string values are encapsulated into apostrophes (').     values are encapsulated into apostrophes (').  Arguments given with
1755     Arguments given with <deplist> which are not dependency parameters of     <deplist> which are not dependency parameters of <param> will be
1756     <param> will be ignored, means the front-end application can simply     ignored, means the front-end application can simply put all
1757     put all parameters in <deplist> with the values selected by the user.     parameters in <deplist> with the values selected by the user.
1758    
1759     Possible Answers:     Possible Answers:
1760    
# Line 1444  Internet-Draft       LinuxSampler Contro Line 1768  Internet-Draft       LinuxSampler Contro
1768     defined:     defined:
1769    
1770        TYPE -        TYPE -
1771    
1772           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
1773           value(s) or "FLOAT" for dotted number(s) or "STRING" for           value(s) or "FLOAT" for dotted number(s) or "STRING" for
1774           character string(s) (always returned, no matter which driver           character string(s) (always returned, no matter which driver
1775           parameter)           parameter)
1776    
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 26]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1777        DESCRIPTION -        DESCRIPTION -
1778    
1779           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
1780           returned, no matter which driver parameter)           returned, no matter which driver parameter)
1781    
1782        MANDATORY -        MANDATORY -
1783    
1784           either true or false, defines if this parameter must be given           either true or false, defines if this parameter must be given
1785           when the device is to be created with the 'CREATE           when the device is to be created with the 'CREATE
1786           MIDI_INPUT_DEVICE' (Section 5.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1787           matter which driver parameter)           matter which driver parameter)
1788    
1789    
1790    
1791    Schoenebeck            Expires September 30, 2007              [Page 32]
1792    
1793    Internet-Draft        LinuxSampler Control Protocol           March 2007
1794    
1795    
1796        FIX -        FIX -
1797    
1798           either true or false, if false then this parameter can be           either true or false, if false then this parameter can be
1799           changed at any time, once the device is created by the 'CREATE           changed at any time, once the device is created by the 'CREATE
1800           MIDI_INPUT_DEVICE' (Section 5.3.5) command (always returned, no           MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1801           matter which driver parameter)           matter which driver parameter)
1802    
1803        MULTIPLICITY -        MULTIPLICITY -
1804    
1805           either true or false, defines if this parameter allows only one           either true or false, defines if this parameter allows only one
1806           value or a list of values, where true means multiple values and           value or a list of values, where true means multiple values and
1807           false only a single value allowed (always returned, no matter           false only a single value allowed (always returned, no matter
1808           which driver parameter)           which driver parameter)
1809    
1810        DEPENDS -        DEPENDS -
1811           comma separated list of paramters this parameter depends on,  
1812             comma separated list of parameters this parameter depends on,
1813           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'           means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
1814           and 'POSSIBILITIES' might depend on these listed parameters,           and 'POSSIBILITIES' might depend on these listed parameters,
1815           for example assuming that an audio driver (like the ALSA           for example assuming that an audio driver (like the ALSA
# Line 1485  Internet-Draft       LinuxSampler Contro Line 1818  Internet-Draft       LinuxSampler Contro
1818           possible values for 'samplerate' depends on the sound card           possible values for 'samplerate' depends on the sound card
1819           which can be chosen by the 'card' parameter (optionally           which can be chosen by the 'card' parameter (optionally
1820           returned, dependent to driver parameter)           returned, dependent to driver parameter)
1821    
1822        DEFAULT -        DEFAULT -
1823    
1824           reflects the default value for this parameter which is used           reflects the default value for this parameter which is used
1825           when the device is created and not explicitly given with the           when the device is created and not explicitly given with the
1826           'CREATE MIDI_INPUT_DEVICE' (Section 5.3.5) command, in case of           'CREATE MIDI_INPUT_DEVICE' (Section 6.3.5) command, in case of
1827           MULTIPLCITY=true, this is a comma separated list, that's why           MULTIPLCITY=true, this is a comma separated list, that's why
1828           character strings are encapsulated into apostrophes (')           character strings are encapsulated into apostrophes (')
1829           (optionally returned, dependent to driver parameter)           (optionally returned, dependent to driver parameter)
1830    
1831        RANGE_MIN -        RANGE_MIN -
1832    
1833           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
1834           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1835           this parameter is often used in conjunction with RANGE_MAX, but           this parameter is often used in conjunction with RANGE_MAX, but
1836           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
1837           driver parameter)           driver parameter)
1838    
1839        RANGE_MAX -        RANGE_MAX -
1840    
1841           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
1842           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
1843           this parameter is often used in conjunction with RANGE_MIN, but           this parameter is often used in conjunction with RANGE_MIN, but
          may also appear without (optionally returned, dependent to  
          driver parameter)  
1844    
1845    
1846    
1847    Schoenebeck            Expires September 30, 2007              [Page 33]
 Schoenebeck             Expires November 7, 2005               [Page 27]  
1848    
1849  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
1850    
1851    
1852             may also appear without (optionally returned, dependent to
1853             driver parameter)
1854    
1855        POSSIBILITIES -        POSSIBILITIES -
1856    
1857           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
1858           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
1859           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1523  Internet-Draft       LinuxSampler Contro Line 1863  Internet-Draft       LinuxSampler Contro
1863     Example:     Example:
1864    
1865        C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"        C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
1866    
1867        S: "DESCRIPTION: Whether device is enabled"        S: "DESCRIPTION: Whether device is enabled"
1868    
1869           "TYPE: BOOL"           "TYPE: BOOL"
1870    
1871           "MANDATORY: false"           "MANDATORY: false"
1872    
1873           "FIX: false"           "FIX: false"
1874    
1875           "MULTIPLICITY: false"           "MULTIPLICITY: false"
1876    
1877           "DEFAULT: true"           "DEFAULT: true"
1878    
1879           "."           "."
1880    
1881  5.3.5  Creating a MIDI input device  6.3.5.  Creating a MIDI input device
1882    
1883     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
1884     desired MIDI input system:     desired MIDI input system:
1885    
1886        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]        CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
1887    
1888     Where <midi-input-driver> should be replaced by the desired MIDI     Where <midi-input-driver> should be replaced by the desired MIDI
1889     input system and <param-list> by an optional list of driver specific     input system as returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1890     parameters in form of "key1=val1 key2=val2 ...", where character     (Section 6.3.2) command and <param-list> by an optional list of
1891     string values should be encapsulated into apostrophes (').  Note that     driver specific parameters in form of "key1=val1 key2=val2 ...",
1892     there might be drivers which require parameter(s) to be given with     where character string values should be encapsulated into apostrophes
1893     this command.  Use the previously described commands in this chapter     (').  Note that there might be drivers which require parameter(s) to
1894     to get that information.     be given with this command.  Use the previously described commands in
1895       this chapter to get that information.
1896    
1897     Possible Answers:     Possible Answers:
1898    
1899    
1900    
1901    
1902    
1903    Schoenebeck            Expires September 30, 2007              [Page 34]
1904    
1905    Internet-Draft        LinuxSampler Control Protocol           March 2007
1906    
1907    
1908        "OK[<device-id>]" -        "OK[<device-id>]" -
1909    
1910           in case the device was successfully created, where <device-id>           in case the device was successfully created, where <device-id>
1911           is the numerical ID of the new device           is the numerical ID of the new device
1912    
1913        "WRN[<device-id>]:<warning-code>:<warning-message>" -        "WRN[<device-id>]:<warning-code>:<warning-message>" -
1914    
1915           in case the driver was loaded successfully, where <device-id>           in case the driver was loaded successfully, where <device-id>
1916           is the numerical ID of the new device, but there are noteworthy           is the numerical ID of the new device, but there are noteworthy
1917           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
1918           warning message           warning message
1919    
1920        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1921    
1922           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1923           error message           error message
1924    
1925     Example:     Example:
1926    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 28]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1927        C: "CREATE MIDI_INPUT_DEVICE ALSA"        C: "CREATE MIDI_INPUT_DEVICE ALSA"
1928    
1929        S: "OK[0]"        S: "OK[0]"
1930    
1931  5.3.6  Destroying a MIDI input device  6.3.6.  Destroying a MIDI input device
1932    
1933     Use the following command to destroy a created MIDI input device:     Use the following command to destroy a created MIDI input device:
1934    
1935        DESTROY MIDI_INPUT_DEVICE <device-id>        DESTROY MIDI_INPUT_DEVICE <device-id>
1936    
1937     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
1938       returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
1939       MIDI_INPUT_DEVICES" (Section 6.3.8) command.
1940    
1941     Possible Answers:     Possible Answers:
1942    
1943        "OK" -        "OK" -
1944    
1945           in case the device was successfully destroyed           in case the device was successfully destroyed
1946    
1947        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
1948    
1949           in case the device was destroyed, but there are noteworthy           in case the device was destroyed, but there are noteworthy
1950           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
1951           warning message           warning message
1952    
1953        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
1954    
1955    
1956    
1957    
1958    
1959    Schoenebeck            Expires September 30, 2007              [Page 35]
1960    
1961    Internet-Draft        LinuxSampler Control Protocol           March 2007
1962    
1963    
1964           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
1965           error message           error message
1966    
1967     Example:     Example:
1968    
1969        C: "DESTROY MIDI_INPUT_DEVICE 0"        C: "DESTROY MIDI_INPUT_DEVICE 0"
1970    
1971        S: "OK"        S: "OK"
1972    
1973  5.3.7  Getting all created MIDI input device count  6.3.7.  Getting all created MIDI input device count
1974    
1975     Use the following command to count all created MIDI input devices:     Use the following command to count all created MIDI input devices:
1976    
# Line 1611  Internet-Draft       LinuxSampler Contro Line 1984  Internet-Draft       LinuxSampler Contro
1984     Example:     Example:
1985    
1986        C: "GET MIDI_INPUT_DEVICES"        C: "GET MIDI_INPUT_DEVICES"
1987    
1988        S: "3"        S: "3"
1989    
1990  5.3.8  Getting all created MIDI input device list  6.3.8.  Getting all created MIDI input device list
1991    
1992     Use the following command to list all created MIDI input devices:     Use the following command to list all created MIDI input devices:
1993    
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 29]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
1994        LIST MIDI_INPUT_DEVICES        LIST MIDI_INPUT_DEVICES
1995    
1996     Possible Answers:     Possible Answers:
# Line 1635  Internet-Draft       LinuxSampler Contro Line 2001  Internet-Draft       LinuxSampler Contro
2001     Examples:     Examples:
2002    
2003        C: "LIST MIDI_INPUT_DEVICES"        C: "LIST MIDI_INPUT_DEVICES"
2004    
2005        S: "0,1,2"        S: "0,1,2"
2006    
2007        C: "LIST MIDI_INPUT_DEVICES"        C: "LIST MIDI_INPUT_DEVICES"
2008    
2009        S: "1,3"        S: "1,3"
2010    
2011  5.3.9  Getting current settings of a MIDI input device  
2012    
2013    
2014    
2015    Schoenebeck            Expires September 30, 2007              [Page 36]
2016    
2017    Internet-Draft        LinuxSampler Control Protocol           March 2007
2018    
2019    
2020    6.3.9.  Getting current settings of a MIDI input device
2021    
2022     Use the following command to get current settings of a specific,     Use the following command to get current settings of a specific,
2023     created MIDI input device:     created MIDI input device:
2024    
2025        GET MIDI_INPUT_DEVICE INFO <device-id>        GET MIDI_INPUT_DEVICE INFO <device-id>
2026    
2027     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
2028       returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2029       MIDI_INPUT_DEVICES" (Section 6.3.8) command.
2030    
2031     Possible Answers:     Possible Answers:
2032    
# Line 1659  Internet-Draft       LinuxSampler Contro Line 2038  Internet-Draft       LinuxSampler Contro
2038        apostrophes (').  At the moment the following information        apostrophes (').  At the moment the following information
2039        categories are defined (independent of driver):        categories are defined (independent of driver):
2040    
2041    
2042    
2043           DRIVER -           DRIVER -
2044              identifier of the used MIDI input driver, as e.g.  returned  
2045              by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 5.3.2)              identifier of the used MIDI input driver, as e.g. returned
2046                by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
2047              command              command
2048    
2049           ACTIVE -           ACTIVE -
2050    
2051              either true or false, if false then the MIDI device is              either true or false, if false then the MIDI device is
2052              inactive and doesn't listen to any incoming MIDI events and              inactive and doesn't listen to any incoming MIDI events and
2053              thus doesn't forward them to connected sampler channels              thus doesn't forward them to connected sampler channels
# Line 1672  Internet-Draft       LinuxSampler Contro Line 2056  Internet-Draft       LinuxSampler Contro
2056     fields above are only those fields which are returned by all MIDI     fields above are only those fields which are returned by all MIDI
2057     input devices.  Every MIDI input driver might have its own,     input devices.  Every MIDI input driver might have its own,
2058     additional driver specific parameters (see "GET MIDI_INPUT_DRIVER     additional driver specific parameters (see "GET MIDI_INPUT_DRIVER
2059     INFO" (Section 5.3.3) command) which are also returned by this     INFO" (Section 6.3.3) command) which are also returned by this
2060       command.
2061    
2062       Example:
2063    
2064          C: "GET MIDI_INPUT_DEVICE INFO 0"
2065    
2066  Schoenebeck             Expires November 7, 2005               [Page 30]        S: "DRIVER: ALSA"
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2067    
2068    
    command.  
2069    
    Example:  
2070    
2071        C: "GET MIDI_INPUT_DEVICE INFO 0"  Schoenebeck            Expires September 30, 2007              [Page 37]
2072        S: "DRIVER: ALSA"  
2073    Internet-Draft        LinuxSampler Control Protocol           March 2007
2074    
2075    
2076           "ACTIVE: true"           "ACTIVE: true"
2077    
2078           "."           "."
2079    
2080  5.3.10  Changing settings of MIDI input devices  6.3.10.  Changing settings of MIDI input devices
2081    
2082     Use the following command to alter a specific setting of a created     Use the following command to alter a specific setting of a created
2083     MIDI input device:     MIDI input device:
# Line 1698  Internet-Draft       LinuxSampler Contro Line 2085  Internet-Draft       LinuxSampler Contro
2085        SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>        SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>
2086    
2087     Where <device-id> should be replaced by the numerical ID of the MIDI     Where <device-id> should be replaced by the numerical ID of the MIDI
2088     input device, <key> by the name of the parameter to change and     input device as returned by the "CREATE MIDI_INPUT_DEVICE"
2089     <value> by the new value for this parameter.     (Section 6.3.5) or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command,
2090       <key> by the name of the parameter to change and <value> by the new
2091       value for this parameter.
2092    
2093     Possible Answers:     Possible Answers:
2094    
2095        "OK" -        "OK" -
2096    
2097           in case setting was successfully changed           in case setting was successfully changed
2098    
2099        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2100    
2101           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
2102           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2103           code and warning message           code and warning message
2104    
2105        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2106    
2107           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2108           error message           error message
2109    
2110     Example:     Example:
2111    
2112        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"        C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
2113    
2114        S: "OK"        S: "OK"
2115    
2116  5.3.11  Getting information about a MIDI port  6.3.11.  Getting information about a MIDI port
2117    
2118     Use the following command to get information about a MIDI port:     Use the following command to get information about a MIDI port:
2119    
2120        GET MIDI_INPUT_PORT INFO <device-id> <midi-port>        GET MIDI_INPUT_PORT INFO <device-id> <midi-port>
2121    
2122     Where <device-id> is the numerical ID of the MIDI input device and     Where <device-id> is the numerical ID of the MIDI input device as
2123     <midi-port> the MIDI input port number.     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2124    
    Possible Answers:  
2125    
2126    
2127    Schoenebeck            Expires September 30, 2007              [Page 38]
2128    
2129    Internet-Draft        LinuxSampler Control Protocol           March 2007
2130    
2131    
2132  Schoenebeck             Expires November 7, 2005               [Page 31]     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2133       input port number.
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2134    
2135       Possible Answers:
2136    
2137        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2138        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2139        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2140        character string to that info category.  At the moment the        character string to that info category.  At the moment the
2141        following information categories are defined:        following information categories are defined:
2142    
2143        NAME -        NAME -
2144    
2145           arbitrary character string naming the port           arbitrary character string naming the port
2146    
2147     The field above is only the one which is returned by all MIDI ports     The field above is only the one which is returned by all MIDI ports
# Line 1752  Internet-Draft       LinuxSampler Contro Line 2151  Internet-Draft       LinuxSampler Contro
2151     Example:     Example:
2152    
2153        C: "GET MIDI_INPUT_PORT INFO 0 0"        C: "GET MIDI_INPUT_PORT INFO 0 0"
2154    
2155        S: "NAME: 'Masterkeyboard'"        S: "NAME: 'Masterkeyboard'"
2156    
2157           "ALSA_SEQ_BINDINGS: '64:0'"           "ALSA_SEQ_BINDINGS: '64:0'"
2158    
2159           "."           "."
2160    
2161  5.3.12  Getting information about specific MIDI port parameter  6.3.12.  Getting information about specific MIDI port parameter
2162    
2163     Use the following command to get detailed information about specific     Use the following command to get detailed information about specific
2164     MIDI port parameter:     MIDI port parameter:
# Line 1764  Internet-Draft       LinuxSampler Contro Line 2166  Internet-Draft       LinuxSampler Contro
2166        GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>        GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
2167    
2168     Where <dev-id> is the numerical ID of the MIDI input device as     Where <dev-id> is the numerical ID of the MIDI input device as
2169     returned by the "LIST MIDI_INPUT_DEVICES" (Section 5.3.8) command,     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2170     <port> the MIDI port number and <param> a specific port parameter     MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> the MIDI port
2171     name for which information should be obtained (as returned by the     number and <param> a specific port parameter name for which
2172     "GET MIDI_INPUT_PORT INFO" (Section 5.3.11) command).     information should be obtained (as returned by the "GET
2173       MIDI_INPUT_PORT INFO" (Section 6.3.11) command).
2174    
2175     Possible Answers:     Possible Answers:
2176    
2177        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2178        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2179        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2180    
2181    
2182    
2183    Schoenebeck            Expires September 30, 2007              [Page 39]
2184    
2185    Internet-Draft        LinuxSampler Control Protocol           March 2007
2186    
2187    
2188        character string to that info category.  There is information        character string to that info category.  There is information
2189        which is always returned, independently of the given channel        which is always returned, independently of the given channel
2190        parameter and there is optional information which are only shown        parameter and there is optional information which are only shown
2191        dependently to the given MIDI port.  At the moment the following        dependently to the given MIDI port.  At the moment the following
2192        information categories are defined:        information categories are defined:
2193    
2194        TYPE -        TYPE -
2195    
2196           either "BOOL" for boolean value(s) or "INT" for integer           either "BOOL" for boolean value(s) or "INT" for integer
2197           value(s) or "FLOAT" for dotted number(s) or "STRING" for           value(s) or "FLOAT" for dotted number(s) or "STRING" for
2198           character string(s) (always returned)           character string(s) (always returned)
       DESCRIPTION -  
   
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 32]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2199    
2200          DESCRIPTION -
2201    
2202           arbitrary text describing the purpose of the parameter (always           arbitrary text describing the purpose of the parameter (always
2203           returned)           returned)
2204    
2205        FIX -        FIX -
2206    
2207           either true or false, if true then this parameter is read only,           either true or false, if true then this parameter is read only,
2208           thus cannot be altered (always returned)           thus cannot be altered (always returned)
2209    
2210        MULTIPLICITY -        MULTIPLICITY -
2211    
2212           either true or false, defines if this parameter allows only one           either true or false, defines if this parameter allows only one
2213           value or a list of values, where true means multiple values and           value or a list of values, where true means multiple values and
2214           false only a single value allowed (always returned)           false only a single value allowed (always returned)
2215    
2216        RANGE_MIN -        RANGE_MIN -
2217    
2218           defines lower limit of the allowed value range for this           defines lower limit of the allowed value range for this
2219           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
2220           this parameter is usually used in conjunction with 'RANGE_MAX'           this parameter is usually used in conjunction with 'RANGE_MAX'
2221           but may also appear without (optionally returned, dependent to           but may also appear without (optionally returned, dependent to
2222           driver and port parameter)           driver and port parameter)
2223    
2224        RANGE_MAX -        RANGE_MAX -
2225    
2226           defines upper limit of the allowed value range for this           defines upper limit of the allowed value range for this
2227           parameter, can be an integer value as well as a dotted number,           parameter, can be an integer value as well as a dotted number,
2228           this parameter is usually used in conjunction with 'RANGE_MIN'           this parameter is usually used in conjunction with 'RANGE_MIN'
2229           but may also appear without (optionally returned, dependent to           but may also appear without (optionally returned, dependent to
2230           driver and port parameter)           driver and port parameter)
2231    
2232        POSSIBILITIES -        POSSIBILITIES -
2233    
2234           comma separated list of possible values for this parameter,           comma separated list of possible values for this parameter,
2235           character strings are encapsulated into apostrophes (optionally           character strings are encapsulated into apostrophes (optionally
2236    
2237    
2238    
2239    Schoenebeck            Expires September 30, 2007              [Page 40]
2240    
2241    Internet-Draft        LinuxSampler Control Protocol           March 2007
2242    
2243    
2244           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
2245    
2246     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 1824  Internet-Draft       LinuxSampler Contro Line 2248  Internet-Draft       LinuxSampler Contro
2248     Example:     Example:
2249    
2250        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"        C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
2251    
2252        S: "DESCRIPTION: bindings to other ALSA sequencer clients"        S: "DESCRIPTION: bindings to other ALSA sequencer clients"
2253    
2254           "TYPE: STRING"           "TYPE: STRING"
2255    
2256           "FIX: false"           "FIX: false"
2257    
2258           "MULTIPLICITY: true"           "MULTIPLICITY: true"
2259    
2260           "POSSIBILITIES: '64:0','68:0','68:1'"           "POSSIBILITIES: '64:0','68:0','68:1'"
2261    
2262           "."           "."
2263    
2264  5.3.13  Changing settings of MIDI input ports  6.3.13.  Changing settings of MIDI input ports
2265    
2266     Use the following command to alter a specific setting of a MIDI input     Use the following command to alter a specific setting of a MIDI input
2267     port:     port:
# Line 1839  Internet-Draft       LinuxSampler Contro Line 2269  Internet-Draft       LinuxSampler Contro
2269        SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value>        SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value>
2270    
2271     Where <device-id> should be replaced by the numerical ID of the MIDI     Where <device-id> should be replaced by the numerical ID of the MIDI
2272     device, <port> by the MIDI port number, <key> by the name of the     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2273     parameter to change and <value> by the new value for this parameter.     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2274       MIDI port number, <key> by the name of the parameter to change and
2275       <value> by the new value for this parameter.
   
 Schoenebeck             Expires November 7, 2005               [Page 33]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
2276    
2277     Possible Answers:     Possible Answers:
2278    
2279        "OK" -        "OK" -
2280    
2281           in case setting was successfully changed           in case setting was successfully changed
2282    
2283        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2284    
2285           in case setting was changed successfully, but there are           in case setting was changed successfully, but there are
2286           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2287           code and warning message           code and warning message
2288    
2289        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2290    
2291    
2292    
2293    
2294    
2295    Schoenebeck            Expires September 30, 2007              [Page 41]
2296    
2297    Internet-Draft        LinuxSampler Control Protocol           March 2007
2298    
2299    
2300           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2301           error message           error message
2302    
# Line 1865  Internet-Draft       LinuxSampler Contro Line 2304  Internet-Draft       LinuxSampler Contro
2304    
2305    
2306    
2307  5.4  Configuring sampler channels  6.4.  Configuring sampler channels
2308    
2309     The following commands describe how to add and remove sampler     The following commands describe how to add and remove sampler
2310     channels, deploy sampler engines, load instruments and connect     channels, associate a sampler channel with a sampler engine, load
2311     sampler channels to MIDI and audio devices.     instruments and connect sampler channels to MIDI and audio devices.
2312    
2313  5.4.1  Loading an instrument  6.4.1.  Loading an instrument
2314    
2315     An instrument file can be loaded and assigned to a sampler channel by     An instrument file can be loaded and assigned to a sampler channel by
2316     one of the following commands:     one of the following commands:
2317    
2318        LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index>        LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-
2319        <sampler-channel>        channel>
2320    
2321     Where <filename> is the name of the instrument file on the     Where <filename> is the name of the instrument file on the
2322     LinuxSampler instance's host system, <instr-index> the index of the     LinuxSampler instance's host system, <instr-index> the index of the
# Line 1889  Internet-Draft       LinuxSampler Contro Line 2328  Internet-Draft       LinuxSampler Contro
2328     is that the regular command returns OK only after the instrument has     is that the regular command returns OK only after the instrument has
2329     been fully loaded and the channel is ready to be used while NON_MODAL     been fully loaded and the channel is ready to be used while NON_MODAL
2330     version returns immediately and a background process is launched to     version returns immediately and a background process is launched to
2331     load the instrument on the channel.  The GET CHANNEL INFO (Section     load the instrument on the channel.  The GET CHANNEL INFO
2332     5.4.10) command can be used to obtain loading progress from     (Section 6.4.10) command can be used to obtain loading progress from
2333     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks     INSTRUMENT_STATUS field.  LOAD command will perform sanity checks
2334     such as making sure that the file could be read and it is of a proper     such as making sure that the file could be read and it is of a proper
2335     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 1898  Internet-Draft       LinuxSampler Contro Line 2337  Internet-Draft       LinuxSampler Contro
2337    
2338     Possible Answers:     Possible Answers:
2339    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 34]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
2340        "OK" -        "OK" -
2341    
2342           in case the instrument was successfully loaded           in case the instrument was successfully loaded
2343    
2344        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2345    
2346           in case the instrument was loaded successfully, but there are           in case the instrument was loaded successfully, but there are
2347           noteworthy issue(s) related (e.g.  Engine doesn't support one           noteworthy issue(s) related (e.g.  Engine doesn't support one
2348    
2349    
2350    
2351    Schoenebeck            Expires September 30, 2007              [Page 42]
2352    
2353    Internet-Draft        LinuxSampler Control Protocol           March 2007
2354    
2355    
2356           or more patch parameters provided by the loaded instrument           or more patch parameters provided by the loaded instrument
2357           file), providing an appropriate warning code and warning           file), providing an appropriate warning code and warning
2358           message           message
2359    
2360        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2361    
2362           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2363           error message           error message
2364    
# Line 1921  Internet-Draft       LinuxSampler Contro Line 2366  Internet-Draft       LinuxSampler Contro
2366    
2367    
2368    
2369  5.4.2  Loading a sampler engine  6.4.2.  Loading a sampler engine
2370    
2371     A sample engine can be deployed and assigned to a specific sampler     A sampler engine type can be associated to a specific sampler channel
2372     channel by the following command:     by the following command:
2373    
2374        LOAD ENGINE <engine-name> <sampler-channel>        LOAD ENGINE <engine-name> <sampler-channel>
2375    
2376     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2377     AVAILABLE_ENGINES" (Section 5.4.8) command and <sampler-channel> the     AVAILABLE_ENGINES" (Section 6.4.8) command and <sampler-channel> the
2378     sampler channel the deployed engine should be assigned to.  Even if     sampler channel as returned by the "ADD CHANNEL" (Section 6.4.5) or
2379     the respective sampler channel has already a deployed engine with     "LIST CHANNELS" (Section 6.4.4) command where the engine type should
2380     that engine name, a new engine instance will be assigned to the     be assigned to.  This command should be issued after adding a new
2381     sampler channel.     sampler channel and before any other control commands on the new
2382       sampler channel.  It can also be used to change the engine type of a
2383       sampler channel.  This command has (currently) no way to define or
2384       force if a new engine instance should be created and assigned to the
2385       given sampler channel or if an already existing instance of that
2386       engine type, shared with other sampler channels, should be used.
2387    
2388     Possible Answers:     Possible Answers:
2389    
2390        "OK" -        "OK" -
2391    
2392           in case the engine was successfully deployed           in case the engine was successfully deployed
2393    
2394        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2395    
2396           in case the engine was deployed successfully, but there are           in case the engine was deployed successfully, but there are
2397           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2398           code and warning message           code and warning message
2399    
2400        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2401    
2402           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2403           error message           error message
2404    
    Example:  
   
   
   
2405    
2406    
2407    Schoenebeck            Expires September 30, 2007              [Page 43]
2408    
2409    Internet-Draft        LinuxSampler Control Protocol           March 2007
2410    
2411    
2412       Example:
2413    
 Schoenebeck             Expires November 7, 2005               [Page 35]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2414    
2415    
2416  5.4.3  Getting all created sampler channel count  6.4.3.  Getting all created sampler channel count
2417    
2418     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2419     current amount of sampler channels, the front-end can send the     current amount of sampler channels, the front-end can send the
# Line 1977  Internet-Draft       LinuxSampler Contro Line 2429  Internet-Draft       LinuxSampler Contro
2429     Example:     Example:
2430    
2431        C: "GET CHANNELS"        C: "GET CHANNELS"
2432    
2433        S: "12"        S: "12"
2434    
2435  5.4.4  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
2436    
2437     The number of sampler channels can change on runtime.  To get the     The number of sampler channels can change on runtime.  To get the
2438     current list of sampler channels, the front-end can send the     current list of sampler channels, the front-end can send the
# Line 1995  Internet-Draft       LinuxSampler Contro Line 2448  Internet-Draft       LinuxSampler Contro
2448     Example:     Example:
2449    
2450        C: "LIST CHANNELS"        C: "LIST CHANNELS"
2451    
2452        S: "0,1,2,3,4,5,6,9,10,11,15,20"        S: "0,1,2,3,4,5,6,9,10,11,15,20"
2453    
2454  5.4.5  Adding a new sampler channel  6.4.5.  Adding a new sampler channel
2455    
2456     A new sampler channel can be added to the end of the sampler channel     A new sampler channel can be added to the end of the sampler channel
2457     list by sending the following command:     list by sending the following command:
2458    
       ADD CHANNEL  
2459    
    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  
2460    
2461    
2462    
2463  Schoenebeck             Expires November 7, 2005               [Page 36]  Schoenebeck            Expires September 30, 2007              [Page 44]
2464    
2465  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
2466    
2467    
2468          ADD CHANNEL
2469    
2470       This will increment the sampler channel count by one and the new
2471       sampler channel will be appended to the end of the sampler channel
2472       list.  The front-end should send the respective, related commands
2473       right after to e.g. load an engine, load an instrument and setting
2474       input, output method and eventually other commands to initialize the
2475     new channel.  The front-end should use the sampler channel returned     new channel.  The front-end should use the sampler channel returned
2476     by the answer of this command to perform the previously recommended     by the answer of this command to perform the previously recommended
2477     commands, to avoid race conditions e.g.  with other front-ends that     commands, to avoid race conditions e.g. with other front-ends that
2478     might also have sent an "ADD CHANNEL" command.     might also have sent an "ADD CHANNEL" command.
2479    
2480     Possible Answers:     Possible Answers:
2481    
2482        "OK[<sampler-channel>]" -        "OK[<sampler-channel>]" -
2483           in case a new sampler channel could be added, where  
2484           <sampler-channel> reflects the channel number of the new           in case a new sampler channel could be added, where <sampler-
2485           created sampler channel which should the be used to set up the           channel> reflects the channel number of the new created sampler
2486           sampler channel by sending subsequent intialization commands           channel which should be used to set up the sampler channel by
2487             sending subsequent initialization commands
2488    
2489        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2490    
2491           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
2492           noteworthy issue(s) related, providing an appropriate warning           noteworthy issue(s) related, providing an appropriate warning
2493           code and warning message           code and warning message
2494    
2495        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2496    
2497           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2498           error message           error message
2499    
# Line 2041  Internet-Draft       LinuxSampler Contro Line 2501  Internet-Draft       LinuxSampler Contro
2501    
2502    
2503    
2504  5.4.6  Removing a sampler channel  6.4.6.  Removing a sampler channel
2505    
2506     A sampler channel can be removed by sending the following command:     A sampler channel can be removed by sending the following command:
2507    
2508        REMOVE CHANNEL <sampler-channel>        REMOVE CHANNEL <sampler-channel>
2509    
2510     This will decrement the sampler channel count by one and also     Where <sampler-channel> should be replaced by the number of the
2511     decrement the channel numbers of all subsequent sampler channels by     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
2512     one.     "LIST CHANNELS" (Section 6.4.4) command.  The channel numbers of all
2513       subsequent sampler channels remain the same.
2514    
2515     Possible Answers:     Possible Answers:
2516    
2517    
2518    
2519    Schoenebeck            Expires September 30, 2007              [Page 45]
2520    
2521    Internet-Draft        LinuxSampler Control Protocol           March 2007
2522    
2523    
2524        "OK" -        "OK" -
2525    
2526           in case the given sampler channel could be removed           in case the given sampler channel could be removed
2527    
2528        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2529    
2530           in case the given channel was removed, but there are noteworthy           in case the given channel was removed, but there are noteworthy
2531           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
2532           warning message           warning message
2533    
2534        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2535    
2536           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2537           error message           error message
2538    
# Line 2067  Internet-Draft       LinuxSampler Contro Line 2540  Internet-Draft       LinuxSampler Contro
2540    
2541    
2542    
2543    6.4.7.  Getting amount of available engines
 Schoenebeck             Expires November 7, 2005               [Page 37]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
   
 5.4.7  Getting amount of available engines  
2544    
2545     The front-end can ask for the number of available engines by sending     The front-end can ask for the number of available engines by sending
2546     the following command:     the following command:
# Line 2090  Internet-Draft       LinuxSampler Contro Line 2555  Internet-Draft       LinuxSampler Contro
2555     Example:     Example:
2556    
2557        C: "GET AVAILABLE_ENGINES"        C: "GET AVAILABLE_ENGINES"
2558    
2559        S: "4"        S: "4"
2560    
2561  5.4.8  Getting all available engines  6.4.8.  Getting all available engines
2562    
2563     The front-end can ask for a list of all available engines by sending     The front-end can ask for a list of all available engines by sending
2564     the following command:     the following command:
# Line 2101  Internet-Draft       LinuxSampler Contro Line 2567  Internet-Draft       LinuxSampler Contro
2567    
2568     Possible Answers:     Possible Answers:
2569    
2570        LinuxSampler will answer by sending a comma separated character  
2571        string of the engines' names.  Engine names can consist of lower  
2572        and upper cases, digits and underlines ("_" character).  
2573    
2574    
2575    Schoenebeck            Expires September 30, 2007              [Page 46]
2576    
2577    Internet-Draft        LinuxSampler Control Protocol           March 2007
2578    
2579    
2580          LinuxSampler will answer by sending a comma separated list of the
2581          engines' names encapsulated into apostrophes (').  Engine names
2582          can consist of lower and upper cases, digits and underlines ("_"
2583          character).
2584    
2585     Example:     Example:
2586    
2587        C: "LIST AVAILABLE_ENGINES"        C: "LIST AVAILABLE_ENGINES"
       S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"  
2588    
2589  5.4.9  Getting information about an engine        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2590    
2591    6.4.9.  Getting information about an engine
2592    
2593     The front-end can ask for information about a specific engine by     The front-end can ask for information about a specific engine by
2594     sending the following command:     sending the following command:
# Line 2118  Internet-Draft       LinuxSampler Contro Line 2596  Internet-Draft       LinuxSampler Contro
2596        GET ENGINE INFO <engine-name>        GET ENGINE INFO <engine-name>
2597    
2598     Where <engine-name> is an engine name as obtained by the "LIST     Where <engine-name> is an engine name as obtained by the "LIST
2599     AVAILABLE_ENGINES" (Section 5.4.8) command.     AVAILABLE_ENGINES" (Section 6.4.8) command.
2600    
2601     Possible Answers:     Possible Answers:
2602    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 38]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
2603        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
2604        answer line begins with the information category name followed by        answer line begins with the information category name followed by
2605        a colon and then a space character <SP> and finally the info        a colon and then a space character <SP> and finally the info
2606        character string to that info category.  At the moment the        character string to that info category.  At the moment the
2607        following categories are defined:        following categories are defined:
2608    
2609    
2610    
2611           DESCRIPTION -           DESCRIPTION -
2612    
2613              arbitrary description text about the engine              arbitrary description text about the engine
2614    
2615           VERSION -           VERSION -
2616    
2617              arbitrary character string regarding the engine's version              arbitrary character string regarding the engine's version
2618    
2619     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 2145  Internet-Draft       LinuxSampler Contro Line 2621  Internet-Draft       LinuxSampler Contro
2621     Example:     Example:
2622    
2623        C: "GET ENGINE INFO JoesCustomEngine"        C: "GET ENGINE INFO JoesCustomEngine"
2624    
2625        S: "DESCRIPTION: this is Joe's custom sampler engine"        S: "DESCRIPTION: this is Joe's custom sampler engine"
2626    
2627    
2628    
2629    
2630    
2631    Schoenebeck            Expires September 30, 2007              [Page 47]
2632    
2633    Internet-Draft        LinuxSampler Control Protocol           March 2007
2634    
2635    
2636           "VERSION: testing-1.0"           "VERSION: testing-1.0"
2637    
2638           "."           "."
2639    
2640  5.4.10  Getting sampler channel information  6.4.10.  Getting sampler channel information
2641    
2642     The front-end can ask for the current settings of a sampler channel     The front-end can ask for the current settings of a sampler channel
2643     by sending the following command:     by sending the following command:
# Line 2157  Internet-Draft       LinuxSampler Contro Line 2645  Internet-Draft       LinuxSampler Contro
2645        GET CHANNEL INFO <sampler-channel>        GET CHANNEL INFO <sampler-channel>
2646    
2647     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2648     is interested in.     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2649       "LIST CHANNELS" (Section 6.4.4) command.
2650    
2651     Possible Answers:     Possible Answers:
2652    
# Line 2167  Internet-Draft       LinuxSampler Contro Line 2656  Internet-Draft       LinuxSampler Contro
2656        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
2657        following categories are defined:        following categories are defined:
2658    
2659    
2660    
2661           ENGINE_NAME -           ENGINE_NAME -
2662              name of the engine that is deployed on the sampler channel,  
2663              "NONE" if there's no engine deployed yet for this sampler              name of the engine that is associated with the sampler
2664              channel              channel, "NONE" if there's no engine associated yet for this
2665                sampler channel
2666    
2667           AUDIO_OUTPUT_DEVICE -           AUDIO_OUTPUT_DEVICE -
2668    
2669              numerical ID of the audio output device which is currently              numerical ID of the audio output device which is currently
2670              connected to this sampler channel to output the audio              connected to this sampler channel to output the audio
2671              signal, "NONE" if there's no device connected to this              signal, "NONE" if there's no device connected to this
2672              sampler channel              sampler channel
2673    
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 39]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
2674           AUDIO_OUTPUT_CHANNELS -           AUDIO_OUTPUT_CHANNELS -
2675    
2676              number of output channels the sampler channel offers              number of output channels the sampler channel offers
2677              (dependent to used sampler engine and loaded instrument)              (dependent to used sampler engine and loaded instrument)
2678    
2679           AUDIO_OUTPUT_ROUTING -           AUDIO_OUTPUT_ROUTING -
2680    
2681              comma separated list which reflects to which audio channel              comma separated list which reflects to which audio channel
2682              of the selected audio output device each sampler output              of the selected audio output device each sampler output
2683              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
2684    
2685    
2686    
2687    Schoenebeck            Expires September 30, 2007              [Page 48]
2688    
2689    Internet-Draft        LinuxSampler Control Protocol           March 2007
2690    
2691    
2692              output channel 0 is routed to channel 0 of the audio output              output channel 0 is routed to channel 0 of the audio output
2693              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2694              channel 3 of the audio output device              channel 3 of the audio output device
2695    
2696           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2697    
2698              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
2699              instrument yet loaded for this sampler channel              instrument yet loaded for this sampler channel
2700    
2701           INSTRUMENT_NR -           INSTRUMENT_NR -
2702    
2703              the instrument index number of the loaded instrument              the instrument index number of the loaded instrument
2704    
2705           INSTRUMENT_NAME -           INSTRUMENT_NAME -
2706    
2707              the instrument name of the loaded instrument              the instrument name of the loaded instrument
2708    
2709           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2710    
2711              integer values 0 to 100 indicating loading progress              integer values 0 to 100 indicating loading progress
2712              percentage for the instrument.  Negative value indicates a              percentage for the instrument.  Negative value indicates a
2713              loading exception.  Value of 100 indicates that the              loading exception.  Value of 100 indicates that the
2714              instrument is fully loaded.              instrument is fully loaded.
2715    
2716           MIDI_INPUT_DEVICE -           MIDI_INPUT_DEVICE -
2717    
2718              numerical ID of the MIDI input device which is currently              numerical ID of the MIDI input device which is currently
2719              connected to this sampler channel to deliver MIDI input              connected to this sampler channel to deliver MIDI input
2720              commands, "NONE" if there's no device connected to this              commands, "NONE" if there's no device connected to this
2721              sampler channel              sampler channel
2722    
2723           MIDI_INPUT_PORT -           MIDI_INPUT_PORT -
2724    
2725              port number of the MIDI input device              port number of the MIDI input device
2726    
2727           MIDI_INPUT_CHANNEL -           MIDI_INPUT_CHANNEL -
2728    
2729              the MIDI input channel number this sampler channel should              the MIDI input channel number this sampler channel should
2730              listen to or "ALL" to listen on all MIDI channels              listen to or "ALL" to listen on all MIDI channels
2731    
2732           VOLUME -           VOLUME -
2733    
2734              optionally dotted number for the channel volume factor              optionally dotted number for the channel volume factor
2735              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2736              means amplification)              means amplification)
2737    
2738    
2739    
2740    
2741    
2742    
2743    Schoenebeck            Expires September 30, 2007              [Page 49]
2744    
2745    Internet-Draft        LinuxSampler Control Protocol           March 2007
2746    
2747    
2748             MUTE -
2749    
2750                Determines whether the channel is muted, "true" if the
2751                channel is muted, "false" if the channel is not muted, and
2752                "MUTED_BY_SOLO" if the channel is muted because of the
2753                presence of a solo channel and will be unmuted when there
2754                are no solo channels left
2755    
2756             SOLO -
2757    
2758                Determines whether this is a solo channel, "true" if the
2759                channel is a solo channel; "false" otherwise
2760    
2761             MIDI_INSTRUMENT_MAP -
2762    
2763                Determines to which MIDI instrument map this sampler channel
2764                is assigned to.  Read chapter "SET CHANNEL
2765                MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2766                values.
2767    
2768     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2769    
2770     Example:     Example:
2771    
2772        C: "GET CHANNEL INFO 34"        C: "GET CHANNEL INFO 34"
       S: "ENGINE_NAME: GigEngine"  
          "VOLUME: 1.0"  
          "AUDIO_OUTPUT_DEVICE: 0"  
          "AUDIO_OUTPUT_CHANNELS: 2"  
          "AUDIO_OUTPUT_ROUTING: 0,1"  
2773    
2774          S: "ENGINE_NAME: GigEngine"
2775    
2776             "VOLUME: 1.0"
2777    
2778             "AUDIO_OUTPUT_DEVICE: 0"
2779    
2780  Schoenebeck             Expires November 7, 2005               [Page 40]           "AUDIO_OUTPUT_CHANNELS: 2"
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2781    
2782             "AUDIO_OUTPUT_ROUTING: 0,1"
2783    
2784           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"           "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2785    
2786           "INSTRUMENT_NR: 0"           "INSTRUMENT_NR: 0"
2787    
2788           "INSTRUMENT_NAME: Fazioli Piano"           "INSTRUMENT_NAME: Fazioli Piano"
2789    
2790           "INSTRUMENT_STATUS: 100"           "INSTRUMENT_STATUS: 100"
2791    
2792           "MIDI_INPUT_DEVICE: 0"           "MIDI_INPUT_DEVICE: 0"
2793    
2794           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2795    
2796    
2797    
2798    
2799    Schoenebeck            Expires September 30, 2007              [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol           March 2007
2802    
2803    
2804           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2805    
2806             "VOLUME: 1.0"
2807    
2808             "MUTE: false"
2809    
2810             "SOLO: false"
2811    
2812             "MIDI_INSTRUMENT_MAP: NONE"
2813    
2814           "."           "."
2815    
2816  5.4.11  Current number of active voices  6.4.11.  Current number of active voices
2817    
2818     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2819     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2258  Internet-Draft       LinuxSampler Contro Line 2821  Internet-Draft       LinuxSampler Contro
2821        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2822    
2823     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2824     is interested in.     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2825       "LIST CHANNELS" (Section 6.4.4) command.
2826    
2827     Possible Answers:     Possible Answers:
2828    
# Line 2269  Internet-Draft       LinuxSampler Contro Line 2833  Internet-Draft       LinuxSampler Contro
2833    
2834    
2835    
2836  5.4.12  Current number of active disk streams  6.4.12.  Current number of active disk streams
2837    
2838     The front-end can ask for the current number of active disk streams     The front-end can ask for the current number of active disk streams
2839     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
# Line 2277  Internet-Draft       LinuxSampler Contro Line 2841  Internet-Draft       LinuxSampler Contro
2841        GET CHANNEL STREAM_COUNT <sampler-channel>        GET CHANNEL STREAM_COUNT <sampler-channel>
2842    
2843     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
2844     is interested in.     is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2845       "LIST CHANNELS" (Section 6.4.4) command.
2846    
2847     Possible Answers:     Possible Answers:
2848    
2849        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
2850        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
2851        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
       return "NA" for not available.  
   
    Example:  
2852    
2853    
2854    
2855    Schoenebeck            Expires September 30, 2007              [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol           March 2007
2858    
2859    
2860  Schoenebeck             Expires November 7, 2005               [Page 41]        return "NA" for not available.
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
2861    
2862       Example:
2863    
2864    
2865    
2866  5.4.13  Current fill state of disk stream buffers  6.4.13.  Current fill state of disk stream buffers
2867    
2868     The front-end can ask for the current fill state of all disk streams     The front-end can ask for the current fill state of all disk streams
2869     on a sampler channel by sending the following command:     on a sampler channel by sending the following command:
# Line 2311  Internet-Draft       LinuxSampler Contro Line 2875  Internet-Draft       LinuxSampler Contro
2875        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
2876    
2877     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
2878     sampler channel number the front-end is interested in.     sampler channel number the front-end is interested in as returned by
2879       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2880       command.
2881    
2882     Possible Answers:     Possible Answers:
2883    
# Line 2329  Internet-Draft       LinuxSampler Contro Line 2895  Internet-Draft       LinuxSampler Contro
2895     Examples:     Examples:
2896    
2897        C: "GET CHANNEL BUFFER_FILL BYTES 4"        C: "GET CHANNEL BUFFER_FILL BYTES 4"
2898    
2899        S: "[115]420500,[116]510300,[75]110000,[120]230700"        S: "[115]420500,[116]510300,[75]110000,[120]230700"
2900    
2901        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2902    
2903        S: "[115]90%,[116]98%,[75]40%,[120]62%"        S: "[115]90%,[116]98%,[75]40%,[120]62%"
2904    
2905        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
       S: ""  
2906    
 5.4.14  Setting audio output device  
2907    
    The front-end can set the audio output device on a specific sampler  
    channel by sending the following command:  
2908    
       SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>  
       <audio-device-id>  
2909    
    Where <audio-device-id> is the numerical ID of the audio output  
    device and <sampler-channel> is the respective sampler channel  
2910    
2911    Schoenebeck            Expires September 30, 2007              [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol           March 2007
2914    
2915    
2916  Schoenebeck             Expires November 7, 2005               [Page 42]        S: ""
2917    
2918  Internet-Draft       LinuxSampler Control Protocol              May 2005  6.4.14.  Setting audio output device
2919    
2920       The front-end can set the audio output device on a specific sampler
2921       channel by sending the following command:
2922    
2923     number.        SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>
2924          <audio-device-id>
2925    
2926       Where <sampler-channel> is the respective sampler channel number as
2927       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
2928       (Section 6.4.4) command and <audio-device-id> is the numerical ID of
2929       the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
2930       (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
2931       command.
2932    
2933     Possible Answers:     Possible Answers:
2934    
2935        "OK" -        "OK" -
2936    
2937           on success           on success
2938    
2939        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2940    
2941           if audio output device was set, but there are noteworthy           if audio output device was set, but there are noteworthy
2942           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
2943           warning message           warning message
2944    
2945        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2946    
2947           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2948           error message           error message
2949    
# Line 2371  Internet-Draft       LinuxSampler Contro Line 2951  Internet-Draft       LinuxSampler Contro
2951    
2952    
2953    
2954  5.4.15  Setting audio output type  6.4.15.  Setting audio output type
2955    
2956     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
2957    
2958     The front-end can alter the audio output type on a specific sampler     The front-end can alter the audio output type on a specific sampler
2959     channel by sending the following command:     channel by sending the following command:
2960    
2961        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel>        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
2962        <audio-output-type>        type>
2963    
2964    
2965    
2966    
2967    Schoenebeck            Expires September 30, 2007              [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol           March 2007
2970    
2971    
2972     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
2973     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
# Line 2387  Internet-Draft       LinuxSampler Contro Line 2975  Internet-Draft       LinuxSampler Contro
2975     Possible Answers:     Possible Answers:
2976    
2977        "OK" -        "OK" -
2978    
2979           on success           on success
2980    
2981        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
2982    
2983           if audio output type was set, but there are noteworthy issue(s)           if audio output type was set, but there are noteworthy issue(s)
2984           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
2985           message           message
2986    
2987        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
2988    
2989           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
2990           error message           error message
2991    
# Line 2400  Internet-Draft       LinuxSampler Contro Line 2993  Internet-Draft       LinuxSampler Contro
2993    
2994    
2995    
2996    6.4.16.  Setting audio output channel
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 43]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
 5.4.16  Setting audio output channel  
2997    
2998     The front-end can alter the audio output channel on a specific     The front-end can alter the audio output channel on a specific
2999     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 2417  Internet-Draft       LinuxSampler Contro Line 3001  Internet-Draft       LinuxSampler Contro
3001        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>        SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3002        <audio-in>        <audio-in>
3003    
3004     Where <sampler-chan> is the sampler channel number, <audio-out> is     Where <sampler-chan> is the sampler channel number as returned by the
3005     the numerical ID of the sampler channel's audio output channel which     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3006     should be rerouted and <audio-in> is the numerical ID of the audio     command, <audio-out> is the numerical ID of the sampler channel's
3007     channel of the selected audio output device where <audio-out> should     audio output channel which should be rerouted and <audio-in> is the
3008     be routed to.     numerical ID of the audio channel of the selected audio output device
3009       where <audio-out> should be routed to.
3010    
3011     Possible Answers:     Possible Answers:
3012    
3013        "OK" -        "OK" -
3014    
3015           on success           on success
3016    
3017        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3018    
3019    
3020    
3021    
3022    
3023    Schoenebeck            Expires September 30, 2007              [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol           March 2007
3026    
3027    
3028           if audio output channel was set, but there are noteworthy           if audio output channel was set, but there are noteworthy
3029           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3030           warning message           warning message
3031    
3032        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3033    
3034           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3035           error message           error message
3036    
# Line 2439  Internet-Draft       LinuxSampler Contro Line 3038  Internet-Draft       LinuxSampler Contro
3038    
3039    
3040    
3041  5.4.17  Setting MIDI input device  6.4.17.  Setting MIDI input device
3042    
3043     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
3044     channel by sending the following command:     channel by sending the following command:
3045    
3046        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>        SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3047    
3048     Where <sampler-channel> is the sampler channel number and     Where <sampler-channel> is the sampler channel number as returned by
3049     <midi-device-id> is the the numerical ID of the MIDI input device.     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3050       command and <midi-device-id> is the numerical ID of the MIDI input
3051       device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3052       or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3053    
3054     Possible Answers:     Possible Answers:
3055    
3056        "OK" -        "OK" -
3057    
3058           on success           on success
3059    
3060        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3061    
3062           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
3063           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3064           message           message
3065    
   
   
 Schoenebeck             Expires November 7, 2005               [Page 44]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
3066        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3067    
3068           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3069           error message           error message
3070    
# Line 2473  Internet-Draft       LinuxSampler Contro Line 3072  Internet-Draft       LinuxSampler Contro
3072    
3073    
3074    
3075  5.4.18  Setting MIDI input type  
3076    
3077    
3078    
3079    Schoenebeck            Expires September 30, 2007              [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol           March 2007
3082    
3083    
3084    6.4.18.  Setting MIDI input type
3085    
3086     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3087    
# Line 2482  Internet-Draft       LinuxSampler Contro Line 3090  Internet-Draft       LinuxSampler Contro
3090    
3091        SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>        SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
3092    
3093     Where <midi-input-type> is currently only "ALSA" and     Where <midi-input-type> is currently only "ALSA" and <sampler-
3094     <sampler-channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3095    
3096     Possible Answers:     Possible Answers:
3097    
3098        "OK" -        "OK" -
3099    
3100           on success           on success
3101    
3102        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3103    
3104           if MIDI input type was set, but there are noteworthy issue(s)           if MIDI input type was set, but there are noteworthy issue(s)
3105           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3106           message           message
3107    
3108        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3109    
3110           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3111           error message           error message
3112    
# Line 2501  Internet-Draft       LinuxSampler Contro Line 3114  Internet-Draft       LinuxSampler Contro
3114    
3115    
3116    
3117  5.4.19  Setting MIDI input port  6.4.19.  Setting MIDI input port
3118    
3119     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
3120     channel by sending the following command:     channel by sending the following command:
# Line 2513  Internet-Draft       LinuxSampler Contro Line 3126  Internet-Draft       LinuxSampler Contro
3126    
3127     Possible Answers:     Possible Answers:
3128    
3129          "OK" -
3130    
3131    
3132    
3133    
3134  Schoenebeck             Expires November 7, 2005               [Page 45]  
3135    Schoenebeck            Expires September 30, 2007              [Page 56]
3136    
3137  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
3138    
3139    
       "OK" -  
3140           on success           on success
3141    
3142        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3143    
3144           if MIDI input port was set, but there are noteworthy issue(s)           if MIDI input port was set, but there are noteworthy issue(s)
3145           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3146           message           message
3147    
3148        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3149    
3150           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3151           error messag           error message
3152    
3153     Examples:     Examples:
3154    
3155    
3156    
3157  5.4.20  Setting MIDI input channel  6.4.20.  Setting MIDI input channel
3158    
3159     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3160     listen to by sending the following command:     listen to by sending the following command:
# Line 2549  Internet-Draft       LinuxSampler Contro Line 3168  Internet-Draft       LinuxSampler Contro
3168     Possible Answers:     Possible Answers:
3169    
3170        "OK" -        "OK" -
3171    
3172           on success           on success
3173    
3174        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3175    
3176           if MIDI input channel was set, but there are noteworthy           if MIDI input channel was set, but there are noteworthy
3177           issue(s) related, providing an appropriate warning code and           issue(s) related, providing an appropriate warning code and
3178           warning message           warning message
3179    
3180        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3181    
3182           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3183           error message           error message
3184    
# Line 2562  Internet-Draft       LinuxSampler Contro Line 3186  Internet-Draft       LinuxSampler Contro
3186    
3187    
3188    
 5.4.21  Setting channel volume  
3189    
    The front-end can alter the volume of a sampler channel by sending  
    the following command:  
3190    
3191        SET CHANNEL VOLUME <sampler-channel> <volume>  Schoenebeck            Expires September 30, 2007              [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol           March 2007
3194    
3195    
3196    
3197    
3198  Schoenebeck             Expires November 7, 2005               [Page 46]  6.4.21.  Setting channel volume
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
3199    
3200       The front-end can alter the volume of a sampler channel by sending
3201       the following command:
3202    
3203          SET CHANNEL VOLUME <sampler-channel> <volume>
3204    
3205     Where <volume> is an optionally dotted positive number (a value     Where <volume> is an optionally dotted positive number (a value
3206     smaller than 1.0 means attenuation, whereas a value greater than 1.0     smaller than 1.0 means attenuation, whereas a value greater than 1.0
# Line 2585  Internet-Draft       LinuxSampler Contro Line 3210  Internet-Draft       LinuxSampler Contro
3210     Possible Answers:     Possible Answers:
3211    
3212        "OK" -        "OK" -
3213    
3214           on success           on success
3215    
3216        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3217    
3218           if channel volume was set, but there are noteworthy issue(s)           if channel volume was set, but there are noteworthy issue(s)
3219           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3220           message           message
3221    
3222          "ERR:<error-code>:<error-message>" -
3223    
3224             in case it failed, providing an appropriate error code and
3225             error message
3226    
3227       Examples:
3228    
3229    
3230    
3231    6.4.22.  Muting a sampler channel
3232    
3233       The front-end can mute/unmute a specific sampler channel by sending
3234       the following command:
3235    
3236          SET CHANNEL MUTE <sampler-channel> <mute>
3237    
3238       Where <sampler-channel> is the respective sampler channel number as
3239       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3240       (Section 6.4.4) command and <mute> should be replaced either by "1"
3241       to mute the channel or "0" to unmute the channel.
3242    
3243       Possible Answers:
3244    
3245    
3246    
3247    Schoenebeck            Expires September 30, 2007              [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol           March 2007
3250    
3251    
3252          "OK" -
3253    
3254             on success
3255    
3256          "WRN:<warning-code>:<warning-message>" -
3257    
3258             if the channel was muted/unmuted, but there are noteworthy
3259             issue(s) related, providing an appropriate warning code and
3260             warning message
3261    
3262          "ERR:<error-code>:<error-message>" -
3263    
3264             in case it failed, providing an appropriate error code and
3265             error message
3266    
3267       Examples:
3268    
3269    
3270    
3271    6.4.23.  Soloing a sampler channel
3272    
3273       The front-end can solo/unsolo a specific sampler channel by sending
3274       the following command:
3275    
3276          SET CHANNEL SOLO <sampler-channel> <solo>
3277    
3278       Where <sampler-channel> is the respective sampler channel number as
3279       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3280       (Section 6.4.4) command and <solo> should be replaced either by "1"
3281       to solo the channel or "0" to unsolo the channel.
3282    
3283       Possible Answers:
3284    
3285          "OK" -
3286    
3287             on success
3288    
3289          "WRN:<warning-code>:<warning-message>" -
3290    
3291             if the channel was soloed/unsoloed, but there are noteworthy
3292             issue(s) related, providing an appropriate warning code and
3293             warning message
3294    
3295        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3296    
3297           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3298           error message           error message
3299    
3300    
3301    
3302    
3303    Schoenebeck            Expires September 30, 2007              [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol           March 2007
3306    
3307    
3308       Examples:
3309    
3310    
3311    
3312    6.4.24.  Assigning a MIDI instrument map to a sampler channel
3313    
3314       The front-end can assign a MIDI instrument map to a specific sampler
3315       channel by sending the following command:
3316    
3317          SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3318    
3319       Where <sampler-channel> is the respective sampler channel number as
3320       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3321       (Section 6.4.4) command and <map> can have the following
3322       possibilites:
3323    
3324          "NONE" -
3325    
3326             This is the default setting.  In this case the sampler channel
3327             is not assigned any MIDI instrument map and thus will ignore
3328             all MIDI program change messages.
3329    
3330          "DEFAULT" -
3331    
3332             The sampler channel will always use the default MIDI instrument
3333             map to handle MIDI program change messages.
3334    
3335          numeric ID -
3336    
3337             You can assign a specific MIDI instrument map by replacing
3338             <map> with the respective numeric ID of the MIDI instrument map
3339             as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3340             command.  Once that map will be deleted, the sampler channel
3341             would fall back to "NONE".
3342    
3343       Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3344       regarding MIDI instrument mapping.
3345    
3346       Possible Answers:
3347    
3348          "OK" -
3349    
3350             on success
3351    
3352          "ERR:<error-code>:<error-message>" -
3353    
3354             in case it failed, providing an appropriate error code and
3355             error message
3356    
3357    
3358    
3359    Schoenebeck            Expires September 30, 2007              [Page 60]
3360    
3361    Internet-Draft        LinuxSampler Control Protocol           March 2007
3362    
3363    
3364       Examples:
3365    
3366    
3367    
3368    6.4.25.  Adding an effect send to a sampler channel
3369    
3370       The front-end can create an additional effect send on a specific
3371       sampler channel by sending the following command:
3372    
3373          CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3374    
3375       Where <sampler-channel> is the respective sampler channel number as
3376       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3377       (Section 6.4.4) command, that is the sampler channel on which the
3378       effect send should be created on, <midi-ctrl> is a number between
3379       0..127 defining the MIDI controller which can alter the effect send
3380       level and <name> is an optional argument defining a name for the
3381       effect send entity.  The name does not have to be unique.
3382    
3383       By default, that is as initial routing, the effect send's audio
3384       channels are automatically routed to the last audio channels of the
3385       sampler channel's audio output device, that way you can i.e. first
3386       increase the amount of audio channels on the audio output device for
3387       having dedicated effect send output channels and when "CREATE
3388       FX_SEND" is called, those channels will automatically be picked.  You
3389       can alter the destination channels however with "SET FX_SEND
3390       AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3391    
3392       Note: Create effect sends on a sampler channel only when needed,
3393       because having effect sends on a sampler channel will decrease
3394       runtime performance, because for implementing channel effect sends,
3395       separate (sampler channel local) audio buffers are needed to render
3396       and mix the voices and route the audio signal afterwards to the
3397       master outputs and effect send outputs (along with their respective
3398       effect send levels).  A sampler channel without effect sends however
3399       can mix its voices directly into the audio output devices's audio
3400       buffers and is thus faster.
3401    
3402       Possible Answers:
3403    
3404          "OK[<fx-send-id>]" -
3405    
3406             in case a new effect send could be added to the sampler
3407             channel, where <fx-send-id> reflects the unique ID of the newly
3408             created effect send entity
3409    
3410    
3411    
3412    
3413    
3414    
3415    Schoenebeck            Expires September 30, 2007              [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol           March 2007
3418    
3419    
3420          "ERR:<error-code>:<error-message>" -
3421    
3422             when a new effect send could not be added, i.e. due to invalid
3423             parameters
3424    
3425       Examples:
3426    
3427          C: "CREATE FX_SEND 0 91 'Reverb Send'"
3428    
3429          S: "OK[0]"
3430    
3431          C: "CREATE FX_SEND 0 93"
3432    
3433          S: "OK[1]"
3434    
3435    6.4.26.  Removing an effect send from a sampler channel
3436    
3437       The front-end can remove an existing effect send on a specific
3438       sampler channel by sending the following command:
3439    
3440          DESTROY FX_SEND <sampler-channel> <fx-send-id>
3441    
3442       Where <sampler-channel> is the respective sampler channel number as
3443       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3444       (Section 6.4.4) command, that is the sampler channel from which the
3445       effect send should be removed from and <fx-send-id> is the respective
3446       effect send number as returned by the "CREATE FX_SEND"
3447       (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3448    
3449       Possible Answers:
3450    
3451          "OK" -
3452    
3453             on success
3454    
3455          "ERR:<error-code>:<error-message>" -
3456    
3457             in case it failed, providing an appropriate error code and
3458             error message
3459    
3460       Example:
3461    
3462          C: "DESTROY FX_SEND 0 0"
3463    
3464          S: "OK"
3465    
3466    
3467    
3468    
3469    
3470    
3471    Schoenebeck            Expires September 30, 2007              [Page 62]
3472    
3473    Internet-Draft        LinuxSampler Control Protocol           March 2007
3474    
3475    
3476    6.4.27.  Getting amount of effect sends on a sampler channel
3477    
3478       The front-end can ask for the amount of effect sends on a specific
3479       sampler channel by sending the following command:
3480    
3481          GET FX_SENDS <sampler-channel>
3482    
3483       Where <sampler-channel> is the respective sampler channel number as
3484       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3485       (Section 6.4.4) command.
3486    
3487       Possible Answers:
3488    
3489          The sampler will answer by returning the number of effect sends on
3490          the given sampler channel.
3491    
3492       Example:
3493    
3494          C: "GET FX_SENDS 0"
3495    
3496          S: "2"
3497    
3498    6.4.28.  Listing all effect sends on a sampler channel
3499    
3500       The front-end can ask for a list of effect sends on a specific
3501       sampler channel by sending the following command:
3502    
3503          LIST FX_SENDS <sampler-channel>
3504    
3505       Where <sampler-channel> is the respective sampler channel number as
3506       returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3507       (Section 6.4.4) command.
3508    
3509       Possible Answers:
3510    
3511          The sampler will answer by returning a comma separated list with
3512          all effect sends' numerical IDs on the given sampler channel.
3513    
3514     Examples:     Examples:
3515    
3516          C: "LIST FX_SENDS 0"
3517    
3518          S: "0,1"
3519    
3520          C: "LIST FX_SENDS 1"
3521    
3522          S: ""
3523    
3524    
3525    
3526    
3527    Schoenebeck            Expires September 30, 2007              [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol           March 2007
3530    
3531    
3532    6.4.29.  Getting effect send information
3533    
3534       The front-end can ask for the current settings of an effect send
3535       entity by sending the following command:
3536    
3537          GET FX_SEND INFO <sampler-channel> <fx-send-id>
3538    
3539       Where <sampler-channel> is the sampler channel number as returned by
3540       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3541       command and <fx-send-id> reflects the numerical ID of the effect send
3542       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3543       FX_SENDS" (Section 6.4.28) command.
3544    
3545       Possible Answers:
3546    
3547          The sampler will answer by sending a <CRLF> separated list.  Each
3548          answer line begins with the settings category name followed by a
3549          colon and then a space character <SP> and finally the info
3550          character string to that setting category.  At the moment the
3551          following categories are defined:
3552    
3553    
3554    
3555             NAME -
3556    
3557                name of the effect send entity
3558    
3559             MIDI_CONTROLLER -
3560    
3561                a value between 0 and 127 reflecting the MIDI controller
3562                which is able to modify the effect send's send level
3563    
3564             LEVEL -
3565    
3566                optionally dotted number reflecting the effect send's
3567                current send level (where a value < 1.0 means attenuation
3568                and a value > 1.0 means amplification)
3569    
3570             AUDIO_OUTPUT_ROUTING -
3571    
3572                comma separated list which reflects to which audio channel
3573                of the selected audio output device each effect send output
3574                channel is routed to, e.g. "0,3" would mean the effect
3575                send's output channel 0 is routed to channel 0 of the audio
3576                output device and the effect send's output channel 1 is
3577                routed to the channel 3 of the audio output device (see "SET
3578                FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3579    
3580    
3581    
3582    
3583    Schoenebeck            Expires September 30, 2007              [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol           March 2007
3586    
3587    
3588       The mentioned fields above don't have to be in particular order.
3589    
3590       Example:
3591    
3592          C: "GET FX_SEND INFO 0 0"
3593    
3594          S: "NAME: Reverb Send"
3595    
3596             "MIDI_CONTROLLER: 91"
3597    
3598             "LEVEL: 0.3"
3599    
3600             "AUDIO_OUTPUT_ROUTING: 2,3"
3601    
3602             "."
3603    
3604    6.4.30.  Changing effect send's name
3605    
3606       The front-end can alter the current name of an effect send entity by
3607       sending the following command:
3608    
3609          SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3610    
3611       Where <sampler-chan> is the sampler channel number as returned by the
3612       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3613       command, <fx-send-id> reflects the numerical ID of the effect send
3614       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3615       FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3616       effect send entity, which does not have to be unique.
3617    
3618       Possible Answers:
3619    
3620          "OK" -
3621    
3622             on success
3623    
3624          "ERR:<error-code>:<error-message>" -
3625    
3626             in case it failed, providing an appropriate error code and
3627             error message
3628    
3629       Example:
3630    
3631          C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3632    
3633          S: "OK"
3634    
3635    
3636    
3637    
3638    
3639  5.4.22  Resetting a sampler channel  Schoenebeck            Expires September 30, 2007              [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol           March 2007
3642    
3643    
3644    6.4.31.  Altering effect send's audio routing
3645    
3646       The front-end can alter the destination of an effect send's audio
3647       channel on a specific sampler channel by sending the following
3648       command:
3649    
3650          SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3651          <audio-src> <audio-dst>
3652    
3653       Where <sampler-chan> is the sampler channel number as returned by the
3654       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3655       command, <fx-send-id> reflects the numerical ID of the effect send
3656       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3657       FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3658       of the effect send's audio channel which should be rerouted and
3659       <audio-dst> is the numerical ID of the audio channel of the selected
3660       audio output device where <audio-src> should be routed to.
3661    
3662       Note that effect sends can only route audio to the same audio output
3663       device as assigned to the effect send's sampler channel.  Also note
3664       that an effect send entity does always have exactly as much audio
3665       channels as its sampler channel.  So if the sampler channel is
3666       stereo, the effect send does have two audio channels as well.  Also
3667       keep in mind that the amount of audio channels on a sampler channel
3668       might be dependant not only to the deployed sampler engine on the
3669       sampler channel, but also dependant to the instrument currently
3670       loaded.  However you can (effectively) turn an i.e. stereo effect
3671       send into a mono one by simply altering its audio routing
3672       appropriately.
3673    
3674       Possible Answers:
3675    
3676          "OK" -
3677    
3678             on success
3679    
3680          "WRN:<warning-code>:<warning-message>" -
3681    
3682             if audio output channel was set, but there are noteworthy
3683             issue(s) related, providing an appropriate warning code and
3684             warning message
3685    
3686          "ERR:<error-code>:<error-message>" -
3687    
3688             in case it failed, providing an appropriate error code and
3689             error message
3690    
3691       Example:
3692    
3693    
3694    
3695    Schoenebeck            Expires September 30, 2007              [Page 66]
3696    
3697    Internet-Draft        LinuxSampler Control Protocol           March 2007
3698    
3699    
3700          C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3701    
3702          S: "OK"
3703    
3704    6.4.32.  Altering effect send's MIDI controller
3705    
3706       The front-end can alter the MIDI controller of an effect send entity
3707       by sending the following command:
3708    
3709          SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3710          ctrl>
3711    
3712       Where <sampler-chan> is the sampler channel number as returned by the
3713       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3714       command, <fx-send-id> reflects the numerical ID of the effect send
3715       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3716       FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3717       controller which shall be able to modify the effect send's send
3718       level.
3719    
3720       Possible Answers:
3721    
3722          "OK" -
3723    
3724             on success
3725    
3726          "WRN:<warning-code>:<warning-message>" -
3727    
3728             if MIDI controller was set, but there are noteworthy issue(s)
3729             related, providing an appropriate warning code and warning
3730             message
3731    
3732          "ERR:<error-code>:<error-message>" -
3733    
3734             in case it failed, providing an appropriate error code and
3735             error message
3736    
3737       Example:
3738    
3739          C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3740    
3741          S: "OK"
3742    
3743    6.4.33.  Altering effect send's send level
3744    
3745       The front-end can alter the current send level of an effect send
3746       entity by sending the following command:
3747    
3748    
3749    
3750    
3751    Schoenebeck            Expires September 30, 2007              [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol           March 2007
3754    
3755    
3756          SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3757    
3758       Where <sampler-chan> is the sampler channel number as returned by the
3759       "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3760       command, <fx-send-id> reflects the numerical ID of the effect send
3761       entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3762       FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3763       dotted positive number (a value smaller than 1.0 means attenuation,
3764       whereas a value greater than 1.0 means amplification) reflecting the
3765       new send level.
3766    
3767       Possible Answers:
3768    
3769          "OK" -
3770    
3771             on success
3772    
3773          "WRN:<warning-code>:<warning-message>" -
3774    
3775             if new send level was set, but there are noteworthy issue(s)
3776             related, providing an appropriate warning code and warning
3777             message
3778    
3779          "ERR:<error-code>:<error-message>" -
3780    
3781             in case it failed, providing an appropriate error code and
3782             error message
3783    
3784       Example:
3785    
3786          C: "SET FX_SEND LEVEL 0 0 0.15"
3787    
3788          S: "OK"
3789    
3790    6.4.34.  Resetting a sampler channel
3791    
3792     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
3793     following command:     following command:
# Line 2612  Internet-Draft       LinuxSampler Contro Line 3801  Internet-Draft       LinuxSampler Contro
3801    
3802     Possible Answers:     Possible Answers:
3803    
3804    
3805    
3806    
3807    Schoenebeck            Expires September 30, 2007              [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol           March 2007
3810    
3811    
3812        "OK" -        "OK" -
3813    
3814           on success           on success
3815    
3816        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3817    
3818           if channel was reset, but there are noteworthy issue(s)           if channel was reset, but there are noteworthy issue(s)
3819           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3820           message           message
3821    
3822        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3823    
3824           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3825           error message           error message
3826    
# Line 2626  Internet-Draft       LinuxSampler Contro Line 3828  Internet-Draft       LinuxSampler Contro
3828    
3829    
3830    
3831    6.5.  Controlling connection
   
 Schoenebeck             Expires November 7, 2005               [Page 47]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
   
   
 5.5  Controlling connection  
3832    
3833     The following commands are used to control the connection to     The following commands are used to control the connection to
3834     LinuxSampler.     LinuxSampler.
3835    
3836  5.5.1  Register front-end for receiving event messages  6.5.1.  Register front-end for receiving event messages
3837    
3838     The front-end can register itself to the LinuxSampler application to     The front-end can register itself to the LinuxSampler application to
3839     be informed about noteworthy events by sending this command:     be informed about noteworthy events by sending this command:
# Line 2653  Internet-Draft       LinuxSampler Contro Line 3846  Internet-Draft       LinuxSampler Contro
3846     Possible Answers:     Possible Answers:
3847    
3848        "OK" -        "OK" -
3849    
3850           on success           on success
3851    
3852        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3853    
3854           if registration succeeded, but there are noteworthy issue(s)           if registration succeeded, but there are noteworthy issue(s)
3855           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3856           message           message
3857    
3858    
3859    
3860    
3861    
3862    
3863    Schoenebeck            Expires September 30, 2007              [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol           March 2007
3866    
3867    
3868        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3869    
3870           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3871           error message           error message
3872    
# Line 2666  Internet-Draft       LinuxSampler Contro Line 3874  Internet-Draft       LinuxSampler Contro
3874    
3875    
3876    
3877  5.5.2  Unregister front-end for not receiving event messages  6.5.2.  Unregister front-end for not receiving event messages
3878    
3879     The front-end can unregister itself if it doesn't want to receive     The front-end can unregister itself if it doesn't want to receive
3880     event messages anymore by sending the following command:     event messages anymore by sending the following command:
# Line 2679  Internet-Draft       LinuxSampler Contro Line 3887  Internet-Draft       LinuxSampler Contro
3887     Possible Answers:     Possible Answers:
3888    
3889        "OK" -        "OK" -
          on success  
   
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 48]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
3890    
3891             on success
3892    
3893        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3894    
3895           if unregistration succeeded, but there are noteworthy issue(s)           if unregistration succeeded, but there are noteworthy issue(s)
3896           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3897           message           message
3898    
3899        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3900    
3901           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3902           error message           error message
3903    
# Line 2701  Internet-Draft       LinuxSampler Contro Line 3905  Internet-Draft       LinuxSampler Contro
3905    
3906    
3907    
3908  5.5.3  Enable or disable echo of commands  6.5.3.  Enable or disable echo of commands
3909    
3910     To enable or disable back sending of commands to the client the     To enable or disable back sending of commands to the client the
3911     following command can be used:     following command can be used:
# Line 2709  Internet-Draft       LinuxSampler Contro Line 3913  Internet-Draft       LinuxSampler Contro
3913        SET ECHO <value>        SET ECHO <value>
3914    
3915     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
3916    
3917    
3918    
3919    Schoenebeck            Expires September 30, 2007              [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol           March 2007
3922    
3923    
3924     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
3925     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
3926     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 2718  Internet-Draft       LinuxSampler Contro Line 3930  Internet-Draft       LinuxSampler Contro
3930     Possible Answers:     Possible Answers:
3931    
3932        "OK" -        "OK" -
3933    
3934           usually           usually
3935    
3936        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3937           on syntax error, e.g.  non boolean value  
3938             on syntax error, e.g. non boolean value
3939    
3940     Examples:     Examples:
3941    
3942    
3943    
3944  5.5.4  Close client connection  6.5.4.  Close client connection
3945    
3946     The client can close its network connection to LinuxSampler by     The client can close its network connection to LinuxSampler by
3947     sending the following command:     sending the following command:
# Line 2736  Internet-Draft       LinuxSampler Contro Line 3951  Internet-Draft       LinuxSampler Contro
3951     This is probably more interesting for manual telnet connections to     This is probably more interesting for manual telnet connections to
3952     LinuxSampler than really useful for a front-end implementation.     LinuxSampler than really useful for a front-end implementation.
3953    
3954    6.6.  Global commands
3955    
3956       The following commands have global impact on the sampler.
3957    
3958    6.6.1.  Current number of active voices
3959    
3960       The front-end can ask for the current number of active voices on the
3961       sampler by sending the following command:
3962    
3963          GET TOTAL_VOICE_COUNT
3964    
3965       Possible Answers:
3966    
3967          LinuxSampler will answer by returning the number of all active
3968          voices on the sampler.
3969    
3970    
3971    
3972    
3973    
3974  Schoenebeck             Expires November 7, 2005               [Page 49]  
3975    Schoenebeck            Expires September 30, 2007              [Page 71]
3976    
3977  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
3978    
3979    
3980  5.6  Global commands  6.6.2.  Maximum amount of active voices
3981    
3982     The following commands have global impact on the sampler.     The front-end can ask for the maximum number of active voices by
3983       sending the following command:
3984    
3985  5.6.1  Reset sampler        GET TOTAL_VOICE_COUNT_MAX
3986    
3987       Possible Answers:
3988    
3989          LinuxSampler will answer by returning the maximum number of active
3990          voices.
3991    
3992    6.6.3.  Reset sampler
3993    
3994     The front-end can reset the whole sampler by sending the following     The front-end can reset the whole sampler by sending the following
3995     command:     command:
# Line 2759  Internet-Draft       LinuxSampler Contro Line 3999  Internet-Draft       LinuxSampler Contro
3999     Possible Answers:     Possible Answers:
4000    
4001        "OK" -        "OK" -
4002    
4003           always           always
4004    
4005     Examples:     Examples:
4006    
4007    
4008    
4009    6.6.4.  General sampler informations
4010    
4011       The client can ask for general informations about the LinuxSampler
4012       instance by sending the following command:
4013    
4014          GET SERVER INFO
4015    
4016       Possible Answers:
4017    
4018          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4019          answer line begins with the information category name followed by
4020          a colon and then a space character <SP> and finally the info
4021          character string to that information category.  At the moment the
4022          following categories are defined:
4023    
4024    
4025    
4026             DESCRIPTION -
4027    
4028    
4029    
4030    
4031    Schoenebeck            Expires September 30, 2007              [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol           March 2007
4034    
4035    
4036                arbitrary textual description about the sampler
4037    
4038             VERSION -
4039    
4040                version of the sampler
4041    
4042             PROTOCOL_VERSION -
4043    
4044                version of the LSCP specification the sampler complies with
4045                (see Section 2 for details)
4046    
4047       The mentioned fields above don't have to be in particular order.
4048       Other fields might be added in future.
4049    
4050    6.6.5.  Getting global volume attenuation
4051    
4052       The client can ask for the current global sampler-wide volume
4053       attenuation by sending the following command:
4054    
4055          GET VOLUME
4056    
4057       Possible Answers:
4058    
4059          The sampler will always answer by returning the optional dotted
4060          floating point coefficient, reflecting the current global volume
4061          attenuation.
4062    
4063       Note: it is up to the respective sampler engine whether to obey that
4064       global volume parameter or not, but in general all engines SHOULD use
4065       this parameter.
4066    
4067    6.6.6.  Setting global volume attenuation
4068    
4069       The client can alter the current global sampler-wide volume
4070       attenuation by sending the following command:
4071    
4072          SET VOLUME <volume>
4073    
4074       Where <volume> should be replaced by the optional dotted floating
4075       point value, reflecting the new global volume parameter.  This value
4076       might usually be in the range between 0.0 and 1.0, that is for
4077       attenuating the overall volume.
4078    
4079       Possible Answers:
4080    
4081          "OK" -
4082    
4083    
4084    
4085    
4086    
4087  Schoenebeck             Expires November 7, 2005               [Page 50]  Schoenebeck            Expires September 30, 2007              [Page 73]
4088    
4089  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
4090    
4091    
4092  6.  Command Syntax           on success
4093    
4094     TODO: will soon automatically included from src/network/lscp.y,        "WRN:<warning-code>:<warning-message>" -
    meanwhile have a look at that file to get the exact definition of the  
    command syntax.  
4095    
4096             if the global volume was set, but there are noteworthy issue(s)
4097             related, providing an appropriate warning code and warning
4098             message
4099    
4100          "ERR:<error-code>:<error-message>" -
4101    
4102             in case it failed, providing an appropriate error code and
4103             error message
4104    
4105    6.7.  MIDI Instrument Mapping
4106    
4107       The MIDI protocol provides a way to switch between instruments by
4108       sending so called MIDI bank select and MIDI program change messages
4109       which are essentially just numbers.  The following commands allow to
4110       actually map arbitrary MIDI bank select / program change numbers with
4111       real instruments.
4112    
4113       The sampler allows to manage an arbitrary amount of MIDI instrument
4114       maps which define which instrument to load on which MIDI program
4115       change message.
4116    
4117       By default, that is when the sampler is launched, there is no map,
4118       thus the sampler will simply ignore all program change messages.  The
4119       front-end has to explicitly create at least one map, add entries to
4120       the map and tell the respective sampler channel(s) which MIDI
4121       instrument map to use, so the sampler knows how to react on a given
4122       program change message on the respective sampler channel, that is by
4123       switching to the respectively defined engine type and loading the
4124       respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4125       (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4126       channel.
4127    
4128       Also note per MIDI specification a bank select message does not cause
4129       to switch to another instrument.  Instead when receiving a bank
4130       select message the bank value will be stored and a subsequent program
4131       change message (which may occur at any time) will finally cause the
4132       sampler to switch to the respective instrument as reflected by the
4133       current MIDI instrument map.
4134    
4135    6.7.1.  Create a new MIDI instrument map
4136    
4137       The front-end can add a new MIDI instrument map by sending the
4138       following command:
4139    
4140    
4141    
4142    
4143    Schoenebeck            Expires September 30, 2007              [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol           March 2007
4146    
4147    
4148          ADD MIDI_INSTRUMENT_MAP [<name>]
4149    
4150       Where <name> is an optional argument allowing to assign a custom name
4151       to the new map.  MIDI instrument Map names do not have to be unique.
4152    
4153       Possible Answers:
4154    
4155          "OK[<map>]" -
4156    
4157             in case a new MIDI instrument map could be added, where <map>
4158             reflects the unique ID of the newly created MIDI instrument map
4159    
4160          "ERR:<error-code>:<error-message>" -
4161    
4162             when a new map could not be created, which might never occur in
4163             practice
4164    
4165       Examples:
4166    
4167          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4168    
4169          S: "OK[0]"
4170    
4171          C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4172    
4173          S: "OK[1]"
4174    
4175          C: "ADD MIDI_INSTRUMENT_MAP"
4176    
4177          S: "OK[5]"
4178    
4179    6.7.2.  Delete one particular or all MIDI instrument maps
4180    
4181       The front-end can delete a particular MIDI instrument map by sending
4182       the following command:
4183    
4184          REMOVE MIDI_INSTRUMENT_MAP <map>
4185    
4186       Where <map> reflects the unique ID of the map to delete as returned
4187       by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4188    
4189       The front-end can delete all MIDI instrument maps by sending the
4190       following command:
4191    
4192          REMOVE MIDI_INSTRUMENT_MAP ALL
4193    
4194       Possible Answers:
4195    
4196    
4197    
4198    
4199    Schoenebeck            Expires September 30, 2007              [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol           March 2007
4202    
4203    
4204          "OK" -
4205    
4206             in case the map(s) could be deleted
4207    
4208          "ERR:<error-code>:<error-message>" -
4209    
4210             when the given map does not exist
4211    
4212       Examples:
4213    
4214          C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4215    
4216          S: "OK"
4217    
4218  Schoenebeck             Expires November 7, 2005               [Page 51]        C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4219    
4220          S: "OK"
4221    
4222    6.7.3.  Get amount of existing MIDI instrument maps
4223    
4224       The front-end can retrieve the current amount of MIDI instrument maps
4225       by sending the following command:
4226    
4227          GET MIDI_INSTRUMENT_MAPS
4228    
4229       Possible Answers:
4230    
4231          The sampler will answer by returning the current number of MIDI
4232          instrument maps.
4233    
4234       Example:
4235    
4236          C: "GET MIDI_INSTRUMENT_MAPS"
4237    
4238          S: "2"
4239    
4240    6.7.4.  Getting all created MIDI instrument maps
4241    
4242       The number of MIDI instrument maps can change on runtime.  To get the
4243       current list of MIDI instrument maps, the front-end can send the
4244       following command:
4245    
4246          LIST MIDI_INSTRUMENT_MAPS
4247    
4248       Possible Answers:
4249    
4250    
4251    
4252    
4253    
4254    
4255    Schoenebeck            Expires September 30, 2007              [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol           March 2007
4258    
4259    
4260          The sampler will answer by returning a comma separated list with
4261          all MIDI instrument maps' numerical IDs.
4262    
4263       Example:
4264    
4265          C: "LIST MIDI_INSTRUMENT_MAPS"
4266    
4267          S: "0,1,5,12"
4268    
4269    6.7.5.  Getting MIDI instrument map information
4270    
4271       The front-end can ask for the current settings of a MIDI instrument
4272       map by sending the following command:
4273    
4274          GET MIDI_INSTRUMENT_MAP INFO <map>
4275    
4276       Where <map> is the numerical ID of the map the front-end is
4277       interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4278       (Section 6.7.4) command.
4279    
4280       Possible Answers:
4281    
4282          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4283          answer line begins with the settings category name followed by a
4284          colon and then a space character <SP> and finally the info
4285          character string to that setting category.  At the moment the
4286          following categories are defined:
4287    
4288    
4289    
4290             NAME -
4291    
4292                custom name of the given map, which does not have to be
4293                unique
4294    
4295             DEFAULT -
4296    
4297                either true or false, defines whether this map is the
4298                default map
4299    
4300       The mentioned fields above don't have to be in particular order.
4301    
4302       Example:
4303    
4304          C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4305    
4306          S: "NAME: Standard Map"
4307    
4308    
4309    
4310    
4311    Schoenebeck            Expires September 30, 2007              [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol           March 2007
4314    
4315    
4316             "DEFAULT: true"
4317    
4318             "."
4319    
4320    6.7.6.  Renaming a MIDI instrument map
4321    
4322       The front-end can alter the custom name of a MIDI instrument map by
4323       sending the following command:
4324    
4325          SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4326    
4327       Where <map> is the numerical ID of the map and <name> the new custom
4328       name of the map, which does not have to be unique.
4329    
4330       Possible Answers:
4331    
4332          "OK" -
4333    
4334             on success
4335    
4336          "ERR:<error-code>:<error-message>" -
4337    
4338             in case the given map does not exist
4339    
4340       Example:
4341    
4342          C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4343    
4344          S: "OK"
4345    
4346    6.7.7.  Create or replace a MIDI instrument map entry
4347    
4348       The front-end can create a new or replace an existing entry in a
4349       sampler's MIDI instrument map by sending the following command:
4350    
4351          MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4352          <engine_name> <filename> <instrument_index> <volume_value>
4353          [<instr_load_mode>] [<name>]
4354    
4355       Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4356       integer value between 0..16383 reflecting the MIDI bank select index,
4357       <midi_prog> an integer value between 0..127 reflecting the MIDI
4358       program change index, <engine_name> a sampler engine name as returned
4359       by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4360       encapsulated into apostrophes), <filename> the name of the
4361       instrument's file to be deployed (encapsulated into apostrophes),
4362       <instrument_index> the index (integer value) of the instrument within
4363       the given file, <volume_value> reflects the master volume of the
4364    
4365    
4366    
4367    Schoenebeck            Expires September 30, 2007              [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol           March 2007
4370    
4371    
4372       instrument as optionally dotted number (where a value < 1.0 means
4373       attenuation and a value > 1.0 means amplification).  This parameter
4374       easily allows to adjust the volume of all intruments within a custom
4375       instrument map without having to adjust their instrument files.  The
4376       OPTIONAL <instr_load_mode> argument defines the life time of the
4377       instrument, that is when the instrument should be loaded, when freed
4378       and has exactly the following possibilities:
4379    
4380          "ON_DEMAND" -
4381    
4382             The instrument will be loaded when needed, that is when
4383             demanded by at least one sampler channel.  It will immediately
4384             be freed from memory when not needed by any sampler channel
4385             anymore.
4386    
4387          "ON_DEMAND_HOLD" -
4388    
4389             The instrument will be loaded when needed, that is when
4390             demanded by at least one sampler channel.  It will be kept in
4391             memory even when not needed by any sampler channel anymore.
4392             Instruments with this mode are only freed when the sampler is
4393             reset or all mapping entries with this mode (and respective
4394             instrument) are explicitly changed to "ON_DEMAND" and no
4395             sampler channel is using the instrument anymore.
4396    
4397          "PERSISTENT" -
4398    
4399             The instrument will immediately be loaded into memory when this
4400             mapping command is sent and the instrument is kept all the
4401             time.  Instruments with this mode are only freed when the
4402             sampler is reset or all mapping entries with this mode (and
4403             respective instrument) are explicitly changed to "ON_DEMAND"
4404             and no sampler channel is using the instrument anymore.
4405    
4406          not supplied -
4407    
4408             In case there is no <instr_load_mode> argument given, it will
4409             be up to the InstrumentManager to decide which mode to use.
4410             Usually it will use "ON_DEMAND" if an entry for the given
4411             instrument does not exist in the InstrumentManager's list yet,
4412             otherwise if an entry already exists, it will simply stick with
4413             the mode currently reflected by the already existing entry,
4414             that is it will not change the mode.
4415    
4416       The <instr_load_mode> argument thus allows to define an appropriate
4417       strategy (low memory consumption vs. fast instrument switching) for
4418       each instrument individually.  Note, the following restrictions apply
4419       to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4420    
4421    
4422    
4423    Schoenebeck            Expires September 30, 2007              [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol           March 2007
4426    
4427    
4428       supported by the respective sampler engine (which is technically the
4429       case when the engine provides an InstrumentManager for its format).
4430       If this is not the case the argument will automatically fall back to
4431       the default value "ON_DEMAND".  Also the load mode of one instrument
4432       may automatically change the laod mode of other instrument(s), i.e.
4433       because the instruments are part of the same file and the engine does
4434       not allow a way to manage load modes for them individually.  Due to
4435       this, in case the frontend shows the load modes of entries, the
4436       frontend should retrieve the actual mode by i.e. sending "GET
4437       MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s).  Finally the
4438       OPTIONAL <name> argument allows to set a custom name (encapsulated
4439       into apostrophes) for the mapping entry, useful for frontends for
4440       displaying an appropriate name for mapped instruments (using "GET
4441       MIDI_INSTRUMENT INFO" (Section 6.7.11)).
4442    
4443       By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4444       completely established in the sampler.  The OPTIONAL "NON_MODAL"
4445       argument however causes the respective "MAP MIDI_INSTRUMENT" command
4446       to return immediately, that is to let the sampler establish the
4447       mapping in the background.  So this argument might be especially
4448       useful for mappings with a "PERSISTENT" type, because these have to
4449       load the respective instruments immediately and might thus block for
4450       a very long time.  It is recommended however to use the OPTIONAL
4451       "NON_MODAL" argument only if really necessary, because it has the
4452       following drawbacks: as "NON_MODAL" instructions return immediately,
4453       they may not necessarily return an error i.e. when the given
4454       instrument file turns out to be corrupt, beside that subsequent
4455       commands in a LSCP instruction sequence might fail, because mandatory
4456       mappings are not yet completed.
4457    
4458       Possible Answers:
4459    
4460          "OK" -
4461    
4462             usually
4463    
4464          "ERR:<error-code>:<error-message>" -
4465    
4466             when the given map or engine does not exist or a value is out
4467             of range
4468    
4469       Examples:
4470    
4471          C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4472          0.8 PERSISTENT"
4473    
4474          S: "OK"
4475    
4476    
4477    
4478    
4479    Schoenebeck            Expires September 30, 2007              [Page 80]
4480    
4481    Internet-Draft        LinuxSampler Control Protocol           March 2007
4482    
4483    
4484          C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4485          1.0"
4486    
4487          S: "OK"
4488    
4489          C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
4490          'Normal Piano'"
4491    
4492          S: "OK"
4493    
4494          C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4495          'Silent Piano'"
4496    
4497          S: "OK"
4498    
4499          C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4500          foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4501    
4502          S: "OK"
4503    
4504    6.7.8.  Getting ammount of MIDI instrument map entries
4505    
4506       The front-end can query the amount of currently existing entries in a
4507       MIDI instrument map by sending the following command:
4508    
4509          GET MIDI_INSTRUMENTS <map>
4510    
4511       The front-end can query the amount of currently existing entries in
4512       all MIDI instrument maps by sending the following command:
4513    
4514          GET MIDI_INSTRUMENTS ALL
4515    
4516       Possible Answers:
4517    
4518          The sampler will answer by sending the current number of entries
4519          in the MIDI instrument map(s).
4520    
4521       Example:
4522    
4523          C: "GET MIDI_INSTRUMENTS 0"
4524    
4525          S: "234"
4526    
4527          C: "GET MIDI_INSTRUMENTS ALL"
4528    
4529          S: "954"
4530    
4531    
4532    
4533    
4534    
4535    Schoenebeck            Expires September 30, 2007              [Page 81]
4536    
4537  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
4538    
4539    
4540    6.7.9.  Getting indeces of all entries of a MIDI instrument map
4541    
4542       The front-end can query a list of all currently existing entries in a
4543       certain MIDI instrument map by sending the following command:
4544    
4545          LIST MIDI_INSTRUMENTS <map>
4546    
4547       Where <map> is the numeric ID of the MIDI instrument map.
4548    
4549       The front-end can query a list of all currently existing entries of
4550       all MIDI instrument maps by sending the following command:
4551    
4552          LIST MIDI_INSTRUMENTS ALL
4553    
4554       Possible Answers:
4555    
4556          The sampler will answer by sending a comma separated list of map
4557          ID - MIDI bank - MIDI program triples, where each triple is
4558          encapsulated into curly braces.  The list is returned in one
4559          single line.  Each triple just reflects the key of the respective
4560          map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4561          (Section 6.7.11) command(s) are necessary to retrieve detailed
4562          informations about each entry.
4563    
4564       Example:
4565    
4566          C: "LIST MIDI_INSTRUMENTS 0"
4567    
4568          S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4569    
4570    6.7.10.  Remove an entry from the MIDI instrument map
4571    
4572       The front-end can delete an entry from a MIDI instrument map by
4573       sending the following command:
4574    
4575          UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4576    
4577       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4578       is an integer value between 0..16383 reflecting the MIDI bank value
4579       and <midi_prog> an integer value between 0..127 reflecting the MIDI
4580       program value of the map's entrie's key index triple.
4581    
4582       Possible Answers:
4583    
4584          "OK" -
4585    
4586             usually
4587    
4588    
4589    
4590    
4591    Schoenebeck            Expires September 30, 2007              [Page 82]
4592    
4593    Internet-Draft        LinuxSampler Control Protocol           March 2007
4594    
4595    
4596          "ERR:<error-code>:<error-message>" -
4597    
4598             when index out of bounds
4599    
4600       Example:
4601    
4602          C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4603    
4604          S: "OK"
4605    
4606    6.7.11.  Get current settings of MIDI instrument map entry
4607    
4608       The front-end can retrieve the current settings of a certain
4609       instrument map entry by sending the following command:
4610    
4611          GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4612    
4613       Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4614       is an integer value between 0..16383 reflecting the MIDI bank value,
4615       <midi_bank> and <midi_prog> an integer value between 0..127
4616       reflecting the MIDI program value of the map's entrie's key index
4617       triple.
4618    
4619       Possible Answers:
4620    
4621          LinuxSampler will answer by sending a <CRLF> separated list.  Each
4622          answer line begins with the information category name followed by
4623          a colon and then a space character <SP> and finally the info
4624          character string to that info category.  At the moment the
4625          following categories are defined:
4626    
4627          "NAME" -
4628    
4629             Name for this MIDI instrument map entry (if defined).  This
4630             name shall be used by frontends for displaying a name for this
4631             mapped instrument.  It can be set and changed with the "MAP
4632             MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4633             be unique.
4634    
4635          "ENGINE_NAME" -
4636    
4637             Name of the engine to be deployed for this instrument.
4638    
4639          "INSTRUMENT_FILE" -
4640    
4641             File name of the instrument.
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck            Expires September 30, 2007              [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol           March 2007
4650    
4651    
4652          "INSTRUMENT_NR" -
4653    
4654             Index of the instrument within the file.
4655    
4656          "INSTRUMENT_NAME" -
4657    
4658             Name of the loaded instrument as reflected by its file.  In
4659             contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4660             cannot be changed.
4661    
4662          "LOAD_MODE" -
4663    
4664             Life time of instrument (see "MAP MIDI_INSTRUMENT"
4665             (Section 6.7.7) for details about this setting).
4666    
4667          "VOLUME" -
4668    
4669             master volume of the instrument as optionally dotted number
4670             (where a value < 1.0 means attenuation and a value > 1.0 means
4671             amplification)
4672    
4673          The mentioned fields above don't have to be in particular order.
4674    
4675       Example:
4676    
4677          C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4678    
4679          S: "NAME: Drums for Foo Song"
4680    
4681             "ENGINE_NAME: GigEngine"
4682    
4683             "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4684    
4685             "INSTRUMENT_NR: 0"
4686    
4687             "INSTRUMENT_NAME: Joe's Drumkit"
4688    
4689             "LOAD_MODE: PERSISTENT"
4690    
4691             "VOLUME: 1.0"
4692    
4693             "."
4694    
4695    6.7.12.  Clear MIDI instrument map
4696    
4697       The front-end can clear a whole MIDI instrument map, that is delete
4698       all its entries by sending the following command:
4699    
4700    
4701    
4702    
4703    Schoenebeck            Expires September 30, 2007              [Page 84]
4704    
4705    Internet-Draft        LinuxSampler Control Protocol           March 2007
4706    
4707    
4708          CLEAR MIDI_INSTRUMENTS <map>
4709    
4710       Where <map> is the numeric ID of the map to clear.
4711    
4712       The front-end can clear all MIDI instrument maps, that is delete all
4713       entries of all maps by sending the following command:
4714    
4715          CLEAR MIDI_INSTRUMENTS ALL
4716    
4717       The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4718       only their entries, thus the map's settings like custom name will be
4719       preservevd.
4720    
4721       Possible Answers:
4722    
4723          "OK" -
4724    
4725             always
4726    
4727       Examples:
4728    
4729          C: "CLEAR MIDI_INSTRUMENTS 0"
4730    
4731          S: "OK"
4732    
4733          C: "CLEAR MIDI_INSTRUMENTS ALL"
4734    
4735          S: "OK"
4736    
4737    
4738    
4739    
4740    
4741    
4742    
4743    
4744    
4745    
4746    
4747    
4748    
4749    
4750    
4751    
4752    
4753    
4754    
4755    
4756  7.  Events  
4757    
4758    
4759    Schoenebeck            Expires September 30, 2007              [Page 85]
4760    
4761    Internet-Draft        LinuxSampler Control Protocol           March 2007
4762    
4763    
4764    7.  Command Syntax
4765    
4766       The grammar of the control protocol as descibed in Section 6 is
4767       defined below using Backus-Naur Form (BNF as described in [RFC2234])
4768       where applicable.
4769    
4770       input =
4771    
4772          line LF
4773    
4774          / line CR LF
4775    
4776       line =
4777    
4778          /* epsilon (empty line ignored) */
4779    
4780          / comment
4781    
4782          / command
4783    
4784          / error
4785    
4786       comment =
4787    
4788          '#'
4789    
4790          / comment '#'
4791    
4792          / comment SP
4793    
4794          / comment number
4795    
4796          / comment string
4797    
4798       command =
4799    
4800          ADD SP add_instruction
4801    
4802          / MAP SP map_instruction
4803    
4804          / UNMAP SP unmap_instruction
4805    
4806          / GET SP get_instruction
4807    
4808          / CREATE SP create_instruction
4809    
4810          / DESTROY SP destroy_instruction
4811    
4812    
4813    
4814    
4815    Schoenebeck            Expires September 30, 2007              [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol           March 2007
4818    
4819    
4820          / LIST SP list_instruction
4821    
4822          / LOAD SP load_instruction
4823    
4824          / REMOVE SP remove_instruction
4825    
4826          / SET SP set_instruction
4827    
4828          / SUBSCRIBE SP subscribe_event
4829    
4830          / UNSUBSCRIBE SP unsubscribe_event
4831    
4832          / SELECT SP text
4833    
4834          / RESET SP reset_instruction
4835    
4836          / CLEAR SP clear_instruction
4837    
4838          / RESET
4839    
4840          / QUIT
4841    
4842       add_instruction =
4843    
4844          CHANNEL
4845    
4846          / MIDI_INSTRUMENT_MAP
4847    
4848          / MIDI_INSTRUMENT_MAP SP map_name
4849    
4850       subscribe_event =
4851    
4852          AUDIO_OUTPUT_DEVICE_COUNT
4853    
4854          / AUDIO_OUTPUT_DEVICE_INFO
4855    
4856          / MIDI_INPUT_DEVICE_COUNT
4857    
4858          / MIDI_INPUT_DEVICE_INFO
4859    
4860          / CHANNEL_COUNT
4861    
4862          / VOICE_COUNT
4863    
4864          / STREAM_COUNT
4865    
4866          / BUFFER_FILL
4867    
4868    
4869    
4870    
4871    Schoenebeck            Expires September 30, 2007              [Page 87]
4872    
4873    Internet-Draft        LinuxSampler Control Protocol           March 2007
4874    
4875    
4876          / CHANNEL_INFO
4877    
4878          / FX_SEND_COUNT
4879    
4880          / FX_SEND_INFO
4881    
4882          / MIDI_INSTRUMENT_MAP_COUNT
4883    
4884          / MIDI_INSTRUMENT_MAP_INFO
4885    
4886          / MIDI_INSTRUMENT_COUNT
4887    
4888          / MIDI_INSTRUMENT_INFO
4889    
4890          / MISCELLANEOUS
4891    
4892          / TOTAL_VOICE_COUNT
4893    
4894          / GLOBAL_INFO
4895    
4896       unsubscribe_event =
4897    
4898          AUDIO_OUTPUT_DEVICE_COUNT
4899    
4900          / AUDIO_OUTPUT_DEVICE_INFO
4901    
4902          / MIDI_INPUT_DEVICE_COUNT
4903    
4904          / MIDI_INPUT_DEVICE_INFO
4905    
4906          / CHANNEL_COUNT
4907    
4908          / VOICE_COUNT
4909    
4910          / STREAM_COUNT
4911    
4912          / BUFFER_FILL
4913    
4914          / CHANNEL_INFO
4915    
4916          / FX_SEND_COUNT
4917    
4918          / FX_SEND_INFO
4919    
4920          / MIDI_INSTRUMENT_MAP_COUNT
4921    
4922          / MIDI_INSTRUMENT_MAP_INFO
4923    
4924    
4925    
4926    
4927    Schoenebeck            Expires September 30, 2007              [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol           March 2007
4930    
4931    
4932          / MIDI_INSTRUMENT_COUNT
4933    
4934          / MIDI_INSTRUMENT_INFO
4935    
4936          / MISCELLANEOUS
4937    
4938          / TOTAL_VOICE_COUNT
4939    
4940          / GLOBAL_INFO
4941    
4942       map_instruction =
4943    
4944          MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
4945          engine_name SP filename SP instrument_index SP volume_value
4946    
4947          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
4948          SP engine_name SP filename SP instrument_index SP volume_value SP
4949          instr_load_mode
4950    
4951          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
4952          SP engine_name SP filename SP instrument_index SP volume_value SP
4953          entry_name
4954    
4955          / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
4956          SP engine_name SP filename SP instrument_index SP volume_value SP
4957          instr_load_mode SP entry_name
4958    
4959       unmap_instruction =
4960    
4961          MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4962    
4963       remove_instruction =
4964    
4965          CHANNEL SP sampler_channel
4966    
4967          / MIDI_INSTRUMENT_MAP SP midi_map
4968    
4969          / MIDI_INSTRUMENT_MAP SP ALL
4970    
4971       get_instruction =
4972    
4973          AVAILABLE_ENGINES
4974    
4975          / AVAILABLE_MIDI_INPUT_DRIVERS
4976    
4977          / MIDI_INPUT_DRIVER SP INFO SP string
4978    
4979    
4980    
4981    
4982    
4983    Schoenebeck            Expires September 30, 2007              [Page 89]
4984    
4985    Internet-Draft        LinuxSampler Control Protocol           March 2007
4986    
4987    
4988          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
4989    
4990          / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
4991          key_val_list
4992    
4993          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
4994    
4995          / AUDIO_OUTPUT_DRIVER SP INFO SP string
4996    
4997          / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
4998    
4999          / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
5000          key_val_list
5001    
5002          / AUDIO_OUTPUT_DEVICES
5003    
5004          / MIDI_INPUT_DEVICES
5005    
5006          / AUDIO_OUTPUT_DEVICE SP INFO SP number
5007    
5008          / MIDI_INPUT_DEVICE SP INFO SP number
5009    
5010          / MIDI_INPUT_PORT SP INFO SP number SP number
5011    
5012          / MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
5013    
5014          / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
5015    
5016          / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
5017          string
5018    
5019          / CHANNELS
5020    
5021          / CHANNEL SP INFO SP sampler_channel
5022    
5023          / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
5024    
5025          / CHANNEL SP STREAM_COUNT SP sampler_channel
5026    
5027          / CHANNEL SP VOICE_COUNT SP sampler_channel
5028    
5029          / ENGINE SP INFO SP engine_name
5030    
5031          / SERVER SP INFO
5032    
5033          / TOTAL_VOICE_COUNT
5034    
5035    
5036    
5037    
5038    
5039    Schoenebeck            Expires September 30, 2007              [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol           March 2007
5042    
5043    
5044          / TOTAL_VOICE_COUNT_MAX
5045    
5046          / MIDI_INSTRUMENTS SP midi_map
5047    
5048          / MIDI_INSTRUMENTS SP ALL
5049    
5050          / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
5051    
5052          / MIDI_INSTRUMENT_MAPS
5053    
5054          / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
5055    
5056          / FX_SENDS SP sampler_channel
5057    
5058          / FX_SEND SP INFO SP sampler_channel SP fx_send_id
5059    
5060          / VOLUME
5061    
5062       set_instruction =
5063    
5064          AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
5065          param_val_list
5066    
5067          / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
5068          param_val_list
5069    
5070          / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
5071          param_val_list
5072    
5073          / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
5074          param_val_list
5075    
5076          / CHANNEL SP set_chan_instruction
5077    
5078          / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5079    
5080          / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5081    
5082          / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
5083          SP audio_channel_index SP audio_channel_index
5084    
5085          / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
5086          midi_ctrl
5087    
5088          / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
5089          volume_value
5090    
5091    
5092    
5093    
5094    
5095    Schoenebeck            Expires September 30, 2007              [Page 91]
5096    
5097    Internet-Draft        LinuxSampler Control Protocol           March 2007
5098    
5099    
5100          / ECHO SP boolean
5101    
5102          / VOLUME SP volume_value
5103    
5104       create_instruction =
5105    
5106          AUDIO_OUTPUT_DEVICE SP string SP key_val_list
5107    
5108          / AUDIO_OUTPUT_DEVICE SP string
5109    
5110          / MIDI_INPUT_DEVICE SP string SP key_val_list
5111    
5112          / MIDI_INPUT_DEVICE SP string
5113    
5114          / FX_SEND SP sampler_channel SP midi_ctrl
5115    
5116          / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5117    
5118       reset_instruction =
5119    
5120          CHANNEL SP sampler_channel
5121    
5122       clear_instruction =
5123    
5124          MIDI_INSTRUMENTS SP midi_map
5125    
5126          / MIDI_INSTRUMENTS SP ALL
5127    
5128       destroy_instruction =
5129    
5130          AUDIO_OUTPUT_DEVICE SP number
5131    
5132          / MIDI_INPUT_DEVICE SP number
5133    
5134          / FX_SEND SP sampler_channel SP fx_send_id
5135    
5136       load_instruction =
5137    
5138          INSTRUMENT SP load_instr_args
5139    
5140          / ENGINE SP load_engine_args
5141    
5142       set_chan_instruction =
5143    
5144          AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
5145    
5146          / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
5147          SP audio_channel_index
5148    
5149    
5150    
5151    Schoenebeck            Expires September 30, 2007              [Page 92]
5152    
5153    Internet-Draft        LinuxSampler Control Protocol           March 2007
5154    
5155    
5156          / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
5157    
5158          / MIDI_INPUT SP sampler_channel SP device_index SP
5159          midi_input_port_index SP midi_input_channel_index
5160    
5161          / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
5162    
5163          / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
5164    
5165          / MIDI_INPUT_CHANNEL SP sampler_channel SP
5166          midi_input_channel_index
5167    
5168          / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
5169    
5170          / VOLUME SP sampler_channel SP volume_value
5171    
5172          / MUTE SP sampler_channel SP boolean
5173    
5174          / SOLO SP sampler_channel SP boolean
5175    
5176          / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
5177    
5178          / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
5179    
5180          / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
5181    
5182       modal_arg =
5183    
5184          /* epsilon (empty argument) */
5185    
5186          / NON_MODAL SP
5187    
5188       key_val_list =
5189    
5190          string '=' param_val_list
5191    
5192          / key_val_list SP string '=' param_val_list
5193    
5194       buffer_size_type =
5195    
5196          BYTES
5197    
5198          / PERCENTAGE
5199    
5200       list_instruction =
5201    
5202          AUDIO_OUTPUT_DEVICES
5203    
5204    
5205    
5206    
5207    Schoenebeck            Expires September 30, 2007              [Page 93]
5208    
5209    Internet-Draft        LinuxSampler Control Protocol           March 2007
5210    
5211    
5212          / MIDI_INPUT_DEVICES
5213    
5214          / CHANNELS
5215    
5216          / AVAILABLE_ENGINES
5217    
5218          / AVAILABLE_MIDI_INPUT_DRIVERS
5219    
5220          / AVAILABLE_AUDIO_OUTPUT_DRIVERS
5221    
5222          / MIDI_INSTRUMENTS SP midi_map
5223    
5224          / MIDI_INSTRUMENTS SP ALL
5225    
5226          / MIDI_INSTRUMENT_MAPS
5227    
5228          / FX_SENDS SP sampler_channel
5229    
5230       load_instr_args =
5231    
5232          filename SP instrument_index SP sampler_channel
5233    
5234          / NON_MODAL SP filename SP instrument_index SP sampler_channel
5235    
5236       load_engine_args =
5237    
5238          engine_name SP sampler_channel
5239    
5240       instr_load_mode =
5241    
5242          ON_DEMAND
5243    
5244          / ON_DEMAND_HOLD
5245    
5246          / PERSISTENT
5247    
5248       device_index =
5249    
5250          number
5251    
5252       audio_channel_index =
5253    
5254          number
5255    
5256       audio_output_type_name =
5257    
5258          string
5259    
5260    
5261    
5262    
5263    Schoenebeck            Expires September 30, 2007              [Page 94]
5264    
5265    Internet-Draft        LinuxSampler Control Protocol           March 2007
5266    
5267    
5268       midi_input_port_index =
5269    
5270          number
5271    
5272       midi_input_channel_index =
5273    
5274          number
5275    
5276          / ALL
5277    
5278       midi_input_type_name =
5279    
5280          string
5281    
5282       midi_map =
5283    
5284          number
5285    
5286       midi_bank =
5287    
5288          number
5289    
5290       midi_prog =
5291    
5292          number
5293    
5294       midi_ctrl =
5295    
5296          number
5297    
5298       volume_value =
5299    
5300          dotnum
5301    
5302          / number
5303    
5304       sampler_channel =
5305    
5306          number
5307    
5308       instrument_index =
5309    
5310          number
5311    
5312       fx_send_id =
5313    
5314          number
5315    
5316    
5317    
5318    
5319    Schoenebeck            Expires September 30, 2007              [Page 95]
5320    
5321    Internet-Draft        LinuxSampler Control Protocol           March 2007
5322    
5323    
5324       engine_name =
5325    
5326          string
5327    
5328       filename =
5329    
5330          stringval
5331    
5332       map_name =
5333    
5334          stringval
5335    
5336       entry_name =
5337    
5338          stringval
5339    
5340       fx_send_name =
5341    
5342          stringval
5343    
5344       param_val_list =
5345    
5346          param_val
5347    
5348          / param_val_list','param_val
5349    
5350       param_val =
5351    
5352          string
5353    
5354          / stringval
5355    
5356          / number
5357    
5358          / dotnum
5359    
5360    
5361    
5362    
5363    
5364    
5365    
5366    
5367    
5368    
5369    
5370    
5371    
5372    
5373    
5374    
5375    Schoenebeck            Expires September 30, 2007              [Page 96]
5376    
5377    Internet-Draft        LinuxSampler Control Protocol           March 2007
5378    
5379    
5380    8.  Events
5381    
5382     This chapter will describe all currently defined events supported by     This chapter will describe all currently defined events supported by
5383     LinuxSampler.     LinuxSampler.
5384    
5385  7.1  Number of sampler channels changed  8.1.  Number of audio output devices changed
5386    
5387       Client may want to be notified when the total number of audio output
5388       devices on the back-end changes by issuing the following command:
5389    
5390          SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
5391    
5392       Server will start sending the following notification messages:
5393    
5394          "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
5395    
5396       where <devices> will be replaced by the new number of audio output
5397       devices.
5398    
5399    8.2.  Audio output device's settings changed
5400    
5401       Client may want to be notified when changes were made to audio output
5402       devices on the back-end by issuing the following command:
5403    
5404          SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
5405    
5406       Server will start sending the following notification messages:
5407    
5408          "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
5409    
5410       where <device-id> will be replaced by the numerical ID of the audio
5411       output device, which settings has been changed.  The front-end will
5412       have to send the respective command to actually get the audio output
5413       device info.  Because these messages will be triggered by LSCP
5414       commands issued by other clients rather than real time events
5415       happening on the server, it is believed that an empty notification
5416       message is sufficient here.
5417    
5418    8.3.  Number of MIDI input devices changed
5419    
5420       Client may want to be notified when the total number of MIDI input
5421       devices on the back-end changes by issuing the following command:
5422    
5423          SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
5424    
5425       Server will start sending the following notification messages:
5426    
5427    
5428    
5429    
5430    
5431    Schoenebeck            Expires September 30, 2007              [Page 97]
5432    
5433    Internet-Draft        LinuxSampler Control Protocol           March 2007
5434    
5435    
5436          "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
5437    
5438       where <devices> will be replaced by the new number of MIDI input
5439       devices.
5440    
5441    8.4.  MIDI input device's settings changed
5442    
5443       Client may want to be notified when changes were made to MIDI input
5444       devices on the back-end by issuing the following command:
5445    
5446          SUBSCRIBE MIDI_INPUT_DEVICE_INFO
5447    
5448       Server will start sending the following notification messages:
5449    
5450          "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
5451    
5452       where <device-id> will be replaced by the numerical ID of the MIDI
5453       input device, which settings has been changed.  The front-end will
5454       have to send the respective command to actually get the MIDI input
5455       device info.  Because these messages will be triggered by LSCP
5456       commands issued by other clients rather than real time events
5457       happening on the server, it is believed that an empty notification
5458       message is sufficient here.
5459    
5460    8.5.  Number of sampler channels changed
5461    
5462     Client may want to be notified when the total number of channels on     Client may want to be notified when the total number of channels on
5463     the back-end changes by issuing the following command:     the back-end changes by issuing the following command:
5464    
5465        SUBSCRIBE CHANNELS        SUBSCRIBE CHANNEL_COUNT
5466    
5467     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5468    
5469        "NOTIFY:CHANNELS:<channels>"        "NOTIFY:CHANNEL_COUNT:<channels>"
5470    
5471     where <channels> will be replaced by the new number of sampler     where <channels> will be replaced by the new number of sampler
5472     channels.     channels.
5473    
5474  7.2  Number of active voices changed  8.6.  Number of active voices changed
5475    
5476     Client may want to be notified when the number of voices on the     Client may want to be notified when the number of voices on the back-
5477     back-end changes by issuing the following command:     end changes by issuing the following command:
5478    
5479        SUBSCRIBE VOICE_COUNT        SUBSCRIBE VOICE_COUNT
5480    
5481     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5482    
5483        "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>  
5484    
5485    
5486    
5487    Schoenebeck            Expires September 30, 2007              [Page 98]
5488    
5489    Internet-Draft        LinuxSampler Control Protocol           March 2007
5490    
5491    
5492          "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
5493    
5494     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5495     voice count change occurred and <voices> by the new number of active     voice count change occurred and <voices> by the new number of active
5496     voices on that channel.     voices on that channel.
5497    
5498  7.3  Number of active disk streams changed  8.7.  Number of active disk streams changed
5499    
5500     Client may want to be notified when the number of streams on the     Client may want to be notified when the number of streams on the
5501     back-end changes by issuing the following command: SUBSCRIBE     back-end changes by issuing the following command: SUBSCRIBE
# Line 2905  Internet-Draft       LinuxSampler Contro Line 5509  Internet-Draft       LinuxSampler Contro
5509    
5510     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5511     stream count change occurred and <streams> by the new number of     stream count change occurred and <streams> by the new number of
   
   
   
 Schoenebeck             Expires November 7, 2005               [Page 52]  
   
 Internet-Draft       LinuxSampler Control Protocol              May 2005  
   
   
5512     active disk streams on that channel.     active disk streams on that channel.
5513    
5514  7.4  Disk stream buffer fill state changed  8.8.  Disk stream buffer fill state changed
5515    
5516     Client may want to be notified when the buffer fill state of a disk     Client may want to be notified when the buffer fill state of a disk
5517     stream on the back-end changes by issuing the following command:     stream on the back-end changes by issuing the following command:
# Line 2928  Internet-Draft       LinuxSampler Contro Line 5524  Internet-Draft       LinuxSampler Contro
5524    
5525     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5526     buffer fill state change occurred on and <fill-data> will be replaced     buffer fill state change occurred on and <fill-data> will be replaced
5527     by the buffer fill data for this channel as described in Section     by the buffer fill data for this channel as described in
5528     5.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE" (Section     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
5529     5.4.13) command was issued on this channel.     (Section 6.4.13) command was issued on this channel.
5530    
5531  7.5  Channel information changed  8.9.  Channel information changed
5532    
5533     Client may want to be notified when changes were made to sampler     Client may want to be notified when changes were made to sampler
5534     channels on the back-end changes by issuing the following command:     channels on the back-end by issuing the following command:
5535    
5536        SUBSCRIBE INFO        SUBSCRIBE CHANNEL_INFO
5537    
5538     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5539    
5540        "NOTIFY:INFO:<sampler-channel>"  
5541    
5542    
5543    Schoenebeck            Expires September 30, 2007              [Page 99]
5544    
5545    Internet-Draft        LinuxSampler Control Protocol           March 2007
5546    
5547    
5548          "NOTIFY:CHANNEL_INFO:<sampler-channel>"
5549    
5550     where <sampler-channel> will be replaced by the sampler channel the     where <sampler-channel> will be replaced by the sampler channel the
5551     channel info change occurred.  The front-end will have to send the     channel info change occurred.  The front-end will have to send the
# Line 2950  Internet-Draft       LinuxSampler Contro Line 5554  Internet-Draft       LinuxSampler Contro
5554     rather than real time events happening on the server, it is believed     rather than real time events happening on the server, it is believed
5555     that an empty notification message is sufficient here.     that an empty notification message is sufficient here.
5556    
5557  7.6  Miscellaneous and debugging events  8.10.  Number of effect sends changed
5558    
5559     Client may want to be notified of miscellaneous and debugging events     Client may want to be notified when the number of effect sends on a
5560     occurring at the server by issuing the following command:     particular sampler channel is changed by issuing the following
5561       command:
5562    
5563        SUBSCRIBE MISCELLANEOUS        SUBSCRIBE FX_SEND_COUNT
5564    
5565     Server will start sending the following notification messages:     Server will start sending the following notification messages:
5566    
5567        "NOTIFY:MISCELLANEOUS:<string>"        "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
5568    
5569       where <channel-id> will be replaced by the numerical ID of the
5570       sampler channel, on which the effect sends number is changed and <fx-
5571       sends> will be replaced by the new number of effect sends on that
5572       channel.
5573    
5574    8.11.  Effect send information changed
5575    
5576       Client may want to be notified when changes were made to effect sends
5577       on a a particular sampler channel by issuing the following command:
5578    
5579          SUBSCRIBE FX_SEND_INFO
5580    
5581       Server will start sending the following notification messages:
5582    
5583          "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
5584    
5585       where <channel-id> will be replaced by the numerical ID of the
5586       sampler channel, on which an effect send entity is changed and <fx-
5587       send-id> will be replaced by the numerical ID of the changed effect
5588       send.
5589    
5590    8.12.  Total number of active voices changed
5591    
5592       Client may want to be notified when the total number of voices on the
5593       back-end changes by issuing the following command:
5594    
5595    
5596    
5597    
5598  Schoenebeck             Expires November 7, 2005               [Page 53]  
5599    Schoenebeck            Expires September 30, 2007             [Page 100]
5600    
5601  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
5602    
5603    
5604     where <string> will be replaced by whatever data server wants to send        SUBSCRIBE TOTAL_VOICE_COUNT
5605     to the client.  Client MAY display this data to the user AS IS to  
5606     facilitate debugging.     Server will start sending the following notification messages:
5607    
5608          "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
5609    
5610       where <voices> will be replaced by the new number of all currently
5611       active voices.
5612    
5613    8.13.  Number of MIDI instrument maps changed
5614    
5615       Client may want to be notified when the number of MIDI instrument
5616       maps on the back-end changes by issuing the following command:
5617    
5618          SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
5619    
5620       Server will start sending the following notification messages:
5621    
5622          "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
5623    
5624       where <maps> will be replaced by the new number of MIDI instrument
5625       maps.
5626    
5627    8.14.  MIDI instrument map information changed
5628    
5629       Client may want to be notified when changes were made to MIDI
5630       instrument maps on the back-end by issuing the following command:
5631    
5632          SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
5633    
5634       Server will start sending the following notification messages:
5635    
5636          "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
5637    
5638       where <map-id> will be replaced by the numerical ID of the MIDI
5639       instrument map, for which information changes occurred.  The front-
5640       end will have to send the respective command to actually get the MIDI
5641       instrument map info.  Because these messages will be triggered by
5642       LSCP commands issued by other clients rather than real time events
5643       happening on the server, it is believed that an empty notification
5644       message is sufficient here.
5645    
5646    8.15.  Number of MIDI instruments changed
5647    
5648       Client may want to be notified when the number of MIDI instrument
5649       maps on the back-end changes by issuing the following command:
5650    
5651    
5652    
5653    
5654    
5655    Schoenebeck            Expires September 30, 2007             [Page 101]
5656    
5657    Internet-Draft        LinuxSampler Control Protocol           March 2007
5658    
5659    
5660          SUBSCRIBE MIDI_INSTRUMENT_COUNT
5661    
5662       Server will start sending the following notification messages:
5663    
5664          "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
5665    
5666       where <map-id> is the numerical ID of the MIDI instrument map, in
5667       which the nuber of instruments has changed and <instruments> will be
5668       replaced by the new number of MIDI instruments in the specified map.
5669    
5670    8.16.  MIDI instrument information changed
5671    
5672       Client may want to be notified when changes were made to MIDI
5673       instruments on the back-end by issuing the following command:
5674    
5675          SUBSCRIBE MIDI_INSTRUMENT_INFO
5676    
5677       Server will start sending the following notification messages:
5678    
5679          "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
5680    
5681       where <map-id> will be replaced by the numerical ID of the MIDI
5682       instrument map, in which a MIDI instrument is changed. <bank> and
5683       <program> specifies the location of the changed MIDI instrument in
5684       the map.  The front-end will have to send the respective command to
5685       actually get the MIDI instrument info.  Because these messages will
5686       be triggered by LSCP commands issued by other clients rather than
5687       real time events happening on the server, it is believed that an
5688       empty notification message is sufficient here.
5689    
5690    8.17.  Global settings changed
5691    
5692       Client may want to be notified when changes to the global settings of
5693       the sampler were made by issuing the following command:
5694    
5695          SUBSCRIBE GLOBAL_INFO
5696    
5697       Server will start sending the following types of notification
5698       messages:
5699    
5700          "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
5701          volume of the sampler is changed, where <volume> will be replaced
5702          by the optional dotted floating point value, reflecting the new
5703          global volume parameter.
5704    
5705    
5706    
# Line 3001  Internet-Draft       LinuxSampler Contro Line 5708  Internet-Draft       LinuxSampler Contro
5708    
5709    
5710    
5711    Schoenebeck            Expires September 30, 2007             [Page 102]
5712    
5713    Internet-Draft        LinuxSampler Control Protocol           March 2007
5714    
5715    
5716    8.18.  Miscellaneous and debugging events
5717    
5718       Client may want to be notified of miscellaneous and debugging events
5719       occurring at the server by issuing the following command:
5720    
5721          SUBSCRIBE MISCELLANEOUS
5722    
5723       Server will start sending the following notification messages:
5724    
5725          "NOTIFY:MISCELLANEOUS:<string>"
5726    
5727       where <string> will be replaced by whatever data server wants to send
5728       to the client.  Client MAY display this data to the user AS IS to
5729       facilitate debugging.
5730    
5731    
5732    
5733    
# Line 3020  Internet-Draft       LinuxSampler Contro Line 5747  Internet-Draft       LinuxSampler Contro
5747    
5748    
5749    
5750  Schoenebeck             Expires November 7, 2005               [Page 54]  
5751    
5752    
5753    
5754    
5755    
5756    
5757    
5758    
5759    
5760    
5761    
5762    
5763    
5764    
5765    
5766    
5767    Schoenebeck            Expires September 30, 2007             [Page 103]
5768    
5769  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
5770    
5771    
5772  8.  Security Considerations  9.  Security Considerations
5773    
5774     As there is so far no method of authentication and authorization     As there is so far no method of authentication and authorization
5775     defined and so not required for a client applications to succeed to     defined and so not required for a client applications to succeed to
# Line 3076  Internet-Draft       LinuxSampler Contro Line 5820  Internet-Draft       LinuxSampler Contro
5820    
5821    
5822    
5823  Schoenebeck             Expires November 7, 2005               [Page 55]  Schoenebeck            Expires September 30, 2007             [Page 104]
5824    
5825  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
5826    
5827    
5828  9.  Acknowledgments  10.  Acknowledgments
5829    
5830     This document has benefited greatly from the comments of the     This document has benefited greatly from the comments of the
5831     following people, discussed on the LinuxSampler developer's mailing     following people, discussed on the LinuxSampler developer's mailing
5832     list:     list:
5833    
5834        Rui Nuno Capela        Rui Nuno Capela
5835    
5836        Vladimir Senkov        Vladimir Senkov
5837    
5838        Mark Knecht        Mark Knecht
5839    
5840  10  References        Grigor Iliev
5841    
    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate  
               Requirement Levels", BCP 14, RFC 2119, March 1997.  
5842    
5843    
 Author's Address  
5844    
    C. Schoenebeck  
    Interessengemeinschaft Software Engineering e. V.  
    Max-Planck-Str. 39  
    74081 Heilbronn  
    Germany  
5845    
    EMail: schoenebeck at software minus engineering dot org  
5846    
5847    
5848    
# Line 3132  Author's Address Line 5869  Author's Address
5869    
5870    
5871    
5872  Schoenebeck             Expires November 7, 2005               [Page 56]  
5873    
5874    
5875    
5876    
5877    
5878    
5879    Schoenebeck            Expires September 30, 2007             [Page 105]
5880    
5881  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
5882    
5883    
5884    11.  References
5885    
5886       [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
5887                  Requirement Levels", RFC 2119, 1997.
5888    
5889       [RFC2234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
5890                  Specifications", RFC 2234, 1997.
5891    
5892       [RFC793]   Defense Advanced Research Projects Agency, "TRANSMISSION
5893                  CONTROL PROTOCOL", RFC 793, 1981.
5894    
5895    
5896    
5897    
5898    
5899    
5900    
5901    
5902    
5903    
5904    
5905    
5906    
5907    
5908    
5909    
5910    
5911    
5912    
5913    
5914    
5915    
5916    
5917    
5918    
 Intellectual Property Statement  
5919    
    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.  
5920    
    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.  
5921    
5922    
 Full Copyright Statement  
5923    
    Copyright (C) The Internet Society (2005).  All Rights Reserved.  
5924    
    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.  
5925    
    The limited permissions granted above are perpetual and will not be  
    revoked by the Internet Society or its successors or assignees.  
5926    
    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  
5927    
5928    
5929    
5930  Schoenebeck             Expires November 7, 2005               [Page 57]  
5931    
5932    
5933    
5934    
5935    Schoenebeck            Expires September 30, 2007             [Page 106]
5936    
5937  Internet-Draft       LinuxSampler Control Protocol              May 2005  Internet-Draft        LinuxSampler Control Protocol           March 2007
5938    
5939    
5940    Author's Address
5941    
5942       C. Schoenebeck
5943       Interessengemeinschaft Software Engineering e. V.
5944       Max-Planck-Str. 39
5945       74081 Heilbronn
5946       Germany
5947    
5948       Email: schoenebeck at software minus engineering dot org
5949    
5950    
5951    
    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF  
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
5952    
5953    
 Acknowledgment  
5954    
    Funding for the RFC Editor function is currently provided by the  
    Internet Society.  
5955    
5956    
5957    
# Line 3237  Acknowledgment Line 5988  Acknowledgment
5988    
5989    
5990    
5991    Schoenebeck            Expires September 30, 2007             [Page 107]
5992    
5993    Internet-Draft        LinuxSampler Control Protocol           March 2007
5994    
5995    
5996    Full Copyright Statement
5997    
5998       Copyright (C) The IETF Trust (2007).
5999    
6000       This document is subject to the rights, licenses and restrictions
6001       contained in BCP 78, and except as set forth therein, the authors
6002       retain all their rights.
6003    
6004       This document and the information contained herein are provided on an
6005       "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
6006       OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
6007       THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
6008       OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
6009       THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
6010       WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
6011    
6012    
6013    Intellectual Property
6014    
6015       The IETF takes no position regarding the validity or scope of any
6016       Intellectual Property Rights or other rights that might be claimed to
6017       pertain to the implementation or use of the technology described in
6018       this document or the extent to which any license under such rights
6019       might or might not be available; nor does it represent that it has
6020       made any independent effort to identify any such rights.  Information
6021       on the procedures with respect to rights in RFC documents can be
6022       found in BCP 78 and BCP 79.
6023    
6024       Copies of IPR disclosures made to the IETF Secretariat and any
6025       assurances of licenses to be made available, or the result of an
6026       attempt made to obtain a general license or permission for the use of
6027       such proprietary rights by implementers or users of this
6028       specification can be obtained from the IETF on-line IPR repository at
6029       http://www.ietf.org/ipr.
6030    
6031       The IETF invites any interested party to bring to its attention any
6032       copyrights, patents or patent applications, or other proprietary
6033       rights that may cover technology that may be required to implement
6034       this standard.  Please address the information to the IETF at
6035       ietf-ipr@ietf.org.
6036    
6037    
6038    Acknowledgment
6039    
6040       Funding for the RFC Editor function is provided by the IETF
6041       Administrative Support Activity (IASA).
6042    
6043    
6044    
6045    
6046    
6047  Schoenebeck             Expires November 7, 2005               [Page 58]  Schoenebeck            Expires September 30, 2007             [Page 108]
6048    
Legend:
Removed from v.542  
changed lines
  Added in v.1137
  ViewVC Help
Powered by ViewVC