/[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 1400 - (hide annotations) (download)
Thu Oct 11 18:59:34 2007 UTC (16 years, 5 months ago) by schoenebeck
File MIME type: text/plain
File size: 222512 byte(s)
* listed LSCP commands which may return escape sequences
  in their response

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 1400 Expires: April 13, 2008 October 11, 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 1400 This Internet-Draft will expire on April 13, 2008.
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 1400 Schoenebeck Expires April 13, 2008 [Page 1]
56 schoenebeck 940
57 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 2]
112 schoenebeck 974
113 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 schoenebeck 1363 6.4.6. Removing a sampler channel . . . . . . . . . . . . . 47
130 iliev 1162 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 schoenebeck 1363 6.4.12. Current number of active disk streams . . . . . . . . 53
136 iliev 1162 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 schoenebeck 1363 6.4.19. Setting MIDI input port . . . . . . . . . . . . . . . 58
143 iliev 1162 6.4.20. Setting MIDI input channel . . . . . . . . . . . . . 58
144     6.4.21. Setting channel volume . . . . . . . . . . . . . . . 59
145 schoenebeck 1363 6.4.22. Muting a sampler channel . . . . . . . . . . . . . . 60
146 iliev 1162 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 1400 Schoenebeck Expires April 13, 2008 [Page 3]
168 schoenebeck 940
169 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
170 senoner 542
171    
172 iliev 1162 6.5.4. Close client connection . . . . . . . . . . . . . . . 72
173 schoenebeck 1363 6.6. Global commands . . . . . . . . . . . . . . . . . . . . . 73
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 schoenebeck 1363 6.6.4. General sampler informations . . . . . . . . . . . . 74
178 iliev 1162 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 schoenebeck 1390 6.7.3. Get amount of existing MIDI instrument maps . . . . . 78
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 schoenebeck 1390 6.7.8. Getting ammount of MIDI instrument map entries . . . 83
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 schoenebeck 1390 6.7.11. Get current settings of MIDI instrument map entry . . 85
193 iliev 1162 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 schoenebeck 1363 6.8.2. Deleting an instrument directory . . . . . . . . . . 88
197 schoenebeck 1390 6.8.3. Getting amount of instrument directories . . . . . . 89
198 schoenebeck 1251 6.8.4. Listing all directories in specific directory . . . . 89
199 schoenebeck 1390 6.8.5. Getting instrument directory information . . . . . . 90
200     6.8.6. Renaming an instrument directory . . . . . . . . . . 91
201 schoenebeck 1251 6.8.7. Moving an instrument directory . . . . . . . . . . . 91
202     6.8.8. Copying instrument directories . . . . . . . . . . . 92
203 schoenebeck 1390 6.8.9. Changing the description of directory . . . . . . . . 93
204 schoenebeck 1251 6.8.10. Finding directories . . . . . . . . . . . . . . . . . 93
205 schoenebeck 1390 6.8.11. Adding instruments to the instruments database . . . 95
206 schoenebeck 1251 6.8.12. Removing an instrument . . . . . . . . . . . . . . . 96
207 schoenebeck 1390 6.8.13. Getting amount of instruments . . . . . . . . . . . . 97
208 schoenebeck 1251 6.8.14. Listing all instruments in specific directory . . . . 97
209 schoenebeck 1363 6.8.15. Getting instrument information . . . . . . . . . . . 98
210 schoenebeck 1251 6.8.16. Renaming an instrument . . . . . . . . . . . . . . . 100
211 schoenebeck 1363 6.8.17. Moving an instrument . . . . . . . . . . . . . . . . 101
212 schoenebeck 1390 6.8.18. Copying instruments . . . . . . . . . . . . . . . . . 102
213 schoenebeck 1251 6.8.19. Changing the description of instrument . . . . . . . 102
214 schoenebeck 1390 6.8.20. Finding instruments . . . . . . . . . . . . . . . . . 103
215 schoenebeck 1363 6.8.21. Getting job status information . . . . . . . . . . . 105
216     6.8.22. Formatting the instruments database . . . . . . . . . 106
217 schoenebeck 1390 6.9. Editing Instruments . . . . . . . . . . . . . . . . . . . 107
218 schoenebeck 1363 6.9.1. Opening an appropriate instrument editor
219 schoenebeck 1390 application . . . . . . . . . . . . . . . . . . . . . 107
220 schoenebeck 945
221    
222    
223 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 4]
224 iliev 1162
225 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
226 schoenebeck 945
227 iliev 1162
228 schoenebeck 1390 7. Command Syntax . . . . . . . . . . . . . . . . . . . . . . . 109
229     7.1. Character Set and Escape Sequences . . . . . . . . . . . 122
230     8. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
231     8.1. Number of audio output devices changed . . . . . . . . . 126
232     8.2. Audio output device's settings changed . . . . . . . . . 126
233     8.3. Number of MIDI input devices changed . . . . . . . . . . 126
234     8.4. MIDI input device's settings changed . . . . . . . . . . 127
235     8.5. Number of sampler channels changed . . . . . . . . . . . 127
236     8.6. Number of active voices changed . . . . . . . . . . . . . 127
237     8.7. Number of active disk streams changed . . . . . . . . . . 128
238     8.8. Disk stream buffer fill state changed . . . . . . . . . . 128
239     8.9. Channel information changed . . . . . . . . . . . . . . . 128
240     8.10. Number of effect sends changed . . . . . . . . . . . . . 129
241     8.11. Effect send information changed . . . . . . . . . . . . . 129
242     8.12. Total number of active voices changed . . . . . . . . . . 129
243     8.13. Number of MIDI instrument maps changed . . . . . . . . . 130
244     8.14. MIDI instrument map information changed . . . . . . . . . 130
245     8.15. Number of MIDI instruments changed . . . . . . . . . . . 130
246     8.16. MIDI instrument information changed . . . . . . . . . . . 131
247     8.17. Global settings changed . . . . . . . . . . . . . . . . . 131
248     8.18. Number of database instrument directories changed . . . . 132
249     8.19. Database instrument directory information changed . . . . 132
250     8.20. Number of database instruments changed . . . . . . . . . 133
251     8.21. Database instrument information changed . . . . . . . . . 133
252     8.22. Database job status information changed . . . . . . . . . 134
253     8.23. Miscellaneous and debugging events . . . . . . . . . . . 134
254     9. Security Considerations . . . . . . . . . . . . . . . . . . . 135
255     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 136
256     11. References . . . . . . . . . . . . . . . . . . . . . . . . . 137
257     Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 138
258     Intellectual Property and Copyright Statements . . . . . . . . . 139
259 iliev 1162
260    
261    
262    
263    
264    
265    
266    
267    
268    
269    
270    
271    
272    
273    
274    
275    
276    
277    
278    
279 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 5]
280 schoenebeck 945
281 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 6]
336 schoenebeck 940
337 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 7]
392 schoenebeck 940
393 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 8]
448 schoenebeck 940
449 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 9]
504 schoenebeck 940
505 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 10]
560 schoenebeck 940
561 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 11]
616 schoenebeck 940
617 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 12]
672 schoenebeck 940
673 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 13]
728 schoenebeck 940
729 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 14]
784 schoenebeck 940
785 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 15]
840 schoenebeck 940
841 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 16]
896 schoenebeck 940
897 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 17]
952 schoenebeck 940
953 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 18]
1008 schoenebeck 940
1009 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 19]
1064 schoenebeck 940
1065 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 20]
1120 schoenebeck 940
1121 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 21]
1176 schoenebeck 940
1177 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 22]
1232 schoenebeck 940
1233 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 23]
1288 schoenebeck 940
1289 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 24]
1344 schoenebeck 940
1345 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 25]
1400 schoenebeck 940
1401 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 26]
1456 schoenebeck 974
1457 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 27]
1512 schoenebeck 940
1513 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 28]
1568 schoenebeck 940
1569 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 29]
1624 schoenebeck 940
1625 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 30]
1680 schoenebeck 940
1681 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 31]
1736 schoenebeck 940
1737 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 32]
1792 schoenebeck 974
1793 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 33]
1848 schoenebeck 974
1849 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 34]
1904 schoenebeck 974
1905 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 35]
1960 schoenebeck 940
1961 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 36]
2016 schoenebeck 974
2017 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 37]
2072 schoenebeck 974
2073 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 38]
2128 schoenebeck 974
2129 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 39]
2184 schoenebeck 940
2185 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 40]
2240 schoenebeck 974
2241 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 1400 Schoenebeck Expires April 13, 2008 [Page 41]
2296 schoenebeck 974
2297 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 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 schoenebeck 1363 <value> by the new value for this parameter (encapsulated into
2332     apostrophes) or NONE (not encapsulated into apostrophes) for
2333     specifying no value for parameters allowing a list of values.
2334 senoner 542
2335     Possible Answers:
2336    
2337     "OK" -
2338 schoenebeck 708
2339 senoner 542 in case setting was successfully changed
2340 schoenebeck 708
2341 senoner 542 "WRN:<warning-code>:<warning-message>" -
2342 schoenebeck 708
2343 senoner 542 in case setting was changed successfully, but there are
2344     noteworthy issue(s) related, providing an appropriate warning
2345     code and warning message
2346 schoenebeck 708
2347    
2348 senoner 542
2349    
2350    
2351 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 42]
2352 schoenebeck 974
2353 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2354 schoenebeck 708
2355 senoner 542
2356 schoenebeck 1363 "ERR:<error-code>:<error-message>" -
2357    
2358 schoenebeck 974 in case it failed, providing an appropriate error code and
2359     error message
2360 schoenebeck 940
2361 schoenebeck 974 Example:
2362 schoenebeck 940
2363 schoenebeck 1363 C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"
2364 schoenebeck 940
2365 schoenebeck 1363 S: "OK"
2366 schoenebeck 940
2367 schoenebeck 1363 C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"
2368    
2369     S: "OK"
2370    
2371 schoenebeck 940 6.4. Configuring sampler channels
2372    
2373 senoner 542 The following commands describe how to add and remove sampler
2374 schoenebeck 575 channels, associate a sampler channel with a sampler engine, load
2375     instruments and connect sampler channels to MIDI and audio devices.
2376 senoner 542
2377 schoenebeck 940 6.4.1. Loading an instrument
2378 senoner 542
2379     An instrument file can be loaded and assigned to a sampler channel by
2380     one of the following commands:
2381    
2382 schoenebeck 708 LOAD INSTRUMENT [NON_MODAL] '<filename>' <instr-index> <sampler-
2383     channel>
2384 schoenebeck 575
2385 senoner 542 Where <filename> is the name of the instrument file on the
2386     LinuxSampler instance's host system, <instr-index> the index of the
2387     instrument in the instrument file and <sampler-channel> is the number
2388     of the sampler channel the instrument should be assigned to. Each
2389     sampler channel can only have one instrument.
2390    
2391 schoenebeck 1251 Notice: since LSCP 1.2 the <filename> argument supports escape
2392     characters for special characters (see chapter "Character Set and
2393     Escape Sequences (Section 7.1)" for details) and accordingly
2394     backslash characters in the filename MUST now be escaped as well!
2395    
2396 senoner 542 The difference between regular and NON_MODAL versions of the command
2397     is that the regular command returns OK only after the instrument has
2398     been fully loaded and the channel is ready to be used while NON_MODAL
2399     version returns immediately and a background process is launched to
2400 schoenebeck 708 load the instrument on the channel. The GET CHANNEL INFO
2401     (Section 6.4.10) command can be used to obtain loading progress from
2402 senoner 542 INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2403     such as making sure that the file could be read and it is of a proper
2404    
2405    
2406 schoenebeck 708
2407 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 43]
2408 schoenebeck 1363
2409 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2410 schoenebeck 708
2411    
2412 schoenebeck 1363 format and SHOULD return ERR and SHOULD not launch the background
2413     process should any errors be detected at that point.
2414 schoenebeck 708
2415 schoenebeck 1363 Possible Answers:
2416 schoenebeck 940
2417 schoenebeck 1363 "OK" -
2418 schoenebeck 940
2419 schoenebeck 1251 in case the instrument was successfully loaded
2420    
2421     "WRN:<warning-code>:<warning-message>" -
2422    
2423     in case the instrument was loaded successfully, but there are
2424     noteworthy issue(s) related (e.g. Engine doesn't support one
2425 schoenebeck 974 or more patch parameters provided by the loaded instrument
2426     file), providing an appropriate warning code and warning
2427     message
2428 schoenebeck 940
2429 senoner 542 "ERR:<error-code>:<error-message>" -
2430 schoenebeck 708
2431 senoner 542 in case it failed, providing an appropriate error code and
2432     error message
2433    
2434     Example:
2435    
2436    
2437    
2438 schoenebeck 940 6.4.2. Loading a sampler engine
2439 schoenebeck 708
2440 schoenebeck 575 A sampler engine type can be associated to a specific sampler channel
2441     by the following command:
2442 senoner 542
2443     LOAD ENGINE <engine-name> <sampler-channel>
2444    
2445     Where <engine-name> is an engine name as obtained by the "LIST
2446 schoenebeck 575 AVAILABLE_ENGINES" (Section 6.4.8) command and <sampler-channel> the
2447     sampler channel as returned by the "ADD CHANNEL" (Section 6.4.5) or
2448     "LIST CHANNELS" (Section 6.4.4) command where the engine type should
2449     be assigned to. This command should be issued after adding a new
2450     sampler channel and before any other control commands on the new
2451     sampler channel. It can also be used to change the engine type of a
2452     sampler channel. This command has (currently) no way to define or
2453     force if a new engine instance should be created and assigned to the
2454     given sampler channel or if an already existing instance of that
2455     engine type, shared with other sampler channels, should be used.
2456    
2457 senoner 542 Possible Answers:
2458    
2459 schoenebeck 1363
2460    
2461    
2462    
2463 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 44]
2464 schoenebeck 1363
2465 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2466 schoenebeck 1363
2467    
2468 senoner 542 "OK" -
2469 schoenebeck 708
2470 senoner 542 in case the engine was successfully deployed
2471 schoenebeck 708
2472 senoner 542 "WRN:<warning-code>:<warning-message>" -
2473 schoenebeck 708
2474 senoner 542 in case the engine was deployed successfully, but there are
2475     noteworthy issue(s) related, providing an appropriate warning
2476     code and warning message
2477 schoenebeck 708
2478 senoner 542 "ERR:<error-code>:<error-message>" -
2479 schoenebeck 708
2480 senoner 542 in case it failed, providing an appropriate error code and
2481     error message
2482    
2483 schoenebeck 974 Example:
2484 senoner 542
2485 schoenebeck 940
2486    
2487     6.4.3. Getting all created sampler channel count
2488    
2489 senoner 542 The number of sampler channels can change on runtime. To get the
2490     current amount of sampler channels, the front-end can send the
2491     following command:
2492    
2493     GET CHANNELS
2494    
2495     Possible Answers:
2496    
2497     LinuxSampler will answer by returning the current number of
2498     sampler channels.
2499    
2500     Example:
2501    
2502     C: "GET CHANNELS"
2503 schoenebeck 708
2504 senoner 542 S: "12"
2505    
2506 schoenebeck 940 6.4.4. Getting all created sampler channel list
2507 schoenebeck 708
2508 senoner 542 The number of sampler channels can change on runtime. To get the
2509     current list of sampler channels, the front-end can send the
2510 schoenebeck 708 following command:
2511    
2512 senoner 542 LIST CHANNELS
2513    
2514     Possible Answers:
2515    
2516    
2517    
2518 schoenebeck 708
2519 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 45]
2520 schoenebeck 1363
2521 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2522 senoner 542
2523 schoenebeck 708
2524 schoenebeck 1363 LinuxSampler will answer by returning a comma separated list with
2525     all sampler channels numerical IDs.
2526 senoner 542
2527 schoenebeck 1363 Example:
2528 senoner 542
2529 schoenebeck 1363 C: "LIST CHANNELS"
2530 schoenebeck 940
2531 schoenebeck 1251 S: "0,1,2,3,4,5,6,9,10,11,15,20"
2532 schoenebeck 940
2533 schoenebeck 1251 6.4.5. Adding a new sampler channel
2534 schoenebeck 940
2535 schoenebeck 1251 A new sampler channel can be added to the end of the sampler channel
2536     list by sending the following command:
2537 schoenebeck 940
2538 schoenebeck 974 ADD CHANNEL
2539    
2540     This will increment the sampler channel count by one and the new
2541 senoner 542 sampler channel will be appended to the end of the sampler channel
2542     list. The front-end should send the respective, related commands
2543 schoenebeck 708 right after to e.g. load an engine, load an instrument and setting
2544 senoner 542 input, output method and eventually other commands to initialize the
2545     new channel. The front-end should use the sampler channel returned
2546     by the answer of this command to perform the previously recommended
2547 schoenebeck 708 commands, to avoid race conditions e.g. with other front-ends that
2548 senoner 542 might also have sent an "ADD CHANNEL" command.
2549    
2550     Possible Answers:
2551    
2552     "OK[<sampler-channel>]" -
2553 schoenebeck 708
2554     in case a new sampler channel could be added, where <sampler-
2555     channel> reflects the channel number of the new created sampler
2556     channel which should be used to set up the sampler channel by
2557     sending subsequent initialization commands
2558    
2559 senoner 542 "WRN:<warning-code>:<warning-message>" -
2560 schoenebeck 708
2561 senoner 542 in case a new channel was added successfully, but there are
2562     noteworthy issue(s) related, providing an appropriate warning
2563     code and warning message
2564 schoenebeck 708
2565 senoner 542 "ERR:<error-code>:<error-message>" -
2566 schoenebeck 708
2567 senoner 542 in case it failed, providing an appropriate error code and
2568     error message
2569    
2570     Example:
2571    
2572    
2573    
2574    
2575 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 46]
2576 schoenebeck 1363
2577 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2578 senoner 542
2579 schoenebeck 1251
2580    
2581    
2582 schoenebeck 1363 6.4.6. Removing a sampler channel
2583 schoenebeck 1251
2584 schoenebeck 1363 A sampler channel can be removed by sending the following command:
2585 schoenebeck 1251
2586 senoner 542 REMOVE CHANNEL <sampler-channel>
2587    
2588 schoenebeck 561 Where <sampler-channel> should be replaced by the number of the
2589 schoenebeck 575 sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
2590     "LIST CHANNELS" (Section 6.4.4) command. The channel numbers of all
2591 schoenebeck 561 subsequent sampler channels remain the same.
2592 senoner 542
2593     Possible Answers:
2594    
2595     "OK" -
2596 schoenebeck 708
2597 senoner 542 in case the given sampler channel could be removed
2598 schoenebeck 708
2599 senoner 542 "WRN:<warning-code>:<warning-message>" -
2600 schoenebeck 708
2601 senoner 542 in case the given channel was removed, but there are noteworthy
2602     issue(s) related, providing an appropriate warning code and
2603     warning message
2604 schoenebeck 708
2605 senoner 542 "ERR:<error-code>:<error-message>" -
2606 schoenebeck 708
2607 senoner 542 in case it failed, providing an appropriate error code and
2608     error message
2609    
2610     Example:
2611    
2612    
2613    
2614 schoenebeck 940 6.4.7. Getting amount of available engines
2615 schoenebeck 708
2616 senoner 542 The front-end can ask for the number of available engines by sending
2617     the following command:
2618    
2619     GET AVAILABLE_ENGINES
2620    
2621     Possible Answers:
2622    
2623     LinuxSampler will answer by sending the number of available
2624     engines.
2625    
2626     Example:
2627    
2628 schoenebeck 708
2629 senoner 542
2630 schoenebeck 708
2631 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 47]
2632 schoenebeck 1363
2633 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2634 senoner 542
2635    
2636 schoenebeck 1363 C: "GET AVAILABLE_ENGINES"
2637 senoner 542
2638 schoenebeck 1363 S: "4"
2639 schoenebeck 940
2640 schoenebeck 1251 6.4.8. Getting all available engines
2641 schoenebeck 940
2642 schoenebeck 1251 The front-end can ask for a list of all available engines by sending
2643     the following command:
2644 schoenebeck 940
2645 schoenebeck 1251 LIST AVAILABLE_ENGINES
2646 schoenebeck 940
2647 schoenebeck 1251 Possible Answers:
2648 schoenebeck 940
2649 schoenebeck 561 LinuxSampler will answer by sending a comma separated list of the
2650     engines' names encapsulated into apostrophes ('). Engine names
2651     can consist of lower and upper cases, digits and underlines ("_"
2652     character).
2653 senoner 542
2654     Example:
2655    
2656     C: "LIST AVAILABLE_ENGINES"
2657 schoenebeck 708
2658 schoenebeck 561 S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"
2659 senoner 542
2660 schoenebeck 940 6.4.9. Getting information about an engine
2661 schoenebeck 708
2662 senoner 542 The front-end can ask for information about a specific engine by
2663     sending the following command:
2664    
2665     GET ENGINE INFO <engine-name>
2666    
2667     Where <engine-name> is an engine name as obtained by the "LIST
2668 schoenebeck 575 AVAILABLE_ENGINES" (Section 6.4.8) command.
2669 senoner 542
2670 schoenebeck 561 Possible Answers:
2671    
2672 senoner 542 LinuxSampler will answer by sending a <CRLF> separated list. Each
2673     answer line begins with the information category name followed by
2674     a colon and then a space character <SP> and finally the info
2675     character string to that info category. At the moment the
2676     following categories are defined:
2677    
2678 schoenebeck 708
2679    
2680 senoner 542 DESCRIPTION -
2681 schoenebeck 708
2682 schoenebeck 1400 arbitrary description text about the engine (note that the
2683     character string may contain escape sequences (Section 7.1))
2684 schoenebeck 708
2685    
2686 senoner 542
2687 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 48]
2688 schoenebeck 1363
2689 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2690 senoner 542
2691 schoenebeck 708
2692 schoenebeck 1363 VERSION -
2693 schoenebeck 708
2694 schoenebeck 1363 arbitrary character string regarding the engine's version
2695 schoenebeck 940
2696 schoenebeck 1251 The mentioned fields above don't have to be in particular order.
2697 schoenebeck 940
2698 schoenebeck 1251 Example:
2699 schoenebeck 940
2700 schoenebeck 1251 C: "GET ENGINE INFO JoesCustomEngine"
2701 schoenebeck 940
2702 schoenebeck 1251 S: "DESCRIPTION: this is Joe's custom sampler engine"
2703 schoenebeck 940
2704 senoner 542 "VERSION: testing-1.0"
2705 schoenebeck 708
2706 senoner 542 "."
2707    
2708 schoenebeck 940 6.4.10. Getting sampler channel information
2709 senoner 542
2710     The front-end can ask for the current settings of a sampler channel
2711     by sending the following command:
2712    
2713     GET CHANNEL INFO <sampler-channel>
2714    
2715     Where <sampler-channel> is the sampler channel number the front-end
2716 schoenebeck 575 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2717     "LIST CHANNELS" (Section 6.4.4) command.
2718 senoner 542
2719     Possible Answers:
2720    
2721     LinuxSampler will answer by sending a <CRLF> separated list. Each
2722     answer line begins with the settings category name followed by a
2723     colon and then a space character <SP> and finally the info
2724     character string to that setting category. At the moment the
2725     following categories are defined:
2726    
2727 schoenebeck 708
2728    
2729 senoner 542 ENGINE_NAME -
2730 schoenebeck 708
2731 schoenebeck 575 name of the engine that is associated with the sampler
2732     channel, "NONE" if there's no engine associated yet for this
2733     sampler channel
2734 schoenebeck 708
2735 senoner 542 AUDIO_OUTPUT_DEVICE -
2736 schoenebeck 708
2737 senoner 542 numerical ID of the audio output device which is currently
2738     connected to this sampler channel to output the audio
2739     signal, "NONE" if there's no device connected to this
2740 schoenebeck 708
2741 schoenebeck 1251
2742    
2743 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 49]
2744 schoenebeck 1363
2745 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2746 schoenebeck 1251
2747    
2748 schoenebeck 1363 sampler channel
2749 schoenebeck 1251
2750 senoner 542 AUDIO_OUTPUT_CHANNELS -
2751 schoenebeck 708
2752 senoner 542 number of output channels the sampler channel offers
2753     (dependent to used sampler engine and loaded instrument)
2754 schoenebeck 708
2755 senoner 542 AUDIO_OUTPUT_ROUTING -
2756 schoenebeck 708
2757 senoner 542 comma separated list which reflects to which audio channel
2758     of the selected audio output device each sampler output
2759 schoenebeck 708 channel is routed to, e.g. "0,3" would mean the engine's
2760 senoner 542 output channel 0 is routed to channel 0 of the audio output
2761     device and the engine's output channel 1 is routed to the
2762     channel 3 of the audio output device
2763 schoenebeck 708
2764 senoner 542 INSTRUMENT_FILE -
2765 schoenebeck 708
2766 senoner 542 the file name of the loaded instrument, "NONE" if there's no
2767 schoenebeck 1400 instrument yet loaded for this sampler channel (note: since
2768     LSCP 1.2 this path may contain escape sequences
2769     (Section 7.1))
2770 schoenebeck 708
2771 senoner 542 INSTRUMENT_NR -
2772 schoenebeck 708
2773 senoner 542 the instrument index number of the loaded instrument
2774 schoenebeck 708
2775 senoner 542 INSTRUMENT_NAME -
2776 schoenebeck 708
2777 schoenebeck 1400 the instrument name of the loaded instrument (note: since
2778     LSCP 1.2 this character string may contain escape sequences
2779     (Section 7.1))
2780 schoenebeck 708
2781 senoner 542 INSTRUMENT_STATUS -
2782 schoenebeck 708
2783 senoner 542 integer values 0 to 100 indicating loading progress
2784     percentage for the instrument. Negative value indicates a
2785 schoenebeck 708 loading exception. Value of 100 indicates that the
2786     instrument is fully loaded.
2787 schoenebeck 575
2788 senoner 542 MIDI_INPUT_DEVICE -
2789 schoenebeck 708
2790 senoner 542 numerical ID of the MIDI input device which is currently
2791     connected to this sampler channel to deliver MIDI input
2792     commands, "NONE" if there's no device connected to this
2793     sampler channel
2794 schoenebeck 708
2795    
2796    
2797    
2798 schoenebeck 1251
2799 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 50]
2800 schoenebeck 1251
2801 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2802 schoenebeck 1251
2803    
2804 schoenebeck 1400 MIDI_INPUT_PORT -
2805    
2806     port number of the MIDI input device
2807    
2808 schoenebeck 1363 MIDI_INPUT_CHANNEL -
2809    
2810 senoner 542 the MIDI input channel number this sampler channel should
2811     listen to or "ALL" to listen on all MIDI channels
2812 schoenebeck 708
2813 senoner 542 VOLUME -
2814 schoenebeck 708
2815 senoner 542 optionally dotted number for the channel volume factor
2816     (where a value < 1.0 means attenuation and a value > 1.0
2817     means amplification)
2818    
2819 schoenebeck 708 MUTE -
2820    
2821     Determines whether the channel is muted, "true" if the
2822     channel is muted, "false" if the channel is not muted, and
2823     "MUTED_BY_SOLO" if the channel is muted because of the
2824     presence of a solo channel and will be unmuted when there
2825     are no solo channels left
2826    
2827     SOLO -
2828    
2829     Determines whether this is a solo channel, "true" if the
2830     channel is a solo channel; "false" otherwise
2831    
2832 schoenebeck 974 MIDI_INSTRUMENT_MAP -
2833    
2834     Determines to which MIDI instrument map this sampler channel
2835     is assigned to. Read chapter "SET CHANNEL
2836     MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible
2837     values.
2838    
2839 senoner 542 The mentioned fields above don't have to be in particular order.
2840    
2841     Example:
2842    
2843     C: "GET CHANNEL INFO 34"
2844 schoenebeck 708
2845 senoner 542 S: "ENGINE_NAME: GigEngine"
2846 schoenebeck 708
2847 senoner 542 "VOLUME: 1.0"
2848 schoenebeck 708
2849 senoner 542 "AUDIO_OUTPUT_DEVICE: 0"
2850 schoenebeck 708
2851    
2852    
2853    
2854 schoenebeck 1251
2855 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 51]
2856 schoenebeck 1251
2857 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2858 schoenebeck 1251
2859    
2860 schoenebeck 1400 "AUDIO_OUTPUT_CHANNELS: 2"
2861    
2862     "AUDIO_OUTPUT_ROUTING: 0,1"
2863    
2864 schoenebeck 1363 "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"
2865    
2866 senoner 542 "INSTRUMENT_NR: 0"
2867 schoenebeck 708
2868 senoner 542 "INSTRUMENT_NAME: Fazioli Piano"
2869 schoenebeck 708
2870 senoner 542 "INSTRUMENT_STATUS: 100"
2871 schoenebeck 708
2872 senoner 542 "MIDI_INPUT_DEVICE: 0"
2873 schoenebeck 708
2874 senoner 542 "MIDI_INPUT_PORT: 0"
2875 schoenebeck 708
2876 schoenebeck 974 "MIDI_INPUT_CHANNEL: 5"
2877 schoenebeck 940
2878 schoenebeck 974 "VOLUME: 1.0"
2879 schoenebeck 940
2880 schoenebeck 974 "MUTE: false"
2881 schoenebeck 940
2882 schoenebeck 974 "SOLO: false"
2883 schoenebeck 940
2884 schoenebeck 974 "MIDI_INSTRUMENT_MAP: NONE"
2885 schoenebeck 940
2886 schoenebeck 974 "."
2887    
2888 schoenebeck 940 6.4.11. Current number of active voices
2889    
2890 senoner 542 The front-end can ask for the current number of active voices on a
2891     sampler channel by sending the following command:
2892    
2893     GET CHANNEL VOICE_COUNT <sampler-channel>
2894    
2895     Where <sampler-channel> is the sampler channel number the front-end
2896 schoenebeck 575 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2897     "LIST CHANNELS" (Section 6.4.4) command.
2898 senoner 542
2899     Possible Answers:
2900    
2901     LinuxSampler will answer by returning the number of active voices
2902     on that channel.
2903    
2904     Example:
2905    
2906    
2907    
2908 schoenebeck 708
2909 senoner 542
2910 schoenebeck 1251
2911 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 52]
2912    
2913     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2914 schoenebeck 1251
2915    
2916    
2917 schoenebeck 1363
2918     6.4.12. Current number of active disk streams
2919    
2920     The front-end can ask for the current number of active disk streams
2921     on a sampler channel by sending the following command:
2922    
2923 senoner 542 GET CHANNEL STREAM_COUNT <sampler-channel>
2924    
2925     Where <sampler-channel> is the sampler channel number the front-end
2926 schoenebeck 575 is interested in as returned by the "ADD CHANNEL" (Section 6.4.5) or
2927     "LIST CHANNELS" (Section 6.4.4) command.
2928 senoner 542
2929     Possible Answers:
2930    
2931     LinuxSampler will answer by returning the number of active disk
2932     streams on that channel in case the engine supports disk
2933     streaming, if the engine doesn't support disk streaming it will
2934     return "NA" for not available.
2935    
2936     Example:
2937    
2938    
2939    
2940 schoenebeck 940 6.4.13. Current fill state of disk stream buffers
2941 schoenebeck 708
2942 senoner 542 The front-end can ask for the current fill state of all disk streams
2943     on a sampler channel by sending the following command:
2944    
2945     GET CHANNEL BUFFER_FILL BYTES <sampler-channel>
2946    
2947     to get the fill state in bytes or
2948    
2949     GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
2950    
2951     to get the fill state in percent, where <sampler-channel> is the
2952 schoenebeck 575 sampler channel number the front-end is interested in as returned by
2953     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
2954     command.
2955 senoner 542
2956     Possible Answers:
2957    
2958     LinuxSampler will either answer by returning a comma separated
2959     string with the fill state of all disk stream buffers on that
2960     channel or an empty line if there are no active disk streams or
2961     "NA" for *not available* in case the engine which is deployed
2962     doesn't support disk streaming. Each entry in the answer list
2963     will begin with the stream's ID in brackets followed by the
2964    
2965    
2966 schoenebeck 1251
2967 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 53]
2968 schoenebeck 1363
2969 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
2970 schoenebeck 1251
2971    
2972 schoenebeck 1400 numerical representation of the fill size (either in bytes or
2973     percentage). Note: due to efficiency reasons the fill states in
2974 schoenebeck 1363 the response are not in particular order, thus the front-end has
2975     to sort them by itself if necessary.
2976 schoenebeck 1251
2977 schoenebeck 1363 Examples:
2978 schoenebeck 1251
2979 senoner 542 C: "GET CHANNEL BUFFER_FILL BYTES 4"
2980 schoenebeck 708
2981 senoner 542 S: "[115]420500,[116]510300,[75]110000,[120]230700"
2982 schoenebeck 708
2983 senoner 542 C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2984 schoenebeck 708
2985 senoner 542 S: "[115]90%,[116]98%,[75]40%,[120]62%"
2986 schoenebeck 708
2987 senoner 542 C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
2988 schoenebeck 708
2989 senoner 542 S: ""
2990    
2991 schoenebeck 940 6.4.14. Setting audio output device
2992 schoenebeck 708
2993 senoner 542 The front-end can set the audio output device on a specific sampler
2994     channel by sending the following command:
2995    
2996     SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel>
2997     <audio-device-id>
2998    
2999 schoenebeck 575 Where <sampler-channel> is the respective sampler channel number as
3000     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3001     (Section 6.4.4) command and <audio-device-id> is the numerical ID of
3002     the audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE"
3003     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
3004     command.
3005 senoner 542
3006     Possible Answers:
3007    
3008     "OK" -
3009 schoenebeck 708
3010 senoner 542 on success
3011 schoenebeck 708
3012 senoner 542 "WRN:<warning-code>:<warning-message>" -
3013 schoenebeck 708
3014 senoner 542 if audio output device was set, but there are noteworthy
3015     issue(s) related, providing an appropriate warning code and
3016     warning message
3017 schoenebeck 708
3018    
3019 senoner 542
3020    
3021    
3022 schoenebeck 1400
3023     Schoenebeck Expires April 13, 2008 [Page 54]
3024 schoenebeck 1363
3025 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3026 senoner 542
3027 schoenebeck 1251
3028 schoenebeck 1400 "ERR:<error-code>:<error-message>" -
3029    
3030     in case it failed, providing an appropriate error code and
3031     error message
3032    
3033 schoenebeck 1363 Examples:
3034 schoenebeck 1251
3035    
3036    
3037 schoenebeck 940 6.4.15. Setting audio output type
3038 senoner 542
3039     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3040    
3041     The front-end can alter the audio output type on a specific sampler
3042     channel by sending the following command:
3043    
3044 schoenebeck 708 SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3045     type>
3046 senoner 542
3047     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3048     <sampler-channel> is the respective sampler channel number.
3049    
3050     Possible Answers:
3051    
3052     "OK" -
3053 schoenebeck 708
3054 senoner 542 on success
3055 schoenebeck 708
3056 senoner 542 "WRN:<warning-code>:<warning-message>" -
3057 schoenebeck 708
3058 senoner 542 if audio output type was set, but there are noteworthy issue(s)
3059     related, providing an appropriate warning code and warning
3060     message
3061 schoenebeck 708
3062 senoner 542 "ERR:<error-code>:<error-message>" -
3063 schoenebeck 708
3064 senoner 542 in case it failed, providing an appropriate error code and
3065     error message
3066    
3067     Examples:
3068    
3069    
3070    
3071 schoenebeck 940 6.4.16. Setting audio output channel
3072 schoenebeck 708
3073 schoenebeck 575 The front-end can alter the audio output channel on a specific
3074     sampler channel by sending the following command:
3075 senoner 542
3076    
3077 schoenebeck 1251
3078    
3079 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 55]
3080 schoenebeck 1251
3081 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3082 schoenebeck 1251
3083    
3084 schoenebeck 1400 SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out>
3085     <audio-in>
3086    
3087     Where <sampler-chan> is the sampler channel number as returned by the
3088     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3089 schoenebeck 1363 command, <audio-out> is the numerical ID of the sampler channel's
3090     audio output channel which should be rerouted and <audio-in> is the
3091 schoenebeck 575 numerical ID of the audio channel of the selected audio output device
3092     where <audio-out> should be routed to.
3093 senoner 542
3094 schoenebeck 575 Possible Answers:
3095 senoner 542
3096 schoenebeck 708 "OK" -
3097 senoner 542
3098 schoenebeck 708 on success
3099 senoner 542
3100 schoenebeck 708 "WRN:<warning-code>:<warning-message>" -
3101 senoner 542
3102     if audio output channel was set, but there are noteworthy
3103     issue(s) related, providing an appropriate warning code and
3104     warning message
3105 schoenebeck 708
3106 senoner 542 "ERR:<error-code>:<error-message>" -
3107 schoenebeck 708
3108 senoner 542 in case it failed, providing an appropriate error code and
3109     error message
3110    
3111     Examples:
3112    
3113    
3114    
3115 schoenebeck 940 6.4.17. Setting MIDI input device
3116    
3117 senoner 542 The front-end can set the MIDI input device on a specific sampler
3118     channel by sending the following command:
3119    
3120     SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id>
3121    
3122 schoenebeck 575 Where <sampler-channel> is the sampler channel number as returned by
3123     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3124 schoenebeck 940 command and <midi-device-id> is the numerical ID of the MIDI input
3125 schoenebeck 575 device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3126     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3127 senoner 542
3128     Possible Answers:
3129    
3130 schoenebeck 708
3131    
3132    
3133    
3134 schoenebeck 1251
3135 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 56]
3136 schoenebeck 1251
3137 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3138 schoenebeck 1251
3139    
3140 schoenebeck 1400 "OK" -
3141    
3142     on success
3143    
3144     "WRN:<warning-code>:<warning-message>" -
3145    
3146 schoenebeck 1363 if MIDI input device was set, but there are noteworthy issue(s)
3147     related, providing an appropriate warning code and warning
3148     message
3149    
3150 senoner 542 "ERR:<error-code>:<error-message>" -
3151 schoenebeck 708
3152 senoner 542 in case it failed, providing an appropriate error code and
3153     error message
3154    
3155     Examples:
3156    
3157    
3158    
3159 schoenebeck 940 6.4.18. Setting MIDI input type
3160 schoenebeck 708
3161 senoner 542 DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!
3162    
3163     The front-end can alter the MIDI input type on a specific sampler
3164     channel by sending the following command:
3165    
3166     SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
3167    
3168 schoenebeck 708 Where <midi-input-type> is currently only "ALSA" and <sampler-
3169     channel> is the respective sampler channel number.
3170 senoner 542
3171     Possible Answers:
3172    
3173     "OK" -
3174 schoenebeck 708
3175 senoner 542 on success
3176 schoenebeck 708
3177 senoner 542 "WRN:<warning-code>:<warning-message>" -
3178 schoenebeck 708
3179 senoner 542 if MIDI input type was set, but there are noteworthy issue(s)
3180     related, providing an appropriate warning code and warning
3181     message
3182 schoenebeck 708
3183 senoner 542 "ERR:<error-code>:<error-message>" -
3184 schoenebeck 708
3185 senoner 542 in case it failed, providing an appropriate error code and
3186     error message
3187    
3188    
3189    
3190    
3191 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 57]
3192    
3193     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3194 schoenebeck 708
3195 senoner 542
3196 schoenebeck 1400 Examples:
3197 senoner 542
3198    
3199    
3200 schoenebeck 1363 6.4.19. Setting MIDI input port
3201    
3202     The front-end can alter the MIDI input port on a specific sampler
3203     channel by sending the following command:
3204    
3205 schoenebeck 1251 SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
3206 schoenebeck 974
3207 schoenebeck 1251 Where <midi-input-port> is a MIDI input port number of the MIDI input
3208     device connected to the sampler channel given by <sampler-channel>.
3209 schoenebeck 974
3210 schoenebeck 1251 Possible Answers:
3211 schoenebeck 974
3212 schoenebeck 1251 "OK" -
3213 schoenebeck 974
3214 senoner 542 on success
3215 schoenebeck 708
3216 senoner 542 "WRN:<warning-code>:<warning-message>" -
3217 schoenebeck 708
3218 senoner 542 if MIDI input port was set, but there are noteworthy issue(s)
3219     related, providing an appropriate warning code and warning
3220     message
3221 schoenebeck 708
3222 senoner 542 "ERR:<error-code>:<error-message>" -
3223 schoenebeck 708
3224 senoner 542 in case it failed, providing an appropriate error code and
3225 schoenebeck 561 error message
3226 senoner 542
3227     Examples:
3228    
3229    
3230    
3231 schoenebeck 940 6.4.20. Setting MIDI input channel
3232 senoner 542
3233     The front-end can alter the MIDI channel a sampler channel should
3234     listen to by sending the following command:
3235    
3236     SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3237    
3238     Where <midi-input-chan> is the number of the new MIDI input channel
3239     where <sampler-channel> should listen to or "ALL" to listen on all 16
3240     MIDI channels.
3241    
3242     Possible Answers:
3243    
3244 schoenebeck 708
3245    
3246 schoenebeck 1363
3247 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 58]
3248 schoenebeck 1363
3249 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3250 schoenebeck 1363
3251    
3252 schoenebeck 1400 "OK" -
3253    
3254     on success
3255    
3256 senoner 542 "WRN:<warning-code>:<warning-message>" -
3257 schoenebeck 708
3258 senoner 542 if MIDI input channel was set, but there are noteworthy
3259     issue(s) related, providing an appropriate warning code and
3260     warning message
3261 schoenebeck 708
3262 senoner 542 "ERR:<error-code>:<error-message>" -
3263 schoenebeck 708
3264 senoner 542 in case it failed, providing an appropriate error code and
3265     error message
3266    
3267     Examples:
3268    
3269    
3270    
3271 schoenebeck 940 6.4.21. Setting channel volume
3272 schoenebeck 708
3273 senoner 542 The front-end can alter the volume of a sampler channel by sending
3274     the following command:
3275    
3276     SET CHANNEL VOLUME <sampler-channel> <volume>
3277    
3278     Where <volume> is an optionally dotted positive number (a value
3279     smaller than 1.0 means attenuation, whereas a value greater than 1.0
3280     means amplification) and <sampler-channel> defines the sampler
3281     channel where this volume factor should be set.
3282    
3283     Possible Answers:
3284    
3285     "OK" -
3286 schoenebeck 708
3287 senoner 542 on success
3288 schoenebeck 708
3289 senoner 542 "WRN:<warning-code>:<warning-message>" -
3290 schoenebeck 708
3291 senoner 542 if channel volume was set, but there are noteworthy issue(s)
3292     related, providing an appropriate warning code and warning
3293 schoenebeck 708 message
3294 schoenebeck 575
3295 schoenebeck 708 "ERR:<error-code>:<error-message>" -
3296 schoenebeck 575
3297 schoenebeck 708 in case it failed, providing an appropriate error code and
3298     error message
3299 schoenebeck 575
3300 schoenebeck 708
3301    
3302    
3303 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 59]
3304 schoenebeck 1363
3305 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3306 schoenebeck 1251
3307    
3308 schoenebeck 1400 Examples:
3309 schoenebeck 1251
3310    
3311 schoenebeck 1400
3312 schoenebeck 1363 6.4.22. Muting a sampler channel
3313 schoenebeck 1251
3314 schoenebeck 1363 The front-end can mute/unmute a specific sampler channel by sending
3315     the following command:
3316    
3317 schoenebeck 708 SET CHANNEL MUTE <sampler-channel> <mute>
3318    
3319     Where <sampler-channel> is the respective sampler channel number as
3320     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3321     (Section 6.4.4) command and <mute> should be replaced either by "1"
3322     to mute the channel or "0" to unmute the channel.
3323    
3324     Possible Answers:
3325    
3326     "OK" -
3327    
3328     on success
3329    
3330     "WRN:<warning-code>:<warning-message>" -
3331    
3332     if the channel was muted/unmuted, but there are noteworthy
3333     issue(s) related, providing an appropriate warning code and
3334     warning message
3335    
3336 senoner 542 "ERR:<error-code>:<error-message>" -
3337 schoenebeck 708
3338 senoner 542 in case it failed, providing an appropriate error code and
3339     error message
3340    
3341     Examples:
3342    
3343    
3344    
3345 schoenebeck 940 6.4.23. Soloing a sampler channel
3346 senoner 542
3347 schoenebeck 708 The front-end can solo/unsolo a specific sampler channel by sending
3348     the following command:
3349    
3350     SET CHANNEL SOLO <sampler-channel> <solo>
3351    
3352     Where <sampler-channel> is the respective sampler channel number as
3353     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3354     (Section 6.4.4) command and <solo> should be replaced either by "1"
3355     to solo the channel or "0" to unsolo the channel.
3356    
3357    
3358    
3359 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 60]
3360 schoenebeck 1363
3361 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3362 schoenebeck 1251
3363    
3364 schoenebeck 1400 Possible Answers:
3365    
3366 schoenebeck 1363 "OK" -
3367 schoenebeck 1251
3368 schoenebeck 1363 on success
3369 schoenebeck 1251
3370 schoenebeck 708 "WRN:<warning-code>:<warning-message>" -
3371    
3372     if the channel was soloed/unsoloed, but there are noteworthy
3373     issue(s) related, providing an appropriate warning code and
3374     warning message
3375    
3376     "ERR:<error-code>:<error-message>" -
3377    
3378     in case it failed, providing an appropriate error code and
3379     error message
3380    
3381     Examples:
3382    
3383    
3384    
3385 schoenebeck 974 6.4.24. Assigning a MIDI instrument map to a sampler channel
3386 schoenebeck 708
3387 schoenebeck 974 The front-end can assign a MIDI instrument map to a specific sampler
3388     channel by sending the following command:
3389 senoner 542
3390 schoenebeck 974 SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <map>
3391 senoner 542
3392 schoenebeck 974 Where <sampler-channel> is the respective sampler channel number as
3393     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3394     (Section 6.4.4) command and <map> can have the following
3395     possibilites:
3396 schoenebeck 940
3397 schoenebeck 974 "NONE" -
3398 schoenebeck 940
3399 schoenebeck 974 This is the default setting. In this case the sampler channel
3400     is not assigned any MIDI instrument map and thus will ignore
3401     all MIDI program change messages.
3402 schoenebeck 940
3403 schoenebeck 974 "DEFAULT" -
3404    
3405     The sampler channel will always use the default MIDI instrument
3406     map to handle MIDI program change messages.
3407    
3408     numeric ID -
3409    
3410     You can assign a specific MIDI instrument map by replacing
3411     <map> with the respective numeric ID of the MIDI instrument map
3412    
3413    
3414 schoenebeck 1251
3415 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 61]
3416 schoenebeck 1251
3417 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3418 schoenebeck 1251
3419    
3420 schoenebeck 1400 as returned by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4)
3421     command. Once that map will be deleted, the sampler channel
3422 schoenebeck 1363 would fall back to "NONE".
3423    
3424     Read chapter "MIDI Instrument Mapping" (Section 6.7) for details
3425     regarding MIDI instrument mapping.
3426    
3427 schoenebeck 974 Possible Answers:
3428    
3429     "OK" -
3430    
3431     on success
3432    
3433     "ERR:<error-code>:<error-message>" -
3434    
3435     in case it failed, providing an appropriate error code and
3436     error message
3437    
3438     Examples:
3439    
3440    
3441    
3442 schoenebeck 1002 6.4.25. Adding an effect send to a sampler channel
3443 schoenebeck 974
3444 schoenebeck 1002 The front-end can create an additional effect send on a specific
3445     sampler channel by sending the following command:
3446    
3447     CREATE FX_SEND <sampler-channel> <midi-ctrl> [<name>]
3448    
3449     Where <sampler-channel> is the respective sampler channel number as
3450     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3451     (Section 6.4.4) command, that is the sampler channel on which the
3452     effect send should be created on, <midi-ctrl> is a number between
3453     0..127 defining the MIDI controller which can alter the effect send
3454     level and <name> is an optional argument defining a name for the
3455 schoenebeck 1390 effect send entity. The name does not have to be unique, but MUST be
3456     encapsulated into apostrophes and supports escape sequences as
3457     described in chapter "Character Set and Escape Sequences
3458     (Section 7.1)".
3459 schoenebeck 1002
3460     By default, that is as initial routing, the effect send's audio
3461     channels are automatically routed to the last audio channels of the
3462     sampler channel's audio output device, that way you can i.e. first
3463     increase the amount of audio channels on the audio output device for
3464     having dedicated effect send output channels and when "CREATE
3465     FX_SEND" is called, those channels will automatically be picked. You
3466     can alter the destination channels however with "SET FX_SEND
3467 iliev 1137 AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).
3468 schoenebeck 1002
3469 schoenebeck 1363
3470    
3471 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 62]
3472 schoenebeck 1363
3473 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3474 schoenebeck 1363
3475    
3476 schoenebeck 1400 Note: Create effect sends on a sampler channel only when needed,
3477 schoenebeck 1390 because having effect sends on a sampler channel will decrease
3478     runtime performance, because for implementing channel effect sends,
3479     separate (sampler channel local) audio buffers are needed to render
3480 schoenebeck 1002 and mix the voices and route the audio signal afterwards to the
3481     master outputs and effect send outputs (along with their respective
3482     effect send levels). A sampler channel without effect sends however
3483     can mix its voices directly into the audio output devices's audio
3484     buffers and is thus faster.
3485    
3486     Possible Answers:
3487    
3488     "OK[<fx-send-id>]" -
3489    
3490     in case a new effect send could be added to the sampler
3491     channel, where <fx-send-id> reflects the unique ID of the newly
3492     created effect send entity
3493    
3494     "ERR:<error-code>:<error-message>" -
3495    
3496     when a new effect send could not be added, i.e. due to invalid
3497     parameters
3498    
3499     Examples:
3500    
3501     C: "CREATE FX_SEND 0 91 'Reverb Send'"
3502    
3503     S: "OK[0]"
3504    
3505     C: "CREATE FX_SEND 0 93"
3506    
3507     S: "OK[1]"
3508    
3509     6.4.26. Removing an effect send from a sampler channel
3510    
3511     The front-end can remove an existing effect send on a specific
3512     sampler channel by sending the following command:
3513    
3514     DESTROY FX_SEND <sampler-channel> <fx-send-id>
3515    
3516     Where <sampler-channel> is the respective sampler channel number as
3517     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3518     (Section 6.4.4) command, that is the sampler channel from which the
3519     effect send should be removed from and <fx-send-id> is the respective
3520     effect send number as returned by the "CREATE FX_SEND"
3521     (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.
3522    
3523     Possible Answers:
3524    
3525    
3526    
3527 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 63]
3528 schoenebeck 1390
3529     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3530 schoenebeck 1002
3531    
3532 schoenebeck 1390 "OK" -
3533 schoenebeck 1002
3534 schoenebeck 1363 on success
3535 schoenebeck 1002
3536 schoenebeck 1363 "ERR:<error-code>:<error-message>" -
3537 schoenebeck 1002
3538 schoenebeck 1363 in case it failed, providing an appropriate error code and
3539     error message
3540    
3541 schoenebeck 1251 Example:
3542 schoenebeck 1002
3543 schoenebeck 1251 C: "DESTROY FX_SEND 0 0"
3544 schoenebeck 1002
3545 schoenebeck 1251 S: "OK"
3546 schoenebeck 1002
3547     6.4.27. Getting amount of effect sends on a sampler channel
3548    
3549     The front-end can ask for the amount of effect sends on a specific
3550     sampler channel by sending the following command:
3551    
3552     GET FX_SENDS <sampler-channel>
3553    
3554     Where <sampler-channel> is the respective sampler channel number as
3555     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3556     (Section 6.4.4) command.
3557    
3558     Possible Answers:
3559    
3560     The sampler will answer by returning the number of effect sends on
3561     the given sampler channel.
3562    
3563     Example:
3564    
3565     C: "GET FX_SENDS 0"
3566    
3567     S: "2"
3568    
3569     6.4.28. Listing all effect sends on a sampler channel
3570    
3571     The front-end can ask for a list of effect sends on a specific
3572     sampler channel by sending the following command:
3573    
3574     LIST FX_SENDS <sampler-channel>
3575    
3576     Where <sampler-channel> is the respective sampler channel number as
3577     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3578     (Section 6.4.4) command.
3579    
3580    
3581    
3582    
3583 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 64]
3584 schoenebeck 1363
3585 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3586 schoenebeck 1002
3587    
3588 schoenebeck 1390 Possible Answers:
3589    
3590 schoenebeck 1363 The sampler will answer by returning a comma separated list with
3591     all effect sends' numerical IDs on the given sampler channel.
3592 schoenebeck 1002
3593 schoenebeck 1363 Examples:
3594 schoenebeck 1002
3595 schoenebeck 1251 C: "LIST FX_SENDS 0"
3596 schoenebeck 1002
3597 schoenebeck 1251 S: "0,1"
3598 schoenebeck 1002
3599 schoenebeck 1251 C: "LIST FX_SENDS 1"
3600    
3601     S: ""
3602    
3603 schoenebeck 1002 6.4.29. Getting effect send information
3604    
3605     The front-end can ask for the current settings of an effect send
3606     entity by sending the following command:
3607    
3608     GET FX_SEND INFO <sampler-channel> <fx-send-id>
3609    
3610     Where <sampler-channel> is the sampler channel number as returned by
3611     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3612     command and <fx-send-id> reflects the numerical ID of the effect send
3613     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3614     FX_SENDS" (Section 6.4.28) command.
3615    
3616     Possible Answers:
3617    
3618     The sampler will answer by sending a <CRLF> separated list. Each
3619     answer line begins with the settings category name followed by a
3620     colon and then a space character <SP> and finally the info
3621     character string to that setting category. At the moment the
3622     following categories are defined:
3623    
3624    
3625    
3626     NAME -
3627    
3628 schoenebeck 1400 name of the effect send entity (note that this character
3629     string may contain escape sequences (Section 7.1))
3630 schoenebeck 1002
3631 schoenebeck 1028 MIDI_CONTROLLER -
3632    
3633     a value between 0 and 127 reflecting the MIDI controller
3634     which is able to modify the effect send's send level
3635    
3636    
3637    
3638 schoenebeck 1251
3639 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 65]
3640 schoenebeck 1363
3641 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3642 schoenebeck 1251
3643    
3644 schoenebeck 1390 LEVEL -
3645    
3646 schoenebeck 1363 optionally dotted number reflecting the effect send's
3647     current send level (where a value < 1.0 means attenuation
3648     and a value > 1.0 means amplification)
3649 schoenebeck 1251
3650 schoenebeck 1002 AUDIO_OUTPUT_ROUTING -
3651    
3652     comma separated list which reflects to which audio channel
3653     of the selected audio output device each effect send output
3654     channel is routed to, e.g. "0,3" would mean the effect
3655     send's output channel 0 is routed to channel 0 of the audio
3656     output device and the effect send's output channel 1 is
3657     routed to the channel 3 of the audio output device (see "SET
3658 iliev 1137 FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details)
3659 schoenebeck 1002
3660     The mentioned fields above don't have to be in particular order.
3661    
3662     Example:
3663    
3664     C: "GET FX_SEND INFO 0 0"
3665    
3666     S: "NAME: Reverb Send"
3667    
3668 schoenebeck 1028 "MIDI_CONTROLLER: 91"
3669 schoenebeck 1002
3670 schoenebeck 1028 "LEVEL: 0.3"
3671 schoenebeck 1002
3672 schoenebeck 1028 "AUDIO_OUTPUT_ROUTING: 2,3"
3673 schoenebeck 1002
3674     "."
3675    
3676 iliev 1137 6.4.30. Changing effect send's name
3677 schoenebeck 1002
3678 iliev 1137 The front-end can alter the current name of an effect send entity by
3679     sending the following command:
3680    
3681     SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
3682    
3683     Where <sampler-chan> is the sampler channel number as returned by the
3684     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3685     command, <fx-send-id> reflects the numerical ID of the effect send
3686     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3687     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the
3688 schoenebeck 1390 effect send entity, which does not have to be unique (name MUST be
3689     encapsulated into apostrophes and supports escape sequences as
3690     described in chapter "Character Set and Escape Sequences
3691     (Section 7.1)").
3692 iliev 1137
3693    
3694    
3695 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 66]
3696 schoenebeck 1390
3697     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3698 iliev 1137
3699 schoenebeck 1251
3700 schoenebeck 1390 Possible Answers:
3701 schoenebeck 1251
3702 schoenebeck 1363 "OK" -
3703 schoenebeck 1251
3704 schoenebeck 1363 on success
3705 schoenebeck 1251
3706 iliev 1137 "ERR:<error-code>:<error-message>" -
3707    
3708     in case it failed, providing an appropriate error code and
3709     error message
3710    
3711     Example:
3712    
3713     C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
3714    
3715     S: "OK"
3716    
3717     6.4.31. Altering effect send's audio routing
3718    
3719 schoenebeck 1002 The front-end can alter the destination of an effect send's audio
3720     channel on a specific sampler channel by sending the following
3721     command:
3722    
3723     SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
3724     <audio-src> <audio-dst>
3725    
3726     Where <sampler-chan> is the sampler channel number as returned by the
3727     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3728     command, <fx-send-id> reflects the numerical ID of the effect send
3729     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3730     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID
3731     of the effect send's audio channel which should be rerouted and
3732     <audio-dst> is the numerical ID of the audio channel of the selected
3733     audio output device where <audio-src> should be routed to.
3734    
3735     Note that effect sends can only route audio to the same audio output
3736     device as assigned to the effect send's sampler channel. Also note
3737     that an effect send entity does always have exactly as much audio
3738     channels as its sampler channel. So if the sampler channel is
3739     stereo, the effect send does have two audio channels as well. Also
3740     keep in mind that the amount of audio channels on a sampler channel
3741     might be dependant not only to the deployed sampler engine on the
3742     sampler channel, but also dependant to the instrument currently
3743     loaded. However you can (effectively) turn an i.e. stereo effect
3744     send into a mono one by simply altering its audio routing
3745     appropriately.
3746    
3747     Possible Answers:
3748    
3749    
3750    
3751 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 67]
3752 schoenebeck 1363
3753 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3754 schoenebeck 1251
3755    
3756 schoenebeck 1363 "OK" -
3757 schoenebeck 1251
3758 schoenebeck 1363 on success
3759 schoenebeck 1251
3760 schoenebeck 1002 "WRN:<warning-code>:<warning-message>" -
3761    
3762     if audio output channel was set, but there are noteworthy
3763     issue(s) related, providing an appropriate warning code and
3764     warning message
3765    
3766     "ERR:<error-code>:<error-message>" -
3767    
3768     in case it failed, providing an appropriate error code and
3769     error message
3770    
3771 schoenebeck 1028 Example:
3772 schoenebeck 1002
3773 schoenebeck 1028 C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"
3774 schoenebeck 1002
3775 schoenebeck 1028 S: "OK"
3776    
3777 iliev 1137 6.4.32. Altering effect send's MIDI controller
3778 schoenebeck 1028
3779     The front-end can alter the MIDI controller of an effect send entity
3780     by sending the following command:
3781    
3782     SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-
3783     ctrl>
3784    
3785     Where <sampler-chan> is the sampler channel number as returned by the
3786     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3787     command, <fx-send-id> reflects the numerical ID of the effect send
3788     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3789     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI
3790     controller which shall be able to modify the effect send's send
3791     level.
3792    
3793     Possible Answers:
3794    
3795     "OK" -
3796    
3797     on success
3798    
3799     "WRN:<warning-code>:<warning-message>" -
3800    
3801     if MIDI controller was set, but there are noteworthy issue(s)
3802     related, providing an appropriate warning code and warning
3803     message
3804    
3805    
3806 schoenebeck 1251
3807 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 68]
3808 schoenebeck 1363
3809 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3810 schoenebeck 1251
3811    
3812 schoenebeck 1363 "ERR:<error-code>:<error-message>" -
3813 schoenebeck 1251
3814 schoenebeck 1028 in case it failed, providing an appropriate error code and
3815     error message
3816    
3817 schoenebeck 1002 Example:
3818    
3819 schoenebeck 1028 C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"
3820 schoenebeck 1002
3821     S: "OK"
3822    
3823 iliev 1137 6.4.33. Altering effect send's send level
3824 schoenebeck 1002
3825 schoenebeck 1028 The front-end can alter the current send level of an effect send
3826     entity by sending the following command:
3827    
3828     SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume>
3829    
3830     Where <sampler-chan> is the sampler channel number as returned by the
3831     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3832     command, <fx-send-id> reflects the numerical ID of the effect send
3833     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST
3834     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally
3835     dotted positive number (a value smaller than 1.0 means attenuation,
3836     whereas a value greater than 1.0 means amplification) reflecting the
3837     new send level.
3838    
3839     Possible Answers:
3840    
3841     "OK" -
3842    
3843     on success
3844    
3845     "WRN:<warning-code>:<warning-message>" -
3846    
3847     if new send level was set, but there are noteworthy issue(s)
3848     related, providing an appropriate warning code and warning
3849     message
3850    
3851     "ERR:<error-code>:<error-message>" -
3852    
3853     in case it failed, providing an appropriate error code and
3854     error message
3855    
3856     Example:
3857    
3858    
3859    
3860 schoenebeck 1251
3861    
3862    
3863 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 69]
3864 schoenebeck 1251
3865 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3866 schoenebeck 1251
3867    
3868 schoenebeck 1363 C: "SET FX_SEND LEVEL 0 0 0.15"
3869    
3870     S: "OK"
3871    
3872 iliev 1137 6.4.34. Resetting a sampler channel
3873 schoenebeck 1028
3874 schoenebeck 974 The front-end can reset a particular sampler channel by sending the
3875     following command:
3876    
3877     RESET CHANNEL <sampler-channel>
3878    
3879     Where <sampler-channel> defines the sampler channel to be reset.
3880 senoner 542 This will cause the engine on that sampler channel, its voices and
3881     eventually disk streams and all control and status variables to be
3882     reset.
3883    
3884     Possible Answers:
3885    
3886     "OK" -
3887 schoenebeck 708
3888 senoner 542 on success
3889 schoenebeck 708
3890 senoner 542 "WRN:<warning-code>:<warning-message>" -
3891 schoenebeck 708
3892 senoner 542 if channel was reset, but there are noteworthy issue(s)
3893     related, providing an appropriate warning code and warning
3894     message
3895 schoenebeck 708
3896 senoner 542 "ERR:<error-code>:<error-message>" -
3897 schoenebeck 708
3898 senoner 542 in case it failed, providing an appropriate error code and
3899     error message
3900    
3901     Examples:
3902    
3903    
3904    
3905 schoenebeck 940 6.5. Controlling connection
3906 schoenebeck 708
3907 schoenebeck 575 The following commands are used to control the connection to
3908     LinuxSampler.
3909 senoner 542
3910 schoenebeck 940 6.5.1. Register front-end for receiving event messages
3911 senoner 542
3912 schoenebeck 575 The front-end can register itself to the LinuxSampler application to
3913     be informed about noteworthy events by sending this command:
3914 senoner 542
3915    
3916    
3917 schoenebeck 1251
3918    
3919 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 70]
3920 schoenebeck 1251
3921 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3922 schoenebeck 1251
3923    
3924 schoenebeck 1363 SUBSCRIBE <event-id>
3925    
3926     where <event-id> will be replaced by the respective event that client
3927     wants to subscribe to.
3928    
3929 senoner 542 Possible Answers:
3930    
3931     "OK" -
3932 schoenebeck 708
3933 senoner 542 on success
3934 schoenebeck 708
3935 senoner 542 "WRN:<warning-code>:<warning-message>" -
3936 schoenebeck 708
3937 senoner 542 if registration succeeded, but there are noteworthy issue(s)
3938     related, providing an appropriate warning code and warning
3939     message
3940 schoenebeck 708
3941 senoner 542 "ERR:<error-code>:<error-message>" -
3942 schoenebeck 708
3943 senoner 542 in case it failed, providing an appropriate error code and
3944     error message
3945    
3946     Examples:
3947    
3948    
3949    
3950 schoenebeck 940 6.5.2. Unregister front-end for not receiving event messages
3951 schoenebeck 708
3952 senoner 542 The front-end can unregister itself if it doesn't want to receive
3953     event messages anymore by sending the following command:
3954    
3955     UNSUBSCRIBE <event-id>
3956    
3957     Where <event-id> will be replaced by the respective event that client
3958     doesn't want to receive anymore.
3959    
3960     Possible Answers:
3961    
3962     "OK" -
3963 schoenebeck 708
3964 senoner 542 on success
3965 schoenebeck 708
3966 senoner 542 "WRN:<warning-code>:<warning-message>" -
3967 schoenebeck 708
3968 senoner 542 if unregistration succeeded, but there are noteworthy issue(s)
3969     related, providing an appropriate warning code and warning
3970     message
3971 schoenebeck 708
3972 senoner 542
3973 schoenebeck 575
3974 schoenebeck 1251
3975 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 71]
3976 schoenebeck 1363
3977 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
3978 schoenebeck 1251
3979    
3980 schoenebeck 1363 "ERR:<error-code>:<error-message>" -
3981 schoenebeck 1251
3982 schoenebeck 1363 in case it failed, providing an appropriate error code and
3983     error message
3984 schoenebeck 1251
3985 schoenebeck 974 Examples:
3986 schoenebeck 940
3987    
3988    
3989     6.5.3. Enable or disable echo of commands
3990    
3991 senoner 542 To enable or disable back sending of commands to the client the
3992     following command can be used:
3993    
3994     SET ECHO <value>
3995    
3996     Where <value> should be replaced either by "1" to enable echo mode or
3997     "0" to disable echo mode. When echo mode is enabled, all commands
3998     send to LinuxSampler will be immediately send back and after this
3999     echo the actual response to the command will be returned. Echo mode
4000     will only be altered for the client connection that issued the "SET
4001     ECHO" command, not globally for all client connections.
4002    
4003     Possible Answers:
4004    
4005     "OK" -
4006 schoenebeck 708
4007 senoner 542 usually
4008 schoenebeck 708
4009 senoner 542 "ERR:<error-code>:<error-message>" -
4010    
4011 schoenebeck 708 on syntax error, e.g. non boolean value
4012    
4013 senoner 542 Examples:
4014    
4015    
4016    
4017 schoenebeck 940 6.5.4. Close client connection
4018 schoenebeck 708
4019 senoner 542 The client can close its network connection to LinuxSampler by
4020     sending the following command:
4021    
4022     QUIT
4023    
4024     This is probably more interesting for manual telnet connections to
4025     LinuxSampler than really useful for a front-end implementation.
4026    
4027 schoenebeck 940
4028    
4029 schoenebeck 1251
4030    
4031 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 72]
4032 schoenebeck 1363
4033 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4034 schoenebeck 1251
4035    
4036 schoenebeck 1363 6.6. Global commands
4037 schoenebeck 1251
4038 schoenebeck 1363 The following commands have global impact on the sampler.
4039 schoenebeck 1251
4040 schoenebeck 974 6.6.1. Current number of active voices
4041 schoenebeck 940
4042 schoenebeck 974 The front-end can ask for the current number of active voices on the
4043     sampler by sending the following command:
4044 schoenebeck 940
4045     GET TOTAL_VOICE_COUNT
4046    
4047     Possible Answers:
4048    
4049     LinuxSampler will answer by returning the number of all active
4050     voices on the sampler.
4051    
4052     6.6.2. Maximum amount of active voices
4053    
4054     The front-end can ask for the maximum number of active voices by
4055     sending the following command:
4056    
4057     GET TOTAL_VOICE_COUNT_MAX
4058    
4059     Possible Answers:
4060    
4061     LinuxSampler will answer by returning the maximum number of active
4062     voices.
4063    
4064     6.6.3. Reset sampler
4065    
4066 schoenebeck 575 The front-end can reset the whole sampler by sending the following
4067     command:
4068 senoner 542
4069 schoenebeck 575 RESET
4070    
4071     Possible Answers:
4072    
4073 schoenebeck 708 "OK" -
4074 schoenebeck 575
4075 schoenebeck 708 always
4076 schoenebeck 575
4077 schoenebeck 708 Examples:
4078 schoenebeck 575
4079 senoner 542
4080    
4081    
4082 schoenebeck 575
4083 schoenebeck 1251
4084    
4085    
4086    
4087 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 73]
4088 schoenebeck 1251
4089 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4090 schoenebeck 1251
4091    
4092 schoenebeck 1363 6.6.4. General sampler informations
4093    
4094     The client can ask for general informations about the LinuxSampler
4095     instance by sending the following command:
4096    
4097 schoenebeck 575 GET SERVER INFO
4098    
4099 senoner 542 Possible Answers:
4100    
4101 schoenebeck 575 LinuxSampler will answer by sending a <CRLF> separated list. Each
4102     answer line begins with the information category name followed by
4103     a colon and then a space character <SP> and finally the info
4104     character string to that information category. At the moment the
4105     following categories are defined:
4106 senoner 542
4107 schoenebeck 708
4108    
4109 schoenebeck 575 DESCRIPTION -
4110 schoenebeck 708
4111 schoenebeck 1390 arbitrary textual description about the sampler (note that
4112     the character string may contain escape sequences
4113     (Section 7.1))
4114 schoenebeck 708
4115 schoenebeck 575 VERSION -
4116 schoenebeck 708
4117 schoenebeck 575 version of the sampler
4118 schoenebeck 708
4119 schoenebeck 575 PROTOCOL_VERSION -
4120 schoenebeck 708
4121 schoenebeck 575 version of the LSCP specification the sampler complies with
4122     (see Section 2 for details)
4123 senoner 542
4124 iliev 1162 INSTRUMENTS_DB_SUPPORT -
4125    
4126     either yes or no, specifies whether the sampler is build
4127     with instruments database support.
4128    
4129 schoenebeck 575 The mentioned fields above don't have to be in particular order.
4130     Other fields might be added in future.
4131 senoner 542
4132 schoenebeck 1006 6.6.5. Getting global volume attenuation
4133    
4134     The client can ask for the current global sampler-wide volume
4135     attenuation by sending the following command:
4136    
4137     GET VOLUME
4138    
4139     Possible Answers:
4140    
4141    
4142 schoenebeck 1251
4143 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 74]
4144 schoenebeck 1251
4145 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4146 schoenebeck 1251
4147    
4148 schoenebeck 1363 The sampler will always answer by returning the optional dotted
4149     floating point coefficient, reflecting the current global volume
4150     attenuation.
4151    
4152     Note: it is up to the respective sampler engine whether to obey that
4153     global volume parameter or not, but in general all engines SHOULD use
4154 schoenebeck 1006 this parameter.
4155    
4156     6.6.6. Setting global volume attenuation
4157    
4158     The client can alter the current global sampler-wide volume
4159     attenuation by sending the following command:
4160    
4161     SET VOLUME <volume>
4162    
4163     Where <volume> should be replaced by the optional dotted floating
4164     point value, reflecting the new global volume parameter. This value
4165     might usually be in the range between 0.0 and 1.0, that is for
4166     attenuating the overall volume.
4167    
4168 iliev 1162 Possible Answers:
4169 iliev 1137
4170 iliev 1162 "OK" -
4171 iliev 1137
4172 schoenebeck 1006 on success
4173    
4174     "WRN:<warning-code>:<warning-message>" -
4175    
4176     if the global volume was set, but there are noteworthy issue(s)
4177     related, providing an appropriate warning code and warning
4178     message
4179    
4180     "ERR:<error-code>:<error-message>" -
4181    
4182     in case it failed, providing an appropriate error code and
4183     error message
4184    
4185 schoenebeck 945 6.7. MIDI Instrument Mapping
4186 senoner 542
4187 schoenebeck 945 The MIDI protocol provides a way to switch between instruments by
4188     sending so called MIDI bank select and MIDI program change messages
4189     which are essentially just numbers. The following commands allow to
4190     actually map arbitrary MIDI bank select / program change numbers with
4191     real instruments.
4192 senoner 542
4193 schoenebeck 974 The sampler allows to manage an arbitrary amount of MIDI instrument
4194     maps which define which instrument to load on which MIDI program
4195     change message.
4196 senoner 542
4197 schoenebeck 1363
4198    
4199 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 75]
4200 schoenebeck 1363
4201 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4202 schoenebeck 1363
4203    
4204 schoenebeck 974 By default, that is when the sampler is launched, there is no map,
4205     thus the sampler will simply ignore all program change messages. The
4206     front-end has to explicitly create at least one map, add entries to
4207 schoenebeck 1006 the map and tell the respective sampler channel(s) which MIDI
4208     instrument map to use, so the sampler knows how to react on a given
4209 schoenebeck 974 program change message on the respective sampler channel, that is by
4210     switching to the respectively defined engine type and loading the
4211     respective instrument. See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4212     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler
4213     channel.
4214    
4215 schoenebeck 945 Also note per MIDI specification a bank select message does not cause
4216     to switch to another instrument. Instead when receiving a bank
4217     select message the bank value will be stored and a subsequent program
4218     change message (which may occur at any time) will finally cause the
4219     sampler to switch to the respective instrument as reflected by the
4220     current MIDI instrument map.
4221 senoner 542
4222 iliev 1162 6.7.1. Create a new MIDI instrument map
4223    
4224     The front-end can add a new MIDI instrument map by sending the
4225     following command:
4226    
4227 schoenebeck 974 ADD MIDI_INSTRUMENT_MAP [<name>]
4228    
4229     Where <name> is an optional argument allowing to assign a custom name
4230 schoenebeck 1390 to the new map. MIDI instrument Map names do not have to be unique,
4231     but MUST be encapsulated into apostrophes and support escape
4232     sequences as described in chapter "Character Set and Escape Sequences
4233     (Section 7.1)".
4234 schoenebeck 974
4235     Possible Answers:
4236    
4237     "OK[<map>]" -
4238    
4239     in case a new MIDI instrument map could be added, where <map>
4240     reflects the unique ID of the newly created MIDI instrument map
4241    
4242     "ERR:<error-code>:<error-message>" -
4243    
4244     when a new map could not be created, which might never occur in
4245     practice
4246    
4247     Examples:
4248    
4249     C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"
4250    
4251    
4252    
4253    
4254    
4255 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 76]
4256 schoenebeck 1390
4257     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4258 schoenebeck 1251
4259    
4260 schoenebeck 1390 S: "OK[0]"
4261 schoenebeck 1251
4262 schoenebeck 1363 C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"
4263 schoenebeck 1251
4264 schoenebeck 1363 S: "OK[1]"
4265 schoenebeck 1251
4266 schoenebeck 1363 C: "ADD MIDI_INSTRUMENT_MAP"
4267    
4268 schoenebeck 974 S: "OK[5]"
4269    
4270     6.7.2. Delete one particular or all MIDI instrument maps
4271    
4272     The front-end can delete a particular MIDI instrument map by sending
4273     the following command:
4274    
4275     REMOVE MIDI_INSTRUMENT_MAP <map>
4276    
4277     Where <map> reflects the unique ID of the map to delete as returned
4278     by the "LIST MIDI_INSTRUMENT_MAPS" (Section 6.7.4) command.
4279    
4280     The front-end can delete all MIDI instrument maps by sending the
4281     following command:
4282    
4283 iliev 1162 REMOVE MIDI_INSTRUMENT_MAP ALL
4284 iliev 1137
4285 iliev 1162 Possible Answers:
4286 iliev 1137
4287 schoenebeck 974 "OK" -
4288    
4289     in case the map(s) could be deleted
4290    
4291     "ERR:<error-code>:<error-message>" -
4292    
4293     when the given map does not exist
4294    
4295     Examples:
4296    
4297     C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4298    
4299     S: "OK"
4300    
4301     C: "REMOVE MIDI_INSTRUMENT_MAP ALL"
4302    
4303     S: "OK"
4304    
4305    
4306    
4307    
4308    
4309 schoenebeck 1251
4310 schoenebeck 1390
4311 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 77]
4312 schoenebeck 1363
4313 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4314 schoenebeck 1251
4315    
4316 schoenebeck 1390 6.7.3. Get amount of existing MIDI instrument maps
4317    
4318     The front-end can retrieve the current amount of MIDI instrument maps
4319     by sending the following command:
4320    
4321 schoenebeck 1363 GET MIDI_INSTRUMENT_MAPS
4322 schoenebeck 1251
4323 schoenebeck 1363 Possible Answers:
4324 schoenebeck 1251
4325 schoenebeck 974 The sampler will answer by returning the current number of MIDI
4326     instrument maps.
4327    
4328     Example:
4329    
4330     C: "GET MIDI_INSTRUMENT_MAPS"
4331    
4332     S: "2"
4333    
4334     6.7.4. Getting all created MIDI instrument maps
4335    
4336     The number of MIDI instrument maps can change on runtime. To get the
4337     current list of MIDI instrument maps, the front-end can send the
4338     following command:
4339    
4340 iliev 1162 LIST MIDI_INSTRUMENT_MAPS
4341 iliev 1137
4342 iliev 1162 Possible Answers:
4343 iliev 1137
4344 schoenebeck 974 The sampler will answer by returning a comma separated list with
4345     all MIDI instrument maps' numerical IDs.
4346    
4347     Example:
4348    
4349     C: "LIST MIDI_INSTRUMENT_MAPS"
4350    
4351     S: "0,1,5,12"
4352    
4353     6.7.5. Getting MIDI instrument map information
4354    
4355     The front-end can ask for the current settings of a MIDI instrument
4356     map by sending the following command:
4357    
4358     GET MIDI_INSTRUMENT_MAP INFO <map>
4359    
4360     Where <map> is the numerical ID of the map the front-end is
4361     interested in as returned by the "LIST MIDI_INSTRUMENT_MAPS"
4362     (Section 6.7.4) command.
4363    
4364    
4365    
4366    
4367 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 78]
4368 schoenebeck 1363
4369 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4370 schoenebeck 1251
4371    
4372 schoenebeck 1390 Possible Answers:
4373    
4374     LinuxSampler will answer by sending a <CRLF> separated list. Each
4375     answer line begins with the settings category name followed by a
4376     colon and then a space character <SP> and finally the info
4377 schoenebeck 1363 character string to that setting category. At the moment the
4378     following categories are defined:
4379 schoenebeck 1251
4380    
4381    
4382 schoenebeck 974 NAME -
4383    
4384     custom name of the given map, which does not have to be
4385 schoenebeck 1400 unique (note that this character string may contain escape
4386     sequences (Section 7.1))
4387 schoenebeck 974
4388 iliev 1137 DEFAULT -
4389    
4390     either true or false, defines whether this map is the
4391     default map
4392    
4393 schoenebeck 974 The mentioned fields above don't have to be in particular order.
4394    
4395     Example:
4396    
4397 iliev 1162 C: "GET MIDI_INSTRUMENT_MAP INFO 0"
4398 iliev 1137
4399 iliev 1162 S: "NAME: Standard Map"
4400 iliev 1137
4401     "DEFAULT: true"
4402    
4403 schoenebeck 974 "."
4404    
4405     6.7.6. Renaming a MIDI instrument map
4406    
4407     The front-end can alter the custom name of a MIDI instrument map by
4408     sending the following command:
4409    
4410     SET MIDI_INSTRUMENT_MAP NAME <map> <name>
4411    
4412     Where <map> is the numerical ID of the map and <name> the new custom
4413 schoenebeck 1390 name of the map, which does not have to be unique (name MUST be
4414     encapsulated into apostrophes and supports escape sequences as
4415     described in chapter "Character Set and Escape Sequences
4416     (Section 7.1)").
4417 schoenebeck 974
4418     Possible Answers:
4419    
4420 schoenebeck 1390
4421    
4422    
4423 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 79]
4424 schoenebeck 1390
4425     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4426    
4427    
4428 schoenebeck 974 "OK" -
4429    
4430     on success
4431    
4432     "ERR:<error-code>:<error-message>" -
4433    
4434     in case the given map does not exist
4435    
4436     Example:
4437    
4438     C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"
4439    
4440     S: "OK"
4441    
4442     6.7.7. Create or replace a MIDI instrument map entry
4443    
4444     The front-end can create a new or replace an existing entry in a
4445 schoenebeck 945 sampler's MIDI instrument map by sending the following command:
4446 senoner 542
4447 schoenebeck 1048 MAP MIDI_INSTRUMENT [NON_MODAL] <map> <midi_bank> <midi_prog>
4448     <engine_name> <filename> <instrument_index> <volume_value>
4449     [<instr_load_mode>] [<name>]
4450 senoner 542
4451 schoenebeck 974 Where <map> is the numeric ID of the map to alter, <midi_bank> is an
4452     integer value between 0..16383 reflecting the MIDI bank select index,
4453     <midi_prog> an integer value between 0..127 reflecting the MIDI
4454     program change index, <engine_name> a sampler engine name as returned
4455     by the "LIST AVAILABLE_ENGINES" (Section 6.4.8) command (not
4456 iliev 1162 encapsulated into apostrophes), <filename> the name of the
4457 schoenebeck 1251 instrument's file to be deployed (encapsulated into apostrophes,
4458     supporting escape sequences as described in chapter "Character Set
4459     and Escape Sequences (Section 7.1)"), <instrument_index> the index
4460     (integer value) of the instrument within the given file,
4461     <volume_value> reflects the master volume of the instrument as
4462     optionally dotted number (where a value < 1.0 means attenuation and a
4463     value > 1.0 means amplification). This parameter easily allows to
4464     adjust the volume of all intruments within a custom instrument map
4465     without having to adjust their instrument files. The OPTIONAL
4466     <instr_load_mode> argument defines the life time of the instrument,
4467     that is when the instrument should be loaded, when freed and has
4468     exactly the following possibilities:
4469 senoner 542
4470 schoenebeck 945 "ON_DEMAND" -
4471 senoner 542
4472 schoenebeck 945 The instrument will be loaded when needed, that is when
4473     demanded by at least one sampler channel. It will immediately
4474     be freed from memory when not needed by any sampler channel
4475     anymore.
4476 senoner 542
4477 schoenebeck 1390
4478    
4479 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 80]
4480 schoenebeck 1390
4481     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4482    
4483    
4484 schoenebeck 945 "ON_DEMAND_HOLD" -
4485 senoner 542
4486 schoenebeck 945 The instrument will be loaded when needed, that is when
4487     demanded by at least one sampler channel. It will be kept in
4488     memory even when not needed by any sampler channel anymore.
4489     Instruments with this mode are only freed when the sampler is
4490     reset or all mapping entries with this mode (and respective
4491     instrument) are explicitly changed to "ON_DEMAND" and no
4492     sampler channel is using the instrument anymore.
4493 senoner 542
4494 schoenebeck 945 "PERSISTENT" -
4495 senoner 542
4496 schoenebeck 1048 The instrument will immediately be loaded into memory when this
4497     mapping command is sent and the instrument is kept all the
4498     time. Instruments with this mode are only freed when the
4499     sampler is reset or all mapping entries with this mode (and
4500     respective instrument) are explicitly changed to "ON_DEMAND"
4501     and no sampler channel is using the instrument anymore.
4502 senoner 542
4503 schoenebeck 945 not supplied -
4504 schoenebeck 708
4505 schoenebeck 945 In case there is no <instr_load_mode> argument given, it will
4506     be up to the InstrumentManager to decide which mode to use.
4507     Usually it will use "ON_DEMAND" if an entry for the given
4508     instrument does not exist in the InstrumentManager's list yet,
4509     otherwise if an entry already exists, it will simply stick with
4510     the mode currently reflected by the already existing entry,
4511     that is it will not change the mode.
4512 schoenebeck 940
4513 iliev 1162 The <instr_load_mode> argument thus allows to define an appropriate
4514     strategy (low memory consumption vs. fast instrument switching) for
4515     each instrument individually. Note, the following restrictions apply
4516     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
4517 schoenebeck 945 supported by the respective sampler engine (which is technically the
4518     case when the engine provides an InstrumentManager for its format).
4519     If this is not the case the argument will automatically fall back to
4520     the default value "ON_DEMAND". Also the load mode of one instrument
4521     may automatically change the laod mode of other instrument(s), i.e.
4522     because the instruments are part of the same file and the engine does
4523     not allow a way to manage load modes for them individually. Due to
4524     this, in case the frontend shows the load modes of entries, the
4525     frontend should retrieve the actual mode by i.e. sending "GET
4526 schoenebeck 974 MIDI_INSTRUMENT INFO" (Section 6.7.11) command(s). Finally the
4527 schoenebeck 945 OPTIONAL <name> argument allows to set a custom name (encapsulated
4528 schoenebeck 1390 into apostrophes, supporting escape sequences as described in chapter
4529     "Character Set and Escape Sequences (Section 7.1)") for the mapping
4530     entry, useful for frontends for displaying an appropriate name for
4531     mapped instruments (using "GET MIDI_INSTRUMENT INFO"
4532 schoenebeck 940
4533 schoenebeck 1390
4534    
4535 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 81]
4536 schoenebeck 1390
4537     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4538    
4539    
4540     (Section 6.7.11)).
4541    
4542 schoenebeck 1048 By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4543     completely established in the sampler. The OPTIONAL "NON_MODAL"
4544     argument however causes the respective "MAP MIDI_INSTRUMENT" command
4545     to return immediately, that is to let the sampler establish the
4546     mapping in the background. So this argument might be especially
4547     useful for mappings with a "PERSISTENT" type, because these have to
4548     load the respective instruments immediately and might thus block for
4549     a very long time. It is recommended however to use the OPTIONAL
4550     "NON_MODAL" argument only if really necessary, because it has the
4551     following drawbacks: as "NON_MODAL" instructions return immediately,
4552     they may not necessarily return an error i.e. when the given
4553     instrument file turns out to be corrupt, beside that subsequent
4554     commands in a LSCP instruction sequence might fail, because mandatory
4555     mappings are not yet completed.
4556 schoenebeck 940
4557 schoenebeck 945 Possible Answers:
4558 schoenebeck 940
4559 schoenebeck 945 "OK" -
4560 schoenebeck 940
4561 schoenebeck 945 usually
4562 schoenebeck 940
4563 schoenebeck 945 "ERR:<error-code>:<error-message>" -
4564    
4565 schoenebeck 974 when the given map or engine does not exist or a value is out
4566     of range
4567 schoenebeck 945
4568     Examples:
4569    
4570 iliev 1162 C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
4571     0.8 PERSISTENT"
4572    
4573     S: "OK"
4574    
4575 schoenebeck 974 C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7
4576 schoenebeck 945 1.0"
4577    
4578     S: "OK"
4579    
4580     C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0
4581     'Normal Piano'"
4582    
4583     S: "OK"
4584    
4585 schoenebeck 974 C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25
4586 schoenebeck 945 'Silent Piano'"
4587    
4588 schoenebeck 1390
4589    
4590    
4591 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 82]
4592 schoenebeck 1390
4593     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4594    
4595    
4596 schoenebeck 945 S: "OK"
4597    
4598 schoenebeck 1048 C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/
4599     foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"
4600 schoenebeck 945
4601     S: "OK"
4602    
4603 schoenebeck 974 6.7.8. Getting ammount of MIDI instrument map entries
4604 schoenebeck 945
4605 schoenebeck 974 The front-end can query the amount of currently existing entries in a
4606     MIDI instrument map by sending the following command:
4607 schoenebeck 945
4608 schoenebeck 974 GET MIDI_INSTRUMENTS <map>
4609 schoenebeck 945
4610 schoenebeck 974 The front-end can query the amount of currently existing entries in
4611     all MIDI instrument maps by sending the following command:
4612    
4613     GET MIDI_INSTRUMENTS ALL
4614    
4615 schoenebeck 945 Possible Answers:
4616    
4617 schoenebeck 974 The sampler will answer by sending the current number of entries
4618     in the MIDI instrument map(s).
4619 schoenebeck 945
4620     Example:
4621    
4622 schoenebeck 974 C: "GET MIDI_INSTRUMENTS 0"
4623 schoenebeck 945
4624 schoenebeck 974 S: "234"
4625 schoenebeck 945
4626 iliev 1162 C: "GET MIDI_INSTRUMENTS ALL"
4627 iliev 1137
4628 iliev 1162 S: "954"
4629 iliev 1137
4630 schoenebeck 974 6.7.9. Getting indeces of all entries of a MIDI instrument map
4631 schoenebeck 945
4632 schoenebeck 974 The front-end can query a list of all currently existing entries in a
4633     certain MIDI instrument map by sending the following command:
4634    
4635     LIST MIDI_INSTRUMENTS <map>
4636    
4637     Where <map> is the numeric ID of the MIDI instrument map.
4638    
4639     The front-end can query a list of all currently existing entries of
4640     all MIDI instrument maps by sending the following command:
4641    
4642 schoenebeck 1390
4643    
4644    
4645    
4646    
4647 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 83]
4648 schoenebeck 1390
4649     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4650    
4651    
4652 schoenebeck 974 LIST MIDI_INSTRUMENTS ALL
4653    
4654 schoenebeck 945 Possible Answers:
4655    
4656 schoenebeck 974 The sampler will answer by sending a comma separated list of map
4657     ID - MIDI bank - MIDI program triples, where each triple is
4658     encapsulated into curly braces. The list is returned in one
4659     single line. Each triple just reflects the key of the respective
4660     map entry, thus subsequent "GET MIDI_INSTRUMENT INFO"
4661     (Section 6.7.11) command(s) are necessary to retrieve detailed
4662     informations about each entry.
4663 schoenebeck 945
4664     Example:
4665    
4666 schoenebeck 974 C: "LIST MIDI_INSTRUMENTS 0"
4667 schoenebeck 945
4668 schoenebeck 974 S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"
4669 schoenebeck 945
4670 schoenebeck 974 6.7.10. Remove an entry from the MIDI instrument map
4671 schoenebeck 945
4672 schoenebeck 974 The front-end can delete an entry from a MIDI instrument map by
4673 schoenebeck 945 sending the following command:
4674    
4675 schoenebeck 974 UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog>
4676 schoenebeck 945
4677 schoenebeck 974 Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4678     is an integer value between 0..16383 reflecting the MIDI bank value
4679     and <midi_prog> an integer value between 0..127 reflecting the MIDI
4680     program value of the map's entrie's key index triple.
4681 schoenebeck 945
4682     Possible Answers:
4683    
4684 iliev 1162 "OK" -
4685 iliev 1137
4686 iliev 1162 usually
4687 iliev 1137
4688 schoenebeck 945 "ERR:<error-code>:<error-message>" -
4689    
4690     when index out of bounds
4691    
4692     Example:
4693    
4694 schoenebeck 974 C: "UNMAP MIDI_INSTRUMENT 0 2 127"
4695 schoenebeck 945
4696     S: "OK"
4697    
4698 schoenebeck 1390
4699    
4700    
4701    
4702    
4703 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 84]
4704 schoenebeck 1390
4705     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4706    
4707    
4708 schoenebeck 974 6.7.11. Get current settings of MIDI instrument map entry
4709 schoenebeck 945
4710     The front-end can retrieve the current settings of a certain
4711     instrument map entry by sending the following command:
4712    
4713 schoenebeck 974 GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog>
4714 schoenebeck 945
4715 schoenebeck 974 Where <map> is the numeric ID of the MIDI instrument map, <midi_bank>
4716     is an integer value between 0..16383 reflecting the MIDI bank value,
4717     <midi_bank> and <midi_prog> an integer value between 0..127
4718     reflecting the MIDI program value of the map's entrie's key index
4719     triple.
4720 schoenebeck 945
4721     Possible Answers:
4722    
4723     LinuxSampler will answer by sending a <CRLF> separated list. Each
4724     answer line begins with the information category name followed by
4725     a colon and then a space character <SP> and finally the info
4726     character string to that info category. At the moment the
4727     following categories are defined:
4728    
4729     "NAME" -
4730    
4731     Name for this MIDI instrument map entry (if defined). This
4732     name shall be used by frontends for displaying a name for this
4733     mapped instrument. It can be set and changed with the "MAP
4734 schoenebeck 974 MIDI_INSTRUMENT" (Section 6.7.7) command and does not have to
4735 schoenebeck 1400 be unique. (note that this character string may contain escape
4736     sequences (Section 7.1))
4737 schoenebeck 945
4738     "ENGINE_NAME" -
4739    
4740     Name of the engine to be deployed for this instrument.
4741    
4742 iliev 1162 "INSTRUMENT_FILE" -
4743 iliev 1137
4744 schoenebeck 1400 File name of the instrument (note that this path may contain
4745     escape sequences (Section 7.1)).
4746 iliev 1137
4747 schoenebeck 945 "INSTRUMENT_NR" -
4748    
4749     Index of the instrument within the file.
4750    
4751     "INSTRUMENT_NAME" -
4752    
4753     Name of the loaded instrument as reflected by its file. In
4754     contrast to the "NAME" field, the "INSTRUMENT_NAME" field
4755 schoenebeck 1400 cannot be changed (note that this character string may contain
4756 schoenebeck 945
4757 schoenebeck 1390
4758    
4759 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 85]
4760 schoenebeck 1390
4761     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4762    
4763    
4764 schoenebeck 1400 escape sequences (Section 7.1)).
4765    
4766 schoenebeck 945 "LOAD_MODE" -
4767    
4768     Life time of instrument (see "MAP MIDI_INSTRUMENT"
4769 schoenebeck 974 (Section 6.7.7) for details about this setting).
4770 schoenebeck 945
4771     "VOLUME" -
4772    
4773     master volume of the instrument as optionally dotted number
4774     (where a value < 1.0 means attenuation and a value > 1.0 means
4775     amplification)
4776    
4777     The mentioned fields above don't have to be in particular order.
4778    
4779     Example:
4780    
4781 schoenebeck 974 C: "GET MIDI_INSTRUMENT INFO 1 45 120"
4782 schoenebeck 945
4783     S: "NAME: Drums for Foo Song"
4784    
4785     "ENGINE_NAME: GigEngine"
4786    
4787     "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"
4788    
4789     "INSTRUMENT_NR: 0"
4790    
4791     "INSTRUMENT_NAME: Joe's Drumkit"
4792    
4793     "LOAD_MODE: PERSISTENT"
4794    
4795     "VOLUME: 1.0"
4796    
4797     "."
4798    
4799 iliev 1162 6.7.12. Clear MIDI instrument map
4800    
4801     The front-end can clear a whole MIDI instrument map, that is delete
4802     all its entries by sending the following command:
4803    
4804 schoenebeck 974 CLEAR MIDI_INSTRUMENTS <map>
4805 schoenebeck 945
4806 schoenebeck 974 Where <map> is the numeric ID of the map to clear.
4807 schoenebeck 945
4808 schoenebeck 974 The front-end can clear all MIDI instrument maps, that is delete all
4809     entries of all maps by sending the following command:
4810 schoenebeck 945
4811    
4812 schoenebeck 1390
4813    
4814    
4815 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 86]
4816 schoenebeck 1390
4817     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4818    
4819    
4820 schoenebeck 1400 CLEAR MIDI_INSTRUMENTS ALL
4821    
4822     The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the maps,
4823 schoenebeck 974 only their entries, thus the map's settings like custom name will be
4824     preservevd.
4825 schoenebeck 945
4826 schoenebeck 974 Possible Answers:
4827 schoenebeck 945
4828 schoenebeck 974 "OK" -
4829 schoenebeck 945
4830 schoenebeck 974 always
4831 schoenebeck 945
4832 schoenebeck 974 Examples:
4833 schoenebeck 945
4834 schoenebeck 974 C: "CLEAR MIDI_INSTRUMENTS 0"
4835 schoenebeck 945
4836 schoenebeck 974 S: "OK"
4837 schoenebeck 945
4838 schoenebeck 974 C: "CLEAR MIDI_INSTRUMENTS ALL"
4839 schoenebeck 945
4840 schoenebeck 974 S: "OK"
4841 schoenebeck 945
4842 iliev 1162 6.8. Managing Instruments Database
4843 schoenebeck 945
4844 iliev 1162 The following commands describe how to use and manage the instruments
4845     database.
4846 schoenebeck 945
4847 schoenebeck 1363 Notice:
4848    
4849     All command arguments representing a path or instrument/directory
4850     name support escape sequences as described in chapter "Character
4851     Set and Escape Sequences (Section 7.1)".
4852    
4853     All occurrences of a forward slash in instrument and directory
4854     names are escaped with its hex (\x2f) or octal (\057) escape
4855     sequence.
4856    
4857 iliev 1162 6.8.1. Creating a new instrument directory
4858 schoenebeck 945
4859 iliev 1162 The front-end can add a new instrument directory to the instruments
4860     database by sending the following command:
4861 schoenebeck 945
4862 iliev 1162 ADD DB_INSTRUMENT_DIRECTORY <dir>
4863 schoenebeck 945
4864 iliev 1162 Where <dir> is the absolute path name of the directory to be created
4865     (encapsulated into apostrophes).
4866 iliev 1137
4867 iliev 1162 Possible Answers:
4868 iliev 1137
4869 schoenebeck 1390
4870    
4871 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 87]
4872 schoenebeck 1390
4873     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4874    
4875    
4876 iliev 1162 "OK" -
4877 iliev 1137
4878 iliev 1162 on success
4879 iliev 1137
4880 iliev 1162 "ERR:<error-code>:<error-message>" -
4881 iliev 1137
4882 iliev 1162 when the directory could not be created, which can happen if
4883     the directory already exists or the name contains not allowed
4884     symbols
4885 iliev 1137
4886 iliev 1162 Examples:
4887 iliev 1137
4888 iliev 1162 C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"
4889 iliev 1137
4890 iliev 1162 S: "OK"
4891 iliev 1137
4892 iliev 1162 6.8.2. Deleting an instrument directory
4893 iliev 1137
4894 iliev 1162 The front-end can delete a particular instrument directory from the
4895     instruments database by sending the following command:
4896 iliev 1137
4897 iliev 1162 REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir>
4898 iliev 1137
4899 iliev 1162 Where <dir> is the absolute path name of the directory to delete.
4900     The optional FORCE argument can be used to force the deletion of a
4901     non-empty directory and all its content.
4902 iliev 1137
4903 iliev 1162 Possible Answers:
4904    
4905     "OK" -
4906    
4907     if the directory is deleted successfully
4908    
4909     "ERR:<error-code>:<error-message>" -
4910    
4911     if the given directory does not exist, or if trying to delete a
4912     non-empty directory, without using the FORCE argument.
4913    
4914     Examples:
4915    
4916     C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"
4917    
4918     S: "OK"
4919    
4920 schoenebeck 1390
4921    
4922    
4923    
4924    
4925    
4926    
4927 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 88]
4928 schoenebeck 1390
4929     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4930    
4931    
4932 iliev 1162 6.8.3. Getting amount of instrument directories
4933    
4934     The front-end can retrieve the current amount of directories in a
4935     specific directory by sending the following command:
4936    
4937 iliev 1189 GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4938 iliev 1162
4939     Where <dir> should be replaced by the absolute path name of the
4940 iliev 1189 directory. If RECURSIVE is specified, the number of all directories,
4941     including those located in subdirectories of the specified directory,
4942     will be returned.
4943 iliev 1162
4944     Possible Answers:
4945    
4946     The current number of instrument directories in the specified
4947     directory.
4948    
4949     "ERR:<error-code>:<error-message>" -
4950    
4951 schoenebeck 1363 if the given directory does not exist.
4952 schoenebeck 1251
4953 schoenebeck 1363 Example:
4954 schoenebeck 1251
4955 schoenebeck 1363 C: "GET DB_INSTRUMENT_DIRECTORIES '/'"
4956 schoenebeck 1251
4957 schoenebeck 1363 S: "2"
4958 schoenebeck 1251
4959 iliev 1162 6.8.4. Listing all directories in specific directory
4960    
4961     The front-end can retrieve the current list of directories in
4962     specific directory by sending the following command:
4963    
4964 iliev 1189 LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir>
4965 iliev 1162
4966     Where <dir> should be replaced by the absolute path name of the
4967 iliev 1189 directory. If RECURSIVE is specified, the absolute path names of all
4968     directories, including those located in subdirectories of the
4969     specified directory, will be returned.
4970 iliev 1162
4971     Possible Answers:
4972    
4973     A comma separated list of all instrument directories (encapsulated
4974     into apostrophes) in the specified directory.
4975    
4976     "ERR:<error-code>:<error-message>" -
4977    
4978     if the given directory does not exist.
4979    
4980 schoenebeck 1390
4981    
4982    
4983 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 89]
4984 schoenebeck 1390
4985     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
4986    
4987    
4988 iliev 1189 Example:
4989 iliev 1162
4990     C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"
4991    
4992     S: "'Piano Collection','Percussion Collection'"
4993    
4994 iliev 1189 C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"
4995    
4996     S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano
4997     Collection/Acoustic/New','/Percussion Collection'"
4998    
4999 iliev 1162 6.8.5. Getting instrument directory information
5000    
5001     The front-end can ask for the current settings of an instrument
5002     directory by sending the following command:
5003    
5004     GET DB_INSTRUMENT_DIRECTORY INFO <dir>
5005    
5006     Where <dir> should be replaced by the absolute path name of the
5007     directory the front-end is interested in.
5008    
5009     Possible Answers:
5010    
5011     LinuxSampler will answer by sending a <CRLF> separated list. Each
5012     answer line begins with the settings category name followed by a
5013     colon and then a space character <SP> and finally the info
5014     character string to that setting category. At the moment the
5015     following categories are defined:
5016    
5017    
5018    
5019     DESCRIPTION -
5020    
5021 schoenebeck 1363 A brief description of the directory content. Note that the
5022     character string may contain escape sequences (Section 7.1).
5023 iliev 1162
5024     CREATED -
5025    
5026     The creation date and time of the directory, represented in
5027     "YYYY-MM-DD HH:MM:SS" format
5028    
5029     MODIFIED -
5030    
5031     The date and time of the last modification of the directory,
5032     represented in "YYYY-MM-DD HH:MM:SS" format
5033    
5034     The mentioned fields above don't have to be in particular order.
5035    
5036 schoenebeck 1390
5037    
5038    
5039 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 90]
5040 schoenebeck 1390
5041     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5042    
5043    
5044 iliev 1162 Example:
5045    
5046 iliev 1189 C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"
5047 iliev 1162
5048 iliev 1189 S: "DESCRIPTION: Piano collection of instruments in GigaSampler
5049     format."
5050 iliev 1162
5051     "CREATED: 2007-02-05 10:23:12"
5052    
5053     "MODIFIED: 2007-04-07 12:50:21"
5054    
5055     "."
5056    
5057     6.8.6. Renaming an instrument directory
5058    
5059     The front-end can alter the name of a specific instrument directory
5060     by sending the following command:
5061    
5062 schoenebeck 1363 SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name>
5063 schoenebeck 1251
5064 schoenebeck 1363 Where <dir> is the absolute path name of the directory and <name> is
5065     the new name for that directory.
5066 schoenebeck 1251
5067 schoenebeck 1363 Possible Answers:
5068 schoenebeck 1251
5069 schoenebeck 1363 "OK" -
5070 schoenebeck 1251
5071 iliev 1162 on success
5072    
5073     "ERR:<error-code>:<error-message>" -
5074    
5075     in case the given directory does not exists, or if a directory
5076     with name equal to the new name already exists.
5077    
5078     Example:
5079    
5080     C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
5081     'Acoustic'"
5082    
5083     S: "OK"
5084    
5085     6.8.7. Moving an instrument directory
5086    
5087     The front-end can move a specific instrument directory by sending the
5088     following command:
5089    
5090 schoenebeck 1390
5091    
5092    
5093    
5094    
5095 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 91]
5096 schoenebeck 1390
5097     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5098    
5099    
5100 iliev 1162 MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst>
5101    
5102     Where <dir> is the absolute path name of the directory to move and
5103     <dst> is the location where the directory will be moved to.
5104    
5105     Possible Answers:
5106    
5107 iliev 1189 "OK" -
5108 iliev 1162
5109 iliev 1189 on success
5110 iliev 1162
5111 iliev 1189 "ERR:<error-code>:<error-message>" -
5112 iliev 1162
5113 iliev 1189 in case a given directory does not exists, or if a directory
5114     with name equal to the name of the specified directory already
5115     exists in the destination directory. Error is also thrown when
5116     trying to move a directory to a subdirectory of itself.
5117 iliev 1162
5118 iliev 1189 Example:
5119 iliev 1162
5120 schoenebeck 1363 C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/
5121     Acoustic'"
5122 schoenebeck 1251
5123 schoenebeck 1363 S: "OK"
5124 schoenebeck 1251
5125 iliev 1189 6.8.8. Copying instrument directories
5126    
5127     The front-end can copy a specific instrument directory by sending the
5128     following command:
5129    
5130     COPY DB_INSTRUMENT_DIRECTORY <dir> <dst>
5131    
5132     Where <dir> is the absolute path name of the directory to copy and
5133     <dst> is the location where the directory will be copied to.
5134    
5135     Possible Answers:
5136    
5137 iliev 1162 "OK" -
5138    
5139     on success
5140    
5141     "ERR:<error-code>:<error-message>" -
5142    
5143     in case a given directory does not exists, or if a directory
5144     with name equal to the name of the specified directory already
5145     exists in the destination directory. Error is also thrown when
5146 iliev 1189 trying to copy a directory to a subdirectory of itself.
5147 iliev 1162
5148 schoenebeck 1390
5149    
5150    
5151 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 92]
5152 schoenebeck 1390
5153     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5154    
5155    
5156 iliev 1162 Example:
5157    
5158 iliev 1189 C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic'
5159     '/Acoustic/Pianos'"
5160 iliev 1162
5161     S: "OK"
5162    
5163 iliev 1189 6.8.9. Changing the description of directory
5164 iliev 1162
5165     The front-end can alter the description of a specific instrument
5166     directory by sending the following command:
5167    
5168     SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc>
5169    
5170     Where <dir> is the absolute path name of the directory and <desc> is
5171 schoenebeck 1363 the new description for the directory (encapsulated into apostrophes,
5172     supporting escape sequences as described in chapter "Character Set
5173     and Escape Sequences (Section 7.1)").
5174 iliev 1162
5175     Possible Answers:
5176    
5177 schoenebeck 1363 "OK" -
5178 schoenebeck 1251
5179 schoenebeck 1363 on success
5180 schoenebeck 1251
5181 iliev 1162 "ERR:<error-code>:<error-message>" -
5182    
5183     in case the given directory does not exists.
5184    
5185     Example:
5186    
5187     C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A
5188     collection of piano instruments in various format.'"
5189    
5190     S: "OK"
5191    
5192 iliev 1189 6.8.10. Finding directories
5193 iliev 1162
5194 iliev 1189 The front-end can search for directories in specific directory by
5195     sending the following command:
5196 iliev 1162
5197 iliev 1189 FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-
5198     list>
5199 iliev 1162
5200 iliev 1189 Where <dir> should be replaced by the absolute path name of the
5201     directory to search in. If NON_RECURSIVE is specified, the
5202     directories located in subdirectories of the specified directory will
5203     not be searched. <criteria-list> is a list of search criterias in
5204 schoenebeck 1390
5205    
5206    
5207 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 93]
5208 schoenebeck 1390
5209     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5210    
5211    
5212 iliev 1189 form of "key1=val1 key2=val2 ...". The following criterias are
5213     allowed:
5214 iliev 1162
5215 iliev 1189 NAME='<search-string>'
5216 iliev 1162
5217 iliev 1189 Restricts the search to directories, which names satisfy the
5218 schoenebeck 1363 supplied search string (encapsulated into apostrophes, supporting
5219     escape sequences as described in chapter "Character Set and Escape
5220     Sequences (Section 7.1)").
5221 iliev 1162
5222 iliev 1189 CREATED='[<date-after>]..[<date-before>]'
5223 iliev 1162
5224 iliev 1189 Restricts the search to directories, which creation date satisfies
5225     the specified period, where <date-after> and <date-before> are in
5226     "YYYY-MM-DD HH:MM:SS" format. If <date-after> is omitted the
5227     search is restricted to directories created before <date-before>.
5228     If <date-before> is omitted, the search is restricted to
5229     directories created after <date-after>.
5230    
5231     MODIFIED='[<date-after>]..[<date-before>]'
5232    
5233     Restricts the search to directories, which date of last
5234     modification satisfies the specified period, where <date-after>
5235     and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. If <date-
5236     after> is omitted the search is restricted to directories, which
5237     are last modified before <date-before>. If <date-before> is
5238     omitted, the search is restricted to directories, which are last
5239     modified after <date-after>.
5240    
5241     DESCRIPTION='<search-string>'
5242    
5243     Restricts the search to directories with description that
5244 schoenebeck 1363 satisfies the supplied search string (encapsulated into
5245     apostrophes, supporting escape sequences as described in chapter
5246     "Character Set and Escape Sequences (Section 7.1)").
5247 iliev 1189
5248     Where <search-string> is either a regular expression, or a word list
5249     separated with spaces for OR search and with '+' for AND search.
5250    
5251     Possible Answers:
5252    
5253     A comma separated list with the absolute path names (encapsulated
5254     into apostrophes) of all directories in the specified directory
5255     that satisfy the supplied search criterias.
5256    
5257     "ERR:<error-code>:<error-message>" -
5258    
5259 schoenebeck 1390
5260    
5261    
5262    
5263 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 94]
5264 schoenebeck 1390
5265     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5266    
5267    
5268 iliev 1189 if the given directory does not exist.
5269    
5270     Example:
5271    
5272     C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"
5273    
5274     S: "'/Piano Collection'"
5275    
5276     C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:
5277     30:13'"
5278    
5279     S: "'/Piano Collection','/Percussions'"
5280    
5281     6.8.11. Adding instruments to the instruments database
5282    
5283 iliev 1162 The front-end can add one or more instruments to the instruments
5284     database by sending the following command:
5285    
5286 iliev 1201 ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path>
5287     [<instr_index>]
5288 iliev 1162
5289     Where <db_dir> is the absolute path name of a directory (encapsulated
5290     into apostrophes) in the instruments database in which only the new
5291     instruments (that are not already in the database) will be added,
5292     <file_path> is the absolute path name of a file or directory in the
5293     file system (encapsulated into apostrophes). In case an instrument
5294     file is supplied, only the instruments in the specified file will be
5295     added to the instruments database. If the optional <instr_index>
5296     (the index of the instrument within the given file) is supplied too,
5297     then only the specified instrument will be added. In case a
5298     directory is supplied, the instruments in that directory will be
5299     added. The OPTIONAL <mode> argument is only applied when a directory
5300     is provided as <file_path> and specifies how the scanning will be
5301     done and has exactly the following possibilities:
5302    
5303 iliev 1201 "RECURSIVE" -
5304    
5305     All instruments will be processed, including those in the
5306     subdirectories, and the respective subdirectory tree structure
5307     will be recreated in the instruments database
5308    
5309 iliev 1162 "NON_RECURSIVE" -
5310    
5311     Only the instruments in the specified directory will be added,
5312     the instruments in the subdirectories will not be processed.
5313    
5314 schoenebeck 1390
5315    
5316    
5317    
5318    
5319 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 95]
5320 schoenebeck 1390
5321     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5322    
5323    
5324 iliev 1162 "FLAT" -
5325    
5326     All instruments will be processed, including those in the
5327     subdirectories, but the respective subdirectory structure will
5328     not be recreated in the instruments database. All instruments
5329     will be added directly in the specified database directory.
5330    
5331 iliev 1201 The difference between regular and NON_MODAL versions of the command
5332     is that the regular command returns when the scanning is finished
5333     while NON_MODAL version returns immediately and a background process
5334     is launched. The GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5335     command can be used to monitor the scanning progress.
5336 iliev 1162
5337     Possible Answers:
5338    
5339 iliev 1201 "OK" -
5340 iliev 1162
5341 iliev 1201 on success when NON_MODAL is not supplied
5342 iliev 1162
5343 iliev 1201 "OK[<job-id>]" -
5344 iliev 1162
5345 iliev 1201 on success when NON_MODAL is supplied, where <job-id> is a
5346     numerical ID used to obtain status information about the job
5347     progress. See GET DB_INSTRUMENTS_JOB INFO (Section 6.8.21)
5348 iliev 1162
5349 schoenebeck 1363 "ERR:<error-code>:<error-message>" -
5350 schoenebeck 1251
5351 schoenebeck 1363 if an invalid path is specified.
5352 schoenebeck 1251
5353 schoenebeck 1363 Examples:
5354 schoenebeck 1251
5355 iliev 1162 C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
5356     Bosendorfer 290.gig' 0"
5357    
5358     S: "OK"
5359    
5360 iliev 1189 6.8.12. Removing an instrument
5361 iliev 1162
5362     The front-end can remove a particular instrument from the instruments
5363     database by sending the following command:
5364    
5365     REMOVE DB_INSTRUMENT <instr_path>
5366    
5367     Where <instr_path> is the absolute path name (in the instruments
5368     database) of the instrument to remove.
5369    
5370     Possible Answers:
5371    
5372 schoenebeck 1390
5373    
5374    
5375 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 96]
5376 schoenebeck 1390
5377     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5378    
5379    
5380 iliev 1162 "OK" -
5381    
5382     if the instrument is removed successfully
5383    
5384     "ERR:<error-code>:<error-message>" -
5385    
5386     if the given path does not exist or is a directory.
5387    
5388     Examples:
5389    
5390     C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"
5391    
5392     S: "OK"
5393    
5394 iliev 1189 6.8.13. Getting amount of instruments
5395 iliev 1162
5396     The front-end can retrieve the current amount of instruments in a
5397     specific directory by sending the following command:
5398    
5399 iliev 1189 GET DB_INSTRUMENTS [RECURSIVE] <dir>
5400 iliev 1162
5401     Where <dir> should be replaced by the absolute path name of the
5402 iliev 1189 directory. If RECURSIVE is specified, the number of all instruments,
5403     including those located in subdirectories of the specified directory,
5404     will be returned.
5405 iliev 1162
5406 schoenebeck 1363 Possible Answers:
5407 schoenebeck 1251
5408 schoenebeck 1363 The current number of instruments in the specified directory.
5409 schoenebeck 1251
5410 iliev 1162 "ERR:<error-code>:<error-message>" -
5411    
5412     if the given directory does not exist.
5413    
5414     Example:
5415    
5416     C: "GET DB_INSTRUMENTS '/Piano Collection'"
5417    
5418     S: "2"
5419    
5420 iliev 1189 6.8.14. Listing all instruments in specific directory
5421 iliev 1162
5422     The front-end can retrieve the current list of instruments in
5423     specific directory by sending the following command:
5424    
5425 iliev 1189 LIST DB_INSTRUMENTS [RECURSIVE] <dir>
5426 iliev 1162
5427     Where <dir> should be replaced by the absolute path name of the
5428 schoenebeck 1390
5429    
5430    
5431 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 97]
5432 schoenebeck 1390
5433     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5434    
5435    
5436 iliev 1189 directory. If RECURSIVE is specified, the absolute path names of all
5437     instruments, including those located in subdirectories of the
5438     specified directory, will be returned.
5439 iliev 1162
5440     Possible Answers:
5441    
5442     A comma separated list of all instruments (encapsulated into
5443     apostrophes) in the specified directory.
5444    
5445     "ERR:<error-code>:<error-message>" -
5446    
5447     if the given directory does not exist.
5448    
5449     Example:
5450    
5451     C: "LIST DB_INSTRUMENTS '/Piano Collection'"
5452    
5453     S: "'Bosendorfer 290','Steinway D'"
5454    
5455 iliev 1189 C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"
5456 iliev 1162
5457 iliev 1189 S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5458     Steinway D','/Piano Collection/Lite/Free Piano'"
5459    
5460 schoenebeck 1363 6.8.15. Getting instrument information
5461    
5462     The front-end can ask for the current settings of an instrument by
5463     sending the following command:
5464    
5465 iliev 1162 GET DB_INSTRUMENT INFO <instr_path>
5466    
5467     Where <instr_path> should be replaced by the absolute path name of
5468     the instrument the front-end is interested in.
5469    
5470     Possible Answers:
5471    
5472     LinuxSampler will answer by sending a <CRLF> separated list. Each
5473     answer line begins with the settings category name followed by a
5474     colon and then a space character <SP> and finally the info
5475     character string to that setting category. At the moment the
5476     following categories are defined:
5477    
5478    
5479    
5480     INSTRUMENT_FILE -
5481    
5482 schoenebeck 1363 File name of the instrument. Note that the character string
5483     may contain escape sequences (Section 7.1).
5484 iliev 1162
5485 schoenebeck 1390
5486    
5487 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 98]
5488 schoenebeck 1390
5489     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5490    
5491    
5492 iliev 1162 INSTRUMENT_NR -
5493    
5494     Index of the instrument within the file.
5495    
5496     FORMAT_FAMILY -
5497    
5498     The format family of the instrument.
5499    
5500     FORMAT_VERSION -
5501    
5502     The format version of the instrument.
5503    
5504     SIZE -
5505    
5506 iliev 1201 The size of the instrument in bytes.
5507 iliev 1189
5508 iliev 1201 CREATED -
5509 iliev 1189
5510 iliev 1201 The date and time when the instrument is added in the
5511     instruments database, represented in "YYYY-MM-DD HH:MM:SS"
5512     format
5513 iliev 1189
5514 schoenebeck 1363 MODIFIED -
5515 schoenebeck 1251
5516 schoenebeck 1363 The date and time of the last modification of the
5517     instrument's database settings, represented in "YYYY-MM-DD
5518     HH:MM:SS" format
5519 schoenebeck 1251
5520 iliev 1162 DESCRIPTION -
5521    
5522 schoenebeck 1363 A brief description of the instrument. Note that the
5523     character string may contain escape sequences (Section 7.1).
5524 iliev 1162
5525     IS_DRUM -
5526    
5527     either true or false, determines whether the instrument is a
5528     drumkit or a chromatic instrument
5529    
5530     PRODUCT -
5531    
5532 schoenebeck 1363 The product title of the instrument. Note that the
5533     character string may contain escape sequences (Section 7.1).
5534 iliev 1162
5535     ARTISTS -
5536    
5537 schoenebeck 1363 Lists the artist names. Note that the character string may
5538     contain escape sequences (Section 7.1).
5539 iliev 1162
5540 schoenebeck 1390
5541    
5542    
5543 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 99]
5544 schoenebeck 1390
5545     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5546    
5547    
5548 iliev 1162 KEYWORDS -
5549    
5550     Provides a list of keywords that refer to the instrument.
5551 schoenebeck 1363 Keywords are separated with semicolon and blank. Note that
5552     the character string may contain escape sequences
5553     (Section 7.1).
5554 iliev 1162
5555     The mentioned fields above don't have to be in particular order.
5556    
5557     Example:
5558    
5559     C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"
5560    
5561     S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"
5562    
5563     "INSTRUMENT_NR: 0"
5564    
5565     "FORMAT_FAMILY: GIG"
5566    
5567 iliev 1201 "FORMAT_VERSION: 2"
5568 iliev 1189
5569 iliev 1201 "SIZE: 2050871870"
5570 iliev 1189
5571 iliev 1201 "CREATED: 2007-02-05 10:23:12"
5572 iliev 1189
5573 iliev 1201 "MODIFIED: 2007-04-07 12:50:21"
5574 iliev 1189
5575 iliev 1162 "DESCRIPTION: "
5576    
5577     "IS_DRUM: false"
5578    
5579     "PRODUCT: GRANDIOSO Bosendorfer 290"
5580    
5581     "ARTISTS: Post Musical Instruments"
5582    
5583     "KEYWORDS: Bosendorfer"
5584    
5585     "."
5586    
5587 iliev 1189 6.8.16. Renaming an instrument
5588 iliev 1162
5589     The front-end can alter the name of a specific instrument by sending
5590     the following command:
5591    
5592     SET DB_INSTRUMENT NAME <instr> <name>
5593    
5594     Where <instr> is the absolute path name of the instrument and <name>
5595     is the new name for that instrument.
5596    
5597 schoenebeck 1390
5598    
5599 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 100]
5600 schoenebeck 1390
5601     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5602    
5603    
5604 iliev 1162 Possible Answers:
5605    
5606     "OK" -
5607    
5608     on success
5609    
5610     "ERR:<error-code>:<error-message>" -
5611    
5612     in case the given instrument does not exists, or if an
5613     instrument with name equal to the new name already exists.
5614    
5615     Example:
5616    
5617     C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer'
5618     'Bosendorfer 290'"
5619    
5620     S: "OK"
5621    
5622 iliev 1189 6.8.17. Moving an instrument
5623 iliev 1162
5624     The front-end can move a specific instrument to another directory by
5625     sending the following command:
5626    
5627     MOVE DB_INSTRUMENT <instr> <dst>
5628    
5629     Where <instr> is the absolute path name of the instrument to move and
5630     <dst> is the directory where the instrument will be moved to.
5631    
5632     Possible Answers:
5633    
5634     "OK" -
5635    
5636     on success
5637    
5638     "ERR:<error-code>:<error-message>" -
5639    
5640     in case the given instrument does not exists, or if an
5641     instrument with name equal to the name of the specified
5642 iliev 1189 instrument already exists in the destination directory.
5643 iliev 1162
5644 iliev 1189 Example:
5645 iliev 1162
5646 iliev 1189 C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano
5647     Collection/Acoustic'"
5648 iliev 1162
5649 iliev 1189 S: "OK"
5650 iliev 1162
5651 schoenebeck 1390
5652    
5653    
5654    
5655 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 101]
5656 schoenebeck 1390
5657     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5658    
5659    
5660 iliev 1189 6.8.18. Copying instruments
5661 iliev 1162
5662 iliev 1189 The front-end can copy a specific instrument to another directory by
5663     sending the following command:
5664    
5665     COPY DB_INSTRUMENT <instr> <dst>
5666    
5667     Where <instr> is the absolute path name of the instrument to copy and
5668     <dst> is the directory where the instrument will be copied to.
5669    
5670     Possible Answers:
5671    
5672     "OK" -
5673    
5674     on success
5675    
5676     "ERR:<error-code>:<error-message>" -
5677    
5678     in case the given instrument does not exists, or if an
5679     instrument with name equal to the name of the specified
5680 iliev 1162 instrument already exists in the destination directory.
5681    
5682     Example:
5683    
5684 iliev 1189 C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'
5685     '/Acoustic/Pianos/'"
5686 iliev 1162
5687     S: "OK"
5688    
5689 iliev 1189 6.8.19. Changing the description of instrument
5690 iliev 1162
5691     The front-end can alter the description of a specific instrument by
5692     sending the following command:
5693    
5694     SET DB_INSTRUMENT DESCRIPTION <instr> <desc>
5695    
5696     Where <instr> is the absolute path name of the instrument and <desc>
5697 schoenebeck 1363 is the new description for the instrument (encapsulated into
5698     apostrophes, supporting escape sequences as described in chapter
5699     "Character Set and Escape Sequences (Section 7.1)").
5700 iliev 1162
5701     Possible Answers:
5702    
5703     "OK" -
5704    
5705     on success
5706    
5707 schoenebeck 1390
5708    
5709    
5710    
5711 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 102]
5712 schoenebeck 1390
5713     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5714    
5715    
5716 iliev 1162 "ERR:<error-code>:<error-message>" -
5717    
5718     in case the given instrument does not exists.
5719    
5720     Example:
5721    
5722     C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/
5723     Bosendorfer 290' 'No comment :)'"
5724    
5725     S: "OK"
5726    
5727 iliev 1189 6.8.20. Finding instruments
5728 iliev 1162
5729 iliev 1189 The front-end can search for instruments in specific directory by
5730     sending the following command:
5731 iliev 1162
5732 iliev 1189 FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list>
5733 iliev 1162
5734 iliev 1189 Where <dir> should be replaced by the absolute path name of the
5735     directory to search in. If NON_RECURSIVE is specified, the
5736     directories located in subdirectories of the specified directory will
5737     not be searched. <criteria-list> is a list of search criterias in
5738     form of "key1=val1 key2=val2 ...". The following criterias are
5739     allowed:
5740 iliev 1162
5741 iliev 1189 NAME='<search-string>'
5742 iliev 1162
5743 iliev 1189 Restricts the search to instruments, which names satisfy the
5744 schoenebeck 1363 supplied search string (encapsulated into apostrophes, supporting
5745     escape sequences as described in chapter "Character Set and Escape
5746     Sequences (Section 7.1)").
5747 iliev 1162
5748 iliev 1189 SIZE=[<min>]..[<max>]
5749 iliev 1162
5750 iliev 1189 Restricts the search to instruments, which size is in the
5751     specified range. If <min> is omitted, the search results are
5752     restricted to instruments with size less then or equal to <max>.
5753     If <max> is omitted, the search is restricted to instruments with
5754     size greater then or equal to <min>.
5755 iliev 1162
5756 iliev 1189 CREATED='[<date-after>]..[<date-before>]'
5757 iliev 1162
5758 iliev 1189 Restricts the search to instruments, which creation date satisfies
5759     the specified period, where <date-after> and <date-before> are in
5760     "YYYY-MM-DD HH:MM:SS" format. If <date-after> is omitted the
5761     search is restricted to instruments created before <date-before>.
5762     If <date-before> is omitted, the search is restricted to
5763     instruments created after <date-after>.
5764 iliev 1162
5765 schoenebeck 1390
5766    
5767 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 103]
5768 schoenebeck 1390
5769     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5770    
5771    
5772 iliev 1189 MODIFIED='[<date-after>]..[<date-before>]'
5773    
5774     Restricts the search to instruments, which date of last
5775     modification satisfies the specified period, where <date-after>
5776     and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. If <date-
5777     after> is omitted the search is restricted to instruments, which
5778     are last modified before <date-before>. If <date-before> is
5779     omitted, the search is restricted to instruments, which are last
5780     modified after <date-after>.
5781    
5782     DESCRIPTION='<search-string>'
5783    
5784     Restricts the search to instruments with description that
5785 schoenebeck 1363 satisfies the supplied search string (encapsulated into
5786     apostrophes, supporting escape sequences as described in chapter
5787     "Character Set and Escape Sequences (Section 7.1)").
5788 iliev 1189
5789     PRODUCT='<search-string>'
5790    
5791     Restricts the search to instruments with product info that
5792 schoenebeck 1363 satisfies the supplied search string (encapsulated into
5793     apostrophes, supporting escape sequences as described in chapter
5794     "Character Set and Escape Sequences (Section 7.1)").
5795 iliev 1189
5796     ARTISTS='<search-string>'
5797    
5798     Restricts the search to instruments with artists info that
5799 schoenebeck 1363 satisfies the supplied search string (encapsulated into
5800     apostrophes, supporting escape sequences as described in chapter
5801     "Character Set and Escape Sequences (Section 7.1)").
5802 iliev 1189
5803     KEYWORDS='<search-string>'
5804    
5805     Restricts the search to instruments with keyword list that
5806 schoenebeck 1363 satisfies the supplied search string (encapsulated into
5807     apostrophes, supporting escape sequences as described in chapter
5808     "Character Set and Escape Sequences (Section 7.1)").
5809 iliev 1189
5810     IS_DRUM=true | false
5811    
5812     Either true or false. Restricts the search to drum kits or
5813     chromatic instruments.
5814    
5815     FORMAT_FAMILIES='<format-list>'
5816    
5817     Restricts the search to instruments of the supplied format
5818     families, where <format-list> is a comma separated list of format
5819     families.
5820    
5821 schoenebeck 1390
5822    
5823 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 104]
5824 schoenebeck 1390
5825     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5826    
5827    
5828 iliev 1189 Where <search-string> is either a regular expression, or a word list
5829     separated with spaces for OR search and with '+' for AND search.
5830    
5831     Possible Answers:
5832    
5833     A comma separated list with the absolute path names (encapsulated
5834     into apostrophes) of all instruments in the specified directory
5835     that satisfy the supplied search criterias.
5836    
5837     "ERR:<error-code>:<error-message>" -
5838    
5839     if the given directory does not exist.
5840    
5841     Example:
5842    
5843     C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+
5844     290'"
5845    
5846     S: "'/Piano Collection/Bosendorfer 290'"
5847    
5848     C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01
5849     09:30:13..'"
5850    
5851     S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/
5852     Steinway D'"
5853    
5854 iliev 1201 6.8.21. Getting job status information
5855 iliev 1189
5856 iliev 1201 The front-end can ask for the current status of a particular database
5857     instruments job by sending the following command:
5858 iliev 1189
5859 iliev 1201 GET DB_INSTRUMENTS_JOB INFO <job-id>
5860 iliev 1189
5861 iliev 1201 Where <job-id> should be replaced by the numerical ID of the job the
5862     front-end is interested in.
5863 iliev 1189
5864 iliev 1201 Possible Answers:
5865 iliev 1189
5866 iliev 1201 LinuxSampler will answer by sending a <CRLF> separated list. Each
5867     answer line begins with the settings category name followed by a
5868     colon and then a space character <SP> and finally the info
5869     character string to that setting category. At the moment the
5870     following categories are defined:
5871 iliev 1189
5872    
5873    
5874 iliev 1201 FILES_TOTAL -
5875    
5876 schoenebeck 1390
5877    
5878    
5879 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 105]
5880 schoenebeck 1390
5881     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5882    
5883    
5884 iliev 1201 The total number of files scheduled for scanning
5885    
5886     FILES_SCANNED -
5887    
5888     The current number of scanned files
5889    
5890     SCANNING -
5891    
5892     The absolute path name of the file which is currently being
5893     scanned
5894    
5895     STATUS -
5896    
5897     An integer value between 0 and 100 indicating the scanning
5898     progress percentage of the file which is currently being
5899     scanned
5900    
5901     The mentioned fields above don't have to be in particular order.
5902    
5903     Example:
5904    
5905     C: "GET DB_INSTRUMENTS_JOB INFO 2"
5906    
5907     S: "FILES_TOTAL: 12"
5908    
5909     "FILES_SCANNED: 7"
5910    
5911     "SCANNING: /home/me/gigs/Bosendorfer 290.gig"
5912    
5913     "STATUS: 42"
5914    
5915     "."
5916    
5917 schoenebeck 1363 6.8.22. Formatting the instruments database
5918 iliev 1201
5919 schoenebeck 1363 The front-end can remove all instruments and directories and re-
5920     create the instruments database structure (e.g., in case of a
5921     database corruption) by sending the following command:
5922 iliev 1201
5923 schoenebeck 1363 FORMAT INSTRUMENTS_DB
5924 iliev 1201
5925 schoenebeck 1363 Possible Answers:
5926 iliev 1201
5927 schoenebeck 1363 "OK" -
5928 iliev 1201
5929 schoenebeck 1363 on success
5930 iliev 1201
5931 schoenebeck 1390
5932    
5933    
5934    
5935 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 106]
5936 schoenebeck 1390
5937     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5938    
5939    
5940 schoenebeck 1363 "ERR:<error-code>:<error-message>" -
5941 iliev 1201
5942 schoenebeck 1363 If the formatting of the instruments database failed.
5943 iliev 1201
5944 schoenebeck 1363 6.9. Editing Instruments
5945    
5946     The sampler allows to edit instruments while playing with the sampler
5947     by spawning an external (3rd party) instrument editor application for
5948     a given instrument. The 3rd party instrument editor applications
5949     have to place a respective plugin DLL file into the sampler's plugins
5950     directory. The sampler will automatically try to load all plugin
5951     DLLs in that directory on startup and only on startup!
5952    
5953     At the moment there is only one command for this feature set, but
5954     this will most probably change in future.
5955    
5956     6.9.1. Opening an appropriate instrument editor application
5957    
5958     The front-end can request to open an appropriate instrument editor
5959     application by sending the following command:
5960    
5961     EDIT INSTRUMENT <sampler-channel>
5962    
5963     Where <sampler-channel> should be replaced by the number of the
5964     sampler channel as given by the "ADD CHANNEL" (Section 6.4.5) or
5965     "LIST CHANNELS" (Section 6.4.4) command.
5966    
5967     The sampler will try to ask all registered instrument editors (or to
5968     be more specific: their sampler plugins) whether they are capable to
5969     handle the instrument on the given sampler channel. The sampler will
5970     simply use the first instrument editor application which replied with
5971     a positive answer and spawn that instrument editor application within
5972     the sampler's process and provide that application access to the
5973     instrument's data structures, so both applications can share and
5974     access the same instruments data at the same time, thus allowing to
5975     immediately hear changes with the sampler made by the instrument
5976     editor.
5977    
5978     Note: consequently instrument editors are always spawned locally on
5979     the same machine where the sampler is running on!
5980    
5981     Possible Answers:
5982    
5983     "OK" -
5984    
5985     when an appropriate instrument editor was launched
5986    
5987 schoenebeck 1390
5988    
5989    
5990    
5991 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 107]
5992 schoenebeck 1390
5993     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
5994    
5995    
5996 schoenebeck 1363 "WRN:<warning-code>:<warning-message>" -
5997    
5998     when an appropriate instrument editor was launched, but there
5999     are noteworthy issues
6000    
6001     "ERR:<error-code>:<error-message>" -
6002    
6003     when an appropriate instrument editor could not be launched
6004    
6005     Examples:
6006    
6007     C: "EDIT INSTRUMENT 0"
6008    
6009     S: "OK"
6010    
6011    
6012    
6013    
6014    
6015    
6016    
6017    
6018    
6019    
6020    
6021 schoenebeck 1390
6022    
6023    
6024    
6025    
6026    
6027    
6028    
6029    
6030    
6031    
6032    
6033    
6034    
6035    
6036    
6037    
6038    
6039    
6040    
6041    
6042    
6043    
6044    
6045    
6046    
6047 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 108]
6048 schoenebeck 1363
6049 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6050 schoenebeck 1363
6051    
6052 schoenebeck 575 7. Command Syntax
6053 senoner 542
6054 schoenebeck 575 The grammar of the control protocol as descibed in Section 6 is
6055     defined below using Backus-Naur Form (BNF as described in [RFC2234])
6056     where applicable.
6057 senoner 542
6058 schoenebeck 575 input =
6059 schoenebeck 708
6060 schoenebeck 575 line LF
6061 schoenebeck 708
6062 schoenebeck 575 / line CR LF
6063 senoner 542
6064 schoenebeck 575 line =
6065 schoenebeck 708
6066 schoenebeck 575 /* epsilon (empty line ignored) */
6067 schoenebeck 708
6068 schoenebeck 575 / comment
6069 schoenebeck 708
6070 schoenebeck 575 / command
6071 schoenebeck 708
6072 schoenebeck 575 / error
6073 senoner 542
6074 schoenebeck 575 comment =
6075 schoenebeck 708
6076 schoenebeck 575 '#'
6077 schoenebeck 708
6078 schoenebeck 575 / comment '#'
6079 schoenebeck 708
6080 schoenebeck 575 / comment SP
6081 schoenebeck 708
6082 schoenebeck 575 / comment number
6083 schoenebeck 708
6084 schoenebeck 575 / comment string
6085 senoner 542
6086 schoenebeck 575 command =
6087 schoenebeck 708
6088 schoenebeck 974 ADD SP add_instruction
6089 schoenebeck 708
6090 schoenebeck 945 / MAP SP map_instruction
6091    
6092     / UNMAP SP unmap_instruction
6093    
6094 schoenebeck 575 / GET SP get_instruction
6095 schoenebeck 708
6096 schoenebeck 575 / CREATE SP create_instruction
6097 schoenebeck 708
6098 schoenebeck 575 / DESTROY SP destroy_instruction
6099 schoenebeck 708
6100    
6101    
6102    
6103 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 109]
6104 schoenebeck 940
6105 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6106 schoenebeck 708
6107    
6108 schoenebeck 945 / LIST SP list_instruction
6109 schoenebeck 708
6110 schoenebeck 945 / LOAD SP load_instruction
6111    
6112     / REMOVE SP remove_instruction
6113    
6114 schoenebeck 575 / SET SP set_instruction
6115 schoenebeck 708
6116 schoenebeck 575 / SUBSCRIBE SP subscribe_event
6117 schoenebeck 708
6118 schoenebeck 575 / UNSUBSCRIBE SP unsubscribe_event
6119 schoenebeck 708
6120 schoenebeck 945 / RESET SP reset_instruction
6121 schoenebeck 708
6122 schoenebeck 945 / CLEAR SP clear_instruction
6123    
6124 iliev 1189 / FIND SP find_instruction
6125    
6126 iliev 1162 / MOVE SP move_instruction
6127    
6128 iliev 1189 / COPY SP copy_instruction
6129    
6130 schoenebeck 1251 / EDIT SP edit_instruction
6131    
6132 schoenebeck 1363 / FORMAT SP format_instruction
6133    
6134 schoenebeck 575 / RESET
6135 schoenebeck 708
6136 schoenebeck 575 / QUIT
6137 senoner 542
6138 schoenebeck 974 add_instruction =
6139    
6140     CHANNEL
6141    
6142 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORY SP db_path
6143 iliev 1162
6144 schoenebeck 1363 / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
6145 iliev 1162
6146 schoenebeck 1363 / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
6147 iliev 1162
6148 schoenebeck 1363 / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
6149 iliev 1201
6150 schoenebeck 1363 / DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP
6151 iliev 1201 instrument_index
6152    
6153 schoenebeck 1363 / DB_INSTRUMENTS SP db_path SP filename
6154 iliev 1162
6155    
6156 schoenebeck 974
6157    
6158 schoenebeck 708
6159 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 110]
6160 iliev 1189
6161 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6162 iliev 1162
6163    
6164 schoenebeck 1363 / DB_INSTRUMENTS SP db_path SP filename SP instrument_index
6165    
6166 schoenebeck 1251 / MIDI_INSTRUMENT_MAP
6167    
6168 iliev 1201 / MIDI_INSTRUMENT_MAP SP map_name
6169    
6170     subscribe_event =
6171    
6172     AUDIO_OUTPUT_DEVICE_COUNT
6173    
6174 iliev 1189 / AUDIO_OUTPUT_DEVICE_INFO
6175 iliev 1162
6176 iliev 1189 / MIDI_INPUT_DEVICE_COUNT
6177 iliev 1162
6178 iliev 993 / MIDI_INPUT_DEVICE_INFO
6179    
6180     / CHANNEL_COUNT
6181    
6182 schoenebeck 575 / VOICE_COUNT
6183 schoenebeck 708
6184 schoenebeck 575 / STREAM_COUNT
6185 schoenebeck 708
6186 schoenebeck 575 / BUFFER_FILL
6187 schoenebeck 708
6188 schoenebeck 575 / CHANNEL_INFO
6189 schoenebeck 708
6190 iliev 1110 / FX_SEND_COUNT
6191    
6192     / FX_SEND_INFO
6193    
6194 iliev 993 / MIDI_INSTRUMENT_MAP_COUNT
6195    
6196     / MIDI_INSTRUMENT_MAP_INFO
6197    
6198     / MIDI_INSTRUMENT_COUNT
6199    
6200     / MIDI_INSTRUMENT_INFO
6201    
6202 iliev 1162 / DB_INSTRUMENT_DIRECTORY_COUNT
6203    
6204     / DB_INSTRUMENT_DIRECTORY_INFO
6205    
6206     / DB_INSTRUMENT_COUNT
6207    
6208     / DB_INSTRUMENT_INFO
6209    
6210 iliev 1201 / DB_INSTRUMENTS_JOB_INFO
6211    
6212 senoner 542
6213 schoenebeck 940
6214 iliev 1110
6215 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 111]
6216 iliev 1201
6217 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6218 senoner 542
6219    
6220 schoenebeck 1363 / MISCELLANEOUS
6221    
6222 schoenebeck 1251 / TOTAL_VOICE_COUNT
6223    
6224 iliev 1201 / GLOBAL_INFO
6225 senoner 542
6226 iliev 1201 unsubscribe_event =
6227 iliev 1162
6228 iliev 1201 AUDIO_OUTPUT_DEVICE_COUNT
6229 iliev 1162
6230 iliev 1201 / AUDIO_OUTPUT_DEVICE_INFO
6231 iliev 1162
6232 iliev 1189 / MIDI_INPUT_DEVICE_COUNT
6233 iliev 1162
6234 iliev 1189 / MIDI_INPUT_DEVICE_INFO
6235 iliev 1162
6236 iliev 993 / CHANNEL_COUNT
6237 schoenebeck 945
6238 schoenebeck 974 / VOICE_COUNT
6239 schoenebeck 945
6240 schoenebeck 974 / STREAM_COUNT
6241 schoenebeck 945
6242 schoenebeck 974 / BUFFER_FILL
6243 schoenebeck 945
6244 schoenebeck 575 / CHANNEL_INFO
6245 schoenebeck 708
6246 iliev 1110 / FX_SEND_COUNT
6247    
6248     / FX_SEND_INFO
6249    
6250 iliev 993 / MIDI_INSTRUMENT_MAP_COUNT
6251    
6252     / MIDI_INSTRUMENT_MAP_INFO
6253    
6254 iliev 1162 / MIDI_INSTRUMENT_COUNT
6255 iliev 1110
6256 iliev 1162 / MIDI_INSTRUMENT_INFO
6257 iliev 1110
6258 iliev 1162 / DB_INSTRUMENT_DIRECTORY_COUNT
6259 iliev 1110
6260 iliev 1162 / DB_INSTRUMENT_DIRECTORY_INFO
6261 iliev 1110
6262 iliev 1162 / DB_INSTRUMENT_COUNT
6263 iliev 1110
6264 iliev 1162 / DB_INSTRUMENT_INFO
6265 iliev 993
6266 iliev 1201 / DB_INSTRUMENTS_JOB_INFO
6267    
6268 schoenebeck 575
6269 schoenebeck 708
6270 iliev 1201
6271 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 112]
6272 iliev 1201
6273 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6274 iliev 1201
6275    
6276 schoenebeck 1363 / MISCELLANEOUS
6277    
6278 schoenebeck 1251 / TOTAL_VOICE_COUNT
6279    
6280 iliev 1110 / GLOBAL_INFO
6281    
6282 schoenebeck 945 map_instruction =
6283 schoenebeck 708
6284 schoenebeck 1048 MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP
6285 schoenebeck 945 engine_name SP filename SP instrument_index SP volume_value
6286 schoenebeck 708
6287 schoenebeck 1048 / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6288     SP engine_name SP filename SP instrument_index SP volume_value SP
6289 schoenebeck 945 instr_load_mode
6290 schoenebeck 708
6291 schoenebeck 1048 / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6292     SP engine_name SP filename SP instrument_index SP volume_value SP
6293 iliev 1189 entry_name
6294    
6295     / MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog
6296     SP engine_name SP filename SP instrument_index SP volume_value SP
6297 schoenebeck 945 instr_load_mode SP entry_name
6298 schoenebeck 708
6299 schoenebeck 945 unmap_instruction =
6300    
6301 schoenebeck 974 MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
6302 schoenebeck 945
6303     remove_instruction =
6304    
6305     CHANNEL SP sampler_channel
6306    
6307 schoenebeck 974 / MIDI_INSTRUMENT_MAP SP midi_map
6308    
6309     / MIDI_INSTRUMENT_MAP SP ALL
6310    
6311 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
6312 iliev 1162
6313 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORY SP db_path
6314 iliev 1162
6315 schoenebeck 1363 / DB_INSTRUMENT SP db_path
6316 iliev 1162
6317 schoenebeck 940 get_instruction =
6318 schoenebeck 708
6319 schoenebeck 940 AVAILABLE_ENGINES
6320 schoenebeck 708
6321 schoenebeck 575 / AVAILABLE_MIDI_INPUT_DRIVERS
6322 schoenebeck 708
6323    
6324    
6325 iliev 1201
6326    
6327 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 113]
6328 iliev 1201
6329 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6330 iliev 1201
6331    
6332 schoenebeck 1363 / MIDI_INPUT_DRIVER SP INFO SP string
6333    
6334 schoenebeck 1251 / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
6335    
6336 schoenebeck 575 / MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6337     key_val_list
6338 schoenebeck 708
6339 schoenebeck 575 / AVAILABLE_AUDIO_OUTPUT_DRIVERS
6340 schoenebeck 708
6341 schoenebeck 575 / AUDIO_OUTPUT_DRIVER SP INFO SP string
6342 schoenebeck 708
6343 schoenebeck 575 / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
6344 schoenebeck 708
6345 schoenebeck 575 / AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP
6346     key_val_list
6347 schoenebeck 708
6348 iliev 1189 / AUDIO_OUTPUT_DEVICES
6349 iliev 1162
6350 iliev 1189 / MIDI_INPUT_DEVICES
6351 iliev 1162
6352 schoenebeck 575 / AUDIO_OUTPUT_DEVICE SP INFO SP number
6353 schoenebeck 708
6354 schoenebeck 575 / MIDI_INPUT_DEVICE SP INFO SP number
6355 schoenebeck 708
6356 schoenebeck 575 / MIDI_INPUT_PORT SP INFO SP number SP number
6357 schoenebeck 708
6358 schoenebeck 575 / MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
6359 schoenebeck 708
6360 schoenebeck 575 / AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
6361 schoenebeck 708
6362 schoenebeck 575 / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
6363     string
6364 schoenebeck 708
6365 schoenebeck 575 / CHANNELS
6366 schoenebeck 708
6367 schoenebeck 575 / CHANNEL SP INFO SP sampler_channel
6368 schoenebeck 708
6369 schoenebeck 575 / CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
6370 schoenebeck 708
6371 schoenebeck 575 / CHANNEL SP STREAM_COUNT SP sampler_channel
6372 schoenebeck 708
6373 schoenebeck 940 / CHANNEL SP VOICE_COUNT SP sampler_channel
6374 schoenebeck 708
6375 schoenebeck 940 / ENGINE SP INFO SP engine_name
6376 schoenebeck 708
6377 schoenebeck 575 / SERVER SP INFO
6378    
6379 schoenebeck 940
6380    
6381 iliev 1201
6382    
6383 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 114]
6384 iliev 1201
6385 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6386 iliev 1201
6387    
6388 schoenebeck 1363 / TOTAL_VOICE_COUNT
6389    
6390 schoenebeck 1251 / TOTAL_VOICE_COUNT_MAX
6391    
6392 schoenebeck 974 / MIDI_INSTRUMENTS SP midi_map
6393 schoenebeck 945
6394 schoenebeck 974 / MIDI_INSTRUMENTS SP ALL
6395 schoenebeck 945
6396 schoenebeck 974 / MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
6397 schoenebeck 708
6398 schoenebeck 974 / MIDI_INSTRUMENT_MAPS
6399 schoenebeck 945
6400 schoenebeck 974 / MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6401 schoenebeck 945
6402 schoenebeck 1002 / FX_SENDS SP sampler_channel
6403 schoenebeck 945
6404 iliev 1189 / FX_SEND SP INFO SP sampler_channel SP fx_send_id
6405 iliev 1162
6406 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6407 iliev 1162
6408 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORIES SP db_path
6409 iliev 1189
6410 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
6411 iliev 1162
6412 schoenebeck 1363 / DB_INSTRUMENTS SP RECURSIVE SP db_path
6413 iliev 1189
6414 schoenebeck 1363 / DB_INSTRUMENTS SP db_path
6415 iliev 1162
6416 schoenebeck 1363 / DB_INSTRUMENT SP INFO SP db_path
6417 iliev 1162
6418 iliev 1201 / DB_INSTRUMENTS_JOB SP INFO SP number
6419    
6420 schoenebeck 1006 / VOLUME
6421    
6422 schoenebeck 1002 set_instruction =
6423    
6424 schoenebeck 575 AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '='
6425     param_val_list
6426 schoenebeck 708
6427 schoenebeck 575 / AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '='
6428     param_val_list
6429 schoenebeck 708
6430 schoenebeck 575 / MIDI_INPUT_DEVICE_PARAMETER SP number SP string '='
6431     param_val_list
6432 schoenebeck 708
6433 schoenebeck 1363 / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
6434 schoenebeck 708
6435    
6436 schoenebeck 974
6437 iliev 1201
6438    
6439 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 115]
6440 iliev 1201
6441 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6442 iliev 1201
6443    
6444 schoenebeck 1363 / MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '='
6445     param_val_list
6446    
6447     / CHANNEL SP set_chan_instruction
6448    
6449 schoenebeck 1251 / MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6450    
6451 iliev 1137 / FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6452    
6453 schoenebeck 1002 / FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id
6454     SP audio_channel_index SP audio_channel_index
6455    
6456 schoenebeck 1028 / FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP
6457     midi_ctrl
6458    
6459     / FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP
6460     volume_value
6461    
6462 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
6463 schoenebeck 575
6464 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP
6465     stringval_escaped
6466 iliev 1162
6467 schoenebeck 1363 / DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
6468 iliev 1162
6469 schoenebeck 1363 / DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
6470 iliev 1110
6471 iliev 1189 / ECHO SP boolean
6472 iliev 1110
6473 schoenebeck 1006 / VOLUME SP volume_value
6474    
6475 schoenebeck 708 create_instruction =
6476 schoenebeck 575
6477 schoenebeck 708 AUDIO_OUTPUT_DEVICE SP string SP key_val_list
6478 schoenebeck 575
6479 schoenebeck 708 / AUDIO_OUTPUT_DEVICE SP string
6480 schoenebeck 575
6481 schoenebeck 708 / MIDI_INPUT_DEVICE SP string SP key_val_list
6482 senoner 542
6483 schoenebeck 575 / MIDI_INPUT_DEVICE SP string
6484 senoner 542
6485 schoenebeck 1002 / FX_SEND SP sampler_channel SP midi_ctrl
6486    
6487     / FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6488    
6489 schoenebeck 945 reset_instruction =
6490    
6491    
6492    
6493 schoenebeck 1006
6494 schoenebeck 974
6495 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 116]
6496 schoenebeck 1363
6497 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6498 iliev 1189
6499 iliev 1201
6500 schoenebeck 1363 CHANNEL SP sampler_channel
6501 iliev 1201
6502 schoenebeck 1363 clear_instruction =
6503 iliev 1201
6504 schoenebeck 1363 MIDI_INSTRUMENTS SP midi_map
6505 iliev 1201
6506 schoenebeck 1251 / MIDI_INSTRUMENTS SP ALL
6507    
6508     find_instruction =
6509    
6510 schoenebeck 1363 DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
6511 iliev 1189
6512 schoenebeck 1363 / DB_INSTRUMENTS SP db_path SP query_val_list
6513 iliev 1189
6514 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP
6515 iliev 1189 query_val_list
6516    
6517 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
6518 iliev 1189
6519 iliev 1162 move_instruction =
6520    
6521 schoenebeck 1363 DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6522 iliev 1162
6523 schoenebeck 1363 / DB_INSTRUMENT SP db_path SP db_path
6524 iliev 1162
6525 iliev 1189 copy_instruction =
6526    
6527 schoenebeck 1363 DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
6528 iliev 1189
6529 schoenebeck 1363 / DB_INSTRUMENT SP db_path SP db_path
6530 iliev 1189
6531 schoenebeck 575 destroy_instruction =
6532 schoenebeck 708
6533 schoenebeck 575 AUDIO_OUTPUT_DEVICE SP number
6534 schoenebeck 708
6535 schoenebeck 575 / MIDI_INPUT_DEVICE SP number
6536 senoner 542
6537 schoenebeck 1002 / FX_SEND SP sampler_channel SP fx_send_id
6538    
6539 schoenebeck 575 load_instruction =
6540 schoenebeck 708
6541 schoenebeck 575 INSTRUMENT SP load_instr_args
6542 schoenebeck 708
6543 schoenebeck 945 / ENGINE SP load_engine_args
6544 schoenebeck 940
6545 schoenebeck 945 set_chan_instruction =
6546 schoenebeck 940
6547 iliev 1162
6548    
6549 schoenebeck 708
6550    
6551 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 117]
6552 schoenebeck 1363
6553 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6554 iliev 1201
6555    
6556 schoenebeck 1363 AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
6557 iliev 1201
6558 schoenebeck 1363 / AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index
6559     SP audio_channel_index
6560 iliev 1201
6561 schoenebeck 1363 / AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
6562    
6563 schoenebeck 1251 / MIDI_INPUT SP sampler_channel SP device_index SP
6564     midi_input_port_index SP midi_input_channel_index
6565 iliev 1201
6566 schoenebeck 575 / MIDI_INPUT_DEVICE SP sampler_channel SP device_index
6567 schoenebeck 708
6568 schoenebeck 575 / MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
6569 schoenebeck 708
6570 schoenebeck 575 / MIDI_INPUT_CHANNEL SP sampler_channel SP
6571     midi_input_channel_index
6572 schoenebeck 708
6573 schoenebeck 575 / MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
6574 schoenebeck 708
6575 schoenebeck 1028 / VOLUME SP sampler_channel SP volume_value
6576 schoenebeck 1002
6577 schoenebeck 1028 / MUTE SP sampler_channel SP boolean
6578 schoenebeck 1002
6579 schoenebeck 1028 / SOLO SP sampler_channel SP boolean
6580 schoenebeck 1002
6581 schoenebeck 1028 / MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
6582 schoenebeck 1002
6583 schoenebeck 1006 / MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
6584    
6585 schoenebeck 974 / MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
6586    
6587 schoenebeck 1251 edit_instruction =
6588    
6589     INSTRUMENT SP sampler_channel
6590    
6591 schoenebeck 1363 format_instruction =
6592    
6593     INSTRUMENTS_DB
6594    
6595 schoenebeck 1048 modal_arg =
6596    
6597     /* epsilon (empty argument) */
6598    
6599     / NON_MODAL SP
6600    
6601 schoenebeck 575 key_val_list =
6602 schoenebeck 708
6603 schoenebeck 1363
6604    
6605    
6606    
6607 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 118]
6608 schoenebeck 1363
6609 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6610 schoenebeck 1363
6611    
6612 schoenebeck 575 string '=' param_val_list
6613 schoenebeck 708
6614 schoenebeck 575 / key_val_list SP string '=' param_val_list
6615 senoner 542
6616 schoenebeck 575 buffer_size_type =
6617 schoenebeck 708
6618 schoenebeck 575 BYTES
6619 schoenebeck 708
6620 iliev 1162 / PERCENTAGE
6621 iliev 1110
6622 iliev 1162 list_instruction =
6623 iliev 1110
6624 schoenebeck 1251 AUDIO_OUTPUT_DEVICES
6625 iliev 1201
6626 schoenebeck 1251 / MIDI_INPUT_DEVICES
6627 iliev 1201
6628 schoenebeck 1251 / CHANNELS
6629 iliev 1201
6630 schoenebeck 945 / AVAILABLE_ENGINES
6631 schoenebeck 708
6632 schoenebeck 974 / AVAILABLE_MIDI_INPUT_DRIVERS
6633 schoenebeck 708
6634 schoenebeck 974 / AVAILABLE_AUDIO_OUTPUT_DRIVERS
6635 senoner 542
6636 schoenebeck 974 / MIDI_INSTRUMENTS SP midi_map
6637 schoenebeck 945
6638 schoenebeck 974 / MIDI_INSTRUMENTS SP ALL
6639 schoenebeck 945
6640 schoenebeck 1048 / MIDI_INSTRUMENT_MAPS
6641 schoenebeck 708
6642 schoenebeck 1048 / FX_SENDS SP sampler_channel
6643 senoner 542
6644 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
6645 iliev 1189
6646 schoenebeck 1363 / DB_INSTRUMENT_DIRECTORIES SP db_path
6647 iliev 1162
6648 schoenebeck 1363 / DB_INSTRUMENTS SP RECURSIVE SP db_path
6649 iliev 1189
6650 schoenebeck 1363 / DB_INSTRUMENTS SP db_path
6651 iliev 1162
6652 schoenebeck 1048 load_instr_args =
6653 schoenebeck 945
6654 schoenebeck 1028 filename SP instrument_index SP sampler_channel
6655 schoenebeck 1002
6656 schoenebeck 1028 / NON_MODAL SP filename SP instrument_index SP sampler_channel
6657 schoenebeck 1002
6658 schoenebeck 1028 load_engine_args =
6659 schoenebeck 1002
6660 schoenebeck 1363
6661    
6662    
6663 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 119]
6664 schoenebeck 1363
6665 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6666 schoenebeck 1363
6667    
6668 schoenebeck 1028 engine_name SP sampler_channel
6669 schoenebeck 1002
6670 schoenebeck 1006 instr_load_mode =
6671    
6672 schoenebeck 945 ON_DEMAND
6673    
6674     / ON_DEMAND_HOLD
6675    
6676     / PERSISTENT
6677    
6678 schoenebeck 575 device_index =
6679 schoenebeck 708
6680 schoenebeck 1251 number
6681 iliev 1201
6682 schoenebeck 1251 audio_channel_index =
6683 iliev 1201
6684 schoenebeck 1251 number
6685 iliev 1201
6686 schoenebeck 575 audio_output_type_name =
6687 schoenebeck 708
6688 schoenebeck 575 string
6689 senoner 542
6690 schoenebeck 575 midi_input_port_index =
6691 schoenebeck 708
6692 schoenebeck 575 number
6693 senoner 542
6694 schoenebeck 575 midi_input_channel_index =
6695 schoenebeck 708
6696 schoenebeck 575 number
6697 schoenebeck 708
6698 schoenebeck 575 / ALL
6699 senoner 542
6700 schoenebeck 575 midi_input_type_name =
6701 schoenebeck 708
6702 schoenebeck 575 string
6703 senoner 542
6704 schoenebeck 1048 midi_map =
6705 schoenebeck 940
6706 schoenebeck 1048 number
6707 schoenebeck 1002
6708 schoenebeck 1048 midi_bank =
6709 schoenebeck 1002
6710 schoenebeck 1028 number
6711 schoenebeck 1002
6712 schoenebeck 1028 midi_prog =
6713 schoenebeck 1002
6714 schoenebeck 1028 number
6715 schoenebeck 1002
6716 schoenebeck 1363
6717    
6718    
6719 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 120]
6720 schoenebeck 1363
6721 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6722 schoenebeck 1363
6723    
6724 schoenebeck 1028 midi_ctrl =
6725 schoenebeck 1002
6726 schoenebeck 1006 number
6727    
6728 schoenebeck 945 volume_value =
6729 schoenebeck 940
6730 schoenebeck 945 dotnum
6731    
6732 schoenebeck 575 / number
6733 senoner 542
6734 schoenebeck 575 sampler_channel =
6735 schoenebeck 708
6736 schoenebeck 1251 number
6737 iliev 1201
6738 schoenebeck 1251 instrument_index =
6739 iliev 1201
6740 schoenebeck 1251 number
6741 iliev 1201
6742 schoenebeck 1002 fx_send_id =
6743    
6744     number
6745    
6746 iliev 1162 engine_name =
6747 iliev 1110
6748 iliev 1162 string
6749 iliev 1110
6750 schoenebeck 1363 filename =
6751 iliev 1110
6752 schoenebeck 1363 path
6753 iliev 1110
6754 schoenebeck 1363 db_path =
6755 iliev 1110
6756 schoenebeck 1363 path
6757 senoner 542
6758 schoenebeck 974 map_name =
6759    
6760 schoenebeck 1390 stringval_escaped
6761 schoenebeck 974
6762 schoenebeck 945 entry_name =
6763    
6764 schoenebeck 1390 stringval_escaped
6765 senoner 542
6766 schoenebeck 1048 fx_send_name =
6767 senoner 542
6768 schoenebeck 1390 stringval_escaped
6769 senoner 542
6770 schoenebeck 1028 param_val_list =
6771 schoenebeck 1002
6772    
6773    
6774    
6775 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 121]
6776 schoenebeck 1363
6777 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6778 schoenebeck 1006
6779 senoner 542
6780 schoenebeck 1363 param_val
6781 senoner 542
6782 schoenebeck 1363 / param_val_list','param_val
6783 senoner 542
6784 schoenebeck 1363 param_val =
6785 iliev 1201
6786 schoenebeck 1363 string
6787 iliev 1201
6788 schoenebeck 1251 / stringval
6789 iliev 1201
6790 schoenebeck 1251 / number
6791 iliev 1201
6792 schoenebeck 1251 / dotnum
6793 iliev 1201
6794 iliev 1189 query_val_list =
6795 senoner 542
6796 iliev 1189 string '=' query_val
6797 senoner 542
6798 iliev 1189 / query_val_list SP string '=' query_val
6799 senoner 542
6800 iliev 1189 query_val =
6801 senoner 542
6802 schoenebeck 1390 text_escaped
6803 senoner 542
6804 schoenebeck 1363 / stringval_escaped
6805 schoenebeck 575
6806 iliev 1201 scan_mode =
6807 schoenebeck 575
6808 iliev 1201 RECURSIVE
6809 iliev 993
6810 iliev 1201 / NON_RECURSIVE
6811 iliev 993
6812 iliev 1201 / FLAT
6813    
6814 schoenebeck 1251 7.1. Character Set and Escape Sequences
6815 iliev 1201
6816 schoenebeck 1251 Older versions of this protocol up to and including v1.1 only
6817     supported the standard ASCII character set (ASCII code 0 - 127)
6818     [RFC20], all younger versions of this protocol however support the
6819     Extended ASCII character set (ASCII code 0 - 255). The same group of
6820     younger protocols also support escape sequences, but only for
6821     certain, explicitly declared parts of the protocol. The supported
6822     escape sequences are defined as follows:
6823 iliev 1201
6824    
6825    
6826    
6827    
6828    
6829    
6830    
6831 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 122]
6832 schoenebeck 1251
6833 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6834 iliev 1201
6835    
6836 schoenebeck 1251 +------------------------+------------------------------------------+
6837     | ASCII Character | Translated into (Name) |
6838     | Sequence | |
6839     +------------------------+------------------------------------------+
6840     | \n | new line |
6841     | | |
6842     | \r | carriage return |
6843     | | |
6844     | \f | form feed |
6845     | | |
6846     | \t | horizontal tab |
6847     | | |
6848     | \v | vertical tab |
6849     | | |
6850     | \' | apostrophe |
6851     | | |
6852     | \" | quotation mark |
6853     | | |
6854     | \\ | backslash |
6855     | | |
6856     | \OOO | three digit octal ASCII code of the |
6857     | | character |
6858     | | |
6859     | \xHH | two digit hex ASCII code of the |
6860     | | character |
6861     +------------------------+------------------------------------------+
6862 iliev 1201
6863 schoenebeck 1251 Notice: due to the transition of certain parts of the protocol which
6864     now support escape sequences, a slight backward incompatibility to
6865     protocols version v1.1 and younger has been introduced. The only
6866     difference is that in parts of the protocol where escape characters
6867     are now supported, a backslash characters MUST be escaped as well
6868     (that is as double backslash), whereas in the old versions a single
6869     backslash was sufficient.
6870 iliev 1201
6871 schoenebeck 1390 The following LSCP commands support escape sequences as part of their
6872 schoenebeck 1400 filename / path based arguments and / or may contain a filename /
6873     path with escape sequences in their response:
6874 iliev 1201
6875 schoenebeck 1390 "LOAD INSTRUMENT" (Section 6.4.1)
6876 iliev 1201
6877 schoenebeck 1400 "GET CHANNEL INFO" (Section 6.4.10)
6878    
6879 schoenebeck 1390 "MAP MIDI_INSTRUMENT" (Section 6.7.7)
6880 iliev 1201
6881 schoenebeck 1400 "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
6882 iliev 1201
6883    
6884    
6885    
6886    
6887 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 123]
6888 schoenebeck 1390
6889     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6890 iliev 1201
6891 schoenebeck 1251
6892 schoenebeck 1400 "ADD DB_INSTRUMENT_DIRECTORY" (Section 6.8.1)
6893    
6894     "ADD DB_INSTRUMENTS" (Section 6.8.11)
6895    
6896     "REMOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.2)
6897    
6898 schoenebeck 1390 "REMOVE DB_INSTRUMENT" (Section 6.8.12)
6899 schoenebeck 1251
6900 schoenebeck 1390 "GET DB_INSTRUMENT_DIRECTORIES" (Section 6.8.3)
6901 schoenebeck 1251
6902 schoenebeck 1390 "LIST DB_INSTRUMENT_DIRECTORIES" (Section 6.8.4)
6903 schoenebeck 1251
6904 schoenebeck 1390 "GET DB_INSTRUMENT_DIRECTORY INFO" (Section 6.8.5)
6905 schoenebeck 1251
6906 schoenebeck 1390 "GET DB_INSTRUMENTS" (Section 6.8.13)
6907 schoenebeck 1251
6908 schoenebeck 1390 "LIST DB_INSTRUMENTS" (Section 6.8.14)
6909    
6910     "GET DB_INSTRUMENT INFO" (Section 6.8.15)
6911    
6912     "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
6913    
6914     "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
6915    
6916     "SET DB_INSTRUMENT NAME" (Section 6.8.16)
6917    
6918     "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
6919    
6920     "FIND DB_INSTRUMENTS" (Section 6.8.20)
6921    
6922     "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
6923    
6924     "MOVE DB_INSTRUMENT" (Section 6.8.17)
6925    
6926     "MOVE DB_INSTRUMENT_DIRECTORY" (Section 6.8.7)
6927    
6928     "COPY DB_INSTRUMENT" (Section 6.8.18)
6929    
6930     "COPY DB_INSTRUMENT_DIRECTORY" (Section 6.8.8)
6931    
6932     Note that the forward slash character ('/') has a special meaning in
6933     filename / path based arguments: it acts as separator of the nodes in
6934     the path, thus if a directory- or filename includes a forward slash
6935     (not intended as path node separator), you MUST escape that slash
6936     either with the respective hex escape sequence ("\x2f") or with the
6937     respective octal escape sequence ("\057").
6938    
6939     The following LSCP commands even support escape sequences as part of
6940 schoenebeck 1400
6941    
6942    
6943     Schoenebeck Expires April 13, 2008 [Page 124]
6944    
6945     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
6946    
6947    
6948 schoenebeck 1390 at least one of their text-based arguments (i.e. entity name,
6949 schoenebeck 1400 description) and / or may contain escape sequences in at least one of
6950     their text-based fields in their response:
6951 schoenebeck 1390
6952 schoenebeck 1400 "GET SERVER INFO" (Section 6.6.4)
6953 schoenebeck 1390
6954 schoenebeck 1400 "GET ENGINE INFO" (Section 6.4.9)
6955 schoenebeck 1390
6956 schoenebeck 1400 "GET CHANNEL INFO" (Section 6.4.10)
6957 schoenebeck 1390
6958 schoenebeck 1400 "CREATE FX_SEND" (Section 6.4.25)
6959 schoenebeck 1390
6960 schoenebeck 1400 "GET FX_SEND INFO" (Section 6.4.29)
6961 schoenebeck 1390
6962 schoenebeck 1400 "SET FX_SEND NAME" (Section 6.4.30)
6963 schoenebeck 575
6964 schoenebeck 1400 "GET MIDI_INSTRUMENT INFO" (Section 6.7.11)
6965 schoenebeck 575
6966 schoenebeck 1400 "GET MIDI_INSTRUMENT_MAP INFO" (Section 6.7.5)
6967    
6968     "ADD MIDI_INSTRUMENT_MAP" (Section 6.7.1)
6969    
6970 schoenebeck 1390 "MAP MIDI_INSTRUMENT" (Section 6.7.7)
6971    
6972     "SET MIDI_INSTRUMENT_MAP NAME" (Section 6.7.6)
6973    
6974     "SET DB_INSTRUMENT_DIRECTORY NAME" (Section 6.8.6)
6975    
6976     "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION" (Section 6.8.9)
6977    
6978 schoenebeck 1400 "FIND DB_INSTRUMENT_DIRECTORIES" (Section 6.8.10)
6979    
6980 schoenebeck 1390 "SET DB_INSTRUMENT NAME" (Section 6.8.16)
6981    
6982     "SET DB_INSTRUMENT DESCRIPTION" (Section 6.8.19)
6983    
6984 schoenebeck 1400 "FIND DB_INSTRUMENTS" (Section 6.8.20)
6985 schoenebeck 1390
6986     Please note that these lists are manually maintained. If you find a
6987     command that also supports escape sequences we forgot to mention
6988     here, please report it!
6989    
6990    
6991    
6992    
6993    
6994    
6995    
6996    
6997    
6998    
6999 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 125]
7000 schoenebeck 1390
7001     Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7002    
7003    
7004 schoenebeck 575 8. Events
7005 senoner 542
7006     This chapter will describe all currently defined events supported by
7007     LinuxSampler.
7008    
7009 iliev 993 8.1. Number of audio output devices changed
7010 senoner 542
7011 iliev 993 Client may want to be notified when the total number of audio output
7012     devices on the back-end changes by issuing the following command:
7013    
7014     SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT
7015    
7016     Server will start sending the following notification messages:
7017    
7018     "NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"
7019    
7020     where <devices> will be replaced by the new number of audio output
7021     devices.
7022    
7023     8.2. Audio output device's settings changed
7024    
7025     Client may want to be notified when changes were made to audio output
7026     devices on the back-end by issuing the following command:
7027    
7028     SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO
7029    
7030     Server will start sending the following notification messages:
7031    
7032     "NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"
7033    
7034     where <device-id> will be replaced by the numerical ID of the audio
7035     output device, which settings has been changed. The front-end will
7036     have to send the respective command to actually get the audio output
7037     device info. Because these messages will be triggered by LSCP
7038     commands issued by other clients rather than real time events
7039     happening on the server, it is believed that an empty notification
7040     message is sufficient here.
7041    
7042     8.3. Number of MIDI input devices changed
7043    
7044     Client may want to be notified when the total number of MIDI input
7045     devices on the back-end changes by issuing the following command:
7046    
7047     SUBSCRIBE MIDI_INPUT_DEVICE_COUNT
7048    
7049     Server will start sending the following notification messages:
7050    
7051    
7052    
7053    
7054    
7055 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 126]
7056 iliev 993
7057 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7058 iliev 993
7059    
7060     "NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"
7061    
7062     where <devices> will be replaced by the new number of MIDI input
7063     devices.
7064    
7065     8.4. MIDI input device's settings changed
7066    
7067     Client may want to be notified when changes were made to MIDI input
7068     devices on the back-end by issuing the following command:
7069    
7070     SUBSCRIBE MIDI_INPUT_DEVICE_INFO
7071    
7072     Server will start sending the following notification messages:
7073    
7074     "NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"
7075    
7076     where <device-id> will be replaced by the numerical ID of the MIDI
7077     input device, which settings has been changed. The front-end will
7078     have to send the respective command to actually get the MIDI input
7079     device info. Because these messages will be triggered by LSCP
7080     commands issued by other clients rather than real time events
7081     happening on the server, it is believed that an empty notification
7082     message is sufficient here.
7083    
7084     8.5. Number of sampler channels changed
7085    
7086 senoner 542 Client may want to be notified when the total number of channels on
7087     the back-end changes by issuing the following command:
7088    
7089 schoenebeck 558 SUBSCRIBE CHANNEL_COUNT
7090 senoner 542
7091     Server will start sending the following notification messages:
7092    
7093 schoenebeck 558 "NOTIFY:CHANNEL_COUNT:<channels>"
7094 senoner 542
7095     where <channels> will be replaced by the new number of sampler
7096     channels.
7097    
7098 iliev 993 8.6. Number of active voices changed
7099 senoner 542
7100 schoenebeck 708 Client may want to be notified when the number of voices on the back-
7101     end changes by issuing the following command:
7102 senoner 542
7103     SUBSCRIBE VOICE_COUNT
7104    
7105     Server will start sending the following notification messages:
7106    
7107 iliev 993
7108    
7109    
7110    
7111 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 127]
7112 iliev 993
7113 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7114 iliev 993
7115    
7116 iliev 1110 "NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"
7117 senoner 542
7118     where <sampler-channel> will be replaced by the sampler channel the
7119     voice count change occurred and <voices> by the new number of active
7120     voices on that channel.
7121    
7122 iliev 993 8.7. Number of active disk streams changed
7123 senoner 542
7124     Client may want to be notified when the number of streams on the
7125     back-end changes by issuing the following command: SUBSCRIBE
7126     STREAM_COUNT
7127    
7128     SUBSCRIBE STREAM_COUNT
7129    
7130     Server will start sending the following notification messages:
7131    
7132     "NOTIFY:STREAM_COUNT:<sampler-channel> <streams>"
7133    
7134     where <sampler-channel> will be replaced by the sampler channel the
7135     stream count change occurred and <streams> by the new number of
7136     active disk streams on that channel.
7137    
7138 iliev 993 8.8. Disk stream buffer fill state changed
7139 senoner 542
7140     Client may want to be notified when the buffer fill state of a disk
7141     stream on the back-end changes by issuing the following command:
7142    
7143     SUBSCRIBE BUFFER_FILL
7144    
7145     Server will start sending the following notification messages:
7146    
7147     "NOTIFY:BUFFER_FILL:<sampler-channel> <fill-data>"
7148    
7149     where <sampler-channel> will be replaced by the sampler channel the
7150     buffer fill state change occurred on and <fill-data> will be replaced
7151 schoenebeck 708 by the buffer fill data for this channel as described in
7152     Section 6.4.13 as if the "GET CHANNEL BUFFER_FILL PERCENTAGE"
7153     (Section 6.4.13) command was issued on this channel.
7154 senoner 542
7155 iliev 993 8.9. Channel information changed
7156 senoner 542
7157     Client may want to be notified when changes were made to sampler
7158 schoenebeck 561 channels on the back-end by issuing the following command:
7159 senoner 542
7160 schoenebeck 558 SUBSCRIBE CHANNEL_INFO
7161 senoner 542
7162     Server will start sending the following notification messages:
7163    
7164 iliev 993
7165    
7166    
7167 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 128]
7168 iliev 993
7169 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7170 iliev 993
7171    
7172 schoenebeck 558 "NOTIFY:CHANNEL_INFO:<sampler-channel>"
7173 senoner 542
7174     where <sampler-channel> will be replaced by the sampler channel the
7175     channel info change occurred. The front-end will have to send the
7176     respective command to actually get the channel info. Because these
7177     messages will be triggered by LSCP commands issued by other clients
7178     rather than real time events happening on the server, it is believed
7179     that an empty notification message is sufficient here.
7180    
7181 iliev 1110 8.10. Number of effect sends changed
7182 senoner 542
7183 iliev 1110 Client may want to be notified when the number of effect sends on a
7184     particular sampler channel is changed by issuing the following
7185     command:
7186    
7187     SUBSCRIBE FX_SEND_COUNT
7188    
7189     Server will start sending the following notification messages:
7190    
7191     "NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"
7192    
7193     where <channel-id> will be replaced by the numerical ID of the
7194     sampler channel, on which the effect sends number is changed and <fx-
7195     sends> will be replaced by the new number of effect sends on that
7196     channel.
7197    
7198     8.11. Effect send information changed
7199    
7200     Client may want to be notified when changes were made to effect sends
7201     on a a particular sampler channel by issuing the following command:
7202    
7203     SUBSCRIBE FX_SEND_INFO
7204    
7205     Server will start sending the following notification messages:
7206    
7207     "NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"
7208    
7209     where <channel-id> will be replaced by the numerical ID of the
7210     sampler channel, on which an effect send entity is changed and <fx-
7211     send-id> will be replaced by the numerical ID of the changed effect
7212     send.
7213    
7214     8.12. Total number of active voices changed
7215    
7216 schoenebeck 940 Client may want to be notified when the total number of voices on the
7217     back-end changes by issuing the following command:
7218 senoner 542
7219 iliev 1110
7220    
7221    
7222    
7223 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 129]
7224 iliev 1110
7225 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7226 iliev 1110
7227    
7228 schoenebeck 940 SUBSCRIBE TOTAL_VOICE_COUNT
7229 senoner 542
7230     Server will start sending the following notification messages:
7231    
7232 iliev 1110 "NOTIFY:TOTAL_VOICE_COUNT:<voices>"
7233 senoner 542
7234 iliev 993 where <voices> will be replaced by the new number of all currently
7235     active voices.
7236 senoner 542
7237 iliev 1110 8.13. Number of MIDI instrument maps changed
7238 senoner 542
7239 iliev 993 Client may want to be notified when the number of MIDI instrument
7240     maps on the back-end changes by issuing the following command:
7241 senoner 542
7242 iliev 993 SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT
7243 senoner 542
7244 iliev 993 Server will start sending the following notification messages:
7245    
7246     "NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"
7247    
7248     where <maps> will be replaced by the new number of MIDI instrument
7249     maps.
7250    
7251 iliev 1110 8.14. MIDI instrument map information changed
7252 iliev 993
7253     Client may want to be notified when changes were made to MIDI
7254     instrument maps on the back-end by issuing the following command:
7255    
7256     SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO
7257    
7258     Server will start sending the following notification messages:
7259    
7260     "NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"
7261 schoenebeck 708
7262 iliev 993 where <map-id> will be replaced by the numerical ID of the MIDI
7263     instrument map, for which information changes occurred. The front-
7264     end will have to send the respective command to actually get the MIDI
7265     instrument map info. Because these messages will be triggered by
7266     LSCP commands issued by other clients rather than real time events
7267     happening on the server, it is believed that an empty notification
7268     message is sufficient here.
7269 schoenebeck 708
7270 iliev 1110 8.15. Number of MIDI instruments changed
7271 senoner 542
7272 iliev 993 Client may want to be notified when the number of MIDI instrument
7273     maps on the back-end changes by issuing the following command:
7274    
7275 iliev 1110
7276    
7277    
7278    
7279 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 130]
7280 iliev 1110
7281 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7282 iliev 1110
7283    
7284 iliev 993 SUBSCRIBE MIDI_INSTRUMENT_COUNT
7285    
7286     Server will start sending the following notification messages:
7287    
7288     "NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"
7289    
7290     where <map-id> is the numerical ID of the MIDI instrument map, in
7291     which the nuber of instruments has changed and <instruments> will be
7292     replaced by the new number of MIDI instruments in the specified map.
7293    
7294 iliev 1110 8.16. MIDI instrument information changed
7295 iliev 993
7296     Client may want to be notified when changes were made to MIDI
7297     instruments on the back-end by issuing the following command:
7298    
7299     SUBSCRIBE MIDI_INSTRUMENT_INFO
7300    
7301     Server will start sending the following notification messages:
7302    
7303     "NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"
7304    
7305     where <map-id> will be replaced by the numerical ID of the MIDI
7306     instrument map, in which a MIDI instrument is changed. <bank> and
7307     <program> specifies the location of the changed MIDI instrument in
7308     the map. The front-end will have to send the respective command to
7309     actually get the MIDI instrument info. Because these messages will
7310     be triggered by LSCP commands issued by other clients rather than
7311     real time events happening on the server, it is believed that an
7312     empty notification message is sufficient here.
7313    
7314 iliev 1110 8.17. Global settings changed
7315 iliev 993
7316 iliev 1110 Client may want to be notified when changes to the global settings of
7317     the sampler were made by issuing the following command:
7318 iliev 993
7319 iliev 1110 SUBSCRIBE GLOBAL_INFO
7320 iliev 993
7321 iliev 1110 Server will start sending the following types of notification
7322     messages:
7323 iliev 993
7324 iliev 1110 "NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the golbal
7325     volume of the sampler is changed, where <volume> will be replaced
7326     by the optional dotted floating point value, reflecting the new
7327     global volume parameter.
7328 iliev 993
7329    
7330 iliev 1110
7331    
7332    
7333    
7334    
7335 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 131]
7336 iliev 993
7337 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7338 iliev 993
7339    
7340 iliev 1162 8.18. Number of database instrument directories changed
7341 iliev 993
7342 iliev 1162 Client may want to be notified when the number of instrument
7343     directories in a particular directory in the instruments database is
7344     changed by issuing the following command:
7345    
7346     SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT
7347    
7348     Server will start sending the following notification messages:
7349    
7350     "NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"
7351    
7352     where <dir-path> will be replaced by the absolute path name of the
7353     directory in the instruments database, in which the number of
7354     directories is changed.
7355    
7356     Note that when a non-empty directory is removed, this event is not
7357     sent for the subdirectories in that directory.
7358    
7359     8.19. Database instrument directory information changed
7360    
7361     Client may want to be notified when changes were made to directories
7362     in the instruments database by issuing the following command:
7363    
7364     SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO
7365    
7366     Server will start sending the following notification messages:
7367    
7368     "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"
7369    
7370     where <dir-path> will be replaced by the absolute path name of the
7371     directory, for which information changes occurred. The front-end
7372     will have to send the respective command to actually get the updated
7373     directory info. Because these messages will be triggered by LSCP
7374     commands issued by other clients rather than real time events
7375     happening on the server, it is believed that an empty notification
7376     message is sufficient here.
7377    
7378     "NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-
7379     name>"
7380    
7381     where <old-dir-path> is the old absolute path name of the directory
7382     (encapsulated into apostrophes), which name is changes and <new-name>
7383     is the new name of the directory, encapsulated into apostrophes.
7384    
7385    
7386    
7387    
7388    
7389    
7390    
7391 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 132]
7392 iliev 1162
7393 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7394 iliev 1162
7395    
7396     8.20. Number of database instruments changed
7397    
7398     Client may want to be notified when the number of instruments in a
7399     particular directory in the instruments database is changed by
7400     issuing the following command:
7401    
7402     SUBSCRIBE DB_INSTRUMENT_COUNT
7403    
7404     Server will start sending the following notification messages:
7405    
7406     "NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"
7407    
7408     where <dir-path> will be replaced by the absolute path name of the
7409     directory in the instruments database, in which the number of
7410     instruments is changed.
7411    
7412     Note that when a non-empty directory is removed, this event is not
7413     sent for the instruments in that directory.
7414    
7415     8.21. Database instrument information changed
7416    
7417     Client may want to be notified when changes were made to instruments
7418     in the instruments database by issuing the following command:
7419    
7420     SUBSCRIBE DB_INSTRUMENT_INFO
7421    
7422     Server will start sending the following notification messages:
7423    
7424     "NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"
7425    
7426     where <instr-path> will be replaced by the absolute path name of the
7427     instrument, which settings are changed. The front-end will have to
7428     send the respective command to actually get the updated directory
7429     info. Because these messages will be triggered by LSCP commands
7430     issued by other clients rather than real time events happening on the
7431     server, it is believed that an empty notification message is
7432     sufficient here.
7433    
7434     "NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"
7435    
7436     where <old-instr-path> is the old absolute path name of the
7437     instrument (encapsulated into apostrophes), which name is changes and
7438     <new-name> is the new name of the instrument, encapsulated into
7439     apostrophes.
7440    
7441    
7442    
7443    
7444    
7445    
7446    
7447 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 133]
7448 iliev 1162
7449 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7450 iliev 1162
7451    
7452 iliev 1201 8.22. Database job status information changed
7453 iliev 1162
7454 iliev 1201 Client may want to be notified when the status of particular database
7455     instruments job is changed by issuing the following command:
7456    
7457     SUBSCRIBE DB_INSTRUMENTS_JOB_INFO
7458    
7459     Server will start sending the following notification messages:
7460    
7461     "NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"
7462    
7463     where <job-id> will be replaced by the numerical ID of the job, which
7464     status is changed. The front-end will have to send the respective
7465     command to actually get the status info. Because these messages will
7466     be triggered by LSCP commands issued by other clients rather than
7467     real time events happening on the server, it is believed that an
7468     empty notification message is sufficient here.
7469    
7470     8.23. Miscellaneous and debugging events
7471    
7472 schoenebeck 940 Client may want to be notified of miscellaneous and debugging events
7473     occurring at the server by issuing the following command:
7474 senoner 542
7475 schoenebeck 940 SUBSCRIBE MISCELLANEOUS
7476 senoner 542
7477 schoenebeck 940 Server will start sending the following notification messages:
7478 senoner 542
7479 schoenebeck 940 "NOTIFY:MISCELLANEOUS:<string>"
7480 senoner 542
7481 schoenebeck 940 where <string> will be replaced by whatever data server wants to send
7482     to the client. Client MAY display this data to the user AS IS to
7483     facilitate debugging.
7484 senoner 542
7485    
7486    
7487    
7488    
7489    
7490    
7491    
7492    
7493    
7494    
7495    
7496    
7497    
7498    
7499    
7500    
7501    
7502    
7503 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 134]
7504 schoenebeck 940
7505 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7506 senoner 542
7507    
7508 schoenebeck 575 9. Security Considerations
7509 senoner 542
7510     As there is so far no method of authentication and authorization
7511     defined and so not required for a client applications to succeed to
7512     connect, running LinuxSampler might be a security risk for the host
7513     system the LinuxSampler instance is running on.
7514    
7515    
7516    
7517    
7518    
7519    
7520    
7521    
7522    
7523    
7524    
7525    
7526    
7527    
7528    
7529    
7530    
7531    
7532    
7533    
7534    
7535    
7536    
7537    
7538    
7539    
7540    
7541    
7542    
7543    
7544    
7545    
7546    
7547    
7548    
7549    
7550    
7551    
7552    
7553    
7554    
7555    
7556    
7557    
7558    
7559 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 135]
7560 schoenebeck 940
7561 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7562 senoner 542
7563    
7564 schoenebeck 575 10. Acknowledgments
7565 senoner 542
7566     This document has benefited greatly from the comments of the
7567     following people, discussed on the LinuxSampler developer's mailing
7568     list:
7569    
7570     Rui Nuno Capela
7571 schoenebeck 708
7572 senoner 542 Vladimir Senkov
7573 schoenebeck 708
7574 senoner 542 Mark Knecht
7575 schoenebeck 708
7576 schoenebeck 561 Grigor Iliev
7577 senoner 542
7578    
7579 schoenebeck 708
7580 senoner 542
7581    
7582 schoenebeck 575
7583    
7584 schoenebeck 940
7585    
7586    
7587    
7588    
7589    
7590    
7591    
7592    
7593    
7594    
7595    
7596    
7597    
7598    
7599    
7600    
7601    
7602    
7603    
7604    
7605    
7606    
7607    
7608 schoenebeck 974
7609    
7610    
7611    
7612    
7613    
7614    
7615 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 136]
7616 schoenebeck 940
7617 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7618 schoenebeck 940
7619    
7620 schoenebeck 974 11. References
7621 senoner 542
7622 schoenebeck 1251 [RFC20] UCLA, "ASCII format for Network Interchange", RFC 20,
7623     1969.
7624    
7625 schoenebeck 974 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
7626     Requirement Levels", RFC 2119, 1997.
7627 senoner 542
7628 schoenebeck 974 [RFC2234] Crocker, D. and P. Overell, "Augmented BNF for Syntax
7629     Specifications", RFC 2234, 1997.
7630 senoner 542
7631 schoenebeck 974 [RFC793] Defense Advanced Research Projects Agency, "TRANSMISSION
7632     CONTROL PROTOCOL", RFC 793, 1981.
7633 senoner 542
7634    
7635    
7636    
7637    
7638    
7639    
7640    
7641    
7642    
7643    
7644    
7645    
7646    
7647    
7648    
7649    
7650 schoenebeck 940
7651    
7652    
7653    
7654    
7655    
7656    
7657    
7658    
7659    
7660    
7661    
7662    
7663    
7664    
7665    
7666    
7667    
7668    
7669    
7670    
7671 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 137]
7672 schoenebeck 940
7673 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7674 schoenebeck 940
7675    
7676 schoenebeck 974 Author's Address
7677 senoner 542
7678 schoenebeck 974 C. Schoenebeck
7679     Interessengemeinschaft Software Engineering e. V.
7680     Max-Planck-Str. 39
7681     74081 Heilbronn
7682     Germany
7683 senoner 542
7684 schoenebeck 974 Email: schoenebeck at software minus engineering dot org
7685 senoner 542
7686    
7687    
7688    
7689    
7690    
7691    
7692    
7693    
7694    
7695    
7696    
7697    
7698    
7699    
7700    
7701    
7702    
7703    
7704    
7705    
7706    
7707    
7708    
7709    
7710    
7711    
7712    
7713    
7714    
7715    
7716    
7717    
7718    
7719    
7720    
7721    
7722    
7723    
7724    
7725    
7726    
7727 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 138]
7728 schoenebeck 974
7729 schoenebeck 1390 Internet-Draft LinuxSampler Control Protocol (draft) October 2007
7730 senoner 542
7731    
7732 schoenebeck 974 Full Copyright Statement
7733 senoner 542
7734 iliev 1110 Copyright (C) The IETF Trust (2007).
7735 senoner 542
7736 schoenebeck 974 This document is subject to the rights, licenses and restrictions
7737     contained in BCP 78, and except as set forth therein, the authors
7738     retain all their rights.
7739 senoner 542
7740 schoenebeck 974 This document and the information contained herein are provided on an
7741     "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
7742 iliev 1110 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
7743     THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
7744     OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
7745     THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
7746 schoenebeck 974 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
7747 senoner 542
7748    
7749 schoenebeck 974 Intellectual Property
7750 senoner 542
7751 schoenebeck 974 The IETF takes no position regarding the validity or scope of any
7752     Intellectual Property Rights or other rights that might be claimed to
7753     pertain to the implementation or use of the technology described in
7754     this document or the extent to which any license under such rights
7755     might or might not be available; nor does it represent that it has
7756     made any independent effort to identify any such rights. Information
7757     on the procedures with respect to rights in RFC documents can be
7758     found in BCP 78 and BCP 79.
7759 senoner 542
7760 schoenebeck 974 Copies of IPR disclosures made to the IETF Secretariat and any
7761     assurances of licenses to be made available, or the result of an
7762     attempt made to obtain a general license or permission for the use of
7763     such proprietary rights by implementers or users of this
7764     specification can be obtained from the IETF on-line IPR repository at
7765     http://www.ietf.org/ipr.
7766 senoner 542
7767 schoenebeck 974 The IETF invites any interested party to bring to its attention any
7768     copyrights, patents or patent applications, or other proprietary
7769     rights that may cover technology that may be required to implement
7770     this standard. Please address the information to the IETF at
7771     ietf-ipr@ietf.org.
7772 senoner 542
7773    
7774 schoenebeck 974 Acknowledgment
7775 senoner 542
7776 schoenebeck 974 Funding for the RFC Editor function is provided by the IETF
7777     Administrative Support Activity (IASA).
7778 senoner 542
7779    
7780 schoenebeck 974
7781    
7782    
7783 schoenebeck 1400 Schoenebeck Expires April 13, 2008 [Page 139]
7784 schoenebeck 940
7785 schoenebeck 1363

  ViewVC Help
Powered by ViewVC