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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1251 - (hide annotations) (download)
Fri Jun 22 14:24:57 2007 UTC (16 years, 8 months ago) by schoenebeck
File MIME type: text/plain
File size: 211573 byte(s)
- updated LSCP spec draft regarding extended ASCII character
  set and support for escape sequences

1 senoner 542
2    
3 schoenebeck 708
4 senoner 542 LinuxSampler Developers C. Schoenebeck
5     Internet-Draft Interessengemeinschaft Software
6 schoenebeck 974 Intended status: Standards Track Engineering e. V.
7 schoenebeck 1251 Expires: December 24, 2007 June 22, 2007
8 senoner 542
9    
10 schoenebeck 1251 LinuxSampler Control Protocol (draft)
11     LSCP 1.2cvs
12 senoner 542
13     Status of this Memo
14    
15 schoenebeck 974 By submitting this Internet-Draft, each author represents that any
16     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 senoner 542
20     Internet-Drafts are working documents of the Internet Engineering
21     Task Force (IETF), its areas, and its working groups. Note that
22 schoenebeck 708 other groups may also distribute working documents as Internet-
23     Drafts.
24 senoner 542
25     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
27     time. It is inappropriate to use Internet-Drafts as reference
28     material or to cite them other than as "work in progress."
29    
30     The list of current Internet-Drafts can be accessed at
31     http://www.ietf.org/ietf/1id-abstracts.txt.
32    
33     The list of Internet-Draft Shadow Directories can be accessed at
34     http://www.ietf.org/shadow.html.
35    
36 schoenebeck 1251 This Internet-Draft will expire on December 24, 2007.
37 senoner 542
38     Copyright Notice
39    
40 iliev 1110 Copyright (C) The IETF Trust (2007).
41 senoner 542
42    
43    
44    
45    
46    
47    
48    
49    
50    
51 schoenebeck 974
52    
53    
54    
55 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 1]
56 schoenebeck 940
57 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
58 senoner 542
59    
60 schoenebeck 974 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 senoner 542 Table of Contents
70    
71 iliev 1162 1. Requirements notation . . . . . . . . . . . . . . . . . . . . 6
72     2. Versioning of this specification . . . . . . . . . . . . . . 7
73     3. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 8
74     4. Focus of this protocol . . . . . . . . . . . . . . . . . . . 9
75     5. Communication Overview . . . . . . . . . . . . . . . . . . . 10
76     5.1. Request/response communication method . . . . . . . . . . 10
77     5.1.1. Result format . . . . . . . . . . . . . . . . . . . . 11
78     5.2. Subscribe/notify communication method . . . . . . . . . . 13
79     6. Description for control commands . . . . . . . . . . . . . . 15
80     6.1. Ignored lines and comments . . . . . . . . . . . . . . . 15
81     6.2. Configuring audio drivers . . . . . . . . . . . . . . . . 15
82     6.2.1. Getting amount of available audio output drivers . . 16
83     6.2.2. Getting all available audio output drivers . . . . . 16
84 schoenebeck 940 6.2.3. Getting information about a specific audio output
85 iliev 1162 driver . . . . . . . . . . . . . . . . . . . . . . . 16
86 schoenebeck 940 6.2.4. Getting information about specific audio output
87 iliev 1162 driver parameter . . . . . . . . . . . . . . . . . . 17
88     6.2.5. Creating an audio output device . . . . . . . . . . . 21
89     6.2.6. Destroying an audio output device . . . . . . . . . . 22
90     6.2.7. Getting all created audio output device count . . . . 23
91     6.2.8. Getting all created audio output device list . . . . 23
92     6.2.9. Getting current settings of an audio output device . 23
93     6.2.10. Changing settings of audio output devices . . . . . . 25
94     6.2.11. Getting information about an audio channel . . . . . 26
95 schoenebeck 940 6.2.12. Getting information about specific audio channel
96 iliev 1162 parameter . . . . . . . . . . . . . . . . . . . . . . 27
97     6.2.13. Changing settings of audio output channels . . . . . 29
98     6.3. Configuring MIDI input drivers . . . . . . . . . . . . . 30
99     6.3.1. Getting amount of available MIDI input drivers . . . 31
100     6.3.2. Getting all available MIDI input drivers . . . . . . 31
101 schoenebeck 940 6.3.3. Getting information about a specific MIDI input
102 iliev 1162 driver . . . . . . . . . . . . . . . . . . . . . . . 32
103 schoenebeck 940 6.3.4. Getting information about specific MIDI input
104 iliev 1162 driver parameter . . . . . . . . . . . . . . . . . . 33
105     6.3.5. Creating a MIDI input device . . . . . . . . . . . . 35
106     6.3.6. Destroying a MIDI input device . . . . . . . . . . . 36
107     6.3.7. Getting all created MIDI input device count . . . . . 37
108 schoenebeck 974
109    
110    
111 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 2]
112 schoenebeck 974
113 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
114 schoenebeck 974
115    
116 iliev 1162 6.3.8. Getting all created MIDI input device list . . . . . 37
117     6.3.9. Getting current settings of a MIDI input device . . . 38
118     6.3.10. Changing settings of MIDI input devices . . . . . . . 39
119     6.3.11. Getting information about a MIDI port . . . . . . . . 39
120 schoenebeck 940 6.3.12. Getting information about specific MIDI port
121 iliev 1162 parameter . . . . . . . . . . . . . . . . . . . . . . 40
122     6.3.13. Changing settings of MIDI input ports . . . . . . . . 42
123     6.4. Configuring sampler channels . . . . . . . . . . . . . . 43
124     6.4.1. Loading an instrument . . . . . . . . . . . . . . . . 43
125     6.4.2. Loading a sampler engine . . . . . . . . . . . . . . 44
126     6.4.3. Getting all created sampler channel count . . . . . . 45
127     6.4.4. Getting all created sampler channel list . . . . . . 45
128 schoenebeck 1251 6.4.5. Adding a new sampler channel . . . . . . . . . . . . 46
129 iliev 1162 6.4.6. Removing a sampler channel . . . . . . . . . . . . . 46
130     6.4.7. Getting amount of available engines . . . . . . . . . 47
131 schoenebeck 1251 6.4.8. Getting all available engines . . . . . . . . . . . . 48
132 iliev 1162 6.4.9. Getting information about an engine . . . . . . . . . 48
133     6.4.10. Getting sampler channel information . . . . . . . . . 49
134     6.4.11. Current number of active voices . . . . . . . . . . . 52
135     6.4.12. Current number of active disk streams . . . . . . . . 52
136     6.4.13. Current fill state of disk stream buffers . . . . . . 53
137     6.4.14. Setting audio output device . . . . . . . . . . . . . 54
138 schoenebeck 1251 6.4.15. Setting audio output type . . . . . . . . . . . . . . 55
139 iliev 1162 6.4.16. Setting audio output channel . . . . . . . . . . . . 55
140     6.4.17. Setting MIDI input device . . . . . . . . . . . . . . 56
141     6.4.18. Setting MIDI input type . . . . . . . . . . . . . . . 57
142     6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 57
143     6.4.20. Setting MIDI input channel . . . . . . . . . . . . . 58
144     6.4.21. Setting channel volume . . . . . . . . . . . . . . . 59
145     6.4.22. Muting a sampler channel . . . . . . . . . . . . . . 59
146     6.4.23. Soloing a sampler channel . . . . . . . . . . . . . . 60
147 schoenebeck 974 6.4.24. Assigning a MIDI instrument map to a sampler
148 iliev 1162 channel . . . . . . . . . . . . . . . . . . . . . . . 61
149     6.4.25. Adding an effect send to a sampler channel . . . . . 62
150     6.4.26. Removing an effect send from a sampler channel . . . 63
151     6.4.27. Getting amount of effect sends on a sampler channel . 64
152     6.4.28. Listing all effect sends on a sampler channel . . . . 64
153     6.4.29. Getting effect send information . . . . . . . . . . . 65
154     6.4.30. Changing effect send's name . . . . . . . . . . . . . 66
155     6.4.31. Altering effect send's audio routing . . . . . . . . 67
156     6.4.32. Altering effect send's MIDI controller . . . . . . . 68
157 schoenebeck 1251 6.4.33. Altering effect send's send level . . . . . . . . . . 69
158     6.4.34. Resetting a sampler channel . . . . . . . . . . . . . 70
159 iliev 1162 6.5. Controlling connection . . . . . . . . . . . . . . . . . 70
160     6.5.1. Register front-end for receiving event messages . . . 70
161 schoenebeck 940 6.5.2. Unregister front-end for not receiving event
162 iliev 1162 messages . . . . . . . . . . . . . . . . . . . . . . 71
163 schoenebeck 1251 6.5.3. Enable or disable echo of commands . . . . . . . . . 72
164 schoenebeck 708
165 senoner 542
166    
167 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 3]
168 schoenebeck 940
169 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
170 senoner 542
171    
172 iliev 1162 6.5.4. Close client connection . . . . . . . . . . . . . . . 72
173     6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 72
174 schoenebeck 1251 6.6.1. Current number of active voices . . . . . . . . . . . 73
175 iliev 1162 6.6.2. Maximum amount of active voices . . . . . . . . . . . 73
176     6.6.3. Reset sampler . . . . . . . . . . . . . . . . . . . . 73
177     6.6.4. General sampler informations . . . . . . . . . . . . 73
178     6.6.5. Getting global volume attenuation . . . . . . . . . . 74
179 schoenebeck 1251 6.6.6. Setting global volume attenuation . . . . . . . . . . 75
180 iliev 1162 6.7. MIDI Instrument Mapping . . . . . . . . . . . . . . . . . 75
181     6.7.1. Create a new MIDI instrument map . . . . . . . . . . 76
182 schoenebeck 1251 6.7.2. Delete one particular or all MIDI instrument maps . . 77
183 iliev 1162 6.7.3. Get amount of existing MIDI instrument maps . . . . . 77
184 schoenebeck 1251 6.7.4. Getting all created MIDI instrument maps . . . . . . 78
185 iliev 1162 6.7.5. Getting MIDI instrument map information . . . . . . . 78
186     6.7.6. Renaming a MIDI instrument map . . . . . . . . . . . 79
187 schoenebeck 1251 6.7.7. Create or replace a MIDI instrument map entry . . . . 80
188 iliev 1162 6.7.8. Getting ammount of MIDI instrument map entries . . . 82
189 schoenebeck 974 6.7.9. Getting indeces of all entries of a MIDI
190 iliev 1162 instrument map . . . . . . . . . . . . . . . . . . . 83
191 schoenebeck 1251 6.7.10. Remove an entry from the MIDI instrument map . . . . 84
192 iliev 1162 6.7.11. Get current settings of MIDI instrument map entry . . 84
193     6.7.12. Clear MIDI instrument map . . . . . . . . . . . . . . 86
194 schoenebeck 1251 6.8. Managing Instruments Database . . . . . . . . . . . . . . 87
195     6.8.1. Creating a new instrument directory . . . . . . . . . 87
196 iliev 1162 6.8.2. Deleting an instrument directory . . . . . . . . . . 87
197     6.8.3. Getting amount of instrument directories . . . . . . 88
198 schoenebeck 1251 6.8.4. Listing all directories in specific directory . . . . 89
199 iliev 1162 6.8.5. Getting instrument directory information . . . . . . 89
200     6.8.6. Renaming an instrument directory . . . . . . . . . . 90
201 schoenebeck 1251 6.8.7. Moving an instrument directory . . . . . . . . . . . 91
202     6.8.8. Copying instrument directories . . . . . . . . . . . 92
203 iliev 1189 6.8.9. Changing the description of directory . . . . . . . . 92
204 schoenebeck 1251 6.8.10. Finding directories . . . . . . . . . . . . . . . . . 93
205 iliev 1189 6.8.11. Adding instruments to the instruments database . . . 94
206 schoenebeck 1251 6.8.12. Removing an instrument . . . . . . . . . . . . . . . 96
207 iliev 1201 6.8.13. Getting amount of instruments . . . . . . . . . . . . 96
208 schoenebeck 1251 6.8.14. Listing all instruments in specific directory . . . . 97
209 iliev 1189 6.8.15. Getting instrument information . . . . . . . . . . . 97
210 schoenebeck 1251 6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 100
211 iliev 1201 6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 100
212 schoenebeck 1251 6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 101
213     6.8.19. Changing the description of instrument . . . . . . . 102
214     6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 102
215 iliev 1201 6.8.21. Getting job status information . . . . . . . . . . . 104
216     7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 106
217 schoenebeck 1251 7.1. Character Set and Escape Sequences . . . . . . . . . . . 119
218     8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
219     8.1. Number of audio output devices changed . . . . . . . . . 121
220 schoenebeck 945
221    
222    
223 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 4]
224 iliev 1162
225 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
226 schoenebeck 945
227 iliev 1162
228 schoenebeck 1251 8.2. Audio output device's settings changed . . . . . . . . . 121
229     8.3. Number of MIDI input devices changed . . . . . . . . . . 121
230     8.4. MIDI input device's settings changed . . . . . . . . . . 122
231     8.5. Number of sampler channels changed . . . . . . . . . . . 122
232     8.6. Number of active voices changed . . . . . . . . . . . . . 122
233     8.7. Number of active disk streams changed . . . . . . . . . . 123
234     8.8. Disk stream buffer fill state changed . . . . . . . . . . 123
235     8.9. Channel information changed . . . . . . . . . . . . . . . 123
236     8.10. Number of effect sends changed . . . . . . . . . . . . . 124
237     8.11. Effect send information changed . . . . . . . . . . . . . 124
238     8.12. Total number of active voices changed . . . . . . . . . . 124
239     8.13. Number of MIDI instrument maps changed . . . . . . . . . 125
240     8.14. MIDI instrument map information changed . . . . . . . . . 125
241     8.15. Number of MIDI instruments changed . . . . . . . . . . . 125
242     8.16. MIDI instrument information changed . . . . . . . . . . . 126
243     8.17. Global settings changed . . . . . . . . . . . . . . . . . 126
244     8.18. Number of database instrument directories changed . . . . 127
245     8.19. Database instrument directory information changed . . . . 127
246     8.20. Number of database instruments changed . . . . . . . . . 128
247     8.21. Database instrument information changed . . . . . . . . . 128
248     8.22. Database job status information changed . . . . . . . . . 129
249     8.23. Miscellaneous and debugging events . . . . . . . . . . . 129
250     9. Security Considerations . . . . . . . . . . . . . . . . . . . 130
251     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 131
252     11. References . . . . . . . . . . . . . . . . . . . . . . . . . 132
253     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 133
254     Intellectual Property and Copyright Statements . . . . . . . . . 134
255 iliev 1162
256    
257    
258    
259    
260    
261    
262    
263    
264    
265    
266    
267    
268    
269    
270    
271    
272    
273    
274    
275    
276    
277    
278    
279 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 5]
280 schoenebeck 945
281 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
282 schoenebeck 945
283    
284 senoner 542 1. Requirements notation
285    
286     The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
287     "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
288     document are to be interpreted as described in [RFC2119].
289    
290     This protocol is always case-sensitive if not explicitly claimed the
291     opposite.
292    
293 schoenebeck 708 In examples, "C:" and "S:" indicate lines sent by the client (front-
294     end) and server (LinuxSampler) respectively. Lines in examples must
295     be interpreted as every line being CRLF terminated (carriage return
296     character followed by line feed character as defined in the ASCII
297 schoenebeck 1251 standard [RFC20]), thus the following example:
298 senoner 542
299     C: "some line"
300 schoenebeck 708
301 senoner 542 "another line"
302    
303     must actually be interpreted as client sending the following message:
304    
305     "some line<CR><LF>another line<CR><LF>"
306    
307     where <CR> symbolizes the carriage return character and <LF> the line
308     feed character as defined in the ASCII standard.
309    
310     Due to technical reasons, messages can arbitrary be fragmented, means
311     the following example:
312    
313     S: "abcd"
314    
315     could also happen to be sent in three messages like in the following
316     sequence scenario:
317    
318     o server sending message "a"
319 schoenebeck 708
320 senoner 542 o followed by a delay (pause) with arbitrary duration
321 schoenebeck 708
322 senoner 542 o followed by server sending message "bcd<CR>"
323 schoenebeck 708
324 senoner 542 o again followed by a delay (pause) with arbitrary duration
325 schoenebeck 708
326 senoner 542 o followed by server sending the message "<LF>"
327    
328     where again <CR> and <LF> symbolize the carriage return and line feed
329     characters respectively.
330    
331    
332    
333    
334    
335 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 6]
336 schoenebeck 940
337 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
338 senoner 542
339    
340 schoenebeck 575 2. Versioning of this specification
341 senoner 542
342 schoenebeck 575 LSCP will certainly be extended and enhanced by-and-by. Each
343     official release of the LSCP specification will be tagged with a
344     unique version tuple. The version tuple consists at least of a major
345     and minor version number like:
346    
347     "1.2"
348    
349     In this example the major version number would be "1" and the minor
350     version number would be "2". Note that the version tuple might also
351     have more than two elements. The major version number defines a
352     group of backward compatible versions. That means a frontend is
353     compatible to the connected sampler if and only if the LSCP versions
354     to which each of the two parties complies to, match both of the
355     following rules:
356    
357     Compatibility:
358    
359     1. The frontend's LSCP major version and the sampler's LSCP major
360     version are exactly equal.
361 schoenebeck 708
362 schoenebeck 575 2. The frontend's LSCP minor version is less or equal than the
363     sampler's LSCP minor version.
364    
365     Compatibility can only be claimed if both rules are true. The
366 schoenebeck 940 frontend can use the "GET SERVER INFO" (Section 6.6.4) command to get
367 schoenebeck 575 the version of the LSCP specification the sampler complies with.
368    
369    
370    
371    
372    
373    
374    
375    
376    
377    
378    
379    
380    
381    
382    
383    
384    
385    
386    
387    
388    
389    
390    
391 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 7]
392 schoenebeck 940
393 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
394 schoenebeck 575
395    
396     3. Introduction
397    
398 senoner 542 LinuxSampler is a so called software sampler application capable to
399     playback audio samples from a computer's Random Access Memory (RAM)
400     as well as directly streaming it from disk. LinuxSampler is designed
401     to be modular. It provides several so called "sampler engines" where
402     each engine is specialized for a certain purpose. LinuxSampler has
403     virtual channels which will be referred in this document as "sampler
404     channels". The channels are in such way virtual as they can be
405     connected to an arbitrary MIDI input method and arbitrary MIDI
406 schoenebeck 708 channel (e.g. sampler channel 17 could be connected to an ALSA
407 senoner 542 sequencer device 64:0 and listening to MIDI channel 1 there). Each
408 schoenebeck 575 sampler channel will be associated with an instance of one of the
409 senoner 542 available sampler engines (e.g. GigEngine, DLSEngine). The audio
410     output of each sampler channel can be routed to an arbitrary audio
411     output method (ALSA / JACK) and an arbitrary audio output channel
412     there.
413    
414    
415    
416    
417    
418    
419    
420    
421    
422    
423    
424    
425    
426    
427    
428    
429    
430    
431    
432    
433    
434    
435    
436    
437    
438    
439    
440    
441    
442    
443    
444    
445    
446    
447 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 8]
448 schoenebeck 940
449 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
450 senoner 542
451    
452 schoenebeck 575 4. Focus of this protocol
453 senoner 542
454     Main focus of this protocol is to provide a way to configure a
455     running LinuxSampler instance and to retrieve information about it.
456     The focus of this protocol is not to provide a way to control
457     synthesis parameters or even to trigger or release notes. Or in
458     other words; the focus are those functionalities which are not
459     covered by MIDI or which may at most be handled via MIDI System
460     Exclusive Messages.
461    
462    
463    
464    
465    
466    
467    
468    
469    
470    
471    
472    
473    
474    
475    
476    
477    
478    
479    
480    
481    
482    
483    
484    
485    
486    
487    
488    
489    
490    
491    
492    
493    
494    
495    
496    
497    
498    
499    
500    
501    
502    
503 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 9]
504 schoenebeck 940
505 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
506 senoner 542
507    
508 schoenebeck 575 5. Communication Overview
509 senoner 542
510     There are two distinct methods of communication between a running
511     instance of LinuxSampler and one or more control applications, so
512     called "front-ends": a simple request/response communication method
513     used by the clients to give commands to the server as well as to
514     inquire about server's status and a subscribe/notify communication
515     method used by the client to subscribe to and receive notifications
516     of certain events as they happen on the server. The latter needs
517     more effort to be implemented in the front-end application. The two
518     communication methods will be described next.
519    
520 schoenebeck 940 5.1. Request/response communication method
521 senoner 542
522 schoenebeck 575 This simple communication method is based on TCP [RFC793]. The
523     front-end application establishes a TCP connection to the
524     LinuxSampler instance on a certain host system. Then the front-end
525     application will send certain ASCII based commands as defined in this
526     document (every command line must be CRLF terminated - see
527     "Conventions used in this document" at the beginning of this
528     document) and the LinuxSampler application will response after a
529     certain process time with an appropriate ASCII based answer, also as
530     defined in this document. So this TCP communication is simply based
531     on query and answer paradigm. That way LinuxSampler is only able to
532     answer on queries from front-ends, but not able to automatically send
533     messages to the client if it's not asked to. The fronted should not
534     reconnect to LinuxSampler for every single command, instead it should
535     keep the connection established and simply resend message(s) for
536     subsequent commands. To keep information in the front-end up-to-date
537     the front-end has to periodically send new requests to get the
538     current information from the LinuxSampler instance. This is often
539     referred to as "polling". While polling is simple to implement and
540     may be OK to use in some cases, there may be disadvantages to polling
541     such as network traffic overhead and information being out of date.
542     It is possible for a client or several clients to open more than one
543 senoner 542 connection to the server at the same time. It is also possible to
544     send more than one request to the server at the same time but if
545     those requests are sent over the same connection server MUST execute
546     them sequentially. Upon executing a request server will produce a
547     result set and send it to the client. Each and every request made by
548     the client MUST result in a result set being sent back to the client.
549     No other data other than a result set may be sent by a server to a
550     client. No result set may be sent to a client without the client
551     sending request to the server first. On any particular connection,
552     result sets MUST be sent in their entirety without being interrupted
553     by other result sets. If several requests got queued up at the
554     server they MUST be processed in the order they were received and
555     result sets MUST be sent back in the same order.
556    
557    
558    
559 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 10]
560 schoenebeck 940
561 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
562 senoner 542
563    
564 schoenebeck 940 5.1.1. Result format
565 schoenebeck 708
566 senoner 542 Result set could be one of the following types:
567    
568     1. Normal
569 schoenebeck 708
570 senoner 542 2. Warning
571 schoenebeck 708
572 senoner 542 3. Error
573    
574     Warning and Error result sets MUST be single line and have the
575     following format:
576    
577     o "WRN:<warning-code>:<warning-message>"
578 schoenebeck 708
579 senoner 542 o "ERR:<error-code>:<error-message>"
580    
581     Where <warning-code> and <error-code> are numeric unique identifiers
582     of the warning or error and <warning-message> and <error-message> are
583     human readable descriptions of the warning or error respectively.
584    
585     Examples:
586    
587     C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0
588 schoenebeck 708
589 senoner 542 S: "WRN:32:This is a 24 bit patch which is not supported natively
590     yet."
591    
592     C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"
593 schoenebeck 708
594 senoner 542 S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter
595     'EAR'."
596    
597     C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"
598 schoenebeck 708
599 senoner 542 S: "ERR:9:There is no audio output device with index 123456."
600    
601     Normal result sets could be:
602    
603     1. Empty
604 schoenebeck 708
605 senoner 542 2. Single line
606 schoenebeck 708
607 senoner 542 3. Multi-line
608    
609     Empty result set is issued when the server only needed to acknowledge
610     the fact that the request was received and it was processed
611     successfully and no additional information is available. This result
612    
613    
614    
615 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 11]
616 schoenebeck 940
617 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
618 senoner 542
619    
620 schoenebeck 708 set has the following format:
621 senoner 542
622 schoenebeck 708 "OK"
623 senoner 542
624 schoenebeck 708 Example:
625 senoner 542
626 schoenebeck 708 C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"
627    
628 senoner 542 S: "OK"
629    
630     Single line result sets are command specific. One example of a
631     single line result set is an empty line. Multi-line result sets are
632     command specific and may include one or more lines of information.
633     They MUST always end with the following line:
634    
635     "."
636    
637     Example:
638    
639     C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
640 schoenebeck 708
641 senoner 542 S: "DRIVER: ALSA"
642 schoenebeck 708
643 senoner 542 "CHANNELS: 2"
644 schoenebeck 708
645 senoner 542 "SAMPLERATE: 44100"
646 schoenebeck 708
647 senoner 542 "ACTIVE: true"
648 schoenebeck 708
649 senoner 542 "FRAGMENTS: 2"
650 schoenebeck 708
651 senoner 542 "FRAGMENTSIZE: 128"
652 schoenebeck 708
653 senoner 542 "CARD: '0,0'"
654 schoenebeck 708
655 senoner 542 "."
656    
657     In addition to above mentioned formats, warnings and empty result
658     sets MAY be indexed. In this case, they have the following formats
659     respectively:
660    
661     o "WRN[<index>]:<warning-code>:<warning-message>"
662 schoenebeck 708
663 senoner 542 o "OK[<index>]"
664    
665     where <index> is command specific and is used to indicate channel
666     number that the result set was related to or other integer value.
667    
668 schoenebeck 708
669    
670    
671 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 12]
672 schoenebeck 940
673 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
674 schoenebeck 708
675    
676 senoner 542 Each line of the result set MUST end with <CRLF>.
677    
678     Examples:
679    
680     C: "ADD CHANNEL"
681 schoenebeck 708
682 senoner 542 S: "OK[12]"
683    
684     C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"
685 schoenebeck 708
686 senoner 542 S: "WRN[0]:32:Sample rate not supported, using 44100 instead."
687    
688 schoenebeck 940 5.2. Subscribe/notify communication method
689 schoenebeck 708
690 senoner 542 This more sophisticated communication method is actually only an
691     extension of the simple request/response communication method. The
692     front-end still uses a TCP connection and sends the same commands on
693     the TCP connection. Two extra commands are SUBSCRIBE and UNSUBSCRIBE
694     commands that allow a client to tell the server that it is interested
695     in receiving notifications about certain events as they happen on the
696     server. The SUBSCRIBE command has the following syntax:
697    
698     SUBSCRIBE <event-id>
699    
700     where <event-id> will be replaced by the respective event that client
701     wants to subscribe to. Upon receiving such request, server SHOULD
702     respond with OK and start sending EVENT notifications when a given
703     even has occurred to the front-end when an event has occurred. It
704     MAY be possible certain events may be sent before OK response during
705     real time nature of their generation. Event messages have the
706     following format:
707    
708     NOTIFY:<event-id>:<custom-event-data>
709    
710     where <event-id> uniquely identifies the event that has occurred and
711     <custom-event-data> is event specific.
712    
713     Several rules must be followed by the server when generating events:
714    
715     1. Events MUST NOT be sent to any client who has not issued an
716     appropriate SUBSCRIBE command.
717 schoenebeck 708
718 senoner 542 2. Events MUST only be sent using the same connection that was used
719     to subscribe to them.
720 schoenebeck 708
721 senoner 542 3. When response is being sent to the client, event MUST be inserted
722     in the stream before or after the response, but NOT in the
723 schoenebeck 940 middle. Same is true about the response. It should never be
724 schoenebeck 708
725    
726    
727 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 13]
728 schoenebeck 940
729 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
730 schoenebeck 708
731    
732 senoner 542 inserted in the middle of the event message as well as any other
733     response.
734    
735     If the client is not interested in a particular event anymore it MAY
736     issue UNSUBSCRIBE command using the following syntax:
737    
738     UNSUBSCRIBE <event-id>
739    
740     where <event-id> will be replace by the respective event that client
741     is no longer interested in receiving. For a list of supported events
742 schoenebeck 575 see Section 8.
743 senoner 542
744     Example: the fill states of disk stream buffers have changed on
745     sampler channel 4 and the LinuxSampler instance will react by sending
746     the following message to all clients who subscribed to this event:
747    
748     NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%
749    
750     Which means there are currently three active streams on sampler
751     channel 4, where the stream with ID "35" is filled by 62%, stream
752     with ID 33 is filled by 80% and stream with ID 37 is filled by 98%.
753    
754     Clients may choose to open more than one connection to the server and
755     use some connections to receive notifications while using other
756     connections to issue commands to the back-end. This is entirely
757     legal and up to the implementation. This does not change the
758     protocol in any way and no special restrictions exist on the server
759     to allow or disallow this or to track what connections belong to what
760     front-ends. Server will listen on a single port, accept multiple
761     connections and support protocol described in this specification in
762     it's entirety on this single port on each connection that it
763     accepted.
764    
765     Due to the fact that TCP is used for this communication, dead peers
766     will be detected automatically by the OS TCP stack. While it may
767     take a while to detect dead peers if no traffic is being sent from
768     server to client (TCP keep-alive timer is set to 2 hours on many
769     OSes) it will not be an issue here as when notifications are sent by
770     the server, dead client will be detected quickly.
771    
772     When connection is closed for any reason server MUST forget all
773     subscriptions that were made on this connection. If client
774     reconnects it MUST resubscribe to all events that it wants to
775     receive.
776    
777    
778    
779    
780    
781    
782    
783 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 14]
784 schoenebeck 940
785 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
786 senoner 542
787    
788 schoenebeck 575 6. Description for control commands
789 senoner 542
790     This chapter will describe the available control commands that can be
791     sent on the TCP connection in detail. Some certain commands (e.g.
792 schoenebeck 708 "GET CHANNEL INFO" (Section 6.4.10) or "GET ENGINE INFO"
793     (Section 6.4.9)) lead to multiple-line responses. In this case
794     LinuxSampler signals the end of the response by a "." (single dot)
795     line.
796 senoner 542
797 schoenebeck 940 6.1. Ignored lines and comments
798 senoner 542
799     White lines, that is lines which only contain space and tabulator
800     characters, and lines that start with a "#" character are ignored,
801     thus it's possible for example to group commands and to place
802     comments in a LSCP script file.
803    
804 schoenebeck 940 6.2. Configuring audio drivers
805 senoner 542
806     Instances of drivers in LinuxSampler are called devices. You can use
807 schoenebeck 708 multiple audio devices simultaneously, e.g. to output the sound of
808 senoner 542 one sampler channel using the ALSA audio output driver, and on
809     another sampler channel you might want to use the JACK audio output
810     driver. For particular audio output systems it's also possible to
811 schoenebeck 708 create several devices of the same audio output driver, e.g. two
812 senoner 542 separate ALSA audio output devices for using two different sound
813     cards at the same time. This chapter describes all commands to
814     configure LinuxSampler's audio output devices and their parameters.
815    
816     Instead of defining commands and parameters for each driver
817     individually, all possible parameters, their meanings and possible
818     values have to be obtained at runtime. This makes the protocol a bit
819     abstract, but has the advantage, that front-ends can be written
820     independently of what drivers are currently implemented and what
821 schoenebeck 708 parameters these drivers are actually offering. This means front-
822     ends can even handle drivers which are implemented somewhere in
823 senoner 542 future without modifying the front-end at all.
824    
825     Note: examples in this chapter showing particular parameters of
826     drivers are not meant as specification of the drivers' parameters.
827     Driver implementations in LinuxSampler might have complete different
828     parameter names and meanings than shown in these examples or might
829     change in future, so these examples are only meant for showing how to
830     retrieve what parameters drivers are offering, how to retrieve their
831     possible values, etc.
832    
833    
834    
835    
836    
837 schoenebeck 974
838    
839 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 15]
840 schoenebeck 940
841 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
842 senoner 542
843    
844 schoenebeck 974 6.2.1. Getting amount of available audio output drivers
845    
846     Use the following command to get the number of audio output drivers
847 schoenebeck 708 currently available for the LinuxSampler instance:
848    
849 senoner 542 GET AVAILABLE_AUDIO_OUTPUT_DRIVERS
850    
851     Possible Answers:
852    
853     LinuxSampler will answer by sending the number of audio output
854     drivers.
855    
856     Example:
857    
858     C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"
859 schoenebeck 708
860 senoner 542 S: "2"
861    
862 schoenebeck 940 6.2.2. Getting all available audio output drivers
863 schoenebeck 708
864 senoner 542 Use the following command to list all audio output drivers currently
865     available for the LinuxSampler instance:
866    
867     LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS
868    
869     Possible Answers:
870    
871     LinuxSampler will answer by sending comma separated character
872     strings, each symbolizing an audio output driver.
873    
874     Example:
875    
876     C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"
877 schoenebeck 708
878 senoner 542 S: "ALSA,JACK"
879    
880 schoenebeck 940 6.2.3. Getting information about a specific audio output driver
881 schoenebeck 708
882 senoner 542 Use the following command to get detailed information about a
883     specific audio output driver:
884    
885     GET AUDIO_OUTPUT_DRIVER INFO <audio-output-driver>
886    
887     Where <audio-output-driver> is the name of the audio output driver,
888 schoenebeck 575 returned by the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
889 senoner 542 command.
890    
891     Possible Answers:
892    
893 schoenebeck 708
894    
895 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 16]
896 schoenebeck 940
897 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
898 schoenebeck 708
899 schoenebeck 940
900 senoner 542 LinuxSampler will answer by sending a <CRLF> separated list. Each
901     answer line begins with the information category name followed by
902     a colon and then a space character <SP> and finally the info
903     character string to that info category. At the moment the
904     following information categories are defined:
905    
906    
907    
908 schoenebeck 708 DESCRIPTION -
909 senoner 542
910 schoenebeck 708 character string describing the audio output driver
911 senoner 542
912 schoenebeck 708 VERSION -
913 senoner 542
914 schoenebeck 708 character string reflecting the driver's version
915 senoner 542
916     PARAMETERS -
917 schoenebeck 708
918 senoner 542 comma separated list of all parameters available for the
919     given audio output driver, at least parameters 'channels',
920     'samplerate' and 'active' are offered by all audio output
921     drivers
922 schoenebeck 708
923 senoner 542 The mentioned fields above don't have to be in particular order.
924    
925     Example:
926    
927     C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"
928 schoenebeck 708
929 senoner 542 S: "DESCRIPTION: Advanced Linux Sound Architecture"
930 schoenebeck 708
931 senoner 542 "VERSION: 1.0"
932 schoenebeck 708
933 senoner 542 "PARAMETERS: DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
934     FRAGMENTSIZE,CARD"
935 schoenebeck 708
936 senoner 542 "."
937    
938 schoenebeck 940 6.2.4. Getting information about specific audio output driver parameter
939 schoenebeck 708
940 senoner 542 Use the following command to get detailed information about a
941     specific audio output driver parameter:
942    
943     GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO <audio> <prm> [<deplist>]
944    
945     Where <audio> is the name of the audio output driver as returned by
946 schoenebeck 575 the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command,
947 schoenebeck 940 <prm> a specific parameter name for which information should be
948 schoenebeck 708
949    
950    
951 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 17]
952 schoenebeck 940
953 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
954 schoenebeck 708
955    
956     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
957     (Section 6.2.3) command) and <deplist> is an optional list of
958     parameters on which the sought parameter <prm> depends on, <deplist>
959     is a list of key-value pairs in form of "key1=val1 key2=val2 ...",
960     where character string values are encapsulated into apostrophes (').
961     Arguments given with <deplist> which are not dependency parameters of
962     <prm> will be ignored, means the front-end application can simply put
963     all parameters into <deplist> with the values already selected by the
964 senoner 542 user.
965    
966     Possible Answers:
967    
968     LinuxSampler will answer by sending a <CRLF> separated list. Each
969     answer line begins with the information category name followed by
970     a colon and then a space character <SP> and finally the info
971     character string to that info category. There are information
972     which is always returned, independently of the given driver
973     parameter and there are optional information which is only shown
974     dependently to given driver parameter. At the moment the
975     following information categories are defined:
976    
977     TYPE -
978 schoenebeck 708
979 senoner 542 either "BOOL" for boolean value(s) or "INT" for integer
980     value(s) or "FLOAT" for dotted number(s) or "STRING" for
981     character string(s) (always returned, no matter which driver
982     parameter)
983 schoenebeck 708
984 senoner 542 DESCRIPTION -
985 schoenebeck 708
986 senoner 542 arbitrary text describing the purpose of the parameter (always
987     returned, no matter which driver parameter)
988 schoenebeck 708
989 senoner 542 MANDATORY -
990 schoenebeck 708
991 senoner 542 either true or false, defines if this parameter must be given
992     when the device is to be created with the 'CREATE
993 schoenebeck 575 AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
994 senoner 542 no matter which driver parameter)
995 schoenebeck 708
996 senoner 542 FIX -
997 schoenebeck 708
998 senoner 542 either true or false, if false then this parameter can be
999     changed at any time, once the device is created by the 'CREATE
1000 schoenebeck 575 AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command (always returned,
1001 senoner 542 no matter which driver parameter)
1002 schoenebeck 708
1003    
1004    
1005    
1006    
1007 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 18]
1008 schoenebeck 940
1009 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1010 schoenebeck 708
1011    
1012 senoner 542 MULTIPLICITY -
1013 schoenebeck 708
1014 senoner 542 either true or false, defines if this parameter allows only one
1015     value or a list of values, where true means multiple values and
1016     false only a single value allowed (always returned, no matter
1017     which driver parameter)
1018 schoenebeck 708
1019 senoner 542 DEPENDS -
1020 schoenebeck 708
1021 schoenebeck 561 comma separated list of parameters this parameter depends on,
1022 senoner 542 means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
1023     and 'POSSIBILITIES' might depend on these listed parameters,
1024     for example assuming that an audio driver (like the ALSA
1025     driver) offers parameters 'card' and 'samplerate' then
1026     parameter 'samplerate' would depend on 'card' because the
1027     possible values for 'samplerate' depends on the sound card
1028     which can be chosen by the 'card' parameter (optionally
1029     returned, dependent to driver parameter)
1030 schoenebeck 708
1031 senoner 542 DEFAULT -
1032 schoenebeck 708
1033 senoner 542 reflects the default value for this parameter which is used
1034     when the device is created and not explicitly given with the
1035 schoenebeck 575 'CREATE AUDIO_OUTPUT_DEVICE' (Section 6.2.5) command, in case
1036 senoner 542 of MULTIPLCITY=true, this is a comma separated list, that's why
1037     character strings are encapsulated into apostrophes (')
1038     (optionally returned, dependent to driver parameter)
1039 schoenebeck 708
1040 senoner 542 RANGE_MIN -
1041 schoenebeck 708
1042 senoner 542 defines lower limit of the allowed value range for this
1043     parameter, can be an integer value as well as a dotted number,
1044     this parameter is often used in conjunction with RANGE_MAX, but
1045     may also appear without (optionally returned, dependent to
1046     driver parameter)
1047 schoenebeck 708
1048 senoner 542 RANGE_MAX -
1049 schoenebeck 708
1050 senoner 542 defines upper limit of the allowed value range for this
1051     parameter, can be an integer value as well as a dotted number,
1052     this parameter is often used in conjunction with RANGE_MIN, but
1053     may also appear without (optionally returned, dependent to
1054     driver parameter)
1055 schoenebeck 708
1056 senoner 542 POSSIBILITIES -
1057 schoenebeck 708
1058 senoner 542 comma separated list of possible values for this parameter,
1059     character strings are encapsulated into apostrophes (optionally
1060 schoenebeck 708
1061    
1062    
1063 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 19]
1064 schoenebeck 940
1065 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1066 schoenebeck 708
1067    
1068 senoner 542 returned, dependent to driver parameter)
1069    
1070     The mentioned fields above don't have to be in particular order.
1071    
1072     Examples:
1073    
1074     C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"
1075 schoenebeck 708
1076 senoner 542 S: "DESCRIPTION: sound card to be used"
1077 schoenebeck 708
1078 senoner 542 "TYPE: STRING"
1079 schoenebeck 708
1080 senoner 542 "MANDATORY: false"
1081 schoenebeck 708
1082 senoner 542 "FIX: true"
1083 schoenebeck 708
1084 senoner 542 "MULTIPLICITY: false"
1085 schoenebeck 708
1086 senoner 542 "DEFAULT: '0,0'"
1087 schoenebeck 708
1088 senoner 542 "POSSIBILITIES: '0,0','1,0','2,0'"
1089 schoenebeck 708
1090 senoner 542 "."
1091    
1092     C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"
1093 schoenebeck 708
1094 senoner 542 S: "DESCRIPTION: output sample rate in Hz"
1095 schoenebeck 708
1096 senoner 542 "TYPE: INT"
1097 schoenebeck 708
1098 senoner 542 "MANDATORY: false"
1099 schoenebeck 708
1100 senoner 542 "FIX: false"
1101 schoenebeck 708
1102 senoner 542 "MULTIPLICITY: false"
1103 schoenebeck 708
1104 senoner 542 "DEPENDS: card"
1105 schoenebeck 708
1106 senoner 542 "DEFAULT: 44100"
1107 schoenebeck 708
1108 senoner 542 "."
1109    
1110     C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE
1111     CARD='0,0'"
1112 schoenebeck 708
1113 senoner 542 S: "DESCRIPTION: output sample rate in Hz"
1114 schoenebeck 708
1115    
1116    
1117    
1118    
1119 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 20]
1120 schoenebeck 940
1121 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1122 schoenebeck 708
1123    
1124 senoner 542 "TYPE: INT"
1125 schoenebeck 708
1126 senoner 542 "MANDATORY: false"
1127 schoenebeck 708
1128 senoner 542 "FIX: false"
1129 schoenebeck 708
1130 senoner 542 "MULTIPLICITY: false"
1131 schoenebeck 708
1132 senoner 542 "DEPENDS: card"
1133 schoenebeck 708
1134 senoner 542 "DEFAULT: 44100"
1135 schoenebeck 708
1136 senoner 542 "RANGE_MIN: 22050"
1137    
1138 schoenebeck 708 "RANGE_MAX: 96000"
1139 senoner 542
1140 schoenebeck 708 "."
1141 senoner 542
1142 schoenebeck 940 6.2.5. Creating an audio output device
1143 senoner 542
1144 schoenebeck 940 Use the following command to create a new audio output device for the
1145     desired audio output system:
1146 senoner 542
1147     CREATE AUDIO_OUTPUT_DEVICE <audio-output-driver> [<param-list>]
1148    
1149     Where <audio-output-driver> should be replaced by the desired audio
1150 schoenebeck 575 output system as returned by the "LIST
1151 schoenebeck 708 AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2) command and <param-
1152     list> by an optional list of driver specific parameters in form of
1153     "key1=val1 key2=val2 ...", where character string values should be
1154     encapsulated into apostrophes ('). Note that there might be drivers
1155     which require parameter(s) to be given with this command. Use the
1156     previously described commands in this chapter to get this
1157 schoenebeck 575 information.
1158 senoner 542
1159     Possible Answers:
1160    
1161     "OK[<device-id>]" -
1162 schoenebeck 708
1163 senoner 542 in case the device was successfully created, where <device-id>
1164     is the numerical ID of the new device
1165 schoenebeck 708
1166 senoner 542 "WRN[<device-id>]:<warning-code>:<warning-message>" -
1167 schoenebeck 708
1168 senoner 542 in case the device was created successfully, where <device-id>
1169     is the numerical ID of the new device, but there are noteworthy
1170 schoenebeck 708 issue(s) related (e.g. sound card doesn't support given
1171 schoenebeck 940 hardware parameters and the driver is using fall-back values),
1172 schoenebeck 708
1173    
1174    
1175 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 21]
1176 schoenebeck 940
1177 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1178 schoenebeck 708
1179    
1180 senoner 542 providing an appropriate warning code and warning message
1181 schoenebeck 708
1182 senoner 542 "ERR:<error-code>:<error-message>" -
1183 schoenebeck 708
1184 senoner 542 in case it failed, providing an appropriate error code and
1185     error message
1186    
1187     Examples:
1188    
1189     C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"
1190 schoenebeck 708
1191 senoner 542 S: "OK[0]"
1192    
1193     C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"
1194 schoenebeck 708
1195 senoner 542 S: "OK[1]"
1196    
1197 schoenebeck 940 6.2.6. Destroying an audio output device
1198 schoenebeck 708
1199 senoner 542 Use the following command to destroy a created output device:
1200    
1201 schoenebeck 575 DESTROY AUDIO_OUTPUT_DEVICE <device-id>
1202    
1203     Where <device-id> should be replaced by the numerical ID of the audio
1204 schoenebeck 708 output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
1205     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1206     command.
1207 senoner 542
1208     Possible Answers:
1209    
1210     "OK" -
1211 schoenebeck 708
1212 senoner 542 in case the device was successfully destroyed
1213 schoenebeck 708
1214 senoner 542 "WRN:<warning-code>:<warning-message>" -
1215 schoenebeck 708
1216 senoner 542 in case the device was destroyed successfully, but there are
1217 schoenebeck 708 noteworthy issue(s) related (e.g. an audio over ethernet driver
1218     was unloaded but the other host might not be informed about
1219     this situation), providing an appropriate warning code and
1220     warning message
1221    
1222 senoner 542 "ERR:<error-code>:<error-message>" -
1223 schoenebeck 708
1224 senoner 542 in case it failed, providing an appropriate error code and
1225     error message
1226    
1227 schoenebeck 940 Example:
1228 schoenebeck 708
1229    
1230    
1231 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 22]
1232 schoenebeck 940
1233 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1234 schoenebeck 708
1235    
1236 senoner 542 C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
1237 schoenebeck 708
1238 senoner 542 S: "OK"
1239    
1240 schoenebeck 940 6.2.7. Getting all created audio output device count
1241 schoenebeck 708
1242 senoner 542 Use the following command to count all created audio output devices:
1243    
1244     GET AUDIO_OUTPUT_DEVICES
1245    
1246     Possible Answers:
1247    
1248     LinuxSampler will answer by sending the current number of all
1249     audio output devices.
1250    
1251     Example:
1252    
1253     C: "GET AUDIO_OUTPUT_DEVICES"
1254 schoenebeck 708
1255 senoner 542 S: "4"
1256    
1257 schoenebeck 940 6.2.8. Getting all created audio output device list
1258 schoenebeck 708
1259 senoner 542 Use the following command to list all created audio output devices:
1260    
1261     LIST AUDIO_OUTPUT_DEVICES
1262    
1263     Possible Answers:
1264    
1265 schoenebeck 575 LinuxSampler will answer by sending a comma separated list with
1266     the numerical IDs of all audio output devices.
1267    
1268 senoner 542 Example:
1269    
1270     C: "LIST AUDIO_OUTPUT_DEVICES"
1271 schoenebeck 708
1272 senoner 542 S: "0,1,4,5"
1273    
1274 schoenebeck 940 6.2.9. Getting current settings of an audio output device
1275 schoenebeck 708
1276 senoner 542 Use the following command to get current settings of a specific,
1277     created audio output device:
1278    
1279 schoenebeck 940 GET AUDIO_OUTPUT_DEVICE INFO <device-id>
1280 schoenebeck 708
1281 schoenebeck 940 Where <device-id> should be replaced by numerical ID of the audio
1282     output device as e.g. returned by the "LIST AUDIO_OUTPUT_DEVICES"
1283     (Section 6.2.8) command.
1284 schoenebeck 708
1285    
1286    
1287 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 23]
1288 schoenebeck 940
1289 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1290 schoenebeck 708
1291    
1292 senoner 542 Possible Answers:
1293    
1294     LinuxSampler will answer by sending a <CRLF> separated list. Each
1295     answer line begins with the information category name followed by a
1296     colon and then a space character <SP> and finally the info character
1297     string to that info category. As some parameters might allow
1298     multiple values, character strings are encapsulated into apostrophes
1299     ('). At the moment the following information categories are defined
1300     (independently of device):
1301    
1302     DRIVER -
1303 schoenebeck 708
1304 senoner 542 identifier of the used audio output driver, as also returned by
1305 schoenebeck 575 the "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS" (Section 6.2.2)
1306 senoner 542 command
1307 schoenebeck 708
1308 senoner 542 CHANNELS -
1309 schoenebeck 708
1310 senoner 542 amount of audio output channels this device currently offers
1311 schoenebeck 708
1312 senoner 542 SAMPLERATE -
1313 schoenebeck 708
1314 senoner 542 playback sample rate the device uses
1315 schoenebeck 708
1316 senoner 542 ACTIVE -
1317 schoenebeck 708
1318 senoner 542 either true or false, if false then the audio device is
1319     inactive and doesn't output any sound, nor do the sampler
1320     channels connected to this audio device render any audio
1321    
1322     The mentioned fields above don't have to be in particular order. The
1323     fields above are only those fields which are returned by all audio
1324     output devices. Every audio output driver might have its own,
1325 schoenebeck 575 additional driver specific parameters (see Section 6.2.3) which are
1326 senoner 542 also returned by this command.
1327    
1328 schoenebeck 708 Example:
1329 senoner 542
1330 schoenebeck 708 C: "GET AUDIO_OUTPUT_DEVICE INFO 0"
1331 senoner 542
1332 schoenebeck 708 S: "DRIVER: ALSA"
1333 senoner 542
1334 schoenebeck 940 "CHANNELS: 2"
1335 senoner 542
1336 schoenebeck 940 "SAMPLERATE: 44100"
1337 senoner 542
1338 schoenebeck 940 "ACTIVE: true"
1339 schoenebeck 575
1340 schoenebeck 708
1341    
1342    
1343 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 24]
1344 schoenebeck 940
1345 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1346 schoenebeck 708
1347    
1348 senoner 542 "FRAGMENTS: 2"
1349 schoenebeck 708
1350 senoner 542 "FRAGMENTSIZE: 128"
1351 schoenebeck 708
1352 senoner 542 "CARD: '0,0'"
1353 schoenebeck 708
1354 senoner 542 "."
1355    
1356 schoenebeck 940 6.2.10. Changing settings of audio output devices
1357 schoenebeck 708
1358 senoner 542 Use the following command to alter a specific setting of a created
1359     audio output device:
1360    
1361     SET AUDIO_OUTPUT_DEVICE_PARAMETER <device-id> <key>=<value>
1362    
1363     Where <device-id> should be replaced by the numerical ID of the audio
1364 schoenebeck 708 output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
1365     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1366     command, <key> by the name of the parameter to change and <value> by
1367     the new value for this parameter.
1368 senoner 542
1369     Possible Answers:
1370    
1371     "OK" -
1372 schoenebeck 708
1373 senoner 542 in case setting was successfully changed
1374 schoenebeck 708
1375 senoner 542 "WRN:<warning-code>:<warning-message>" -
1376 schoenebeck 708
1377 senoner 542 in case setting was changed successfully, but there are
1378     noteworthy issue(s) related, providing an appropriate warning
1379     code and warning message
1380 schoenebeck 708
1381 senoner 542 "ERR:<error-code>:<error-message>" -
1382 schoenebeck 708
1383 senoner 542 in case it failed, providing an appropriate error code and
1384     error message
1385    
1386     Example:
1387    
1388 schoenebeck 940 C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"
1389 schoenebeck 708
1390 schoenebeck 940 S: "OK"
1391 schoenebeck 708
1392    
1393    
1394    
1395    
1396    
1397 schoenebeck 974
1398    
1399 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 25]
1400 schoenebeck 940
1401 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1402 schoenebeck 708
1403 senoner 542
1404 schoenebeck 974 6.2.11. Getting information about an audio channel
1405    
1406     Use the following command to get information about an audio channel:
1407    
1408 senoner 542 GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan>
1409    
1410 schoenebeck 575 Where <device-id> is the numerical ID of the audio output device as
1411     given by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1412     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command and <audio-chan> the
1413     audio channel number.
1414    
1415     Possible Answers:
1416    
1417 senoner 542 LinuxSampler will answer by sending a <CRLF> separated list. Each
1418     answer line begins with the information category name followed by
1419     a colon and then a space character <SP> and finally the info
1420     character string to that info category. At the moment the
1421     following information categories are defined:
1422    
1423 schoenebeck 708
1424    
1425 senoner 542 NAME -
1426 schoenebeck 708
1427 senoner 542 arbitrary character string naming the channel, which doesn't
1428     have to be unique (always returned by all audio channels)
1429 schoenebeck 708
1430 senoner 542 IS_MIX_CHANNEL -
1431 schoenebeck 708
1432 senoner 542 either true or false, a mix-channel is not a real,
1433     independent audio channel, but a virtual channel which is
1434     mixed to another real channel, this mechanism is needed for
1435     sampler engines which need more audio channels than the used
1436     audio system might be able to offer (always returned by all
1437     audio channels)
1438 schoenebeck 708
1439 senoner 542 MIX_CHANNEL_DESTINATION -
1440 schoenebeck 708
1441 senoner 542 numerical ID (positive integer including 0) which reflects
1442     the real audio channel (of the same audio output device)
1443     this mix channel refers to, means where the audio signal
1444     actually will be routed / added to (only returned in case
1445     the audio channel is mix channel)
1446    
1447     The mentioned fields above don't have to be in particular order. The
1448     fields above are only those fields which are generally returned for
1449     the described cases by all audio channels regardless of the audio
1450     driver. Every audio channel might have its own, additional driver
1451     and channel specific parameters.
1452    
1453    
1454 schoenebeck 940
1455 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 26]
1456 schoenebeck 974
1457 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1458 schoenebeck 940
1459    
1460 schoenebeck 974 Examples:
1461 schoenebeck 940
1462 senoner 542 C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"
1463 schoenebeck 708
1464 senoner 542 S: "NAME: studio monitor left"
1465 schoenebeck 708
1466 senoner 542 "IS_MIX_CHANNEL: false"
1467 schoenebeck 708
1468 senoner 542 "."
1469    
1470     C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"
1471 schoenebeck 708
1472 senoner 542 S: "NAME: studio monitor right"
1473 schoenebeck 708
1474 senoner 542 "IS_MIX_CHANNEL: false"
1475 schoenebeck 708
1476 senoner 542 "."
1477    
1478 schoenebeck 708 C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"
1479 senoner 542
1480 schoenebeck 708 S: "NAME: studio monitor left"
1481 senoner 542
1482 schoenebeck 708 "IS_MIX_CHANNEL: true"
1483 senoner 542
1484 schoenebeck 708 "MIX_CHANNEL_DESTINATION: 1"
1485 senoner 542
1486 schoenebeck 575 "."
1487    
1488 senoner 542 C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"
1489 schoenebeck 708
1490 senoner 542 S: "NAME: 'ardour (left)'"
1491 schoenebeck 708
1492 senoner 542 "IS_MIX_CHANNEL: false"
1493 schoenebeck 708
1494 senoner 542 "JACK_BINDINGS: 'ardour:0'"
1495 schoenebeck 708
1496 senoner 542 "."
1497    
1498 schoenebeck 940 6.2.12. Getting information about specific audio channel parameter
1499 schoenebeck 708
1500 senoner 542 Use the following command to get detailed information about specific
1501     audio channel parameter:
1502    
1503     GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO <dev-id> <chan> <param>
1504    
1505     Where <dev-id> is the numerical ID of the audio output device as
1506 schoenebeck 575 returned by the "CREATE AUDIO_OUTPUT_DEVICE" (Section 6.2.5) or "LIST
1507     AUDIO_OUTPUT_DEVICES" (Section 6.2.8) command, <chan> the audio
1508 schoenebeck 940
1509    
1510    
1511 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 27]
1512 schoenebeck 940
1513 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1514 schoenebeck 940
1515    
1516 schoenebeck 974 channel number and <param> a specific channel parameter name for
1517     which information should be obtained (as returned by the "GET
1518 schoenebeck 575 AUDIO_OUTPUT_CHANNEL INFO" (Section 6.2.11) command).
1519 senoner 542
1520     Possible Answers:
1521    
1522     LinuxSampler will answer by sending a <CRLF> separated list. Each
1523     answer line begins with the information category name followed by
1524     a colon and then a space character <SP> and finally the info
1525     character string to that info category. There are information
1526     which is always returned, independently of the given channel
1527     parameter and there is optional information which is only shown
1528     dependently to the given audio channel. At the moment the
1529     following information categories are defined:
1530    
1531 schoenebeck 708
1532    
1533 senoner 542 TYPE -
1534 schoenebeck 708
1535 senoner 542 either "BOOL" for boolean value(s) or "INT" for integer
1536     value(s) or "FLOAT" for dotted number(s) or "STRING" for
1537     character string(s) (always returned)
1538 schoenebeck 708
1539 senoner 542 DESCRIPTION -
1540 schoenebeck 708
1541 senoner 542 arbitrary text describing the purpose of the parameter
1542     (always returned)
1543 schoenebeck 708
1544 senoner 542 FIX -
1545 schoenebeck 708
1546 senoner 542 either true or false, if true then this parameter is read
1547     only, thus cannot be altered (always returned)
1548 schoenebeck 575
1549 schoenebeck 708 MULTIPLICITY -
1550 schoenebeck 575
1551 schoenebeck 708 either true or false, defines if this parameter allows only
1552     one value or a list of values, where true means multiple
1553     values and false only a single value allowed (always
1554     returned)
1555 schoenebeck 575
1556 schoenebeck 940 RANGE_MIN -
1557 schoenebeck 575
1558 schoenebeck 940 defines lower limit of the allowed value range for this
1559     parameter, can be an integer value as well as a dotted
1560     number, usually used in conjunction with 'RANGE_MAX', but
1561     may also appear without (optionally returned, dependent to
1562     driver and channel parameter)
1563 schoenebeck 575
1564    
1565 schoenebeck 708
1566    
1567 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 28]
1568 schoenebeck 940
1569 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1570 schoenebeck 708
1571    
1572 senoner 542 RANGE_MAX -
1573 schoenebeck 708
1574 senoner 542 defines upper limit of the allowed value range for this
1575     parameter, can be an integer value as well as a dotted
1576     number, usually used in conjunction with 'RANGE_MIN', but
1577     may also appear without (optionally returned, dependent to
1578     driver and channel parameter)
1579 schoenebeck 708
1580 senoner 542 POSSIBILITIES -
1581 schoenebeck 708
1582 senoner 542 comma separated list of possible values for this parameter,
1583     character strings are encapsulated into apostrophes
1584     (optionally returned, dependent to driver and channel
1585     parameter)
1586 schoenebeck 708
1587 senoner 542 The mentioned fields above don't have to be in particular order.
1588    
1589     Example:
1590    
1591     C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"
1592 schoenebeck 708
1593 senoner 542 S: "DESCRIPTION: bindings to other JACK clients"
1594 schoenebeck 708
1595 senoner 542 "TYPE: STRING"
1596 schoenebeck 708
1597 senoner 542 "FIX: false"
1598 schoenebeck 708
1599 senoner 542 "MULTIPLICITY: true"
1600 schoenebeck 708
1601 senoner 542 "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"
1602 schoenebeck 708
1603 senoner 542 "."
1604    
1605 schoenebeck 940 6.2.13. Changing settings of audio output channels
1606 schoenebeck 708
1607 senoner 542 Use the following command to alter a specific setting of an audio
1608     output channel:
1609    
1610     SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value>
1611    
1612     Where <dev-id> should be replaced by the numerical ID of the audio
1613 schoenebeck 575 output device as returned by the "CREATE AUDIO_OUTPUT_DEVICE"
1614     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
1615     command, <chn> by the audio channel number, <key> by the name of the
1616 senoner 542 parameter to change and <value> by the new value for this parameter.
1617    
1618     Possible Answers:
1619    
1620 schoenebeck 940
1621    
1622    
1623 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 29]
1624 schoenebeck 940
1625 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1626 schoenebeck 940
1627    
1628 schoenebeck 708 "OK" -
1629 schoenebeck 575
1630 schoenebeck 708 in case setting was successfully changed
1631 schoenebeck 575
1632 schoenebeck 708 "WRN:<warning-code>:<warning-message>" -
1633 schoenebeck 575
1634 senoner 542 in case setting was changed successfully, but there are
1635     noteworthy issue(s) related, providing an appropriate warning
1636     code and warning message
1637 schoenebeck 708
1638 senoner 542 "ERR:<error-code>:<error-message>" -
1639 schoenebeck 708
1640 senoner 542 in case it failed, providing an appropriate error code and
1641     error message
1642    
1643     Example:
1644    
1645     C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"
1646 schoenebeck 708
1647 senoner 542 S: "OK"
1648    
1649     C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"
1650 schoenebeck 708
1651 senoner 542 S: "OK"
1652    
1653 schoenebeck 940 6.3. Configuring MIDI input drivers
1654 schoenebeck 708
1655 senoner 542 Instances of drivers in LinuxSampler are called devices. You can use
1656 schoenebeck 708 multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet
1657 senoner 542 as MIDI input on one sampler channel and ALSA as MIDI input on
1658     another sampler channel. For particular MIDI input systems it's also
1659     possible to create several devices of the same MIDI input type. This
1660     chapter describes all commands to configure LinuxSampler's MIDI input
1661     devices and their parameters.
1662    
1663     Instead of defining commands and parameters for each driver
1664     individually, all possible parameters, their meanings and possible
1665     values have to be obtained at runtime. This makes the protocol a bit
1666     abstract, but has the advantage, that front-ends can be written
1667     independently of what drivers are currently implemented and what
1668 schoenebeck 708 parameters these drivers are actually offering. This means front-
1669     ends can even handle drivers which are implemented somewhere in
1670 senoner 542 future without modifying the front-end at all.
1671    
1672     Commands for configuring MIDI input devices are pretty much the same
1673     as the commands for configuring audio output drivers, already
1674     described in the last chapter.
1675    
1676 schoenebeck 940
1677    
1678    
1679 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 30]
1680 schoenebeck 940
1681 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1682 schoenebeck 940
1683    
1684 senoner 542 Note: examples in this chapter showing particular parameters of
1685     drivers are not meant as specification of the drivers' parameters.
1686     Driver implementations in LinuxSampler might have complete different
1687     parameter names and meanings than shown in these examples or might
1688     change in future, so these examples are only meant for showing how to
1689     retrieve what parameters drivers are offering, how to retrieve their
1690     possible values, etc.
1691    
1692 schoenebeck 940 6.3.1. Getting amount of available MIDI input drivers
1693 schoenebeck 575
1694 senoner 542 Use the following command to get the number of MIDI input drivers
1695     currently available for the LinuxSampler instance:
1696    
1697     GET AVAILABLE_MIDI_INPUT_DRIVERS
1698    
1699     Possible Answers:
1700    
1701     LinuxSampler will answer by sending the number of available MIDI
1702     input drivers.
1703    
1704     Example:
1705    
1706     C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"
1707 schoenebeck 708
1708 senoner 542 S: "2"
1709    
1710 schoenebeck 940 6.3.2. Getting all available MIDI input drivers
1711 schoenebeck 708
1712 senoner 542 Use the following command to list all MIDI input drivers currently
1713     available for the LinuxSampler instance:
1714    
1715     LIST AVAILABLE_MIDI_INPUT_DRIVERS
1716    
1717     Possible Answers:
1718    
1719     LinuxSampler will answer by sending comma separated character
1720     strings, each symbolizing a MIDI input driver.
1721    
1722     Example:
1723    
1724     C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1725 schoenebeck 708
1726 senoner 542 S: "ALSA,JACK"
1727    
1728 schoenebeck 708
1729 senoner 542
1730 schoenebeck 940
1731    
1732 schoenebeck 974
1733    
1734    
1735 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 31]
1736 schoenebeck 940
1737 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1738 schoenebeck 940
1739    
1740 schoenebeck 974 6.3.3. Getting information about a specific MIDI input driver
1741    
1742     Use the following command to get detailed information about a
1743     specific MIDI input driver:
1744    
1745 senoner 542 GET MIDI_INPUT_DRIVER INFO <midi-input-driver>
1746    
1747 schoenebeck 575 Where <midi-input-driver> is the name of the MIDI input driver as
1748     returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
1749     command.
1750 senoner 542
1751     Possible Answers:
1752    
1753     LinuxSampler will answer by sending a <CRLF> separated list. Each
1754     answer line begins with the information category name followed by
1755     a colon and then a space character <SP> and finally the info
1756     character string to that info category. At the moment the
1757     following information categories are defined:
1758    
1759 schoenebeck 708
1760    
1761 senoner 542 DESCRIPTION -
1762 schoenebeck 708
1763 senoner 542 arbitrary description text about the MIDI input driver
1764 schoenebeck 708
1765 senoner 542 VERSION -
1766 schoenebeck 708
1767 senoner 542 arbitrary character string regarding the driver's version
1768 schoenebeck 708
1769 senoner 542 PARAMETERS -
1770 schoenebeck 708
1771 senoner 542 comma separated list of all parameters available for the
1772     given MIDI input driver
1773 schoenebeck 708
1774 senoner 542 The mentioned fields above don't have to be in particular order.
1775    
1776     Example:
1777    
1778     C: "GET MIDI_INPUT_DRIVER INFO ALSA"
1779 schoenebeck 708
1780 senoner 542 S: "DESCRIPTION: Advanced Linux Sound Architecture"
1781 schoenebeck 708
1782 senoner 542 "VERSION: 1.0"
1783 schoenebeck 708
1784 senoner 542 "PARAMETERS: DRIVER,ACTIVE"
1785 schoenebeck 708
1786 senoner 542 "."
1787    
1788 schoenebeck 708
1789 senoner 542
1790 schoenebeck 940
1791 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 32]
1792 schoenebeck 974
1793 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1794 schoenebeck 940
1795    
1796 schoenebeck 974 6.3.4. Getting information about specific MIDI input driver parameter
1797 schoenebeck 940
1798 schoenebeck 974 Use the following command to get detailed information about a
1799     specific parameter of a specific MIDI input driver:
1800 schoenebeck 940
1801 senoner 542 GET MIDI_INPUT_DRIVER_PARAMETER INFO <midit> <param> [<deplist>]
1802    
1803 schoenebeck 561 Where <midit> is the name of the MIDI input driver as returned by the
1804 schoenebeck 575 "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2) command, <param>
1805 schoenebeck 561 a specific parameter name for which information should be obtained
1806 schoenebeck 575 (as returned by the "GET MIDI_INPUT_DRIVER INFO" (Section 6.3.3)
1807 schoenebeck 561 command) and <deplist> is an optional list of parameters on which the
1808     sought parameter <param> depends on, <deplist> is a key-value pair
1809     list in form of "key1=val1 key2=val2 ...", where character string
1810     values are encapsulated into apostrophes ('). Arguments given with
1811     <deplist> which are not dependency parameters of <param> will be
1812     ignored, means the front-end application can simply put all
1813     parameters in <deplist> with the values selected by the user.
1814 senoner 542
1815     Possible Answers:
1816    
1817     LinuxSampler will answer by sending a <CRLF> separated list. Each
1818     answer line begins with the information category name followed by a
1819     colon and then a space character <SP> and finally the info character
1820     string to that info category. There is information which is always
1821     returned, independent of the given driver parameter and there is
1822     optional information which is only shown dependent to given driver
1823     parameter. At the moment the following information categories are
1824     defined:
1825    
1826     TYPE -
1827 schoenebeck 708
1828 senoner 542 either "BOOL" for boolean value(s) or "INT" for integer
1829     value(s) or "FLOAT" for dotted number(s) or "STRING" for
1830     character string(s) (always returned, no matter which driver
1831     parameter)
1832 schoenebeck 708
1833 senoner 542 DESCRIPTION -
1834 schoenebeck 708
1835 senoner 542 arbitrary text describing the purpose of the parameter (always
1836     returned, no matter which driver parameter)
1837 schoenebeck 708
1838 senoner 542 MANDATORY -
1839 schoenebeck 708
1840 senoner 542 either true or false, defines if this parameter must be given
1841     when the device is to be created with the 'CREATE
1842 schoenebeck 575 MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1843 senoner 542 matter which driver parameter)
1844 schoenebeck 708
1845    
1846 schoenebeck 940
1847 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 33]
1848 schoenebeck 974
1849 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1850 schoenebeck 940
1851    
1852 schoenebeck 974 FIX -
1853 schoenebeck 940
1854 schoenebeck 974 either true or false, if false then this parameter can be
1855     changed at any time, once the device is created by the 'CREATE
1856 schoenebeck 575 MIDI_INPUT_DEVICE' (Section 6.3.5) command (always returned, no
1857 senoner 542 matter which driver parameter)
1858 schoenebeck 708
1859 senoner 542 MULTIPLICITY -
1860 schoenebeck 708
1861 senoner 542 either true or false, defines if this parameter allows only one
1862     value or a list of values, where true means multiple values and
1863     false only a single value allowed (always returned, no matter
1864     which driver parameter)
1865 schoenebeck 708
1866 senoner 542 DEPENDS -
1867 schoenebeck 708
1868 schoenebeck 561 comma separated list of parameters this parameter depends on,
1869 senoner 542 means the values for fields 'DEFAULT', 'RANGE_MIN', 'RANGE_MAX'
1870     and 'POSSIBILITIES' might depend on these listed parameters,
1871     for example assuming that an audio driver (like the ALSA
1872     driver) offers parameters 'card' and 'samplerate' then
1873     parameter 'samplerate' would depend on 'card' because the
1874     possible values for 'samplerate' depends on the sound card
1875     which can be chosen by the 'card' parameter (optionally
1876     returned, dependent to driver parameter)
1877 schoenebeck 708
1878 senoner 542 DEFAULT -
1879 schoenebeck 708
1880 senoner 542 reflects the default value for this parameter which is used
1881     when the device is created and not explicitly given with the
1882 schoenebeck 575 'CREATE MIDI_INPUT_DEVICE' (Section 6.3.5) command, in case of
1883 senoner 542 MULTIPLCITY=true, this is a comma separated list, that's why
1884     character strings are encapsulated into apostrophes (')
1885     (optionally returned, dependent to driver parameter)
1886 schoenebeck 575
1887 schoenebeck 708 RANGE_MIN -
1888    
1889     defines lower limit of the allowed value range for this
1890     parameter, can be an integer value as well as a dotted number,
1891 senoner 542 this parameter is often used in conjunction with RANGE_MAX, but
1892     may also appear without (optionally returned, dependent to
1893     driver parameter)
1894 schoenebeck 708
1895 senoner 542 RANGE_MAX -
1896 schoenebeck 708
1897 senoner 542 defines upper limit of the allowed value range for this
1898     parameter, can be an integer value as well as a dotted number,
1899     this parameter is often used in conjunction with RANGE_MIN, but
1900 schoenebeck 708
1901 schoenebeck 940
1902    
1903 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 34]
1904 schoenebeck 974
1905 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1906 schoenebeck 940
1907    
1908 schoenebeck 974 may also appear without (optionally returned, dependent to
1909     driver parameter)
1910 schoenebeck 940
1911 senoner 542 POSSIBILITIES -
1912 schoenebeck 708
1913 senoner 542 comma separated list of possible values for this parameter,
1914     character strings are encapsulated into apostrophes (optionally
1915     returned, dependent to driver parameter)
1916    
1917     The mentioned fields above don't have to be in particular order.
1918    
1919     Example:
1920    
1921     C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"
1922 schoenebeck 708
1923 senoner 542 S: "DESCRIPTION: Whether device is enabled"
1924 schoenebeck 708
1925 senoner 542 "TYPE: BOOL"
1926 schoenebeck 708
1927 senoner 542 "MANDATORY: false"
1928 schoenebeck 708
1929 senoner 542 "FIX: false"
1930 schoenebeck 708
1931 senoner 542 "MULTIPLICITY: false"
1932 schoenebeck 708
1933 senoner 542 "DEFAULT: true"
1934 schoenebeck 708
1935 senoner 542 "."
1936    
1937 schoenebeck 940 6.3.5. Creating a MIDI input device
1938 schoenebeck 708
1939 schoenebeck 940 Use the following command to create a new MIDI input device for the
1940 senoner 542 desired MIDI input system:
1941    
1942     CREATE MIDI_INPUT_DEVICE <midi-input-driver> [<param-list>]
1943    
1944     Where <midi-input-driver> should be replaced by the desired MIDI
1945 schoenebeck 575 input system as returned by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS"
1946     (Section 6.3.2) command and <param-list> by an optional list of
1947     driver specific parameters in form of "key1=val1 key2=val2 ...",
1948     where character string values should be encapsulated into apostrophes
1949     ('). Note that there might be drivers which require parameter(s) to
1950     be given with this command. Use the previously described commands in
1951     this chapter to get that information.
1952 senoner 542
1953     Possible Answers:
1954    
1955 schoenebeck 708
1956 schoenebeck 575
1957 schoenebeck 940
1958    
1959 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 35]
1960 schoenebeck 940
1961 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
1962 schoenebeck 940
1963    
1964 schoenebeck 974 "OK[<device-id>]" -
1965    
1966     in case the device was successfully created, where <device-id>
1967     is the numerical ID of the new device
1968    
1969 schoenebeck 708 "WRN[<device-id>]:<warning-code>:<warning-message>" -
1970 schoenebeck 575
1971 senoner 542 in case the driver was loaded successfully, where <device-id>
1972     is the numerical ID of the new device, but there are noteworthy
1973     issue(s) related, providing an appropriate warning code and
1974     warning message
1975 schoenebeck 708
1976 senoner 542 "ERR:<error-code>:<error-message>" -
1977 schoenebeck 708
1978 senoner 542 in case it failed, providing an appropriate error code and
1979     error message
1980    
1981     Example:
1982    
1983     C: "CREATE MIDI_INPUT_DEVICE ALSA"
1984 schoenebeck 708
1985 senoner 542 S: "OK[0]"
1986    
1987 schoenebeck 940 6.3.6. Destroying a MIDI input device
1988 schoenebeck 708
1989 senoner 542 Use the following command to destroy a created MIDI input device:
1990    
1991     DESTROY MIDI_INPUT_DEVICE <device-id>
1992    
1993 schoenebeck 575 Where <device-id> should be replaced by the device's numerical ID as
1994     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
1995     MIDI_INPUT_DEVICES" (Section 6.3.8) command.
1996 senoner 542
1997     Possible Answers:
1998    
1999     "OK" -
2000 schoenebeck 708
2001 senoner 542 in case the device was successfully destroyed
2002 schoenebeck 708
2003 senoner 542 "WRN:<warning-code>:<warning-message>" -
2004 schoenebeck 708
2005 senoner 542 in case the device was destroyed, but there are noteworthy
2006     issue(s) related, providing an appropriate warning code and
2007     warning message
2008 schoenebeck 708
2009 senoner 542 "ERR:<error-code>:<error-message>" -
2010 schoenebeck 708
2011 senoner 542
2012    
2013 schoenebeck 940
2014    
2015 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 36]
2016 schoenebeck 974
2017 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2018 schoenebeck 940
2019    
2020 schoenebeck 974 in case it failed, providing an appropriate error code and
2021     error message
2022 schoenebeck 940
2023 schoenebeck 974 Example:
2024 schoenebeck 940
2025 senoner 542 C: "DESTROY MIDI_INPUT_DEVICE 0"
2026 schoenebeck 708
2027 senoner 542 S: "OK"
2028    
2029 schoenebeck 940 6.3.7. Getting all created MIDI input device count
2030 schoenebeck 708
2031 senoner 542 Use the following command to count all created MIDI input devices:
2032    
2033     GET MIDI_INPUT_DEVICES
2034    
2035     Possible Answers:
2036    
2037     LinuxSampler will answer by sending the current number of all MIDI
2038     input devices.
2039    
2040     Example:
2041    
2042     C: "GET MIDI_INPUT_DEVICES"
2043 schoenebeck 708
2044 senoner 542 S: "3"
2045    
2046 schoenebeck 940 6.3.8. Getting all created MIDI input device list
2047 schoenebeck 708
2048 senoner 542 Use the following command to list all created MIDI input devices:
2049    
2050     LIST MIDI_INPUT_DEVICES
2051    
2052     Possible Answers:
2053    
2054     LinuxSampler will answer by sending a comma separated list with
2055     the numerical Ids of all created MIDI input devices.
2056    
2057     Examples:
2058    
2059     C: "LIST MIDI_INPUT_DEVICES"
2060 schoenebeck 708
2061 senoner 542 S: "0,1,2"
2062    
2063     C: "LIST MIDI_INPUT_DEVICES"
2064 schoenebeck 708
2065 senoner 542 S: "1,3"
2066    
2067 schoenebeck 708
2068 senoner 542
2069 schoenebeck 940
2070    
2071 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 37]
2072 schoenebeck 974
2073 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2074 schoenebeck 940
2075    
2076 schoenebeck 974 6.3.9. Getting current settings of a MIDI input device
2077 schoenebeck 940
2078 schoenebeck 974 Use the following command to get current settings of a specific,
2079     created MIDI input device:
2080 schoenebeck 940
2081 senoner 542 GET MIDI_INPUT_DEVICE INFO <device-id>
2082    
2083 schoenebeck 575 Where <device-id> is the numerical ID of the MIDI input device as
2084     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2085     MIDI_INPUT_DEVICES" (Section 6.3.8) command.
2086 senoner 542
2087     Possible Answers:
2088    
2089     LinuxSampler will answer by sending a <CRLF> separated list. Each
2090     answer line begins with the information category name followed by
2091     a colon and then a space character <SP> and finally the info
2092     character string to that info category. As some parameters might
2093     allow multiple values, character strings are encapsulated into
2094     apostrophes ('). At the moment the following information
2095     categories are defined (independent of driver):
2096    
2097 schoenebeck 575
2098    
2099 schoenebeck 708 DRIVER -
2100 schoenebeck 575
2101 schoenebeck 708 identifier of the used MIDI input driver, as e.g. returned
2102 schoenebeck 575 by the "LIST AVAILABLE_MIDI_INPUT_DRIVERS" (Section 6.3.2)
2103 senoner 542 command
2104 schoenebeck 708
2105 senoner 542 ACTIVE -
2106 schoenebeck 708
2107 senoner 542 either true or false, if false then the MIDI device is
2108     inactive and doesn't listen to any incoming MIDI events and
2109     thus doesn't forward them to connected sampler channels
2110    
2111     The mentioned fields above don't have to be in particular order. The
2112     fields above are only those fields which are returned by all MIDI
2113     input devices. Every MIDI input driver might have its own,
2114     additional driver specific parameters (see "GET MIDI_INPUT_DRIVER
2115 schoenebeck 575 INFO" (Section 6.3.3) command) which are also returned by this
2116 senoner 542 command.
2117    
2118     Example:
2119    
2120     C: "GET MIDI_INPUT_DEVICE INFO 0"
2121 schoenebeck 708
2122 senoner 542 S: "DRIVER: ALSA"
2123 schoenebeck 708
2124    
2125 senoner 542
2126 schoenebeck 708
2127 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 38]
2128 schoenebeck 974
2129 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2130 senoner 542
2131 schoenebeck 940
2132 schoenebeck 974 "ACTIVE: true"
2133 schoenebeck 940
2134 schoenebeck 974 "."
2135 schoenebeck 940
2136     6.3.10. Changing settings of MIDI input devices
2137    
2138 senoner 542 Use the following command to alter a specific setting of a created
2139     MIDI input device:
2140    
2141     SET MIDI_INPUT_DEVICE_PARAMETER <device-id> <key>=<value>
2142    
2143     Where <device-id> should be replaced by the numerical ID of the MIDI
2144 schoenebeck 708 input device as returned by the "CREATE MIDI_INPUT_DEVICE"
2145     (Section 6.3.5) or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command,
2146     <key> by the name of the parameter to change and <value> by the new
2147     value for this parameter.
2148 senoner 542
2149     Possible Answers:
2150    
2151     "OK" -
2152 schoenebeck 708
2153 senoner 542 in case setting was successfully changed
2154 schoenebeck 708
2155 senoner 542 "WRN:<warning-code>:<warning-message>" -
2156 schoenebeck 708
2157 senoner 542 in case setting was changed successfully, but there are
2158     noteworthy issue(s) related, providing an appropriate warning
2159     code and warning message
2160 schoenebeck 708
2161 senoner 542 "ERR:<error-code>:<error-message>" -
2162 schoenebeck 708
2163 senoner 542 in case it failed, providing an appropriate error code and
2164     error message
2165    
2166     Example:
2167    
2168     C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"
2169 schoenebeck 708
2170 senoner 542 S: "OK"
2171    
2172 schoenebeck 940 6.3.11. Getting information about a MIDI port
2173 schoenebeck 708
2174 senoner 542 Use the following command to get information about a MIDI port:
2175    
2176     GET MIDI_INPUT_PORT INFO <device-id> <midi-port>
2177    
2178 schoenebeck 575 Where <device-id> is the numerical ID of the MIDI input device as
2179     returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2180 senoner 542
2181    
2182 schoenebeck 940
2183 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 39]
2184 schoenebeck 940
2185 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2186 schoenebeck 940
2187    
2188 schoenebeck 974 MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
2189     input port number.
2190    
2191     Possible Answers:
2192    
2193 senoner 542 LinuxSampler will answer by sending a <CRLF> separated list. Each
2194     answer line begins with the information category name followed by
2195     a colon and then a space character <SP> and finally the info
2196     character string to that info category. At the moment the
2197     following information categories are defined:
2198 schoenebeck 708
2199 senoner 542 NAME -
2200 schoenebeck 708
2201 senoner 542 arbitrary character string naming the port
2202    
2203     The field above is only the one which is returned by all MIDI ports
2204     regardless of the MIDI driver and port. Every MIDI port might have
2205     its own, additional driver and port specific parameters.
2206    
2207     Example:
2208    
2209     C: "GET MIDI_INPUT_PORT INFO 0 0"
2210 schoenebeck 708
2211 senoner 542 S: "NAME: 'Masterkeyboard'"
2212 schoenebeck 708
2213 senoner 542 "ALSA_SEQ_BINDINGS: '64:0'"
2214 schoenebeck 708
2215 senoner 542 "."
2216    
2217 schoenebeck 940 6.3.12. Getting information about specific MIDI port parameter
2218 schoenebeck 708
2219 senoner 542 Use the following command to get detailed information about specific
2220     MIDI port parameter:
2221    
2222     GET MIDI_INPUT_PORT_PARAMETER INFO <dev-id> <port> <param>
2223    
2224     Where <dev-id> is the numerical ID of the MIDI input device as
2225 schoenebeck 575 returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5) or "LIST
2226     MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> the MIDI port
2227     number and <param> a specific port parameter name for which
2228     information should be obtained (as returned by the "GET
2229     MIDI_INPUT_PORT INFO" (Section 6.3.11) command).
2230    
2231 senoner 542 Possible Answers:
2232    
2233     LinuxSampler will answer by sending a <CRLF> separated list. Each
2234     answer line begins with the information category name followed by
2235     a colon and then a space character <SP> and finally the info
2236 schoenebeck 974
2237    
2238    
2239 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 40]
2240 schoenebeck 974
2241 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2242 schoenebeck 974
2243    
2244 senoner 542 character string to that info category. There is information
2245     which is always returned, independently of the given channel
2246     parameter and there is optional information which are only shown
2247     dependently to the given MIDI port. At the moment the following
2248     information categories are defined:
2249 schoenebeck 708
2250 senoner 542 TYPE -
2251 schoenebeck 708
2252 senoner 542 either "BOOL" for boolean value(s) or "INT" for integer
2253     value(s) or "FLOAT" for dotted number(s) or "STRING" for
2254     character string(s) (always returned)
2255 schoenebeck 708
2256 senoner 542 DESCRIPTION -
2257 schoenebeck 708
2258 senoner 542 arbitrary text describing the purpose of the parameter (always
2259     returned)
2260 schoenebeck 708
2261 senoner 542 FIX -
2262 schoenebeck 708
2263 senoner 542 either true or false, if true then this parameter is read only,
2264     thus cannot be altered (always returned)
2265 schoenebeck 708
2266 senoner 542 MULTIPLICITY -
2267 schoenebeck 708
2268 senoner 542 either true or false, defines if this parameter allows only one
2269     value or a list of values, where true means multiple values and
2270     false only a single value allowed (always returned)
2271 schoenebeck 708
2272 senoner 542 RANGE_MIN -
2273 schoenebeck 708
2274 senoner 542 defines lower limit of the allowed value range for this
2275     parameter, can be an integer value as well as a dotted number,
2276     this parameter is usually used in conjunction with 'RANGE_MAX'
2277     but may also appear without (optionally returned, dependent to
2278     driver and port parameter)
2279 schoenebeck 708
2280 senoner 542 RANGE_MAX -
2281 schoenebeck 708
2282 senoner 542 defines upper limit of the allowed value range for this
2283     parameter, can be an integer value as well as a dotted number,
2284     this parameter is usually used in conjunction with 'RANGE_MIN'
2285     but may also appear without (optionally returned, dependent to
2286     driver and port parameter)
2287 schoenebeck 708
2288 senoner 542 POSSIBILITIES -
2289 schoenebeck 708
2290 senoner 542 comma separated list of possible values for this parameter,
2291     character strings are encapsulated into apostrophes (optionally
2292    
2293    
2294    
2295 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 41]
2296 schoenebeck 974
2297 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2298 schoenebeck 940
2299    
2300 schoenebeck 974 returned, dependent to device and port parameter)
2301 schoenebeck 940
2302 schoenebeck 974 The mentioned fields above don't have to be in particular order.
2303 schoenebeck 940
2304 schoenebeck 974 Example:
2305 schoenebeck 940
2306 schoenebeck 708 C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"
2307 schoenebeck 575
2308 schoenebeck 708 S: "DESCRIPTION: bindings to other ALSA sequencer clients"
2309 schoenebeck 575
2310 schoenebeck 708 "TYPE: STRING"
2311 schoenebeck 575
2312 schoenebeck 708 "FIX: false"
2313 schoenebeck 575
2314 schoenebeck 708 "MULTIPLICITY: true"
2315 schoenebeck 575
2316 senoner 542 "POSSIBILITIES: '64:0','68:0','68:1'"
2317 schoenebeck 708
2318 senoner 542 "."
2319    
2320 schoenebeck 940 6.3.13. Changing settings of MIDI input ports
2321 schoenebeck 708
2322 senoner 542 Use the following command to alter a specific setting of a MIDI input
2323     port:
2324    
2325     SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value>
2326    
2327     Where <device-id> should be replaced by the numerical ID of the MIDI
2328 schoenebeck 575 device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
2329     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, <port> by the
2330     MIDI port number, <key> by the name of the parameter to change and
2331     <value> by the new value for this parameter.
2332 senoner 542
2333     Possible Answers:
2334    
2335     "OK" -
2336 schoenebeck 708
2337 senoner 542 in case setting was successfully changed
2338 schoenebeck 708
2339 senoner 542 "WRN:<warning-code>:<warning-message>" -
2340 schoenebeck 708
2341 senoner 542 in case setting was changed successfully, but there are
2342     noteworthy issue(s) related, providing an appropriate warning
2343     code and warning message
2344 schoenebeck 708
2345 senoner 542 "ERR:<error-code>:<error-message>" -
2346 schoenebeck 708
2347 senoner 542
2348    
2349    
2350    
2351 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 42]
2352 schoenebeck 974
2353 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2354 schoenebeck 708
2355 senoner 542
2356 schoenebeck 974 in case it failed, providing an appropriate error code and
2357     error message
2358 schoenebeck 940
2359 schoenebeck 974 Example:
2360 schoenebeck 940
2361    
2362    
2363     6.4. Configuring sampler channels
2364    
2365 senoner 542 The following commands describe how to add and remove sampler
2366 schoenebeck 575 channels, associate a sampler channel with a sampler engine, load
2367     instruments and connect sampler channels to MIDI and audio devices.
2368 senoner 542
2369 schoenebeck 940 6.4.1. Loading an instrument
2370 senoner 542
2371     An instrument file can be loaded and assigned to a sampler channel by
2372     one of the following commands:
2373    
2374 schoenebeck 708 LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-
2375     channel>
2376 schoenebeck 575
2377 senoner 542 Where <filename> is the name of the instrument file on the
2378     LinuxSampler instance's host system, <instr-index> the index of the
2379     instrument in the instrument file and <sampler-channel> is the number
2380     of the sampler channel the instrument should be assigned to. Each
2381     sampler channel can only have one instrument.
2382    
2383 schoenebeck 1251 Notice: since LSCP 1.2 the <filename> argument supports escape
2384     characters for special characters (see chapter "Character Set and
2385     Escape Sequences (Section 7.1)" for details) and accordingly
2386     backslash characters in the filename MUST now be escaped as well!
2387    
2388 senoner 542 The difference between regular and NON_MODAL versions of the command
2389     is that the regular command returns OK only after the instrument has
2390     been fully loaded and the channel is ready to be used while NON_MODAL
2391     version returns immediately and a background process is launched to
2392 schoenebeck 708 load the instrument on the channel. The GET CHANNEL INFO
2393     (Section 6.4.10) command can be used to obtain loading progress from
2394 senoner 542 INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2395     such as making sure that the file could be read and it is of a proper
2396     format and SHOULD return ERR and SHOULD not launch the background
2397     process should any errors be detected at that point.
2398    
2399     Possible Answers:
2400    
2401     "OK" -
2402 schoenebeck 708
2403    
2404    
2405    
2406 schoenebeck 940
2407 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 43]
2408 schoenebeck 974
2409 schoenebeck 1251 Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2410 schoenebeck 940
2411    
2412 schoenebeck 1251 in case the instrument was successfully loaded
2413    
2414     "WRN:<warning-code>:<warning-message>" -
2415    
2416     in case the instrument was loaded successfully, but there are
2417     noteworthy issue(s) related (e.g. Engine doesn't support one
2418 schoenebeck 974 or more patch parameters provided by the loaded instrument
2419     file), providing an appropriate warning code and warning
2420     message
2421 schoenebeck 940
2422 senoner 542 "ERR:<error-code>:<error-message>" -
2423 schoenebeck 708
2424 senoner 542 in case it failed, providing an appropriate error code and
2425     error message
2426    
2427     Example:
2428    
2429    
2430    
2431 schoenebeck 940 6.4.2. Loading a sampler engine
2432 schoenebeck 708
2433 schoenebeck 575 A sampler engine type can be associated to a specific sampler channel
2434     by the following command:
2435 senoner 542
2436     LOAD ENGINE <engine-name> <sampler-channel>
2437    
2438     Where <engine-name> is an engine name as obtained by the "LIST
2439 schoenebeck 575 AVAILABLE_ENGINES" (Section 6.4.8) command and <sampler-channel> the
2440     sampler channel as returned by the "ADD CHANNEL" (Section 6.4.5) or
2441     "LIST CHANNELS" (Section 6.4.4) command where the engine type should
2442     be assigned to. This command should be issued after adding a new
2443     sampler channel and before any other control commands on the new
2444     sampler channel. It can also be used to change the engine type of a
2445     sampler channel. This command has (currently) no way to define or
2446     force if a new engine instance should be created and assigned to the
2447     given sampler channel or if an already existing instance of that
2448     engine type, shared with other sampler channels, should be used.
2449    
2450 senoner 542 Possible Answers:
2451    
2452     "OK" -
2453 schoenebeck 708
2454 senoner 542 in case the engine was successfully deployed
2455 schoenebeck 708
2456 senoner 542 "WRN:<warning-code>:<warning-message>" -
2457 schoenebeck 708
2458 senoner 542 in case the engine was deployed successfully, but there are
2459     noteworthy issue(s) related, providing an appropriate warning
2460 schoenebeck 1251
2461    
2462    
2463     Schoenebeck Expires December 24, 2007 [Page 44]
2464    
2465     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2466    
2467    
2468 senoner 542 code and warning message
2469 schoenebeck 708
2470 senoner 542 "ERR:<error-code>:<error-message>" -
2471 schoenebeck 708
2472 senoner 542 in case it failed, providing an appropriate error code and
2473     error message
2474    
2475 schoenebeck 974 Example:
2476 senoner 542
2477 schoenebeck 940
2478    
2479     6.4.3. Getting all created sampler channel count
2480    
2481 senoner 542 The number of sampler channels can change on runtime. To get the
2482     current amount of sampler channels, the front-end can send the
2483     following command:
2484    
2485     GET CHANNELS
2486    
2487     Possible Answers:
2488    
2489     LinuxSampler will answer by returning the current number of
2490     sampler channels.
2491    
2492     Example:
2493    
2494     C: "GET CHANNELS"
2495 schoenebeck 708
2496 senoner 542 S: "12"
2497    
2498 schoenebeck 940 6.4.4. Getting all created sampler channel list
2499 schoenebeck 708
2500 senoner 542 The number of sampler channels can change on runtime. To get the
2501     current list of sampler channels, the front-end can send the
2502 schoenebeck 708 following command:
2503    
2504 senoner 542 LIST CHANNELS
2505    
2506     Possible Answers:
2507    
2508     LinuxSampler will answer by returning a comma separated list with
2509     all sampler channels numerical IDs.
2510    
2511     Example:
2512    
2513     C: "LIST CHANNELS"
2514 schoenebeck 708
2515 senoner 542
2516 schoenebeck 708
2517 senoner 542
2518    
2519 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 45]
2520    
2521     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2522 schoenebeck 940
2523    
2524 schoenebeck 1251 S: "0,1,2,3,4,5,6,9,10,11,15,20"
2525 schoenebeck 940
2526 schoenebeck 1251 6.4.5. Adding a new sampler channel
2527 schoenebeck 940
2528 schoenebeck 1251 A new sampler channel can be added to the end of the sampler channel
2529     list by sending the following command:
2530 schoenebeck 940
2531 schoenebeck 974 ADD CHANNEL
2532    
2533     This will increment the sampler channel count by one and the new
2534 senoner 542 sampler channel will be appended to the end of the sampler channel
2535     list. The front-end should send the respective, related commands
2536 schoenebeck 708 right after to e.g. load an engine, load an instrument and setting
2537 senoner 542 input, output method and eventually other commands to initialize the
2538     new channel. The front-end should use the sampler channel returned
2539     by the answer of this command to perform the previously recommended
2540 schoenebeck 708 commands, to avoid race conditions e.g. with other front-ends that
2541 senoner 542 might also have sent an "ADD CHANNEL" command.
2542    
2543     Possible Answers:
2544    
2545     "OK[<sampler-channel>]" -
2546 schoenebeck 708
2547     in case a new sampler channel could be added, where <sampler-
2548     channel> reflects the channel number of the new created sampler
2549     channel which should be used to set up the sampler channel by
2550     sending subsequent initialization commands
2551    
2552 senoner 542 "WRN:<warning-code>:<warning-message>" -
2553 schoenebeck 708
2554 senoner 542 in case a new channel was added successfully, but there are
2555     noteworthy issue(s) related, providing an appropriate warning
2556     code and warning message
2557 schoenebeck 708
2558 senoner 542 "ERR:<error-code>:<error-message>" -
2559 schoenebeck 708
2560 senoner 542 in case it failed, providing an appropriate error code and
2561     error message
2562    
2563     Example:
2564    
2565    
2566    
2567 schoenebeck 940 6.4.6. Removing a sampler channel
2568 senoner 542
2569     A sampler channel can be removed by sending the following command:
2570    
2571 schoenebeck 1251
2572    
2573    
2574    
2575     Schoenebeck Expires December 24, 2007 [Page 46]
2576    
2577     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2578    
2579    
2580 senoner 542 REMOVE CHANNEL <sampler-channel>
2581    
2582 schoenebeck 561 Where <sampler-channel> should be replaced by the number of the
2583 schoenebeck 575 sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
2584     "LIST CHANNELS" (Section 6.4.4) command. The channel numbers of all
2585 schoenebeck 561 subsequent sampler channels remain the same.
2586 senoner 542
2587     Possible Answers:
2588    
2589     "OK" -
2590 schoenebeck 708
2591 senoner 542 in case the given sampler channel could be removed
2592 schoenebeck 708
2593 senoner 542 "WRN:<warning-code>:<warning-message>" -
2594 schoenebeck 708
2595 senoner 542 in case the given channel was removed, but there are noteworthy
2596     issue(s) related, providing an appropriate warning code and
2597     warning message
2598 schoenebeck 708
2599 senoner 542 "ERR:<error-code>:<error-message>" -
2600 schoenebeck 708
2601 senoner 542 in case it failed, providing an appropriate error code and
2602     error message
2603    
2604     Example:
2605    
2606    
2607    
2608 schoenebeck 940 6.4.7. Getting amount of available engines
2609 schoenebeck 708
2610 senoner 542 The front-end can ask for the number of available engines by sending
2611     the following command:
2612    
2613     GET AVAILABLE_ENGINES
2614    
2615     Possible Answers:
2616    
2617     LinuxSampler will answer by sending the number of available
2618     engines.
2619    
2620     Example:
2621    
2622     C: "GET AVAILABLE_ENGINES"
2623 schoenebeck 708
2624 senoner 542 S: "4"
2625    
2626 schoenebeck 708
2627 senoner 542
2628    
2629    
2630 schoenebeck 940
2631 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 47]
2632    
2633     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2634 schoenebeck 940
2635    
2636 schoenebeck 1251 6.4.8. Getting all available engines
2637 schoenebeck 940
2638 schoenebeck 1251 The front-end can ask for a list of all available engines by sending
2639     the following command:
2640 schoenebeck 940
2641 schoenebeck 1251 LIST AVAILABLE_ENGINES
2642 schoenebeck 940
2643 schoenebeck 1251 Possible Answers:
2644 schoenebeck 940
2645 schoenebeck 561 LinuxSampler will answer by sending a comma separated list of the
2646     engines' names encapsulated into apostrophes ('). Engine names
2647     can consist of lower and upper cases, digits and underlines ("_"
2648     character).
2649 senoner 542
2650     Example:
2651    
2652     C: "LIST AVAILABLE_ENGINES"
2653 schoenebeck 708
2654 schoenebeck 561 S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2655 senoner 542
2656 schoenebeck 940 6.4.9. Getting information about an engine
2657 schoenebeck 708
2658 senoner 542 The front-end can ask for information about a specific engine by
2659     sending the following command:
2660    
2661     GET ENGINE INFO <engine-name>
2662    
2663     Where <engine-name> is an engine name as obtained by the "LIST
2664 schoenebeck 575 AVAILABLE_ENGINES" (Section 6.4.8) command.
2665 senoner 542
2666 schoenebeck 561 Possible Answers:
2667    
2668 senoner 542 LinuxSampler will answer by sending a <CRLF> separated list. Each
2669     answer line begins with the information category name followed by
2670     a colon and then a space character <SP> and finally the info
2671     character string to that info category. At the moment the
2672     following categories are defined:
2673    
2674 schoenebeck 708
2675    
2676 senoner 542 DESCRIPTION -
2677 schoenebeck 708
2678 senoner 542 arbitrary description text about the engine
2679 schoenebeck 708
2680 senoner 542 VERSION -
2681 schoenebeck 708
2682 senoner 542 arbitrary character string regarding the engine's version
2683    
2684    
2685    
2686 schoenebeck 708
2687 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 48]
2688    
2689     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2690 schoenebeck 708
2691 schoenebeck 940
2692 schoenebeck 1251 The mentioned fields above don't have to be in particular order.
2693 schoenebeck 940
2694 schoenebeck 1251 Example:
2695 schoenebeck 940
2696 schoenebeck 1251 C: "GET ENGINE INFO JoesCustomEngine"
2697 schoenebeck 940
2698 schoenebeck 1251 S: "DESCRIPTION: this is Joe's custom sampler engine"
2699 schoenebeck 940
2700 senoner 542 "VERSION: testing-1.0"
2701 schoenebeck 708
2702 senoner 542 "."
2703    
2704 schoenebeck 940 6.4.10. Getting sampler channel information
2705 senoner 542
2706     The front-end can ask for the current settings of a sampler channel
2707     by sending the following command:
2708    
2709     GET CHANNEL INFO <sampler-channel>
2710    
2711     Where <sampler-channel> is the sampler channel number the front-end
2712 schoenebeck 575 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2713     "LIST CHANNELS" (Section 6.4.4) command.
2714 senoner 542
2715     Possible Answers:
2716    
2717     LinuxSampler will answer by sending a <CRLF> separated list. Each
2718     answer line begins with the settings category name followed by a
2719     colon and then a space character <SP> and finally the info
2720     character string to that setting category. At the moment the
2721     following categories are defined:
2722    
2723 schoenebeck 708
2724    
2725 senoner 542 ENGINE_NAME -
2726 schoenebeck 708
2727 schoenebeck 575 name of the engine that is associated with the sampler
2728     channel, "NONE" if there's no engine associated yet for this
2729     sampler channel
2730 schoenebeck 708
2731 senoner 542 AUDIO_OUTPUT_DEVICE -
2732 schoenebeck 708
2733 senoner 542 numerical ID of the audio output device which is currently
2734     connected to this sampler channel to output the audio
2735     signal, "NONE" if there's no device connected to this
2736 schoenebeck 561 sampler channel
2737 schoenebeck 708
2738 schoenebeck 1251
2739    
2740    
2741    
2742    
2743     Schoenebeck Expires December 24, 2007 [Page 49]
2744    
2745     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2746    
2747    
2748 senoner 542 AUDIO_OUTPUT_CHANNELS -
2749 schoenebeck 708
2750 senoner 542 number of output channels the sampler channel offers
2751     (dependent to used sampler engine and loaded instrument)
2752 schoenebeck 708
2753 senoner 542 AUDIO_OUTPUT_ROUTING -
2754 schoenebeck 708
2755 senoner 542 comma separated list which reflects to which audio channel
2756     of the selected audio output device each sampler output
2757 schoenebeck 708 channel is routed to, e.g. "0,3" would mean the engine's
2758 senoner 542 output channel 0 is routed to channel 0 of the audio output
2759     device and the engine's output channel 1 is routed to the
2760     channel 3 of the audio output device
2761 schoenebeck 708
2762 senoner 542 INSTRUMENT_FILE -
2763 schoenebeck 708
2764 senoner 542 the file name of the loaded instrument, "NONE" if there's no
2765     instrument yet loaded for this sampler channel
2766 schoenebeck 708
2767 senoner 542 INSTRUMENT_NR -
2768 schoenebeck 708
2769 senoner 542 the instrument index number of the loaded instrument
2770 schoenebeck 708
2771 senoner 542 INSTRUMENT_NAME -
2772 schoenebeck 708
2773 senoner 542 the instrument name of the loaded instrument
2774 schoenebeck 708
2775 senoner 542 INSTRUMENT_STATUS -
2776 schoenebeck 708
2777 senoner 542 integer values 0 to 100 indicating loading progress
2778     percentage for the instrument. Negative value indicates a
2779 schoenebeck 708 loading exception. Value of 100 indicates that the
2780     instrument is fully loaded.
2781 schoenebeck 575
2782 senoner 542 MIDI_INPUT_DEVICE -
2783 schoenebeck 708
2784 senoner 542 numerical ID of the MIDI input device which is currently
2785     connected to this sampler channel to deliver MIDI input
2786     commands, "NONE" if there's no device connected to this
2787     sampler channel
2788 schoenebeck 708
2789 senoner 542 MIDI_INPUT_PORT -
2790 schoenebeck 708
2791 senoner 542 port number of the MIDI input device
2792 schoenebeck 708
2793 senoner 542 MIDI_INPUT_CHANNEL -
2794 schoenebeck 708
2795 schoenebeck 1251
2796    
2797    
2798    
2799     Schoenebeck Expires December 24, 2007 [Page 50]
2800    
2801     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2802    
2803    
2804 senoner 542 the MIDI input channel number this sampler channel should
2805     listen to or "ALL" to listen on all MIDI channels
2806 schoenebeck 708
2807 senoner 542 VOLUME -
2808 schoenebeck 708
2809 senoner 542 optionally dotted number for the channel volume factor
2810     (where a value < 1.0 means attenuation and a value > 1.0
2811     means amplification)
2812    
2813 schoenebeck 708 MUTE -
2814    
2815     Determines whether the channel is muted, "true" if the
2816     channel is muted, "false" if the channel is not muted, and
2817     "MUTED_BY_SOLO" if the channel is muted because of the
2818     presence of a solo channel and will be unmuted when there
2819     are no solo channels left
2820    
2821     SOLO -
2822    
2823     Determines whether this is a solo channel, "true" if the
2824     channel is a solo channel; "false" otherwise
2825    
2826 schoenebeck 974 MIDI_INSTRUMENT_MAP -
2827    
2828     Determines to which MIDI instrument map this sampler channel
2829     is assigned to. Read chapter "SET CHANNEL
2830     MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2831     values.
2832    
2833 senoner 542 The mentioned fields above don't have to be in particular order.
2834    
2835     Example:
2836    
2837     C: "GET CHANNEL INFO 34"
2838 schoenebeck 708
2839 senoner 542 S: "ENGINE_NAME: GigEngine"
2840 schoenebeck 708
2841 senoner 542 "VOLUME: 1.0"
2842 schoenebeck 708
2843 senoner 542 "AUDIO_OUTPUT_DEVICE: 0"
2844 schoenebeck 708
2845 senoner 542 "AUDIO_OUTPUT_CHANNELS: 2"
2846 schoenebeck 708
2847 schoenebeck 561 "AUDIO_OUTPUT_ROUTING: 0,1"
2848 schoenebeck 708
2849 senoner 542 "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2850 schoenebeck 708
2851 schoenebeck 1251
2852    
2853    
2854    
2855     Schoenebeck Expires December 24, 2007 [Page 51]
2856    
2857     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2858    
2859    
2860 senoner 542 "INSTRUMENT_NR: 0"
2861 schoenebeck 708
2862 senoner 542 "INSTRUMENT_NAME: Fazioli Piano"
2863 schoenebeck 708
2864 senoner 542 "INSTRUMENT_STATUS: 100"
2865 schoenebeck 708
2866 senoner 542 "MIDI_INPUT_DEVICE: 0"
2867 schoenebeck 708
2868 senoner 542 "MIDI_INPUT_PORT: 0"
2869 schoenebeck 708
2870 schoenebeck 974 "MIDI_INPUT_CHANNEL: 5"
2871 schoenebeck 940
2872 schoenebeck 974 "VOLUME: 1.0"
2873 schoenebeck 940
2874 schoenebeck 974 "MUTE: false"
2875 schoenebeck 940
2876 schoenebeck 974 "SOLO: false"
2877 schoenebeck 940
2878 schoenebeck 974 "MIDI_INSTRUMENT_MAP: NONE"
2879 schoenebeck 940
2880 schoenebeck 974 "."
2881    
2882 schoenebeck 940 6.4.11. Current number of active voices
2883    
2884 senoner 542 The front-end can ask for the current number of active voices on a
2885     sampler channel by sending the following command:
2886    
2887     GET CHANNEL VOICE_COUNT <sampler-channel>
2888    
2889     Where <sampler-channel> is the sampler channel number the front-end
2890 schoenebeck 575 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2891     "LIST CHANNELS" (Section 6.4.4) command.
2892 senoner 542
2893     Possible Answers:
2894    
2895     LinuxSampler will answer by returning the number of active voices
2896     on that channel.
2897    
2898     Example:
2899    
2900    
2901    
2902 schoenebeck 940 6.4.12. Current number of active disk streams
2903 schoenebeck 708
2904 senoner 542 The front-end can ask for the current number of active disk streams
2905     on a sampler channel by sending the following command:
2906    
2907 schoenebeck 1251
2908    
2909    
2910    
2911     Schoenebeck Expires December 24, 2007 [Page 52]
2912    
2913     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2914    
2915    
2916 senoner 542 GET CHANNEL STREAM_COUNT <sampler-channel>
2917    
2918     Where <sampler-channel> is the sampler channel number the front-end
2919 schoenebeck 575 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2920     "LIST CHANNELS" (Section 6.4.4) command.
2921 senoner 542
2922     Possible Answers:
2923    
2924     LinuxSampler will answer by returning the number of active disk
2925     streams on that channel in case the engine supports disk
2926     streaming, if the engine doesn't support disk streaming it will
2927     return "NA" for not available.
2928    
2929     Example:
2930    
2931    
2932    
2933 schoenebeck 940 6.4.13. Current fill state of disk stream buffers
2934 schoenebeck 708
2935 senoner 542 The front-end can ask for the current fill state of all disk streams
2936     on a sampler channel by sending the following command:
2937    
2938     GET CHANNEL BUFFER_FILL BYTES <sampler-channel>
2939    
2940     to get the fill state in bytes or
2941    
2942     GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
2943    
2944     to get the fill state in percent, where <sampler-channel> is the
2945 schoenebeck 575 sampler channel number the front-end is interested in as returned by
2946     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2947     command.
2948 senoner 542
2949     Possible Answers:
2950    
2951     LinuxSampler will either answer by returning a comma separated
2952     string with the fill state of all disk stream buffers on that
2953     channel or an empty line if there are no active disk streams or
2954     "NA" for *not available* in case the engine which is deployed
2955     doesn't support disk streaming. Each entry in the answer list
2956     will begin with the stream's ID in brackets followed by the
2957     numerical representation of the fill size (either in bytes or
2958     percentage). Note: due to efficiency reasons the fill states in
2959     the response are not in particular order, thus the front-end has
2960     to sort them by itself if necessary.
2961    
2962     Examples:
2963    
2964 schoenebeck 1251
2965    
2966    
2967     Schoenebeck Expires December 24, 2007 [Page 53]
2968    
2969     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
2970    
2971    
2972 senoner 542 C: "GET CHANNEL BUFFER_FILL BYTES 4"
2973 schoenebeck 708
2974 senoner 542 S: "[115]420500,[116]510300,[75]110000,[120]230700"
2975 schoenebeck 708
2976 senoner 542 C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2977 schoenebeck 708
2978 senoner 542 S: "[115]90%,[116]98%,[75]40%,[120]62%"
2979 schoenebeck 708
2980 senoner 542 C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2981 schoenebeck 708
2982 senoner 542 S: ""
2983    
2984 schoenebeck 940 6.4.14. Setting audio output device
2985 schoenebeck 708
2986 senoner 542 The front-end can set the audio output device on a specific sampler
2987     channel by sending the following command:
2988    
2989     SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>
2990     <audio-device-id>
2991    
2992 schoenebeck 575 Where <sampler-channel> is the respective sampler channel number as
2993     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
2994     (Section 6.4.4) command and <audio-device-id> is the numerical ID of
2995     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
2996     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
2997     command.
2998 senoner 542
2999     Possible Answers:
3000    
3001     "OK" -
3002 schoenebeck 708
3003 senoner 542 on success
3004 schoenebeck 708
3005 senoner 542 "WRN:<warning-code>:<warning-message>" -
3006 schoenebeck 708
3007 senoner 542 if audio output device was set, but there are noteworthy
3008     issue(s) related, providing an appropriate warning code and
3009     warning message
3010 schoenebeck 708
3011 senoner 542 "ERR:<error-code>:<error-message>" -
3012 schoenebeck 708
3013 senoner 542 in case it failed, providing an appropriate error code and
3014     error message
3015    
3016     Examples:
3017    
3018    
3019    
3020 schoenebeck 1251
3021    
3022    
3023     Schoenebeck Expires December 24, 2007 [Page 54]
3024    
3025     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3026    
3027    
3028    
3029    
3030 schoenebeck 940 6.4.15. Setting audio output type
3031 senoner 542
3032     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3033    
3034     The front-end can alter the audio output type on a specific sampler
3035     channel by sending the following command:
3036    
3037 schoenebeck 708 SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3038     type>
3039 senoner 542
3040     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3041     <sampler-channel> is the respective sampler channel number.
3042    
3043     Possible Answers:
3044    
3045     "OK" -
3046 schoenebeck 708
3047 senoner 542 on success
3048 schoenebeck 708
3049 senoner 542 "WRN:<warning-code>:<warning-message>" -
3050 schoenebeck 708
3051 senoner 542 if audio output type was set, but there are noteworthy issue(s)
3052     related, providing an appropriate warning code and warning
3053     message
3054 schoenebeck 708
3055 senoner 542 "ERR:<error-code>:<error-message>" -
3056 schoenebeck 708
3057 senoner 542 in case it failed, providing an appropriate error code and
3058     error message
3059    
3060     Examples:
3061    
3062    
3063    
3064 schoenebeck 940 6.4.16. Setting audio output channel
3065 schoenebeck 708
3066 schoenebeck 575 The front-end can alter the audio output channel on a specific
3067     sampler channel by sending the following command:
3068 senoner 542
3069 schoenebeck 575 SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3070     <audio-in>
3071 senoner 542
3072 schoenebeck 575 Where <sampler-chan> is the sampler channel number as returned by the
3073     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3074     command, <audio-out> is the numerical ID of the sampler channel's
3075     audio output channel which should be rerouted and <audio-in> is the
3076 schoenebeck 1251
3077    
3078    
3079     Schoenebeck Expires December 24, 2007 [Page 55]
3080    
3081     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3082    
3083    
3084 schoenebeck 575 numerical ID of the audio channel of the selected audio output device
3085     where <audio-out> should be routed to.
3086 senoner 542
3087 schoenebeck 575 Possible Answers:
3088 senoner 542
3089 schoenebeck 708 "OK" -
3090 senoner 542
3091 schoenebeck 708 on success
3092 senoner 542
3093 schoenebeck 708 "WRN:<warning-code>:<warning-message>" -
3094 senoner 542
3095     if audio output channel was set, but there are noteworthy
3096     issue(s) related, providing an appropriate warning code and
3097     warning message
3098 schoenebeck 708
3099 senoner 542 "ERR:<error-code>:<error-message>" -
3100 schoenebeck 708
3101 senoner 542 in case it failed, providing an appropriate error code and
3102     error message
3103    
3104     Examples:
3105    
3106    
3107    
3108 schoenebeck 940 6.4.17. Setting MIDI input device
3109    
3110 senoner 542 The front-end can set the MIDI input device on a specific sampler
3111     channel by sending the following command:
3112    
3113     SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3114    
3115 schoenebeck 575 Where <sampler-channel> is the sampler channel number as returned by
3116     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3117 schoenebeck 940 command and <midi-device-id> is the numerical ID of the MIDI input
3118 schoenebeck 575 device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3119     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3120 senoner 542
3121     Possible Answers:
3122    
3123     "OK" -
3124 schoenebeck 708
3125 senoner 542 on success
3126 schoenebeck 708
3127 senoner 542 "WRN:<warning-code>:<warning-message>" -
3128 schoenebeck 708
3129 senoner 542 if MIDI input device was set, but there are noteworthy issue(s)
3130     related, providing an appropriate warning code and warning
3131     message
3132 schoenebeck 708
3133 schoenebeck 1251
3134    
3135     Schoenebeck Expires December 24, 2007 [Page 56]
3136    
3137     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3138    
3139    
3140 senoner 542 "ERR:<error-code>:<error-message>" -
3141 schoenebeck 708
3142 senoner 542 in case it failed, providing an appropriate error code and
3143     error message
3144    
3145     Examples:
3146    
3147    
3148    
3149 schoenebeck 940 6.4.18. Setting MIDI input type
3150 schoenebeck 708
3151 senoner 542 DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3152    
3153     The front-end can alter the MIDI input type on a specific sampler
3154     channel by sending the following command:
3155    
3156     SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
3157    
3158 schoenebeck 708 Where <midi-input-type> is currently only "ALSA" and <sampler-
3159     channel> is the respective sampler channel number.
3160 senoner 542
3161     Possible Answers:
3162    
3163     "OK" -
3164 schoenebeck 708
3165 senoner 542 on success
3166 schoenebeck 708
3167 senoner 542 "WRN:<warning-code>:<warning-message>" -
3168 schoenebeck 708
3169 senoner 542 if MIDI input type was set, but there are noteworthy issue(s)
3170     related, providing an appropriate warning code and warning
3171     message
3172 schoenebeck 708
3173 senoner 542 "ERR:<error-code>:<error-message>" -
3174 schoenebeck 708
3175 senoner 542 in case it failed, providing an appropriate error code and
3176     error message
3177    
3178     Examples:
3179    
3180    
3181    
3182 schoenebeck 940 6.4.19. Setting MIDI input port
3183 schoenebeck 708
3184 senoner 542 The front-end can alter the MIDI input port on a specific sampler
3185     channel by sending the following command:
3186    
3187    
3188    
3189    
3190 schoenebeck 708
3191 schoenebeck 1251 Schoenebeck Expires December 24, 2007 [Page 57]
3192    
3193     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3194 schoenebeck 974
3195    
3196 schoenebeck 1251 SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
3197 schoenebeck 974
3198 schoenebeck 1251 Where <midi-input-port> is a MIDI input port number of the MIDI input
3199     device connected to the sampler channel given by <sampler-channel>.
3200 schoenebeck 974
3201 schoenebeck 1251 Possible Answers:
3202 schoenebeck 974
3203 schoenebeck 1251 "OK" -
3204 schoenebeck 974
3205 senoner 542 on success
3206 schoenebeck 708
3207 senoner 542 "WRN:<warning-code>:<warning-message>" -
3208 schoenebeck 708
3209 senoner 542 if MIDI input port was set, but there are noteworthy issue(s)
3210     related, providing an appropriate warning code and warning
3211     message
3212 schoenebeck 708
3213 senoner 542 "ERR:<error-code>:<error-message>" -
3214 schoenebeck 708
3215 senoner 542 in case it failed, providing an appropriate error code and
3216 schoenebeck 561 error message
3217 senoner 542
3218     Examples:
3219    
3220    
3221    
3222 schoenebeck 940 6.4.20. Setting MIDI input channel
3223 senoner 542
3224     The front-end can alter the MIDI channel a sampler channel should
3225     listen to by sending the following command:
3226    
3227     SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3228    
3229     Where <midi-input-chan> is the number of the new MIDI input channel
3230     where <sampler-channel> should listen to or "ALL" to listen on all 16
3231     MIDI channels.
3232    
3233     Possible Answers:
3234    
3235     "OK" -
3236 schoenebeck 708
3237 senoner 542 on success
3238 schoenebeck 708
3239 senoner 542 "WRN:<warning-code>:<warning-message>" -
3240 schoenebeck 708
3241 senoner 542 if MIDI input channel was set, but there are noteworthy
3242     issue(s) related, providing an appropriate warning code and
3243     warning message
3244 schoenebeck 708
3245 schoenebeck 1251
3246    
3247     Schoenebeck Expires December 24, 2007 [Page 58]
3248    
3249     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3250    
3251    
3252 senoner 542 "ERR:<error-code>:<error-message>" -
3253 schoenebeck 708
3254 senoner 542 in case it failed, providing an appropriate error code and
3255     error message
3256    
3257     Examples:
3258    
3259    
3260    
3261 schoenebeck 940 6.4.21. Setting channel volume
3262 schoenebeck 708
3263 senoner 542 The front-end can alter the volume of a sampler channel by sending
3264     the following command:
3265    
3266     SET CHANNEL VOLUME <sampler-channel> <volume>
3267    
3268     Where <volume> is an optionally dotted positive number (a value
3269     smaller than 1.0 means attenuation, whereas a value greater than 1.0
3270     means amplification) and <sampler-channel> defines the sampler
3271     channel where this volume factor should be set.
3272    
3273     Possible Answers:
3274    
3275     "OK" -
3276 schoenebeck 708
3277 senoner 542 on success
3278 schoenebeck 708
3279 senoner 542 "WRN:<warning-code>:<warning-message>" -
3280 schoenebeck 708
3281 senoner 542 if channel volume was set, but there are noteworthy issue(s)
3282     related, providing an appropriate warning code and warning
3283 schoenebeck 708 message
3284 schoenebeck 575
3285 schoenebeck 708 "ERR:<error-code>:<error-message>" -
3286 schoenebeck 575
3287 schoenebeck 708 in case it failed, providing an appropriate error code and
3288     error message
3289 schoenebeck 575
3290 schoenebeck 708 Examples:
3291    
3292    
3293    
3294 schoenebeck 940 6.4.22. Muting a sampler channel
3295 schoenebeck 708
3296     The front-end can mute/unmute a specific sampler channel by sending
3297     the following command:
3298    
3299 schoenebeck 1251
3300    
3301    
3302    
3303     Schoenebeck Expires December 24, 2007 [Page 59]
3304    
3305     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3306    
3307    
3308 schoenebeck 708 SET CHANNEL MUTE <sampler-channel> <mute>
3309    
3310     Where <sampler-channel> is the respective sampler channel number as
3311     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3312     (Section 6.4.4) command and <mute> should be replaced either by "1"
3313     to mute the channel or "0" to unmute the channel.
3314    
3315     Possible Answers:
3316    
3317     "OK" -
3318    
3319     on success
3320    
3321     "WRN:<warning-code>:<warning-message>" -
3322    
3323     if the channel was muted/unmuted, but there are noteworthy
3324     issue(s) related, providing an appropriate warning code and
3325     warning message
3326    
3327 senoner 542 "ERR:<error-code>:<error-message>" -
3328 schoenebeck 708
3329 senoner 542 in case it failed, providing an appropriate error code and
3330     error message
3331    
3332     Examples:
3333    
3334    
3335    
3336 schoenebeck 940 6.4.23. Soloing a sampler channel
3337 senoner 542
3338 schoenebeck 708 The front-end can solo/unsolo a specific sampler channel by sending
3339     the following command:
3340    
3341     SET CHANNEL SOLO <sampler-channel> <solo>
3342    
3343     Where <sampler-channel> is the respective sampler channel number as
3344     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3345     (Section 6.4.4) command and <solo> should be replaced either by "1"
3346     to solo the channel or "0" to unsolo the channel.
3347    
3348     Possible Answers:
3349    
3350     "OK" -
3351    
3352     on success
3353    
3354 schoenebeck 1251
3355    
3356    
3357    
3358    
3359     Schoenebeck Expires December 24, 2007 [Page 60]
3360    
3361     Internet-Draft LinuxSampler Control Protocol (draft) June 2007
3362    
3363    
3364 schoenebeck 708 "WRN:<warning-code>:<warning-message>" -
3365    
3366     if the channel was soloed/unsoloed, but there are noteworthy
3367     issue(s) related, providing an appropriate warning code and
3368     warning message
3369    
3370     "ERR:<error-code>:<error-message>" -
3371    
3372     in case it failed, providing an appropriate error code and
3373     error message
3374    
3375     Examples:
3376    
3377    
3378    
3379 schoenebeck 974 6.4.24. Assigning a MIDI instrument map to a sampler channel
3380 schoenebeck 708
3381 schoenebeck 974 The front-end can assign a MIDI instrument map to a specific sampler
3382     channel by sending the following command:
3383 senoner 542
3384 schoenebeck 974 SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3385 senoner 542
3386 schoenebeck 974 Where <sampler-channel> is the respective sampler channel number as
3387     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3388     (Section 6.4.4) command and <map> can have the following
3389     possibilites:
3390 schoenebeck 940
3391 schoenebeck 974 "NONE" -
3392 schoenebeck 940
3393 schoenebeck 974 This is the default setting. In this case the sampler channel
3394     is not assigned any MIDI instrument map and thus will ignore
3395     all MIDI program change messages.
3396 schoenebeck 940
3397 schoenebeck 974 "DEFAULT" -
3398    
3399     The sampler channel will always use the default MIDI instrument
3400     map to handle MIDI program change messages.
3401    
3402     numeric ID -
3403    
3404     You can assign a specific MIDI instrument map by replacing
3405     <map> with the respective numeric ID of the MIDI instrument map
3406     as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3407     command. Once that map will be deleted, the sampler channel
3408     would fall back to "NONE".
3409    
3410     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3411     regarding MIDI instrument mapping.
3412    
3413 schoenebeck 1251
3414    
3415