/[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 1002 - (hide annotations) (download)
Wed Dec 27 16:23:46 2006 UTC (17 years, 3 months ago) by schoenebeck
File MIME type: text/plain
File size: 160527 byte(s)
- added new LSCP commands for managing FX sends

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

  ViewVC Help
Powered by ViewVC