/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Contents of /linuxsampler/trunk/Documentation/lscp.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1956 - (show annotations) (download) (as text)
Fri Jul 31 07:45:47 2009 UTC (8 years, 9 months ago) by schoenebeck
File MIME type: text/xml
File size: 410978 byte(s)
* preparations for release 1.0.0

1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
4 <!ENTITY rfc2119 PUBLIC ''
5 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
6 ]>
7
8 <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
9
10 <?rfc toc="yes" ?>
11 <?rfc symrefs="yes" ?>
12 <?rfc sortrefs="yes"?>
13 <?rfc iprnotified="no" ?>
14
15 <!-- FIXME: next attribute should actually be "yes", temporarily disbled due
16 to an annoying "missing Normative/Informative References" error message -->
17 <?rfc strict="no" ?>
18
19 <rfc category="std" ipr="full3978" docName="LSCP 1.4">
20 <front>
21 <title>LinuxSampler Control Protocol</title>
22 <author initials='C.S.' surname="Schoenebeck" fullname='C.
23 Schoenebeck'>
24 <organization>
25 Interessengemeinschaft Software Engineering e. V.
26 </organization>
27 <address>
28 <postal>
29 <street>Max-Planck-Str. 39</street>
30 <!-- <code>74081</code> -->
31 <city>74081 Heilbronn</city>
32 <country>Germany</country>
33 </postal>
34 <email>schoenebeck at software minus engineering dot org</email>
35 </address>
36 </author>
37 <date month="July" year="2009"/>
38 <workgroup>LinuxSampler Developers</workgroup>
39 <keyword>LSCP</keyword>
40 <abstract>
41 <t>The LinuxSampler Control Protocol (LSCP) is an
42 application-level protocol primarily intended for local and
43 remote controlling the LinuxSampler backend application, which is a
44 sophisticated server-like console application essentially playing
45 back audio samples and manipulating the samples in real time to
46 certain extent.</t>
47 </abstract>
48 </front>
49
50 <middle>
51 <section title="Requirements notation">
52 <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
53 "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
54 and "OPTIONAL" in this document are to be interpreted as
55 described in <xref target="RFC2119"/>.</t>
56
57 <t>This protocol is always case-sensitive if not explicitly
58 claimed the opposite.</t>
59
60 <t>In examples, "C:" and "S:" indicate lines sent by the client
61 (front-end) and server (LinuxSampler) respectively. Lines in
62 examples must be interpreted as every line being CRLF
63 terminated (carriage return character followed by line feed
64 character as defined in the ASCII standard <xref target="RFC20"/>),
65 thus the following example:</t>
66
67 <t>
68 <list>
69 <t>C: "some line"</t>
70 <t>&nbsp;&nbsp;&nbsp;"another line"</t>
71 </list>
72 </t>
73
74 <t>must actually be interpreted as client sending the following
75 message:</t>
76
77 <t>
78 <list>
79 <t>"some line&lt;CR&gt;&lt;LF&gt;another
80 line&lt;CR&gt;&lt;LF&gt;"</t>
81 </list>
82 </t>
83
84 <t>where &lt;CR&gt; symbolizes the carriage return character and
85 &lt;LF&gt; the line feed character as defined in the ASCII
86 standard.</t>
87
88 <t>Due to technical reasons, messages can arbitrary be
89 fragmented, means the following example:</t>
90
91 <t>
92 <list>
93 <t>S: "abcd"</t>
94 </list>
95 </t>
96
97 <t>could also happen to be sent in three messages like in the
98 following sequence scenario:</t>
99
100 <t>
101 <list style="symbols">
102 <t>server sending message "a"</t>
103 <t>followed by a delay (pause) with
104 arbitrary duration</t>
105 <t>followed by server sending message
106 "bcd&lt;CR&gt;"</t>
107 <t>again followed by a delay (pause) with arbitrary
108 duration</t>
109 <t>followed by server sending the message
110 "&lt;LF&gt;"</t>
111 </list>
112 </t>
113
114 <t>where again &lt;CR&gt; and &lt;LF&gt; symbolize the carriage
115 return and line feed characters respectively.</t>
116 </section>
117
118 <section title="Versioning of this specification" anchor="LSCP versioning">
119 <t>LSCP will certainly be extended and enhanced by-and-by. Each official
120 release of the LSCP specification will be tagged with a unique version
121 tuple. The version tuple consists at least of a major and minor version
122 number like:
123 </t>
124 <t>
125 <list>
126 <t>"1.2"</t>
127 </list>
128 </t>
129 <t>
130 In this example the major version number would be "1" and the minor
131 version number would be "2". Note that the version tuple might also
132 have more than two elements. The major version number defines a
133 group of backward compatible versions. That means a frontend is
134 compatible to the connected sampler if and only if the LSCP versions
135 to which each of the two parties complies to, match both of the
136 following rules:
137 </t>
138 <t>Compatibility:</t>
139 <t>
140 <list style="numbers">
141 <t>The frontend's LSCP major version and the sampler's LSCP
142 major version are exactly equal.</t>
143 <t>The frontend's LSCP minor version is less or equal than
144 the sampler's LSCP minor version.</t>
145 </list>
146 </t>
147 <t>
148 Compatibility can only be claimed if both rules are true.
149 The frontend can use the
150 <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
151 get the version of the LSCP specification the sampler complies with.
152 </t>
153 </section>
154
155 <section title="Introduction">
156 <t>LinuxSampler is a so called software sampler application
157 capable to playback audio samples from a computer's Random
158 Access Memory (RAM) as well as directly streaming it from disk.
159 LinuxSampler is designed to be modular. It provides several so
160 called "sampler engines" where each engine is specialized for a
161 certain purpose. LinuxSampler has virtual channels which will be
162 referred in this document as "sampler channels". The channels
163 are in such way virtual as they can be connected to an
164 arbitrary MIDI input method and arbitrary MIDI channel (e.g.
165 sampler channel 17 could be connected to an ALSA sequencer
166 device 64:0 and listening to MIDI channel 1 there). Each sampler
167 channel will be associated with an instance of one of the available
168 sampler engines (e.g. GigEngine, DLSEngine). The audio output of
169 each sampler channel can be routed to an arbitrary audio output
170 method (ALSA / JACK) and an arbitrary audio output channel
171 there.</t>
172 </section>
173
174 <section title="Focus of this protocol">
175 <t>Main focus of this protocol is to provide a way to configure
176 a running LinuxSampler instance and to retrieve information
177 about it. The focus of this protocol is not to provide a way to
178 control synthesis parameters or even to trigger or release
179 notes. Or in other words; the focus are those functionalities
180 which are not covered by MIDI or which may at most be handled
181 via MIDI System Exclusive Messages.</t>
182 </section>
183
184 <section title="Communication Overview">
185 <t>There are two distinct methods of communication between a
186 running instance of LinuxSampler and one or more control
187 applications, so called "front-ends": a simple request/response
188 communication method used by the clients to give commands to the
189 server as well as to inquire about server's status and a
190 subscribe/notify communication method used by the client to
191 subscribe to and receive notifications of certain events as they
192 happen on the server. The latter needs more effort to be
193 implemented in the front-end application. The two communication
194 methods will be described next.</t>
195
196 <section title="Request/response communication method">
197 <t>This simple communication method is based on
198 <xref target="RFC793">TCP</xref>. The
199 front-end application establishes a TCP connection to the
200 LinuxSampler instance on a certain host system. Then the
201 front-end application will send certain ASCII based commands
202 as defined in this document (every command line must be CRLF
203 terminated - see "Conventions used in this document" at the
204 beginning of this document) and the LinuxSampler application
205 will response after a certain process time with an
206 appropriate ASCII based answer, also as defined in this
207 document. So this TCP communication is simply based on query
208 and answer paradigm. That way LinuxSampler is only able to
209 answer on queries from front-ends, but not able to
210 automatically send messages to the client if it's not asked
211 to. The fronted should not reconnect to LinuxSampler for
212 every single command, instead it should keep the connection
213 established and simply resend message(s) for subsequent
214 commands. To keep information in the front-end up-to-date
215 the front-end has to periodically send new requests to get
216 the current information from the LinuxSampler instance. This
217 is often referred to as "polling". While polling is simple
218 to implement and may be OK to use in some cases, there may
219 be disadvantages to polling such as network traffic overhead
220 and information being out of date.
221 It is possible for a client or several clients to open more
222 than one connection to the server at the same time. It is
223 also possible to send more than one request to the server
224 at the same time but if those requests are sent over the
225 same connection server MUST execute them sequentially. Upon
226 executing a request server will produce a result set and
227 send it to the client. Each and every request made by the
228 client MUST result in a result set being sent back to the
229 client. No other data other than a result set may be sent by
230 a server to a client. No result set may be sent to a client
231 without the client sending request to the server first. On
232 any particular connection, result sets MUST be sent in their
233 entirety without being interrupted by other result sets. If
234 several requests got queued up at the server they MUST be
235 processed in the order they were received and result sets
236 MUST be sent back in the same order.</t>
237
238 <section title="Result format">
239 <t>Result set could be one of the following types:</t>
240 <t>
241 <list style="numbers">
242 <t>Normal</t>
243 <t>Warning</t>
244 <t>Error</t>
245 </list>
246 </t>
247 <t>Warning and Error result sets MUST be single line and
248 have the following format:</t>
249 <t>
250 <list style="symbols">
251 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"</t>
252 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"</t>
253 </list>
254 </t>
255 <t>Where &lt;warning-code&gt; and &lt;error-code&gt; are
256 numeric unique identifiers of the warning or error and
257 &lt;warning-message&gt; and &lt;error-message&gt; are
258 human readable descriptions of the warning or error
259 respectively.</t>
260 <t>Examples:</t>
261 <t>
262 <list>
263 <t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t>
264 <t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t>
265 </list>
266 </t>
267 <t>
268 <list>
269 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t>
270 <t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t>
271 </list>
272 </t>
273 <t>
274 <list>
275 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>
276 <t>S: "ERR:9:There is no audio output device with index 123456."</t>
277 </list>
278 </t>
279 <t>Normal result sets could be:</t>
280 <t>
281 <list style="numbers">
282 <t>Empty</t>
283 <t>Single line</t>
284 <t>Multi-line</t>
285 </list>
286 </t>
287 <t> Empty result set is issued when the server only
288 needed to acknowledge the fact that the request was
289 received and it was processed successfully and no
290 additional information is available. This result set has
291 the following format:</t>
292 <t>
293 <list>
294 <t>"OK"</t>
295 </list>
296 </t>
297 <t>Example:</t>
298 <t>
299 <list>
300 <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t>
301 <t>S: "OK"</t>
302 </list>
303 </t>
304 <t>Single line result sets are command specific. One
305 example of a single line result set is an empty line.
306 Multi-line result sets are command specific and may
307 include one or more lines of information. They MUST
308 always end with the following line:</t>
309 <t>
310 <list>
311 <t>"."</t>
312 </list>
313 </t>
314 <t>Example:</t>
315 <t>
316 <list>
317 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
318 <t>S: "DRIVER: ALSA"</t>
319 <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
320 <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
321 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
322 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
323 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
324 <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
325 <t>&nbsp;&nbsp;&nbsp;"."</t>
326 </list>
327 </t>
328 <t>In addition to above mentioned formats, warnings and
329 empty result sets MAY be indexed. In this case, they
330 have the following formats respectively:</t>
331 <t>
332 <list style="symbols">
333 <t>"WRN[&lt;index&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;"</t>
334 <t>"OK[&lt;index&gt;]"</t>
335 </list>
336 </t>
337 <t>where &lt;index&gt; is command specific and is used
338 to indicate channel number that the result set was
339 related to or other integer value.</t>
340 <t>Each line of the result set MUST end with
341 &lt;CRLF&gt;.</t>
342 <t>Examples:</t>
343 <t>
344 <list>
345 <t>C: "ADD CHANNEL"</t>
346 <t>S: "OK[12]"</t>
347 </list>
348 </t>
349 <t>
350 <list>
351 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t>
352 <t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t>
353 </list>
354 </t>
355 </section>
356 </section>
357 <section title="Subscribe/notify communication method">
358 <t>This more sophisticated communication method is actually
359 only an extension of the simple request/response
360 communication method. The front-end still uses a TCP
361 connection and sends the same commands on the TCP
362 connection. Two extra commands are SUBSCRIBE and UNSUBSCRIBE
363 commands that allow a client to tell the server that it is
364 interested in receiving notifications about certain events
365 as they happen on the server. The SUBSCRIBE command has the
366 following syntax:</t>
367
368 <t>
369 <list>
370 <t>SUBSCRIBE &lt;event-id&gt;</t>
371 </list>
372 </t>
373
374 <t>where &lt;event-id&gt; will be replaced by the respective
375 event that client wants to subscribe to. Upon receiving such
376 request, server SHOULD respond with OK and start sending
377 EVENT notifications when a given even has occurred to the
378 front-end when an event has occurred. It MAY be possible
379 certain events may be sent before OK response during real
380 time nature of their generation. Event messages have the
381 following format:</t>
382
383 <t>
384 <list>
385 <t>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;</t>
386 </list>
387 </t>
388
389 <t>where &lt;event-id&gt; uniquely identifies the event that
390 has occurred and &lt;custom-event-data&gt; is event
391 specific.</t>
392
393 <t>Several rules must be followed by the server when
394 generating events:</t>
395
396 <t>
397 <list style="numbers">
398 <t>Events MUST NOT be sent to any client who has not
399 issued an appropriate SUBSCRIBE command.</t>
400 <t>Events MUST only be sent using the same
401 connection that was used to subscribe to them.</t>
402 <t>When response is being sent to the client, event
403 MUST be inserted in the stream before or after the
404 response, but NOT in the middle. Same is true about
405 the response. It should never be inserted in the
406 middle of the event message as well as any other
407 response.</t>
408 </list>
409 </t>
410
411 <t>If the client is not interested in a particular event
412 anymore it MAY issue UNSUBSCRIBE command using the following
413 syntax:</t>
414
415 <t>
416 <list>
417 <t>UNSUBSCRIBE &lt;event-id&gt;</t>
418 </list>
419 </t>
420
421 <t>where &lt;event-id&gt; will be replace by the respective
422 event that client is no longer interested in receiving. For
423 a list of supported events see <xref target="events" />.</t>
424
425 <t>Example: the fill states of disk stream buffers have
426 changed on sampler channel 4 and the LinuxSampler instance
427 will react by sending the following message to all clients
428 who subscribed to this event:</t>
429
430 <t>
431 <list>
432 <t>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%</t>
433 </list>
434 </t>
435
436 <t>Which means there are currently three active streams on
437 sampler channel 4, where the stream with ID "35" is filled
438 by 62%, stream with ID 33 is filled by 80% and stream with
439 ID 37 is filled by 98%.</t>
440
441 <t>Clients may choose to open more than one connection to
442 the server and use some connections to receive notifications
443 while using other connections to issue commands to the
444 back-end. This is entirely legal and up to the
445 implementation. This does not change the protocol in any way
446 and no special restrictions exist on the server to allow or
447 disallow this or to track what connections belong to what
448 front-ends. Server will listen on a single port, accept
449 multiple connections and support protocol described in this
450 specification in it's entirety on this single port on each
451 connection that it accepted.</t>
452
453 <t>Due to the fact that TCP is used for this communication,
454 dead peers will be detected automatically by the OS TCP
455 stack. While it may take a while to detect dead peers if no
456 traffic is being sent from server to client (TCP keep-alive
457 timer is set to 2 hours on many OSes) it will not be an
458 issue here as when notifications are sent by the server,
459 dead client will be detected quickly.</t>
460
461 <t>When connection is closed for any reason server MUST
462 forget all subscriptions that were made on this connection.
463 If client reconnects it MUST resubscribe to all events that
464 it wants to receive.</t>
465
466 </section>
467 </section>
468
469 <section title="Description for control commands" anchor="control_commands">
470 <t>This chapter will describe the available control commands
471 that can be sent on the TCP connection in detail. Some certain
472 commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
473 or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to
474 multiple-line responses. In this case LinuxSampler signals the
475 end of the response by a "." (single dot) line.</t>
476
477 <section title="Ignored lines and comments">
478 <t>White lines, that is lines which only contain space and
479 tabulator characters, and lines that start with a "#"
480 character are ignored, thus it's possible for example to
481 group commands and to place comments in a LSCP script
482 file.</t>
483 </section>
484
485 <section title="Configuring audio drivers">
486 <t>Instances of drivers in LinuxSampler are called devices.
487 You can use multiple audio devices simultaneously, e.g. to
488 output the sound of one sampler channel using the ALSA audio
489 output driver, and on another sampler channel you might want
490 to use the JACK audio output driver. For particular audio
491 output systems it's also possible to create several devices
492 of the same audio output driver, e.g. two separate ALSA
493 audio output devices for using two different sound cards at
494 the same time. This chapter describes all commands to
495 configure LinuxSampler's audio output devices and their
496 parameters.</t>
497
498 <t>Instead of defining commands and parameters for each
499 driver individually, all possible parameters, their meanings
500 and possible values have to be obtained at runtime. This
501 makes the protocol a bit abstract, but has the advantage,
502 that front-ends can be written independently of what drivers
503 are currently implemented and what parameters these drivers
504 are actually offering. This means front-ends can even handle
505 drivers which are implemented somewhere in future without
506 modifying the front-end at all.</t>
507
508 <t>Note: examples in this chapter showing particular
509 parameters of drivers are not meant as specification of the
510 drivers' parameters. Driver implementations in LinuxSampler
511 might have complete different parameter names and meanings
512 than shown in these examples or might change in future, so
513 these examples are only meant for showing how to retrieve
514 what parameters drivers are offering, how to retrieve their
515 possible values, etc.</t>
516
517 <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">
518 <t>Use the following command to get the number of
519 audio output drivers currently available for the
520 LinuxSampler instance:</t>
521 <t>
522 <list>
523 <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
524 </list>
525 </t>
526 <t>Possible Answers:</t>
527 <t>
528 <list>
529 <t>LinuxSampler will answer by sending the
530 number of audio output drivers.</t>
531 </list>
532 </t>
533 <t>Example:</t>
534 <t>
535 <list>
536 <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
537 <t>S: "2"</t>
538 </list>
539 </t>
540 </section>
541
542 <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
543 <t>Use the following command to list all audio output
544 drivers currently available for the LinuxSampler
545 instance:</t>
546 <t>
547 <list>
548 <t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
549 </list>
550 </t>
551 <t>Possible Answers:</t>
552 <t>
553 <list>
554 <t>LinuxSampler will answer by sending comma
555 separated character strings, each symbolizing an
556 audio output driver.</t>
557 </list>
558 </t>
559 <t>Example:</t>
560 <t>
561 <list>
562 <t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
563 <t>S: "ALSA,JACK"</t>
564 </list>
565 </t>
566 </section>
567
568 <section title="Getting information about a specific audio
569 output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">
570 <t>Use the following command to get detailed information
571 about a specific audio output driver:</t>
572 <t>
573 <list>
574 <t>GET AUDIO_OUTPUT_DRIVER INFO
575 &lt;audio-output-driver&gt;</t>
576 </list>
577 </t>
578 <t>Where &lt;audio-output-driver&gt; is the name of the
579 audio output driver, returned by the
580 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t>
581 <t>Possible Answers:</t>
582 <t>
583 <list>
584 <t>LinuxSampler will answer by sending a
585 &lt;CRLF&gt; separated list. Each answer line
586 begins with the information category name
587 followed by a colon and then a space character
588 &lt;SP&gt; and finally the info character string
589 to that info category. At the moment the
590 following information categories are
591 defined:</t>
592
593 <t>
594 <list>
595 <t>DESCRIPTION -
596 <list>
597 <t> character string describing the
598 audio output driver</t>
599 </list>
600 </t>
601
602 <t>VERSION -
603 <list>
604 <t>character string reflecting the
605 driver's version</t>
606 </list>
607 </t>
608
609 <t>PARAMETERS -
610 <list>
611 <t>comma separated list of all
612 parameters available for the given
613 audio output driver, at least
614 parameters 'channels', 'samplerate'
615 and 'active' are offered by all audio
616 output drivers</t>
617 </list>
618 </t>
619 </list>
620 </t>
621
622 <t>The mentioned fields above don't have to be
623 in particular order.</t>
624 </list>
625 </t>
626 <t>Example:</t>
627 <t>
628 <list>
629 <t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t>
630 <t>S: "DESCRIPTION: Advanced Linux Sound
631 Architecture"</t>
632 <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
633 <t>&nbsp;&nbsp;&nbsp;"PARAMETERS:
634 DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
635 FRAGMENTSIZE,CARD"</t>
636 <t>&nbsp;&nbsp;&nbsp;"."</t>
637 </list>
638 </t>
639 </section>
640
641 <section title="Getting information about specific audio
642 output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">
643 <t>Use the following command to get detailed information
644 about a specific audio output driver parameter:</t>
645 <t>
646 <list>
647 <t>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO &lt;audio&gt; &lt;prm&gt; [&lt;deplist&gt;]</t>
648 </list>
649 </t>
650 <t>Where &lt;audio&gt; is the name of the audio output
651 driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
652 "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command,
653 &lt;prm&gt; a specific parameter name for which information should be
654 obtained (as returned by the
655 <xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and
656 &lt;deplist&gt; is an optional list of parameters on which the sought
657 parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
658 pairs in form of "key1=val1 key2=val2 ...", where character string values
659 are encapsulated into apostrophes ('). Arguments given with &lt;deplist&gt;
660 which are not dependency parameters of &lt;prm&gt; will be ignored, means
661 the front-end application can simply put all parameters into &lt;deplist&gt;
662 with the values already selected by the user.</t>
663 <t>Possible Answers:</t>
664 <t>
665 <list>
666 <t>LinuxSampler will answer by sending a
667 &lt;CRLF&gt; separated list.
668 Each answer line begins with the information category name
669 followed by a colon and then a space character &lt;SP&gt; and
670 finally
671 the info character string to that info category. There are
672 information which is always returned, independently of the
673 given driver parameter and there are optional information
674 which is only shown dependently to given driver parameter. At
675 the moment the following information categories are defined:</t>
676 </list>
677 </t>
678
679 <t>
680 <list>
681 <t>TYPE -
682 <list>
683 <t>either "BOOL" for boolean value(s) or
684 "INT" for integer
685 value(s) or "FLOAT" for dotted number(s) or "STRING" for
686 character string(s)
687 (always returned, no matter which driver parameter)</t>
688 </list>
689 </t>
690
691 <t>DESCRIPTION -
692 <list>
693 <t>arbitrary text describing the purpose of the parameter
694 (always returned, no matter which driver parameter)</t>
695 </list>
696 </t>
697
698 <t>MANDATORY -
699 <list>
700 <t>either true or false, defines if this parameter must be
701 given when the device is to be created with the
702 <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
703 command (always returned, no matter which driver parameter)</t>
704 </list>
705 </t>
706
707 <t>FIX -
708 <list>
709 <t>either true or false, if false then this parameter can
710 be changed at any time, once the device is created by
711 the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
712 command (always returned, no matter which driver parameter)</t>
713 </list>
714 </t>
715
716 <t>MULTIPLICITY -
717 <list>
718 <t>either true or false, defines if this parameter allows
719 only one value or a list of values, where true means
720 multiple values and false only a single value allowed
721 (always returned, no matter which driver parameter)</t>
722 </list>
723 </t>
724
725 <t>DEPENDS -
726 <list>
727 <t>comma separated list of parameters this parameter depends
728 on, means the values for fields 'DEFAULT', 'RANGE_MIN',
729 'RANGE_MAX' and 'POSSIBILITIES' might depend on these
730 listed parameters, for example assuming that an audio
731 driver (like the ALSA driver) offers parameters 'card'
732 and 'samplerate' then parameter 'samplerate' would
733 depend on 'card' because the possible values for
734 'samplerate' depends on the sound card which can be
735 chosen by the 'card' parameter
736 (optionally returned, dependent to driver parameter)</t>
737 </list>
738 </t>
739
740 <t>DEFAULT -
741 <list>
742 <t>reflects the default value for this parameter which is
743 used when the device is created and not explicitly
744 given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE">
745 'CREATE AUDIO_OUTPUT_DEVICE'</xref> command,
746 in case of MULTIPLCITY=true, this is a comma separated
747 list, that's why character strings are encapsulated into
748 apostrophes (')
749 (optionally returned, dependent to driver parameter)</t>
750 </list>
751 </t>
752
753 <t>RANGE_MIN -
754 <list>
755 <t>defines lower limit of the allowed value range for this
756 parameter, can be an integer value as well as a dotted
757 number, this parameter is often used in conjunction
758 with RANGE_MAX, but may also appear without
759 (optionally returned, dependent to driver parameter)</t>
760 </list>
761 </t>
762
763 <t>RANGE_MAX -
764 <list>
765 <t>defines upper limit of the allowed value range for this
766 parameter, can be an integer value as well as a dotted
767 number, this parameter is often used in conjunction with
768 RANGE_MIN, but may also appear without
769 (optionally returned, dependent to driver parameter)</t>
770 </list>
771 </t>
772
773 <t>POSSIBILITIES -
774 <list>
775 <t>comma separated list of possible values for this
776 parameter, character strings are encapsulated into
777 apostrophes
778 (optionally returned, dependent to driver parameter)</t>
779 </list>
780 </t>
781 </list>
782 </t>
783
784 <t>The mentioned fields above don't have to be in particular order.</t>
785
786 <t>Examples:</t>
787 <t>
788 <list>
789 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t>
790 <t>S: "DESCRIPTION: sound card to be used"</t>
791 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
792 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
793 <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>
794 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
795 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>
796 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"</t>
797 <t>&nbsp;&nbsp;&nbsp;"."</t>
798 </list>
799 </t>
800 <t>
801 <list>
802 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t>
803 <t>S: "DESCRIPTION: output sample rate in Hz"</t>
804 <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
805 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
806 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
807 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
808 <t>&nbsp;&nbsp;&nbsp;"DEPENDS: card"</t>
809 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"</t>
810 <t>&nbsp;&nbsp;&nbsp;"."</t>
811 </list>
812 </t>
813 <t>
814 <list>
815 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"</t>
816 <t>S: "DESCRIPTION: output sample rate in Hz"</t>
817 <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
818 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
819 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
820 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
821 <t>&nbsp;&nbsp;&nbsp;"DEPENDS: card"</t>
822 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"</t>
823 <t>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 22050"</t>
824 <t>&nbsp;&nbsp;&nbsp;"RANGE_MAX: 96000"</t>
825 <t>&nbsp;&nbsp;&nbsp;"."</t>
826 </list>
827 </t>
828 </section>
829
830 <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">
831 <t>Use the following command to create a new audio output device for the desired audio output system:</t>
832
833 <t>
834 <list>
835 <t>CREATE AUDIO_OUTPUT_DEVICE &lt;audio-output-driver&gt; [&lt;param-list&gt;]</t>
836 </list>
837 </t>
838
839 <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
840 output system as returned by the
841 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
842 command and &lt;param-list&gt; by an optional list of driver
843 specific parameters in form of "key1=val1 key2=val2 ...", where
844 character string values should be encapsulated into apostrophes (').
845 Note that there might be drivers which require parameter(s) to be
846 given with this command. Use the previously described commands in
847 this chapter to get this information.</t>
848
849 <t>Possible Answers:</t>
850 <t>
851 <list>
852 <t>"OK[&lt;device-id&gt;]" -
853 <list>
854 <t>in case the device was successfully created, where
855 &lt;device-id&gt; is the numerical ID of the new device</t>
856 </list>
857 </t>
858 <t>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
859 <list>
860 <t>in case the device was created successfully, where
861 &lt;device-id&gt; is the numerical ID of the new device, but there
862 are noteworthy issue(s) related (e.g. sound card doesn't
863 support given hardware parameters and the driver is using
864 fall-back values), providing an appropriate warning code and
865 warning message</t>
866 </list>
867 </t>
868 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
869 <list>
870 <t>in case it failed, providing an appropriate error code and error message</t>
871 </list>
872 </t>
873 </list>
874 </t>
875 <t>Examples:</t>
876 <t>
877 <list>
878 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t>
879 <t>S: "OK[0]"</t>
880 </list>
881 </t>
882 <t>
883 <list>
884 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"</t>
885 <t>S: "OK[1]"</t>
886 </list>
887 </t>
888 </section>
889
890 <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">
891 <t>Use the following command to destroy a created output device:</t>
892 <t>
893 <list>
894 <t>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;</t>
895 </list>
896 </t>
897 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
898 audio output device as given by the
899 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
900 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
901 command.</t>
902 <t>Possible Answers:</t>
903 <t>
904 <list>
905 <t>"OK" -
906 <list>
907 <t>in case the device was successfully destroyed</t>
908 </list>
909 </t>
910 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
911 <list>
912 <t>in case the device was destroyed successfully, but there are
913 noteworthy issue(s) related (e.g. an audio over ethernet
914 driver was unloaded but the other host might not be
915 informed about this situation), providing an appropriate
916 warning code and warning message</t>
917 </list>
918 </t>
919 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
920 <list>
921 <t>in case it failed, providing an appropriate error code and
922 error message</t>
923 </list>
924 </t>
925 </list>
926 </t>
927 <t>Example:</t>
928 <t>
929 <list>
930 <t>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"</t>
931 <t>S: "OK"</t>
932 </list>
933 </t>
934 </section>
935
936 <section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES">
937 <t>Use the following command to count all created audio output devices:</t>
938 <t>
939 <list>
940 <t>GET AUDIO_OUTPUT_DEVICES</t>
941 </list>
942 </t>
943 <t>Possible Answers:</t>
944 <t>
945 <list>
946 <t>LinuxSampler will answer by sending the current number of all
947 audio output devices.</t>
948 </list>
949 </t>
950 <t>Example:</t>
951 <t>
952 <list>
953 <t>C: "GET AUDIO_OUTPUT_DEVICES"</t>
954 <t>S: "4"</t>
955 </list>
956 </t>
957 </section>
958
959 <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">
960 <t>Use the following command to list all created audio output devices:</t>
961 <t>
962 <list>
963 <t>LIST AUDIO_OUTPUT_DEVICES</t>
964 </list>
965 </t>
966 <t>Possible Answers:</t>
967 <t>
968 <list>
969 <t>LinuxSampler will answer by sending a comma separated list with
970 the numerical IDs of all audio output devices.</t>
971 </list>
972 </t>
973 <t>Example:</t>
974 <t>
975 <list>
976 <t>C: "LIST AUDIO_OUTPUT_DEVICES"</t>
977 <t>S: "0,1,4,5"</t>
978 </list>
979 </t>
980 </section>
981
982 <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO">
983 <t>Use the following command to get current settings of a specific, created audio output device:</t>
984 <t>
985 <list>
986 <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>
987 </list>
988 </t>
989 <t>Where &lt;device-id&gt; should be replaced by numerical ID
990 of the audio output device as e.g. returned by the
991 <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
992 <t>Possible Answers:</t>
993 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
994 Each answer line begins with the information category name
995 followed by a colon and then a space character &lt;SP&gt; and finally
996 the info character string to that info category. As some
997 parameters might allow multiple values, character strings are
998 encapsulated into apostrophes ('). At the moment the following
999 information categories are defined (independently of device):</t>
1000 <t>
1001 <list>
1002 <t>DRIVER -
1003 <list>
1004 <t>identifier of the used audio output driver, as also
1005 returned by the
1006 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
1007 "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
1008 command</t>
1009 </list>
1010 </t>
1011 <t>CHANNELS -
1012 <list>
1013 <t>amount of audio output channels this device currently
1014 offers</t>
1015 </list>
1016 </t>
1017 <t>SAMPLERATE -
1018 <list>
1019 <t>playback sample rate the device uses</t>
1020 </list>
1021 </t>
1022 <t>ACTIVE -
1023 <list>
1024 <t>either true or false, if false then the audio device is
1025 inactive and doesn't output any sound, nor do the
1026 sampler channels connected to this audio device render
1027 any audio</t>
1028 </list>
1029 </t>
1030 </list>
1031 </t>
1032 <t>The mentioned fields above don't have to be in particular
1033 order. The fields above are only those fields which are
1034 returned by all audio output devices. Every audio output driver
1035 might have its own, additional driver specific parameters (see
1036 <xref target="GET AUDIO_OUTPUT_DRIVER INFO" />)
1037 which are also returned by this command.</t>
1038 <t>Example:</t>
1039 <t>
1040 <list>
1041 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
1042 <t>S: "DRIVER: ALSA"</t>
1043 <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
1044 <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
1045 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1046 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
1047 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
1048 <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
1049 <t>&nbsp;&nbsp;&nbsp;"."</t>
1050 </list>
1051 </t>
1052 </section>
1053
1054
1055 <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">
1056 <t>Use the following command to alter a specific setting of a created audio output device:</t>
1057 <t>
1058 <list>
1059 <t>SET AUDIO_OUTPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;</t>
1060 </list>
1061 </t>
1062 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1063 audio output device as given by the
1064 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1065 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1066 command, &lt;key&gt; by the name of the parameter to change
1067 and &lt;value&gt; by the new value for this parameter.</t>
1068 <t>Possible Answers:</t>
1069 <t>
1070 <list>
1071 <t>"OK" -
1072 <list>
1073 <t>in case setting was successfully changed</t>
1074 </list>
1075 </t>
1076 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1077 <list>
1078 <t>in case setting was changed successfully, but there are
1079 noteworthy issue(s) related, providing an appropriate
1080 warning code and warning message</t>
1081 </list>
1082 </t>
1083 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1084 <list>
1085 <t>in case it failed, providing an appropriate error code and
1086 error message</t>
1087 </list>
1088 </t>
1089 </list>
1090 </t>
1091 <t>Example:</t>
1092 <t>
1093 <list>
1094 <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t>
1095 <t>S: "OK"</t>
1096 </list>
1097 </t>
1098 </section>
1099
1100 <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">
1101 <t>Use the following command to get information about an audio channel:</t>
1102 <t>
1103 <list>
1104 <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
1105 </list>
1106 </t>
1107 <t>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1108 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1109 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1110 command and &lt;audio-chan&gt; the audio channel number.</t>
1111 <t>Possible Answers:</t>
1112 <t>
1113 <list>
1114 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1115 Each answer line begins with the information category name
1116 followed by a colon and then a space character &lt;SP&gt; and finally
1117 the info character string to that info category. At the moment
1118 the following information categories are defined:</t>
1119
1120 <t>
1121 <list>
1122 <t>NAME -
1123 <list>
1124 <t>arbitrary character string naming the channel, which
1125 doesn't have to be unique (always returned by all audio channels)</t>
1126 </list>
1127 </t>
1128 <t>IS_MIX_CHANNEL -
1129 <list>
1130 <t>either true or false, a mix-channel is not a real,
1131 independent audio channel, but a virtual channel which
1132 is mixed to another real channel, this mechanism is
1133 needed for sampler engines which need more audio
1134 channels than the used audio system might be able to offer
1135 (always returned by all audio channels)</t>
1136 </list>
1137 </t>
1138 <t>MIX_CHANNEL_DESTINATION -
1139 <list>
1140 <t>numerical ID (positive integer including 0)
1141 which reflects the real audio channel (of the same audio
1142 output device) this mix channel refers to, means where
1143 the audio signal actually will be routed / added to
1144 (only returned in case the audio channel is mix channel)</t>
1145 </list>
1146 </t>
1147 </list>
1148 </t>
1149 </list>
1150 </t>
1151
1152 <t>The mentioned fields above don't have to be in particular
1153 order. The fields above are only those fields which are
1154 generally returned for the described cases by all audio
1155 channels regardless of the audio driver. Every audio channel
1156 might have its own, additional driver and channel specific
1157 parameters.</t>
1158
1159 <t>Examples:</t>
1160
1161 <t>
1162 <list>
1163 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"</t>
1164 <t>S: "NAME: studio monitor left"</t>
1165 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1166 <t>&nbsp;&nbsp;&nbsp;"."</t>
1167 </list>
1168 </t>
1169
1170 <t>
1171 <list>
1172 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"</t>
1173 <t>S: "NAME: studio monitor right"</t>
1174 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1175 <t>&nbsp;&nbsp;&nbsp;"."</t>
1176 </list>
1177 </t>
1178
1179 <t>
1180 <list>
1181 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"</t>
1182 <t>S: "NAME: studio monitor left"</t>
1183 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: true"</t>
1184 <t>&nbsp;&nbsp;&nbsp;"MIX_CHANNEL_DESTINATION: 1"</t>
1185 <t>&nbsp;&nbsp;&nbsp;"."</t>
1186 </list>
1187 </t>
1188
1189 <t>
1190 <list>
1191 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t>
1192 <t>S: "NAME: 'ardour (left)'"</t>
1193 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1194 <t>&nbsp;&nbsp;&nbsp;"JACK_BINDINGS: 'ardour:0'"</t>
1195 <t>&nbsp;&nbsp;&nbsp;"."</t>
1196 </list>
1197 </t>
1198 </section>
1199
1200 <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">
1201 <t>Use the following command to get detailed information about specific audio channel parameter:</t>
1202
1203 <t>
1204 <list>
1205 <t>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO &lt;dev-id&gt; &lt;chan&gt; &lt;param&gt;</t>
1206 </list>
1207 </t>
1208
1209 <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
1210 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1211 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1212 command, &lt;chan&gt; the audio channel number
1213 and &lt;param&gt; a specific channel parameter name for which information should
1214 be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
1215 "GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t>
1216 <t>Possible Answers:</t>
1217
1218 <t>
1219 <list>
1220 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1221 Each answer line begins with the information category name
1222 followed by a colon and then a space character &lt;SP&gt; and finally
1223 the info character string to that info category. There are
1224 information which is always returned, independently of the
1225 given channel parameter and there is optional information
1226 which is only shown dependently to the given audio channel. At
1227 the moment the following information categories are defined:</t>
1228 <t>
1229 <list>
1230 <t>TYPE -
1231 <list>
1232 <t>either "BOOL" for boolean value(s) or "INT" for integer
1233 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1234 character string(s)
1235 (always returned)</t>
1236 </list>
1237 </t>
1238 <t>DESCRIPTION -
1239 <list>
1240 <t>arbitrary text describing the purpose of the parameter (always returned)</t>
1241 </list>
1242 </t>
1243 <t>FIX -
1244 <list>
1245 <t>either true or false, if true then this parameter is
1246 read only, thus cannot be altered
1247 (always returned)</t>
1248 </list>
1249 </t>
1250 <t>MULTIPLICITY -
1251 <list>
1252 <t>either true or false, defines if this parameter allows
1253 only one value or a list of values, where true means
1254 multiple values and false only a single value allowed
1255 (always returned)</t>
1256 </list>
1257 </t>
1258 <t>RANGE_MIN -
1259 <list>
1260 <t>defines lower limit of the allowed value range for this
1261 parameter, can be an integer value as well as a dotted
1262 number, usually used in conjunction with 'RANGE_MAX',
1263 but may also appear without
1264 (optionally returned, dependent to driver and channel
1265 parameter)</t>
1266 </list>
1267 </t>
1268 <t>RANGE_MAX -
1269 <list>
1270 <t>defines upper limit of the allowed value range for this
1271 parameter, can be an integer value as well as a dotted
1272 number, usually used in conjunction with 'RANGE_MIN',
1273 but may also appear without
1274 (optionally returned, dependent to driver and channel
1275 parameter)</t>
1276 </list>
1277 </t>
1278 <t>POSSIBILITIES -
1279 <list>
1280 <t>comma separated list of possible values for this
1281 parameter, character strings are encapsulated into
1282 apostrophes
1283 (optionally returned, dependent to driver and channel
1284 parameter)</t>
1285 </list>
1286 </t>
1287 </list>
1288 </t>
1289 <t>The mentioned fields above don't have to be in particular order.</t>
1290 </list>
1291 </t>
1292 <t>Example:</t>
1293 <t>
1294 <list>
1295 <t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"</t>
1296 <t>S: "DESCRIPTION: bindings to other JACK clients"</t>
1297 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
1298 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1299 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
1300 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
1301 <t>&nbsp;&nbsp;&nbsp;"."</t>
1302 </list>
1303 </t>
1304 </section>
1305
1306 <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">
1307 <t>Use the following command to alter a specific setting of an audio output channel:</t>
1308 <t>
1309 <list>
1310 <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
1311 </list>
1312 </t>
1313 <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
1314 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1315 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1316 command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
1317 parameter to change and &lt;value&gt; by the new value for this parameter.</t>
1318 <t>Possible Answers:</t>
1319 <t>
1320 <list>
1321 <t>"OK" -
1322 <list>
1323 <t>in case setting was successfully changed</t>
1324 </list>
1325 </t>
1326 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1327 <list>
1328 <t>in case setting was changed successfully, but there are
1329 noteworthy issue(s) related, providing an appropriate
1330 warning code and warning message</t>
1331 </list>
1332 </t>
1333 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1334 <list>
1335 <t>in case it failed, providing an appropriate error code and
1336 error message</t>
1337 </list>
1338 </t>
1339 </list>
1340 </t>
1341 <t>Example:</t>
1342 <t>
1343 <list>
1344 <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"</t>
1345 <t>S: "OK"</t>
1346 </list>
1347 </t>
1348 <t>
1349 <list>
1350 <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"</t>
1351 <t>S: "OK"</t>
1352 </list>
1353 </t>
1354 </section>
1355 </section>
1356
1357 <section title="Configuring MIDI input drivers">
1358 <t>Instances of drivers in LinuxSampler are called devices. You can use
1359 multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
1360 MIDI input on one sampler channel and ALSA as MIDI input on another sampler
1361 channel. For particular MIDI input systems it's also possible to create
1362 several devices of the same MIDI input type. This chapter describes all
1363 commands to configure LinuxSampler's MIDI input devices and their parameters.</t>
1364
1365 <t>Instead of defining commands and parameters for each driver individually,
1366 all possible parameters, their meanings and possible values have to be obtained
1367 at runtime. This makes the protocol a bit abstract, but has the advantage, that
1368 front-ends can be written independently of what drivers are currently implemented
1369 and what parameters these drivers are actually offering. This means front-ends can
1370 even handle drivers which are implemented somewhere in future without modifying
1371 the front-end at all.</t>
1372
1373 <t>Commands for configuring MIDI input devices are pretty much the same as the
1374 commands for configuring audio output drivers, already described in the last
1375 chapter.</t>
1376
1377 <t>Note: examples in this chapter showing particular parameters of drivers are
1378 not meant as specification of the drivers' parameters. Driver implementations in
1379 LinuxSampler might have complete different parameter names and meanings than shown
1380 in these examples or might change in future, so these examples are only meant for
1381 showing how to retrieve what parameters drivers are offering, how to retrieve their
1382 possible values, etc.</t>
1383
1384 <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">
1385 <t>Use the following command to get the number of
1386 MIDI input drivers currently available for the
1387 LinuxSampler instance:</t>
1388 <t>
1389 <list>
1390 <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
1391 </list>
1392 </t>
1393 <t>Possible Answers:</t>
1394 <t>
1395 <list>
1396 <t>LinuxSampler will answer by sending the
1397 number of available MIDI input drivers.</t>
1398 </list>
1399 </t>
1400 <t>Example:</t>
1401 <t>
1402 <list>
1403 <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1404 <t>S: "2"</t>
1405 </list>
1406 </t>
1407 </section>
1408
1409 <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1410 <t>Use the following command to list all MIDI input drivers currently available
1411 for the LinuxSampler instance:</t>
1412 <t>
1413 <list>
1414 <t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t>
1415 </list>
1416 </t>
1417 <t>Possible Answers:</t>
1418 <t>
1419 <list>
1420 <t>LinuxSampler will answer by sending comma separated character
1421 strings, each symbolizing a MIDI input driver.</t>
1422 </list>
1423 </t>
1424 <t>Example:</t>
1425 <t>
1426 <list>
1427 <t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1428 <t>S: "ALSA,JACK"</t>
1429 </list>
1430 </t>
1431 </section>
1432
1433 <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO">
1434 <t>Use the following command to get detailed information about a specific MIDI input driver:</t>
1435 <t>
1436 <list>
1437 <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
1438 </list>
1439 </t>
1440 <t>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
1441 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1442 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
1443 <t>Possible Answers:</t>
1444 <t>
1445 <list>
1446 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1447 Each answer line begins with the information category name
1448 followed by a colon and then a space character &lt;SP&gt; and finally
1449 the info character string to that info category. At the moment
1450 the following information categories are defined:</t>
1451
1452 <t>
1453 <list>
1454 <t>DESCRIPTION -
1455 <list>
1456 <t>arbitrary description text about the MIDI input driver</t>
1457 </list>
1458 </t>
1459 <t>VERSION -
1460 <list>
1461 <t>arbitrary character string regarding the driver's version</t>
1462 </list>
1463 </t>
1464 <t>PARAMETERS -
1465 <list>
1466 <t>comma separated list of all parameters available for the given MIDI input driver</t>
1467 </list>
1468 </t>
1469 </list>
1470 </t>
1471
1472 <t>The mentioned fields above don't have to be in particular order.</t>
1473 </list>
1474 </t>
1475
1476 <t>Example:</t>
1477
1478 <t>
1479 <list>
1480 <t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t>
1481 <t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t>
1482 <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
1483 <t>&nbsp;&nbsp;&nbsp;"PARAMETERS: DRIVER,ACTIVE"</t>
1484 <t>&nbsp;&nbsp;&nbsp;"."</t>
1485 </list>
1486 </t>
1487 </section>
1488
1489 <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO">
1490 <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>
1491 <t>
1492 <list>
1493 <t>GET MIDI_INPUT_DRIVER_PARAMETER INFO &lt;midit&gt; &lt;param&gt; [&lt;deplist&gt;]</t>
1494 </list>
1495 </t>
1496
1497 <t>Where &lt;midit&gt; is the name of the MIDI input driver as returned
1498 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1499 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
1500 parameter name for which information should be obtained (as returned by the
1501 <xref target="GET MIDI_INPUT_DRIVER INFO">
1502 "GET MIDI_INPUT_DRIVER INFO"</xref> command) and &lt;deplist&gt; is an optional list
1503 of parameters on which the sought parameter &lt;param&gt; depends on,
1504 &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
1505 where character string values are encapsulated into apostrophes ('). Arguments
1506 given with &lt;deplist&gt; which are not dependency parameters of &lt;param&gt;
1507 will be ignored, means the front-end application can simply put all parameters
1508 in &lt;deplist&gt; with the values selected by the user.</t>
1509
1510 <t>Possible Answers:</t>
1511
1512 <t>LinuxSampler will answer by sending a &lt;CRLF> separated list.
1513 Each answer line begins with the information category name
1514 followed by a colon and then a space character &lt;SP> and finally
1515 the info character string to that info category. There is
1516 information which is always returned, independent of the
1517 given driver parameter and there is optional information
1518 which is only shown dependent to given driver parameter. At
1519 the moment the following information categories are defined:</t>
1520
1521 <t>
1522 <list>
1523 <t>TYPE -
1524 <list>
1525 <t>either "BOOL" for boolean value(s) or "INT" for integer
1526 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1527 character string(s)
1528 (always returned, no matter which driver parameter)</t>
1529 </list>
1530 </t>
1531
1532 <t>DESCRIPTION -
1533 <list>
1534 <t>arbitrary text describing the purpose of the parameter
1535 (always returned, no matter which driver parameter)</t>
1536 </list>
1537 </t>
1538
1539 <t>MANDATORY -
1540 <list>
1541 <t>either true or false, defines if this parameter must be
1542 given when the device is to be created with the
1543 <xref target="CREATE MIDI_INPUT_DEVICE">
1544 'CREATE MIDI_INPUT_DEVICE'</xref> command
1545 (always returned, no matter which driver parameter)</t>
1546 </list>
1547 </t>
1548
1549 <t>FIX -
1550 <list>
1551 <t>either true or false, if false then this parameter can
1552 be changed at any time, once the device is created by
1553 the <xref target="CREATE MIDI_INPUT_DEVICE">
1554 'CREATE MIDI_INPUT_DEVICE'</xref> command
1555 (always returned, no matter which driver parameter)</t>
1556 </list>
1557 </t>
1558
1559 <t>MULTIPLICITY -
1560 <list>
1561 <t>either true or false, defines if this parameter allows
1562 only one value or a list of values, where true means
1563 multiple values and false only a single value allowed
1564 (always returned, no matter which driver parameter)</t>
1565 </list>
1566 </t>
1567
1568 <t>DEPENDS -
1569 <list>
1570 <t>comma separated list of parameters this parameter depends
1571 on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1572 'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1573 listed parameters, for example assuming that an audio
1574 driver (like the ALSA driver) offers parameters 'card'
1575 and 'samplerate' then parameter 'samplerate' would
1576 depend on 'card' because the possible values for
1577 'samplerate' depends on the sound card which can be
1578 chosen by the 'card' parameter
1579 (optionally returned, dependent to driver parameter)</t>
1580 </list>
1581 </t>
1582
1583 <t>DEFAULT -
1584 <list>
1585 <t>reflects the default value for this parameter which is
1586 used when the device is created and not explicitly
1587 given with the <xref target="CREATE MIDI_INPUT_DEVICE">
1588 'CREATE MIDI_INPUT_DEVICE'</xref> command,
1589 in case of MULTIPLCITY=true, this is a comma separated
1590 list, that's why character strings are encapsulated into
1591 apostrophes (')
1592 (optionally returned, dependent to driver parameter)</t>
1593 </list>
1594 </t>
1595
1596 <t>RANGE_MIN -
1597 <list>
1598 <t>defines lower limit of the allowed value range for this
1599 parameter, can be an integer value as well as a dotted
1600 number, this parameter is often used in conjunction
1601 with RANGE_MAX, but may also appear without
1602 (optionally returned, dependent to driver parameter)</t>
1603 </list>
1604 </t>
1605
1606 <t>RANGE_MAX -
1607 <list>
1608 <t>defines upper limit of the allowed value range for this
1609 parameter, can be an integer value as well as a dotted
1610 number, this parameter is often used in conjunction with
1611 RANGE_MIN, but may also appear without
1612 (optionally returned, dependent to driver parameter)</t>
1613 </list>
1614 </t>
1615
1616 <t>POSSIBILITIES -
1617 <list>
1618 <t>comma separated list of possible values for this
1619 parameter, character strings are encapsulated into
1620 apostrophes
1621 (optionally returned, dependent to driver parameter)</t>
1622 </list>
1623 </t>
1624 </list>
1625 </t>
1626
1627 <t>The mentioned fields above don't have to be in particular order.</t>
1628
1629 <t>Example:</t>
1630 <t>
1631 <list>
1632 <t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t>
1633 <t>S: "DESCRIPTION: Whether device is enabled"</t>
1634 <t>&nbsp;&nbsp;&nbsp;"TYPE: BOOL"</t>
1635 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
1636 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1637 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
1638 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
1639 <t>&nbsp;&nbsp;&nbsp;"."</t>
1640 </list>
1641 </t>
1642 </section>
1643
1644 <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">
1645 <t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t>
1646 <t>
1647 <list>
1648 <t>CREATE MIDI_INPUT_DEVICE &lt;midi-input-driver&gt; [&lt;param-list&gt;]</t>
1649 </list>
1650 </t>
1651
1652 <t>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
1653 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1654 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
1655 optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
1656 character string values should be encapsulated into apostrophes (').
1657 Note that there might be drivers which require parameter(s) to be
1658 given with this command. Use the previously described commands in
1659 this chapter to get that information.</t>
1660
1661 <t>Possible Answers:</t>
1662 <t>
1663 <list>
1664 <t>"OK[&lt;device-id&gt;]" -
1665 <list>
1666 <t>in case the device was successfully created, where
1667 &lt;device-id&gt; is the numerical ID of the new device</t>
1668 </list>
1669 </t>
1670 <t>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1671 <list>
1672 <t>in case the driver was loaded successfully, where
1673 &lt;device-id&gt; is the numerical ID of the new device, but
1674 there are noteworthy issue(s) related, providing an
1675 appropriate warning code and warning message</t>
1676 </list>
1677 </t>
1678 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1679 <list>
1680 <t>in case it failed, providing an appropriate error code and error message</t>
1681 </list>
1682 </t>
1683 </list>
1684 </t>
1685 <t>Example:</t>
1686 <t>
1687 <list>
1688 <t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t>
1689 <t>S: "OK[0]"</t>
1690 </list>
1691 </t>
1692 </section>
1693
1694 <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">
1695 <t>Use the following command to destroy a created MIDI input device:</t>
1696 <t>
1697 <list>
1698 <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
1699 </list>
1700 </t>
1701 <t>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
1702 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1703 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1704 command.</t>
1705 <t>Possible Answers:</t>
1706 <t>
1707 <list>
1708 <t>"OK" -
1709 <list>
1710 <t>in case the device was successfully destroyed</t>
1711 </list>
1712 </t>
1713 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1714 <list>
1715 <t>in case the device was destroyed, but there are noteworthy
1716 issue(s) related, providing an appropriate warning code and
1717 warning message</t>
1718 </list>
1719 </t>
1720 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1721 <list>
1722 <t>in case it failed, providing an appropriate error code and error message</t>
1723 </list>
1724 </t>
1725 </list>
1726 </t>
1727 <t>Example:</t>
1728 <t>
1729 <list>
1730 <t>C: "DESTROY MIDI_INPUT_DEVICE 0"</t>
1731 <t>S: "OK"</t>
1732 </list>
1733 </t>
1734 </section>
1735
1736 <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">
1737 <t>Use the following command to count all created MIDI input devices:</t>
1738 <t>
1739 <list>
1740 <t>GET MIDI_INPUT_DEVICES</t>
1741 </list>
1742 </t>
1743 <t>Possible Answers:</t>
1744 <t>
1745 <list>
1746 <t>LinuxSampler will answer by sending the current number of all
1747 MIDI input devices.</t>
1748 </list>
1749 </t>
1750 <t>Example:</t>
1751 <t>
1752 <list>
1753 <t>C: "GET MIDI_INPUT_DEVICES"</t>
1754 <t>S: "3"</t>
1755 </list>
1756 </t>
1757 </section>
1758
1759
1760 <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">
1761 <t>Use the following command to list all created MIDI input devices:</t>
1762 <t>
1763 <list>
1764 <t>LIST MIDI_INPUT_DEVICES</t>
1765 </list>
1766 </t>
1767 <t>Possible Answers:</t>
1768 <t>
1769 <list>
1770 <t>LinuxSampler will answer by sending a comma separated list
1771 with the numerical Ids of all created MIDI input devices.</t>
1772 </list>
1773 </t>
1774 <t>Examples:</t>
1775 <t>
1776 <list>
1777 <t>C: "LIST MIDI_INPUT_DEVICES"</t>
1778 <t>S: "0,1,2"</t>
1779 </list>
1780 </t>
1781 <t>
1782 <list>
1783 <t>C: "LIST MIDI_INPUT_DEVICES"</t>
1784 <t>S: "1,3"</t>
1785 </list>
1786 </t>
1787 </section>
1788
1789 <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO">
1790 <t>Use the following command to get current settings of a specific, created MIDI input device:</t>
1791 <t>
1792 <list>
1793 <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
1794 </list>
1795 </t>
1796 <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1797 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1798 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1799 command.</t>
1800 <t>Possible Answers:</t>
1801 <t>
1802 <list>
1803 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1804 Each answer line begins with the information category name
1805 followed by a colon and then a space character &lt;SP&gt; and finally
1806 the info character string to that info category. As some
1807 parameters might allow multiple values, character strings are
1808 encapsulated into apostrophes ('). At the moment the following
1809 information categories are defined (independent of driver):</t>
1810
1811 <t>
1812 <list>
1813 <t>DRIVER -
1814 <list>
1815 <t>identifier of the used MIDI input driver, as e.g.
1816 returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1817 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref>
1818 command</t>
1819 </list>
1820 </t>
1821 </list>
1822 <list>
1823 <t>ACTIVE -
1824 <list>
1825 <t>either true or false, if false then the MIDI device is
1826 inactive and doesn't listen to any incoming MIDI events
1827 and thus doesn't forward them to connected sampler
1828 channels</t>
1829 </list>
1830 </t>
1831 </list>
1832 </t>
1833 </list>
1834 </t>
1835
1836 <t>The mentioned fields above don't have to be in particular
1837 order. The fields above are only those fields which are
1838 returned by all MIDI input devices. Every MIDI input driver
1839 might have its own, additional driver specific parameters (see
1840 <xref target="GET MIDI_INPUT_DRIVER INFO">
1841 "GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned
1842 by this command.</t>
1843
1844 <t>Example:</t>
1845 <t>
1846 <list>
1847 <t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t>
1848 <t>S: "DRIVER: ALSA"</t>
1849 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1850 <t>&nbsp;&nbsp;&nbsp;"."</t>
1851 </list>
1852 </t>
1853 </section>
1854
1855 <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
1856 <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
1857 <t>
1858 <list>
1859 <t>SET MIDI_INPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;</t>
1860 </list>
1861 </t>
1862
1863 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1864 MIDI input device as returned by the
1865 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1866 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1867 command, &lt;key&gt; by the name of the parameter to change and
1868 &lt;value&gt; by the new value for this parameter.</t>
1869
1870 <t>Possible Answers:</t>
1871 <t>
1872 <list>
1873 <t>"OK" -
1874 <list>
1875 <t>in case setting was successfully changed</t>
1876 </list>
1877 </t>
1878 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1879 <list>
1880 <t>in case setting was changed successfully, but there are
1881 noteworthy issue(s) related, providing an appropriate
1882 warning code and warning message</t>
1883 </list>
1884 </t>
1885 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1886 <list>
1887 <t>in case it failed, providing an appropriate error code and error message</t>
1888 </list>
1889 </t>
1890 </list>
1891 </t>
1892 <t>Example:</t>
1893 <t>
1894 <list>
1895 <t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t>
1896 <t>S: "OK"</t>
1897 </list>
1898 </t>
1899 </section>
1900
1901 <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">
1902 <t>Use the following command to get information about a MIDI port:</t>
1903 <t>
1904 <list>
1905 <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
1906 </list>
1907 </t>
1908 <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1909 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1910 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1911 command and &lt;midi-port&gt; the MIDI input port number.</t>
1912 <t>Possible Answers:</t>
1913 <t>
1914 <list>
1915 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1916 Each answer line begins with the information category name
1917 followed by a colon and then a space character &lt;SP&gt; and finally
1918 the info character string to that info category. At the moment
1919 the following information categories are defined:</t>
1920
1921 <t>NAME -
1922 <list>
1923 <t>arbitrary character string naming the port</t>
1924 </list>
1925 </t>
1926 </list>
1927 </t>
1928
1929 <t>The field above is only the one which is returned by all MIDI
1930 ports regardless of the MIDI driver and port. Every MIDI port
1931 might have its own, additional driver and port specific
1932 parameters.</t>
1933
1934 <t>Example:</t>
1935 <t>
1936 <list>
1937 <t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t>
1938 <t>S: "NAME: 'Masterkeyboard'"</t>
1939 <t>&nbsp;&nbsp;&nbsp;"ALSA_SEQ_BINDINGS: '64:0'"</t>
1940 <t>&nbsp;&nbsp;&nbsp;"."</t>
1941 </list>
1942 </t>
1943 </section>
1944
1945 <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO">
1946 <t>Use the following command to get detailed information about specific MIDI port parameter:</t>
1947 <t>
1948 <list>
1949 <t>GET MIDI_INPUT_PORT_PARAMETER INFO &lt;dev-id&gt; &lt;port&gt; &lt;param&gt;</t>
1950 </list>
1951 </t>
1952
1953 <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
1954 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1955 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1956 command, &lt;port&gt; the MIDI port number and
1957 &lt;param&gt; a specific port parameter name for which information should be
1958 obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1959 "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
1960
1961 <t>Possible Answers:</t>
1962 <t>
1963 <list>
1964 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1965 Each answer line begins with the information category name
1966 followed by a colon and then a space character &lt;SP&gt; and finally
1967 the info character string to that info category. There is
1968 information which is always returned, independently of the
1969 given channel parameter and there is optional information
1970 which are only shown dependently to the given MIDI port. At the
1971 moment the following information categories are defined:</t>
1972
1973 <t>TYPE -
1974 <list>
1975 <t>either "BOOL" for boolean value(s) or "INT" for integer
1976 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1977 character string(s)
1978 (always returned)</t>
1979 </list>
1980 </t>
1981 <t>DESCRIPTION -
1982 <list>
1983 <t>arbitrary text describing the purpose of the parameter
1984 (always returned)</t>
1985 </list>
1986 </t>
1987 <t>FIX -
1988 <list>
1989 <t>either true or false, if true then this parameter is
1990 read only, thus cannot be altered
1991 (always returned)</t>
1992 </list>
1993 </t>
1994 <t>MULTIPLICITY -
1995 <list>
1996 <t>either true or false, defines if this parameter allows
1997 only one value or a list of values, where true means
1998 multiple values and false only a single value allowed
1999 (always returned)</t>
2000 </list>
2001 </t>
2002 <t>RANGE_MIN -
2003 <list>
2004 <t>defines lower limit of the allowed value range for this
2005 parameter, can be an integer value as well as a dotted
2006 number, this parameter is usually used in conjunction
2007 with 'RANGE_MAX' but may also appear without
2008 (optionally returned, dependent to driver and port
2009 parameter)</t>
2010 </list>
2011 </t>
2012 <t>RANGE_MAX -
2013 <list>
2014 <t>defines upper limit of the allowed value range for this
2015 parameter, can be an integer value as well as a dotted
2016 number, this parameter is usually used in conjunction
2017 with 'RANGE_MIN' but may also appear without
2018 (optionally returned, dependent to driver and port
2019 parameter)</t>
2020 </list>
2021 </t>
2022 <t>POSSIBILITIES -
2023 <list>
2024 <t>comma separated list of possible values for this
2025 parameter, character strings are encapsulated into
2026 apostrophes
2027 (optionally returned, dependent to device and port
2028 parameter)</t>
2029 </list>
2030 </t>
2031 </list>
2032 </t>
2033
2034 <t>The mentioned fields above don't have to be in particular order.</t>
2035
2036 <t>Example:</t>
2037 <t>
2038 <list>
2039 <t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"</t>
2040 <t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t>
2041 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
2042 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
2043 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
2044 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"</t>
2045 <t>&nbsp;&nbsp;&nbsp;"."</t>
2046 </list>
2047 </t>
2048 </section>
2049
2050 <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">
2051 <t>Use the following command to alter a specific setting of a MIDI input port:</t>
2052 <t>
2053 <list>
2054 <t>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;</t>
2055 </list>
2056 </t>
2057
2058 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
2059 MIDI device as returned by the
2060 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2061 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062 command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2063 the parameter to change and &lt;value&gt; by the new value for this
2064 parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
2065 for specifying no value for parameters allowing a list of values.</t>
2066
2067 <t>Possible Answers:</t>
2068 <t>
2069 <list>
2070 <t>"OK" -
2071 <list>
2072 <t>in case setting was successfully changed</t>
2073 </list>
2074 </t>
2075 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2076 <list>
2077 <t>in case setting was changed successfully, but there are
2078 noteworthy issue(s) related, providing an appropriate
2079 warning code and warning message</t>
2080 </list>
2081 </t>
2082 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2083 <list>
2084 <t>in case it failed, providing an appropriate error code and error message</t>
2085 </list>
2086 </t>
2087 </list>
2088 </t>
2089 <t>Example:</t>
2090 <t>
2091 <list>
2092 <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t>
2093 <t>S: "OK"</t>
2094 </list>
2095 </t>
2096 <t>
2097 <list>
2098 <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t>
2099 <t>S: "OK"</t>
2100 </list>
2101 </t>
2102 </section>
2103 </section>
2104
2105 <section title="Configuring sampler channels">
2106 <t>The following commands describe how to add and remove sampler channels, associate a
2107 sampler channel with a sampler engine, load instruments and connect sampler channels to
2108 MIDI and audio devices.</t>
2109
2110 <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2111 <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
2112 <t>
2113 <list>
2114 <t>LOAD INSTRUMENT [NON_MODAL] '&lt;filename&gt;' &lt;instr-index&gt; &lt;sampler-channel&gt;</t>
2115 </list>
2116 </t>
2117
2118 <t>Where &lt;filename&gt; is the name of the instrument file on the
2119 LinuxSampler instance's host system, &lt;instr-index&gt; the index of the
2120 instrument in the instrument file and &lt;sampler-channel> is the
2121 number of the sampler channel the instrument should be assigned to.
2122 Each sampler channel can only have one instrument.</t>
2123
2124 <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125 escape characters for special characters (see chapter
2126 "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127 for details) and accordingly backslash characters in the filename
2128 MUST now be escaped as well!</t>
2129
2130 <t>The difference between regular and NON_MODAL versions of the command
2131 is that the regular command returns OK only after the instrument has been
2132 fully loaded and the channel is ready to be used while NON_MODAL version
2133 returns immediately and a background process is launched to load the instrument
2134 on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref>
2135 command can be used to obtain loading
2136 progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2137 such as making sure that the file could be read and it is of a proper format
2138 and SHOULD return ERR and SHOULD not launch the background process should any
2139 errors be detected at that point.</t>
2140
2141 <t>Possible Answers:</t>
2142 <t>
2143 <list>
2144 <t>"OK" -
2145 <list>
2146 <t>in case the instrument was successfully loaded</t>
2147 </list>
2148 </t>
2149 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2150 <list>
2151 <t>in case the instrument was loaded successfully, but there
2152 are noteworthy issue(s) related (e.g. Engine doesn't support
2153 one or more patch parameters provided by the loaded
2154 instrument file), providing an appropriate warning code and
2155 warning message</t>
2156 </list>
2157 </t>
2158 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2159 <list>
2160 <t>in case it failed, providing an appropriate error code and error message</t>
2161 </list>
2162 </t>
2163 </list>
2164 </t>
2165 <t>Example (Unix):</t>
2166 <t>
2167 <list>
2168 <t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t>
2169 <t>S: OK</t>
2170 </list>
2171 </t>
2172 <t>Example (Windows):</t>
2173 <t>
2174 <list>
2175 <t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t>
2176 <t>S: OK</t>
2177 </list>
2178 </t>
2179 </section>
2180
2181 <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2182 <t>A sampler engine type can be associated to a specific sampler
2183 channel by the following command:</t>
2184 <t>
2185 <list>
2186 <t>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;</t>
2187 </list>
2188 </t>
2189
2190 <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2191 <xref target="LIST AVAILABLE_ENGINES">
2192 "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
2193 the sampler channel as returned by the
2194 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
2195 <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
2196 the engine type should be assigned to. This command should be issued
2197 after adding a new sampler channel and before any other control
2198 commands on the new sampler channel. It can also be used to change
2199 the engine type of a sampler channel. This command has (currently) no
2200 way to define or force if a new engine instance should be created and
2201 assigned to the given sampler channel or if an already existing
2202 instance of that engine type, shared with other sampler channels,
2203 should be used.</t>
2204
2205 <t>Possible Answers:</t>
2206 <t>
2207 <list>
2208 <t>"OK" -
2209 <list>
2210 <t>in case the engine was successfully deployed</t>
2211 </list>
2212 </t>
2213 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2214 <list>
2215 <t>in case the engine was deployed successfully, but there
2216 are noteworthy issue(s) related, providing an appropriate
2217 warning code and warning message</t>
2218 </list>
2219 </t>
2220 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2221 <list>
2222 <t>in case it failed, providing an appropriate error code and
2223 error message</t>
2224 </list>
2225 </t>
2226 </list>
2227 </t>
2228 <t>Example:</t>
2229 <t>
2230 <list>
2231 <t></t>
2232 </list>
2233 </t>
2234 </section>
2235
2236 <section title="Getting all created sampler channel count" anchor="GET CHANNELS">
2237 <t>The number of sampler channels can change on runtime. To get the
2238 current amount of sampler channels, the front-end can send the
2239 following command:</t>
2240 <t>
2241 <list>
2242 <t>GET CHANNELS</t>
2243 </list>
2244 </t>
2245 <t>Possible Answers:</t>
2246 <t>
2247 <list>
2248 <t>LinuxSampler will answer by returning the current number of sampler channels.</t>
2249 </list>
2250 </t>
2251 <t>Example:</t>
2252 <t>
2253 <list>
2254 <t>C: "GET CHANNELS"</t>
2255 <t>S: "12"</t>
2256 </list>
2257 </t>
2258 </section>
2259
2260 <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">
2261 <t>The number of sampler channels can change on runtime. To get the
2262 current list of sampler channels, the front-end can send the
2263 following command:</t>
2264 <t>
2265 <list>
2266 <t>LIST CHANNELS</t>
2267 </list>
2268 </t>
2269 <t>Possible Answers:</t>
2270 <t>
2271 <list>
2272 <t>LinuxSampler will answer by returning a comma separated list
2273 with all sampler channels numerical IDs.</t>
2274 </list>
2275 </t>
2276 <t>Example:</t>
2277 <t>
2278 <list>
2279 <t>C: "LIST CHANNELS"</t>
2280 <t>S: "0,1,2,3,4,5,6,9,10,11,15,20"</t>
2281 </list>
2282 </t>
2283 </section>
2284
2285 <section title="Adding a new sampler channel" anchor="ADD CHANNEL">
2286 <t>A new sampler channel can be added to the end of the sampler
2287 channel list by sending the following command:</t>
2288 <t>
2289 <list>
2290 <t>ADD CHANNEL</t>
2291 </list>
2292 </t>
2293 <t>This will increment the sampler channel count by one and the new
2294 sampler channel will be appended to the end of the sampler channel
2295 list. The front-end should send the respective, related commands
2296 right after to e.g. load an engine, load an instrument and setting
2297 input, output method and eventually other commands to initialize
2298 the new channel. The front-end should use the sampler channel
2299 returned by the answer of this command to perform the previously
2300 recommended commands, to avoid race conditions e.g. with other
2301 front-ends that might also have sent an "ADD CHANNEL" command.</t>
2302 <t>Possible Answers:</t>
2303 <t>
2304 <list>
2305 <t>"OK[&lt;sampler-channel&gt;]" -
2306 <list>
2307 <t>in case a new sampler channel could be added, where
2308 &lt;sampler-channel&gt; reflects the channel number of the new
2309 created sampler channel which should be used to set up
2310 the sampler channel by sending subsequent initialization
2311 commands</t>
2312 </list>
2313 </t>
2314 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2315 <list>
2316 <t>in case a new channel was added successfully, but there are
2317 noteworthy issue(s) related, providing an appropriate
2318 warning code and warning message</t>
2319 </list>
2320 </t>
2321 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2322 <list>
2323 <t>in case it failed, providing an appropriate error code and
2324 error message</t>
2325 </list>
2326 </t>
2327 </list>
2328 </t>
2329 <t>Example:</t>
2330 <t>
2331 <list>
2332 <t></t>
2333 </list>
2334 </t>
2335 </section>
2336
2337 <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">
2338 <t>A sampler channel can be removed by sending the following command:</t>
2339 <t>
2340 <list>
2341 <t>REMOVE CHANNEL &lt;sampler-channel&gt;</t>
2342 </list>
2343 </t>
2344
2345 <t>Where &lt;sampler-channel&gt; should be replaced by the
2346 number of the sampler channel as given by the
2347 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2348 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
2349 command. The channel numbers of all subsequent sampler channels
2350 remain the same.</t>
2351
2352 <t>Possible Answers:</t>
2353 <t>
2354 <list>
2355 <t>"OK" -
2356 <list>
2357 <t>in case the given sampler channel could be removed</t>
2358 </list>
2359 </t>
2360 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2361 <list>
2362 <t>in case the given channel was removed, but there are
2363 noteworthy issue(s) related, providing an appropriate
2364 warning code and warning message</t>
2365 </list>
2366 </t>
2367 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2368 <list>
2369 <t>in case it failed, providing an appropriate error code and
2370 error message</t>
2371 </list>
2372 </t>
2373 </list>
2374 </t>
2375 <t>Example:</t>
2376 <t>
2377 <list>
2378 <t></t>
2379 </list>
2380 </t>
2381 </section>
2382
2383 <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">
2384 <t>The front-end can ask for the number of available engines by sending the following command:</t>
2385 <t>
2386 <list>
2387 <t>GET AVAILABLE_ENGINES</t>
2388 </list>
2389 </t>
2390 <t>Possible Answers:</t>
2391 <t>
2392 <list>
2393 <t>LinuxSampler will answer by sending the number of available engines.</t>
2394 </list>
2395 </t>
2396 <t>Example:</t>
2397 <t>
2398 <list>
2399 <t>C: "GET AVAILABLE_ENGINES"</t>
2400 <t>S: "4"</t>
2401 </list>
2402 </t>
2403 </section>
2404
2405 <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">
2406 <t>The front-end can ask for a list of all available engines by sending the following command:</t>
2407 <t>
2408 <list>
2409 <t>LIST AVAILABLE_ENGINES</t>
2410 </list>
2411 </t>
2412 <t>Possible Answers:</t>
2413 <t>
2414 <list>
2415 <t>LinuxSampler will answer by sending a comma separated list
2416 of the engines' names encapsulated into apostrophes (').
2417 Engine names can consist of lower and upper cases,
2418 digits and underlines ("_" character).</t>
2419 </list>
2420 </t>
2421 <t>Example:</t>
2422 <t>
2423 <list>
2424 <t>C: "LIST AVAILABLE_ENGINES"</t>
2425 <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
2426 </list>
2427 </t>
2428 </section>
2429
2430 <section title="Getting information about an engine" anchor="GET ENGINE INFO">
2431 <t>The front-end can ask for information about a specific engine by
2432 sending the following command:</t>
2433 <t>
2434 <list>
2435 <t>GET ENGINE INFO &lt;engine-name&gt;</t>
2436 </list>
2437 </t>
2438 <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2439 <xref target="LIST AVAILABLE_ENGINES">
2440 "LIST AVAILABLE_ENGINES"</xref> command.</t>
2441 <t>Possible Answers:</t>
2442 <t>
2443 <list>
2444 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2445 Each answer line begins with the information category name
2446 followed by a colon and then a space character &lt;SP&gt; and finally
2447 the info character string to that info category. At the moment
2448 the following categories are defined:</t>
2449
2450 <t>
2451 <list>
2452 <t>DESCRIPTION -
2453 <list>
2454 <t>arbitrary description text about the engine
2455 (note that the character string may contain
2456 <xref target="character_set">escape sequences</xref>)</t>
2457 </list>
2458 </t>
2459 <t>VERSION -
2460 <list>
2461 <t>arbitrary character string regarding the engine's version</t>
2462 </list>
2463 </t>
2464 </list>
2465 </t>
2466 </list>
2467 </t>
2468
2469 <t>The mentioned fields above don't have to be in particular order.</t>
2470
2471 <t>Example:</t>
2472 <t>
2473 <list>
2474 <t>C: "GET ENGINE INFO JoesCustomEngine"</t>
2475 <t>S: "DESCRIPTION: this is Joe's custom sampler engine"</t>
2476 <t>&nbsp;&nbsp;&nbsp;"VERSION: testing-1.0"</t>
2477 <t>&nbsp;&nbsp;&nbsp;"."</t>
2478 </list>
2479 </t>
2480 </section>
2481
2482 <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">
2483 <t>The front-end can ask for the current settings of a sampler channel
2484 by sending the following command:</t>
2485 <t>
2486 <list>
2487 <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
2488 </list>
2489 </t>
2490 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2491 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2492 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2493 <t>Possible Answers:</t>
2494 <t>
2495 <list>
2496 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2497 Each answer line begins with the settings category name
2498 followed by a colon and then a space character &lt;SP&gt; and finally
2499 the info character string to that setting category. At the
2500 moment the following categories are defined:</t>
2501
2502 <t>
2503 <list>
2504 <t>ENGINE_NAME -
2505 <list>
2506 <t>name of the engine that is associated with the sampler
2507 channel, "NONE" if there's no engine associated yet for
2508 this sampler channel</t>
2509 </list>
2510 </t>
2511 <t>AUDIO_OUTPUT_DEVICE -
2512 <list>
2513 <t>numerical ID of the audio output device which is
2514 currently connected to this sampler channel to output
2515 the audio signal, "-1" if there's no device
2516 connected to this sampler channel</t>
2517 </list>
2518 </t>
2519 <t>AUDIO_OUTPUT_CHANNELS -
2520 <list>
2521 <t>number of output channels the sampler channel offers
2522 (dependent to used sampler engine and loaded instrument)</t>
2523 </list>
2524 </t>
2525 <t>AUDIO_OUTPUT_ROUTING -
2526 <list>
2527 <t>comma separated list which reflects to which audio
2528 channel of the selected audio output device each
2529 sampler output channel is routed to, e.g. "0,3" would
2530 mean the engine's output channel 0 is routed to channel
2531 0 of the audio output device and the engine's output
2532 channel 1 is routed to the channel 3 of the audio
2533 output device</t>
2534 </list>
2535 </t>
2536 <t>INSTRUMENT_FILE -
2537 <list>
2538 <t>the file name of the loaded instrument, "NONE" if
2539 there's no instrument yet loaded for this sampler
2540 channel (note: since LSCP 1.2 this path may contain
2541 <xref target="character_set">escape sequences</xref>)</t>
2542 </list>
2543 </t>
2544 <t>INSTRUMENT_NR -
2545 <list>
2546 <t>the instrument index number of the loaded instrument,
2547 "-1" if there's no instrument loaded for this sampler
2548 channel</t>
2549 </list>
2550 </t>
2551 <t>INSTRUMENT_NAME -
2552 <list>
2553 <t>the instrument name of the loaded instrument
2554 (note: since LSCP 1.2 this character string may contain
2555 <xref target="character_set">escape sequences</xref>)</t>
2556 </list>
2557 </t>
2558 <t>INSTRUMENT_STATUS -
2559 <list>
2560 <t>Integer values 0 to 100 indicating loading progress
2561 percentage for the instrument. Negative
2562 value indicates a loading exception (also returns "-1" in case no
2563 instrument was yet to be loaded on the sampler channel).
2564 Value of 100 indicates that the instrument is fully
2565 loaded.</t>
2566 </list>
2567 </t>
2568 <t>MIDI_INPUT_DEVICE -
2569 <list>
2570 <t>numerical ID of the MIDI input device which is
2571 currently connected to this sampler channel to deliver
2572 MIDI input commands, "-1" if there's no device
2573 connected to this sampler channel</t>
2574 </list>
2575 </t>
2576 <t>MIDI_INPUT_PORT -
2577 <list>
2578 <t>port number of the MIDI input device (in case a
2579 MIDI device was already assigned to the sampler
2580 channel)</t>
2581 </list>
2582 </t>
2583 <t>MIDI_INPUT_CHANNEL -
2584 <list>
2585 <t>the MIDI input channel number this sampler channel
2586 should listen to or "ALL" to listen on all MIDI channels</t>
2587 </list>
2588 </t>
2589 <t>VOLUME -
2590 <list>
2591 <t>optionally dotted number for the channel volume factor
2592 (where a value &lt; 1.0 means attenuation and a value >
2593 1.0 means amplification)</t>
2594 </list>
2595 </t>
2596 <t>MUTE -
2597 <list>
2598 <t>Determines whether the channel is muted, "true" if the
2599 channel is muted, "false" if the channel is not muted, and
2600 "MUTED_BY_SOLO" if the channel is muted because of the
2601 presence of a solo channel and will be unmuted when
2602 there are no solo channels left</t>
2603 </list>
2604 </t>
2605 <t>SOLO -
2606 <list>
2607 <t>Determines whether this is a solo channel, "true" if
2608 the channel is a solo channel; "false" otherwise</t>
2609 </list>
2610 </t>
2611 <t>MIDI_INSTRUMENT_MAP -
2612 <list>
2613 <t>Determines to which MIDI instrument map this sampler
2614 channel is assigned to. Read chapter
2615 <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
2616 for a list of possible values.</t>
2617 </list>
2618 </t>
2619 </list>
2620 </t>
2621 </list>
2622 </t>
2623 <t>The mentioned fields above don't have to be in particular order.</t>
2624
2625 <t>Example:</t>
2626 <t>
2627 <list>
2628 <t>C: "GET CHANNEL INFO 34"</t>
2629 <t>S: "ENGINE_NAME: GigEngine"</t>
2630 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2631 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_DEVICE: 0"</t>
2632 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_CHANNELS: 2"</t>
2633 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 0,1"</t>
2634 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t>
2635 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
2636 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Fazioli Piano"</t>
2637 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_STATUS: 100"</t>
2638 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
2639 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
2640 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
2641 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2642 <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
2643 <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
2644 <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
2645 <t>&nbsp;&nbsp;&nbsp;"."</t>
2646 </list>
2647 </t>
2648 </section>
2649
2650 <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">
2651 <t>The front-end can ask for the current number of active voices on a
2652 sampler channel by sending the following command:</t>
2653 <t>
2654 <list>
2655 <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
2656 </list>
2657 </t>
2658 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2659 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2660 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2661
2662 <t>Possible Answers:</t>
2663 <t>
2664 <list>
2665 <t>LinuxSampler will answer by returning the number of active
2666 voices on that channel.</t>
2667 </list>
2668 </t>
2669 <t>Example:</t>
2670 <t>
2671 <list>
2672 <t></t>
2673 </list>
2674 </t>
2675 </section>
2676
2677 <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">
2678 <t>The front-end can ask for the current number of active disk streams
2679 on a sampler channel by sending the following command:</t>
2680 <t>
2681 <list>
2682 <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
2683 </list>
2684 </t>
2685 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2686 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2687 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2688
2689 <t>Possible Answers:</t>
2690 <t>
2691 <list>
2692 <t>LinuxSampler will answer by returning the number of active
2693 disk streams on that channel in case the engine supports disk
2694 streaming, if the engine doesn't support disk streaming it will
2695 return "NA" for not available.</t>
2696 </list>
2697 </t>
2698 <t>Example:</t>
2699 <t>
2700 <list>
2701 <t></t>
2702 </list>
2703 </t>
2704 </section>
2705
2706 <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">
2707 <t>The front-end can ask for the current fill state of all disk streams
2708 on a sampler channel by sending the following command:</t>
2709 <t>
2710 <list>
2711 <t>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;</t>
2712 </list>
2713 </t>
2714 <t>to get the fill state in bytes or</t>
2715 <t>
2716 <list>
2717 <t>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;</t>
2718 </list>
2719 </t>
2720 <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
2721 sampler channel number the front-end is interested in
2722 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2723 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2724
2725 <t>Possible Answers:</t>
2726 <t>
2727 <list>
2728 <t>LinuxSampler will either answer by returning a comma separated
2729 string with the fill state of all disk stream buffers on that
2730 channel or an empty line if there are no active disk streams or
2731 "NA" for *not available* in case the engine which is deployed
2732 doesn't support disk streaming. Each entry in the answer list
2733 will begin with the stream's ID in brackets followed by the
2734 numerical representation of the fill size (either in bytes or
2735 percentage). Note: due to efficiency reasons the fill states in
2736 the response are not in particular order, thus the front-end has
2737 to sort them by itself if necessary.</t>
2738 </list>
2739 </t>
2740 <t>Examples:</t>
2741 <t>
2742 <list>
2743 <t>C: "GET CHANNEL BUFFER_FILL BYTES 4"</t>
2744 <t>S: "[115]420500,[116]510300,[75]110000,[120]230700"</t>
2745 </list>
2746
2747 <list>
2748 <t>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"</t>
2749 <t>S: "[115]90%,[116]98%,[75]40%,[120]62%"</t>
2750 </list>
2751
2752 <list>
2753 <t>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"</t>
2754 <t>S: ""</t>
2755 </list>
2756 </t>
2757 </section>
2758
2759 <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">
2760 <t>The front-end can set the audio output device on a specific sampler
2761 channel by sending the following command:</t>
2762 <t>
2763 <list>
2764 <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
2765 </list>
2766 </t>
2767 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
2768 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2769 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
2770 &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
2771 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
2772 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
2773 command.</t>
2774
2775 <t>Possible Answers:</t>
2776 <t>
2777 <list>
2778 <t>"OK" -
2779 <list>
2780 <t>on success</t>
2781 </list>
2782 </t>
2783 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2784 <list>
2785 <t>if audio output device was set, but there are noteworthy
2786 issue(s) related, providing an appropriate warning code and
2787 warning message</t>
2788 </list>
2789 </t>
2790 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2791 <list>
2792 <t>in case it failed, providing an appropriate error code and error message</t>
2793 </list>
2794 </t>
2795 </list>
2796 </t>
2797 <t>Examples:</t>
2798 <t>
2799 <list>
2800 <t></t>
2801 </list>
2802 </t>
2803 </section>
2804
2805 <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">
2806 <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2807
2808 <t>The front-end can alter the audio output type on a specific sampler
2809 channel by sending the following command:</t>
2810 <t>
2811 <list>
2812 <t>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;</t>
2813 </list>
2814 </t>
2815 <t>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and
2816 &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2817
2818 <t>Possible Answers:</t>
2819 <t>
2820 <list>
2821 <t>"OK" -
2822 <list>
2823 <t>on success</t>
2824 </list>
2825 </t>
2826 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2827 <list>
2828 <t>if audio output type was set, but there are noteworthy
2829 issue(s) related, providing an appropriate warning code and
2830 warning message</t>
2831 </list>
2832 </t>
2833 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2834 <list>
2835 <t>in case it failed, providing an appropriate error code and error message</t>
2836 </list>
2837 </t>
2838 </list>
2839 </t>
2840 <t>Examples:</t>
2841 <t>
2842 <list>
2843 <t></t>
2844 </list>
2845 </t>
2846 </section>
2847
2848 <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">
2849 <t>The front-end can alter the audio output channel on a specific
2850 sampler channel by sending the following command:</t>
2851 <t>
2852 <list>
2853 <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
2854 </list>
2855 </t>
2856 <t>Where &lt;sampler-chan&gt; is the sampler channel number
2857 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2858 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
2859 numerical ID of the sampler channel's audio output channel which should be
2860 rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
2861 output device where &lt;audio-out&gt; should be routed to.</t>
2862
2863 <t>Possible Answers:</t>
2864 <t>
2865 <list>
2866 <t>"OK" -
2867 <list>
2868 <t>on success</t>
2869 </list>
2870 </t>
2871 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2872 <list>
2873 <t>if audio output channel was set, but there are noteworthy
2874 issue(s) related, providing an appropriate warning code and
2875 warning message</t>
2876 </list>
2877 </t>
2878 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2879 <list>
2880 <t>in case it failed, providing an appropriate error code and error message</t>
2881 </list>
2882 </t>
2883 </list>
2884 </t>
2885 <t>Examples:</t>
2886 <t>
2887 <list>
2888 <t></t>
2889 </list>
2890 </t>
2891 </section>
2892
2893 <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">
2894 <t>The front-end can set the MIDI input device on a specific sampler
2895 channel by sending the following command:</t>
2896 <t>
2897 <list>
2898 <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
2899 </list>
2900 </t>
2901 <t>Where &lt;sampler-channel&gt; is the sampler channel number
2902 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2903 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2904 and &lt;midi-device-id&gt; is the numerical ID of the MIDI input device as returned by the
2905 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2906 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
2907
2908 <t>Possible Answers:</t>
2909 <t>
2910 <list>
2911 <t>"OK" -
2912 <list>
2913 <t>on success</t>
2914 </list>
2915 </t>
2916 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2917 <list>
2918 <t>if MIDI input device was set, but there are noteworthy
2919 issue(s) related, providing an appropriate warning code and
2920 warning message</t>
2921 </list>
2922 </t>
2923 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2924 <list>
2925 <t>in case it failed, providing an appropriate error code and error message</t>
2926 </list>
2927 </t>
2928 </list>
2929 </t>
2930 <t>Examples:</t>
2931 <t>
2932 <list>
2933 <t></t>
2934 </list>
2935 </t>
2936 </section>
2937
2938 <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">
2939 <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2940
2941 <t>The front-end can alter the MIDI input type on a specific sampler
2942 channel by sending the following command:</t>
2943 <t>
2944 <list>
2945 <t>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;</t>
2946 </list>
2947 </t>
2948 <t>Where &lt;midi-input-type&gt; is currently only "ALSA" and
2949 &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2950
2951 <t>Possible Answers:</t>
2952 <t>
2953 <list>
2954 <t>"OK" -
2955 <list>
2956 <t>on success</t>
2957 </list>
2958 </t>
2959 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2960 <list>
2961 <t>if MIDI input type was set, but there are noteworthy
2962 issue(s) related, providing an appropriate warning code and
2963 warning message</t>
2964 </list>
2965 </t>
2966 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2967 <list>
2968 <t>in case it failed, providing an appropriate error code and error message</t>
2969 </list>
2970 </t>
2971 </list>
2972 </t>
2973 <t>Examples:</t>
2974 <t>
2975 <list>
2976 <t></t>
2977 </list>
2978 </t>
2979 </section>
2980
2981 <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">
2982 <t>The front-end can alter the MIDI input port on a specific sampler
2983 channel by sending the following command:</t>
2984 <t>
2985 <list>
2986 <t>SET CHANNEL MIDI_INPUT_PORT &lt;sampler-channel&gt; &lt;midi-input-port&gt;</t>
2987 </list>
2988 </t>
2989 <t>Where &lt;midi-input-port&gt; is a MIDI input port number of the
2990 MIDI input device connected to the sampler channel given by
2991 &lt;sampler-channel&gt;.</t>
2992
2993 <t>Possible Answers:</t>
2994 <t>
2995 <list>
2996 <t>"OK" -
2997 <list>
2998 <t>on success</t>
2999 </list>
3000 </t>
3001 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3002 <list>
3003 <t>if MIDI input port was set, but there are noteworthy
3004 issue(s) related, providing an appropriate warning code and
3005 warning message</t>
3006 </list>
3007 </t>
3008 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3009 <list>
3010 <t>in case it failed, providing an appropriate error code and error message</t>
3011 </list>
3012 </t>
3013 </list>
3014 </t>
3015 <t>Examples:</t>
3016 <t>
3017 <list>
3018 <t></t>
3019 </list>
3020 </t>
3021 </section>
3022
3023 <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">
3024 <t>The front-end can alter the MIDI channel a sampler channel should
3025 listen to by sending the following command:</t>
3026 <t>
3027 <list>
3028 <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>
3029 </list>
3030 </t>
3031 <t>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where
3032 &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
3033 channels.</t>
3034
3035 <t>Possible Answers:</t>
3036 <t>
3037 <list>
3038 <t>"OK" -
3039 <list>
3040 <t>on success</t>
3041 </list>
3042 </t>
3043 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3044 <list>
3045 <t>if MIDI input channel was set, but there are noteworthy
3046 issue(s) related, providing an appropriate warning code and
3047 warning message</t>
3048 </list>
3049 </t>
3050 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3051 <list>
3052 <t>in case it failed, providing an appropriate error code and error message</t>
3053 </list>
3054 </t>
3055 </list>
3056 </t>
3057 <t>Examples:</t>
3058 <t>
3059 <list>
3060 <t></t>
3061 </list>
3062 </t>
3063 </section>
3064
3065 <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">
3066 <t>The front-end can alter the volume of a sampler channel by sending
3067 the following command:</t>
3068 <t>
3069 <list>
3070 <t>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;</t>
3071 </list>
3072 </t>
3073 <t>Where &lt;volume&gt; is an optionally dotted positive number (a value
3074 smaller than 1.0 means attenuation, whereas a value greater than
3075 1.0 means amplification) and &lt;sampler-channel&gt; defines the sampler
3076 channel where this volume factor should be set.</t>
3077
3078 <t>Possible Answers:</t>
3079 <t>
3080 <list>
3081 <t>"OK" -
3082 <list>
3083 <t>on success</t>
3084 </list>
3085 </t>
3086 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3087 <list>
3088 <t>if channel volume was set, but there are noteworthy
3089 issue(s) related, providing an appropriate warning code and
3090 warning message</t>
3091 </list>
3092 </t>
3093 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3094 <list>
3095 <t>in case it failed, providing an appropriate error code and error message</t>
3096 </list>
3097 </t>
3098 </list>
3099 </t>
3100 <t>Examples:</t>
3101 <t>
3102 <list>
3103 <t></t>
3104 </list>
3105 </t>
3106 </section>
3107
3108 <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
3109 <t>The front-end can mute/unmute a specific sampler
3110 channel by sending the following command:</t>
3111 <t>
3112 <list>
3113 <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
3114 </list>
3115 </t>
3116 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3117 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3118 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3119 &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
3120 to unmute the channel.</t>
3121
3122 <t>Possible Answers:</t>
3123 <t>
3124 <list>
3125 <t>"OK" -
3126 <list>
3127 <t>on success</t>
3128 </list>
3129 </t>
3130 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3131 <list>
3132 <t>if the channel was muted/unmuted, but there are noteworthy
3133 issue(s) related, providing an appropriate warning code and
3134 warning message</t>
3135 </list>
3136 </t>
3137 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3138 <list>
3139 <t>in case it failed, providing an appropriate error code and error message</t>
3140 </list>
3141 </t>
3142 </list>
3143 </t>
3144 <t>Examples:</t>
3145 <t>
3146 <list>
3147 <t></t>
3148 </list>
3149 </t>
3150 </section>
3151
3152 <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
3153 <t>The front-end can solo/unsolo a specific sampler channel
3154 by sending the following command:</t>
3155 <t>
3156 <list>
3157 <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
3158 </list>
3159 </t>
3160 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3161 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3162 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3163 &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
3164 to unsolo the channel.</t>
3165
3166 <t>Possible Answers:</t>
3167 <t>
3168 <list>
3169 <t>"OK" -
3170 <list>
3171 <t>on success</t>
3172 </list>
3173 </t>
3174 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3175 <list>
3176 <t>if the channel was soloed/unsoloed, but there are noteworthy
3177 issue(s) related, providing an appropriate warning code and
3178 warning message</t>
3179 </list>
3180 </t>
3181 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3182 <list>
3183 <t>in case it failed, providing an appropriate error code and error message</t>
3184 </list>
3185 </t>
3186 </list>
3187 </t>
3188 <t>Examples:</t>
3189 <t>
3190 <list>
3191 <t></t>
3192 </list>
3193 </t>
3194 </section>
3195
3196 <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">
3197 <t>The front-end can assign a MIDI instrument map to a specific sampler channel
3198 by sending the following command:</t>
3199 <t>
3200 <list>
3201 <t>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;</t>
3202 </list>
3203 </t>
3204 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3205 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3206 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3207 &lt;map&gt; can have the following possibilites:</t>
3208 <t>
3209 <list>
3210 <t>"NONE" -
3211 <list>
3212 <t>This is the default setting. In this case
3213 the sampler channel is not assigned any MIDI
3214 instrument map and thus will ignore all MIDI
3215 program change messages.</t>
3216 </list>
3217 </t>
3218 <t>"DEFAULT" -
3219 <list>
3220 <t>The sampler channel will always use the
3221 default MIDI instrument map to handle MIDI
3222 program change messages.</t>
3223 </list>
3224 </t>
3225 <t>numeric ID -
3226 <list>
3227 <t>You can assign a specific MIDI instrument map
3228 by replacing &lt;map&gt; with the respective numeric
3229 ID of the MIDI instrument map as returned by the
3230 <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
3231 command. Once that map will be deleted, the sampler
3232 channel would fall back to "NONE".</t>
3233 </list>
3234 </t>
3235 </list>
3236 </t>
3237 <t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref>
3238 for details regarding MIDI instrument mapping.</t>
3239
3240 <t>Possible Answers:</t>
3241 <t>
3242 <list>
3243 <t>"OK" -
3244 <list>
3245 <t>on success</t>
3246 </list>
3247 </t>
3248 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3249 <list>
3250 <t>in case it failed, providing an appropriate error code and error message</t>
3251 </list>
3252 </t>
3253 </list>
3254 </t>
3255
3256 <t>Examples:</t>
3257 <t>
3258 <list>
3259 <t></t>
3260 </list>
3261 </t>
3262 </section>
3263
3264 <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3265 <t>The front-end can create an additional effect send on a specific sampler channel
3266 by sending the following command:</t>
3267 <t>
3268 <list>
3269 <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3270 </list>
3271 </t>
3272 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3273 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3274 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3275 sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3276 is a number between 0..127 defining the MIDI controller which can alter the
3277 effect send level and &lt;name&gt; is an optional argument defining a name
3278 for the effect send entity. The name does not have to be unique, but MUST be
3279 encapsulated into apostrophes and supports escape sequences as described in chapter
3280 "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3281
3282 <t>By default, that is as initial routing, the effect send's audio channels
3283 are automatically routed to the last audio channels of the sampler channel's
3284 audio output device, that way you can i.e. first increase the amount of audio
3285 channels on the audio output device for having dedicated effect send output
3286 channels and when "CREATE FX_SEND" is called, those channels will automatically
3287 be picked. You can alter the destination channels however with
3288 <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3289 </t>
3290
3291 <t>Note: Create effect sends on a sampler channel only when needed, because having effect
3292 sends on a sampler channel will decrease runtime performance, because for implementing channel
3293 effect sends, separate (sampler channel local) audio buffers are needed to render and mix
3294 the voices and route the audio signal afterwards to the master outputs and effect send
3295 outputs (along with their respective effect send levels). A sampler channel without effect
3296 sends however can mix its voices directly into the audio output devices's audio buffers
3297 and is thus faster.
3298 </t>
3299
3300 <t>Possible Answers:</t>
3301 <t>
3302 <list>
3303 <t>"OK[&lt;fx-send-id&gt;]" -
3304 <list>
3305 <t>in case a new effect send could be added to the
3306 sampler channel, where &lt;fx-send-id&gt; reflects the
3307 unique ID of the newly created effect send entity</t>
3308 </list>
3309 </t>
3310 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3311 <list>
3312 <t>when a new effect send could not be added, i.e.
3313 due to invalid parameters</t>
3314 </list>
3315 </t>
3316 </list>
3317 </t>
3318
3319 <t>Examples:</t>
3320 <t>
3321 <list>
3322 <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
3323 <t>S: "OK[0]"</t>
3324 </list>
3325 </t>
3326 <t>
3327 <list>
3328 <t>C: "CREATE FX_SEND 0 93"</t>
3329 <t>S: "OK[1]"</t>
3330 </list>
3331 </t>
3332 </section>
3333
3334 <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
3335 <t>The front-end can remove an existing effect send on a specific sampler channel
3336 by sending the following command:</t>
3337 <t>
3338 <list>
3339 <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3340 </list>
3341 </t>
3342 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3343 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3344 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3345 sampler channel from which the effect send should be removed from and
3346 &lt;fx-send-id&gt; is the respective effect send number as returned by the
3347 <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3348 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3349
3350 <t>Possible Answers:</t>
3351 <t>
3352 <list>
3353 <t>"OK" -
3354 <list>
3355 <t>on success</t>
3356 </list>
3357 </t>
3358 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3359 <list>
3360 <t>in case it failed, providing an appropriate error code and
3361 error message</t>
3362 </list>
3363 </t>
3364 </list>
3365 </t>
3366
3367 <t>Example:</t>
3368 <t>
3369 <list>
3370 <t>C: "DESTROY FX_SEND 0 0"</t>
3371 <t>S: "OK"</t>
3372 </list>
3373 </t>
3374 </section>
3375
3376 <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
3377 <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3378 by sending the following command:</t>
3379 <t>
3380 <list>
3381 <t>GET FX_SENDS &lt;sampler-channel&gt;</t>
3382 </list>
3383 </t>
3384 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3385 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3386 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3387
3388 <t>Possible Answers:</t>
3389 <t>
3390 <list>
3391 <t>The sampler will answer by returning the number of effect
3392 sends on the given sampler channel.</t>
3393 </list>
3394 </t>
3395
3396 <t>Example:</t>
3397 <t>
3398 <list>
3399 <t>C: "GET FX_SENDS 0"</t>
3400 <t>S: "2"</t>
3401 </list>
3402 </t>
3403 </section>
3404
3405 <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
3406 <t>The front-end can ask for a list of effect sends on a specific sampler channel
3407 by sending the following command:</t>
3408 <t>
3409 <list>
3410 <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
3411 </list>
3412 </t>
3413 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3414 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3415 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3416
3417 <t>Possible Answers:</t>
3418 <t>
3419 <list>
3420 <t>The sampler will answer by returning a comma separated list
3421 with all effect sends' numerical IDs on the given sampler
3422 channel.</t>
3423 </list>
3424 </t>
3425
3426 <t>Examples:</t>
3427 <t>
3428 <list>
3429 <t>C: "LIST FX_SENDS 0"</t>
3430 <t>S: "0,1"</t>
3431 </list>
3432 </t>
3433 <t>
3434 <list>
3435 <t>C: "LIST FX_SENDS 1"</t>
3436 <t>S: ""</t>
3437 </list>
3438 </t>
3439 </section>
3440
3441 <section title="Getting effect send information" anchor="GET FX_SEND INFO">
3442 <t>The front-end can ask for the current settings of an effect send entity
3443 by sending the following command:</t>
3444 <t>
3445 <list>
3446 <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3447 </list>
3448 </t>
3449 <t>Where &lt;sampler-channel&gt; is the sampler channel number
3450 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3451 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3452 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3453 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3454 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
3455 </t>
3456
3457 <t>Possible Answers:</t>
3458 <t>
3459 <list>
3460 <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
3461 Each answer line begins with the settings category name
3462 followed by a colon and then a space character &lt;SP&gt; and finally
3463 the info character string to that setting category. At the
3464 moment the following categories are defined:</t>
3465
3466 <t>
3467 <list>
3468 <t>NAME -
3469 <list>
3470 <t>name of the effect send entity
3471 (note that this character string may contain
3472 <xref target="character_set">escape sequences</xref>)</t>
3473 </list>
3474 </t>
3475 <t>MIDI_CONTROLLER -
3476 <list>
3477 <t>a value between 0 and 127 reflecting the MIDI controller
3478 which is able to modify the effect send's send level</t>
3479 </list>
3480 </t>
3481 <t>LEVEL -
3482 <list>
3483 <t>optionally dotted number reflecting the effect send's
3484 current send level (where a value &lt; 1.0 means attenuation
3485 and a value > 1.0 means amplification)</t>
3486 </list>
3487 </t>
3488 <t>AUDIO_OUTPUT_ROUTING -
3489 <list>
3490 <t>comma separated list which reflects to which audio
3491 channel of the selected audio output device each
3492 effect send output channel is routed to, e.g. "0,3" would
3493 mean the effect send's output channel 0 is routed to channel
3494 0 of the audio output device and the effect send's output
3495 channel 1 is routed to the channel 3 of the audio
3496 output device (see
3497 <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3498 for details)</t>
3499 </list>
3500 </t>
3501 </list>
3502 </t>
3503 </list>
3504 </t>
3505 <t>The mentioned fields above don't have to be in particular order.</t>
3506
3507 <t>Example:</t>
3508 <t>
3509 <list>
3510 <t>C: "GET FX_SEND INFO 0 0"</t>
3511 <t>S: "NAME: Reverb Send"</t>
3512 <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3513 <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3514 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3515 <t>&nbsp;&nbsp;&nbsp;"."</t>
3516 </list>
3517 </t>
3518 </section>
3519
3520 <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3521 <t>The front-end can alter the current name of an effect
3522 send entity by sending the following command:</t>
3523 <t>
3524 <list>
3525 <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3526 </list>
3527 </t>
3528 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3529 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3530 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3531 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3532 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3533 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3534 &lt;name&gt; is the new name of the effect send entity, which
3535 does not have to be unique (name MUST be encapsulated into apostrophes
3536 and supports escape sequences as described in chapter
3537 "<xref target="character_set">Character Set and Escape Sequences</xref>").
3538 </t>
3539
3540 <t>Possible Answers:</t>
3541 <t>
3542 <list>
3543 <t>"OK" -
3544 <list>
3545 <t>on success</t>
3546 </list>
3547 </t>
3548 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3549 <list>
3550 <t>in case it failed, providing an appropriate error code and error message</t>
3551 </list>
3552 </t>
3553 </list>
3554 </t>
3555 <t>Example:</t>
3556 <t>
3557 <list>
3558 <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3559 <t>S: "OK"</t>
3560 </list>
3561 </t>
3562 </section>
3563
3564 <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3565 <t>The front-end can alter the destination of an effect send's audio channel on a specific
3566 sampler channel by sending the following command:</t>
3567 <t>
3568 <list>
3569 <t>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;</t>
3570 </list>
3571 </t>
3572 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3573 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3574 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3575 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3576 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3577 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3578 &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3579 which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3580 the audio channel of the selected audio output device where &lt;audio-src&gt;
3581 should be routed to.</t>
3582
3583 <t>Note that effect sends can only route audio to the same audio output
3584 device as assigned to the effect send's sampler channel. Also note that an
3585 effect send entity does always have exactly as much audio channels as its
3586 sampler channel. So if the sampler channel is stereo, the effect send does
3587 have two audio channels as well. Also keep in mind that the amount of audio
3588 channels on a sampler channel might be dependant not only to the deployed
3589 sampler engine on the sampler channel, but also dependant to the instrument
3590 currently loaded. However you can (effectively) turn an i.e. stereo effect
3591 send into a mono one by simply altering its audio routing appropriately.</t>
3592
3593 <t>Possible Answers:</t>
3594 <t>
3595 <list>
3596 <t>"OK" -
3597 <list>
3598 <t>on success</t>
3599 </list>
3600 </t>
3601 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3602 <list>
3603 <t>if audio output channel was set, but there are noteworthy
3604 issue(s) related, providing an appropriate warning code and
3605 warning message</t>
3606 </list>
3607 </t>
3608 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3609 <list>
3610 <t>in case it failed, providing an appropriate error code and error message</t>
3611 </list>
3612 </t>
3613 </list>
3614 </t>
3615 <t>Example:</t>
3616 <t>
3617 <list>
3618 <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3619 <t>S: "OK"</t>
3620 </list>
3621 </t>
3622 </section>
3623
3624 <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3625 <t>The front-end can alter the MIDI controller of an effect
3626 send entity by sending the following command:</t>
3627 <t>
3628 <list>
3629 <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3630 </list>
3631 </t>
3632 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3633 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3634 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3635 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3636 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3637 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3638 &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3639 able to modify the effect send's send level.</t>
3640
3641 <t>Possible Answers:</t>
3642 <t>
3643 <list>
3644 <t>"OK" -
3645 <list>
3646 <t>on success</t>
3647 </list>
3648 </t>
3649 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3650 <list>
3651 <t>if MIDI controller was set, but there are noteworthy
3652 issue(s) related, providing an appropriate warning code and
3653 warning message</t>
3654 </list>
3655 </t>
3656 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3657 <list>
3658 <t>in case it failed, providing an appropriate error code and error message</t>
3659 </list>
3660 </t>
3661 </list>
3662 </t>
3663 <t>Example:</t>
3664 <t>
3665 <list>
3666 <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3667 <t>S: "OK"</t>
3668 </list>
3669 </t>
3670 </section>
3671
3672 <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3673 <t>The front-end can alter the current send level of an effect
3674 send entity by sending the following command:</t>
3675 <t>
3676 <list>
3677 <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3678 </list>
3679 </t>
3680 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3681 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3682 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3683 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3684 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3685 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3686 &lt;volume&gt; is an optionally dotted positive number (a value
3687 smaller than 1.0 means attenuation, whereas a value greater than
3688 1.0 means amplification) reflecting the new send level.</t>
3689
3690 <t>Possible Answers:</t>
3691 <t>
3692 <list>
3693 <t>"OK" -
3694 <list>
3695 <t>on success</t>
3696 </list>
3697 </t>
3698 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3699 <list>
3700 <t>if new send level was set, but there are noteworthy
3701 issue(s) related, providing an appropriate warning code and
3702 warning message</t>
3703 </list>
3704 </t>
3705 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3706 <list>
3707 <t>in case it failed, providing an appropriate error code and error message</t>
3708 </list>
3709 </t>
3710 </list>
3711 </t>
3712 <t>Example:</t>
3713 <t>
3714 <list>
3715 <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3716 <t>S: "OK"</t>
3717 </list>
3718 </t>
3719 </section>
3720
3721 <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3722 <t>The front-end can send MIDI events to specific sampler channel
3723 by sending the following command:</t>
3724 <t>
3725 <list>
3726 <t>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;</t>
3727 </list>
3728 </t>
3729 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3730 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3731 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3732 &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
3733 specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3734 <t>
3735 <list>
3736 <t>"NOTE_ON" -
3737 <list>
3738 <t>For turning on MIDI notes, where &lt;arg1&gt;
3739 specifies the key number and &lt;arg2&gt; the velocity
3740 as described in the MIDI specification.</t>
3741 </list>
3742 </t>
3743 <t>"NOTE_OFF" -
3744 <list>
3745 <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3746 specifies the key number and &lt;arg2&gt; the velocity
3747 as described in the MIDI specification.</t>
3748 </list>
3749 </t>
3750 </list>
3751 </t>
3752 <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3753 and no realtime guarantee whatsoever will be made!</t>
3754 <t>Possible Answers:</t>
3755 <t>
3756 <list>
3757 <t>"OK" -
3758 <list>
3759 <t>on success</t>
3760 </list>
3761 </t>
3762 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3763 <list>
3764 <t>in case it failed, providing an appropriate error code and error message</t>
3765 </list>
3766 </t>
3767 </list>
3768 </t>
3769 <t>Example:</t>
3770 <t>
3771 <list>
3772 <t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t>
3773 <t>S: "OK"</t>
3774 </list>
3775 </t>
3776 </section>
3777
3778 <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3779 <t>The front-end can reset a particular sampler channel by sending the following command:</t>
3780 <t>
3781 <list>
3782 <t>RESET CHANNEL &lt;sampler-channel&gt;</t>
3783 </list>
3784 </t>
3785 <t>
3786 Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
3787 This will cause the engine on that sampler channel, its voices and
3788 eventually disk streams and all control and status variables to be
3789 reset.</t>
3790
3791 <t>Possible Answers:</t>
3792 <t>
3793 <list>
3794 <t>"OK" -
3795 <list>
3796 <t>on success</t>
3797 </list>
3798 </t>
3799 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3800 <list>
3801 <t>if channel was reset, but there are noteworthy issue(s)
3802 related, providing an appropriate warning code and warning
3803 message</t>
3804 </list>
3805 </t>
3806 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3807 <list>
3808 <t>in case it failed, providing an appropriate error code and
3809 error message</t>
3810 </list>
3811 </t>
3812 </list>
3813 </t>
3814 <t>Examples:</t>
3815 <t>
3816 <list>
3817 <t></t>
3818 </list>
3819 </t>
3820 </section>
3821 </section>
3822
3823 <section title="Controlling connection">
3824 <t>The following commands are used to control the connection to LinuxSampler.</t>
3825
3826 <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
3827 <t>The front-end can register itself to the LinuxSampler application to
3828 be informed about noteworthy events by sending this command:</t>
3829 <t>
3830 <list>
3831 <t>SUBSCRIBE &lt;event-id&gt;</t>
3832 </list>
3833 </t>
3834 <t>where &lt;event-id&gt; will be replaced by the respective event that
3835 client wants to subscribe to.</t>
3836
3837 <t>Possible Answers:</t>
3838 <t>
3839 <list>
3840 <t>"OK" -
3841 <list>
3842 <t>on success</t>
3843 </list>
3844 </t>
3845 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3846 <list>
3847 <t>if registration succeeded, but there are noteworthy
3848 issue(s) related, providing an appropriate warning code and
3849 warning message</t>
3850 </list>
3851 </t>
3852 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3853 <list>
3854 <t>in case it failed, providing an appropriate error code and
3855 error message</t>
3856 </list>
3857 </t>
3858 </list>
3859 </t>
3860 <t>Examples:</t>
3861 <t>
3862 <list>
3863 <t></t>
3864 </list>
3865 </t>
3866 </section>
3867
3868 <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
3869 <t>The front-end can unregister itself if it doesn't want to receive event
3870 messages anymore by sending the following command:</t>
3871 <t>
3872 <list>
3873 <t>UNSUBSCRIBE &lt;event-id&gt;</t>
3874 </list>
3875 </t>
3876 <t>Where &lt;event-id&gt; will be replaced by the respective event that
3877 client doesn't want to receive anymore.</t>
3878
3879 <t>Possible Answers:</t>
3880 <t>
3881 <list>
3882 <t>"OK" -
3883 <list>
3884 <t>on success</t>
3885 </list>
3886 </t>
3887 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3888 <list>
3889 <t>if unregistration succeeded, but there are noteworthy
3890 issue(s) related, providing an appropriate warning code and
3891 warning message</t>
3892 </list>
3893 </t>
3894 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3895 <list>
3896 <t>in case it failed, providing an appropriate error code and
3897 error message</t>
3898 </list>
3899 </t>
3900 </list>
3901 </t>
3902 <t>Examples:</t>
3903 <t>
3904 <list>
3905 <t></t>
3906 </list>
3907 </t>
3908 </section>
3909
3910 <section title="Enable or disable echo of commands" anchor="SET ECHO">
3911 <t>To enable or disable back sending of commands to the client the following command can be used:</t>
3912 <t>
3913 <list>
3914 <t>SET ECHO &lt;value&gt;</t>
3915 </list>
3916 </t>
3917 <t>Where &lt;value&gt; should be replaced either by "1" to enable echo mode
3918 or "0" to disable echo mode. When echo mode is enabled, all
3919 commands send to LinuxSampler will be immediately send back and
3920 after this echo the actual response to the command will be
3921 returned. Echo mode will only be altered for the client connection
3922 that issued the "SET ECHO" command, not globally for all client
3923 connections.</t>
3924
3925 <t>Possible Answers:</t>
3926 <t>
3927 <list>
3928 <t>"OK" -
3929 <list>
3930 <t>usually</t>
3931 </list>
3932 </t>
3933 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3934 <list>
3935 <t>on syntax error, e.g. non boolean value</t>
3936 </list>
3937 </t>
3938 </list>
3939 </t>
3940 <t>Examples:</t>
3941 <t>
3942 <list>
3943 <t></t>
3944 </list>
3945 </t>
3946 </section>
3947
3948 <section title="Close client connection" anchor="QUIT">
3949 <t>The client can close its network connection to LinuxSampler by sending the following command:</t>
3950 <t>
3951 <list>
3952 <t>QUIT</t>
3953 </list>
3954 </t>
3955 <t>This is probably more interesting for manual telnet connections to
3956 LinuxSampler than really useful for a front-end implementation.</t>
3957 </section>
3958 </section>
3959
3960 <section title="Global commands">
3961 <t>The following commands have global impact on the sampler.</t>
3962
3963 <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
3964 <t>The front-end can ask for the current number of active voices on
3965 the sampler by sending the following command:</t>
3966 <t>
3967 <list>
3968 <t>GET TOTAL_VOICE_COUNT</t>
3969 </list>
3970 </t>
3971
3972 <t>Possible Answers:</t>
3973 <t>
3974 <list>
3975 <t>LinuxSampler will answer by returning the number of all active
3976 voices on the sampler.</t>
3977 </list>
3978 </t>
3979 </section>
3980
3981 <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
3982 <t>The front-end can ask for the maximum number of active voices
3983 by sending the following command:</t>
3984 <t>
3985 <list>
3986 <t>GET TOTAL_VOICE_COUNT_MAX</t>
3987 </list>
3988 </t>
3989
3990 <t>Possible Answers:</t>
3991 <t>
3992 <list>
3993 <t>LinuxSampler will answer by returning the maximum number
3994 of active voices.</t>
3995 </list>
3996 </t>
3997 </section>
3998
3999 <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
4000 <t>The front-end can ask for the current number of active disk streams on
4001 the sampler by sending the following command:</t>
4002 <t>
4003 <list>
4004 <t>GET TOTAL_STREAM_COUNT</t>
4005 </list>
4006 </t>
4007
4008 <t>Possible Answers:</t>
4009 <t>
4010 <list>
4011 <t>LinuxSampler will answer by returning the number of all active
4012 disk streams on the sampler.</t>
4013 </list>
4014 </t>
4015 </section>
4016
4017 <section title="Reset sampler" anchor="RESET">
4018 <t>The front-end can reset the whole sampler by sending the following command:</t>
4019 <t>
4020 <list>
4021 <t>RESET</t>
4022 </list>
4023 </t>
4024
4025 <t>Possible Answers:</t>
4026 <t>
4027 <list>
4028 <t>"OK" -
4029 <list>
4030 <t>always</t>
4031 </list>
4032 </t>
4033 </list>
4034 </t>
4035 <t>Examples:</t>
4036 <t>
4037 <list>
4038 <t></t>
4039 </list>
4040 </t>
4041 </section>
4042
4043 <section title="General sampler informations" anchor="GET SERVER INFO">
4044 <t>The client can ask for general informations about the LinuxSampler
4045 instance by sending the following command:</t>
4046 <t>
4047 <list>
4048 <t>GET SERVER INFO</t>
4049 </list>
4050 </t>
4051 <t>Possible Answers:</t>
4052 <t>
4053 <list>
4054 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4055 Each answer line begins with the information category name
4056 followed by a colon and then a space character &lt;SP&gt; and finally
4057 the info character string to that information category. At the
4058 moment the following categories are defined:
4059 </t>
4060 <t>
4061 <list>
4062 <t>DESCRIPTION -
4063 <list>
4064 <t>arbitrary textual description about the sampler
4065 (note that the character string may contain
4066 <xref target="character_set">escape sequences</xref>)</t>
4067 </list>
4068 </t>
4069 <t>VERSION -
4070 <list>
4071 <t>version of the sampler</t>
4072 </list>
4073 </t>
4074 <t>PROTOCOL_VERSION -
4075 <list>
4076 <t>version of the LSCP specification the sampler
4077 complies with (see <xref target="LSCP versioning" /> for details)</t>
4078 </list>
4079 </t>
4080 <t>INSTRUMENTS_DB_SUPPORT -
4081 <list>
4082 <t>either yes or no, specifies whether the
4083 sampler is build with instruments database support.</t>
4084 </list>
4085 </t>
4086 </list>
4087 </t>
4088 </list>
4089 </t>
4090 <t>The mentioned fields above don't have to be in particular order.
4091 Other fields might be added in future.</t>
4092 </section>
4093
4094 <section title="Getting global volume attenuation" anchor="GET VOLUME">
4095 <t>The client can ask for the current global sampler-wide volume
4096 attenuation by sending the following command:</t>
4097 <t>
4098 <list>
4099 <t>GET VOLUME</t>
4100 </list>
4101 </t>
4102 <t>Possible Answers:</t>
4103 <t>
4104 <list>
4105 <t>The sampler will always answer by returning the optional
4106 dotted floating point coefficient, reflecting the current
4107 global volume attenuation.
4108 </t>
4109 </list>
4110 </t>
4111 <t>Note: it is up to the respective sampler engine whether to obey
4112 that global volume parameter or not, but in general all engines SHOULD
4113 use this parameter.</t>
4114 </section>
4115
4116 <section title="Setting global volume attenuation" anchor="SET VOLUME">
4117 <t>The client can alter the current global sampler-wide volume
4118 attenuation by sending the following command:</t>
4119 <t>
4120 <list>
4121 <t>SET VOLUME &lt;volume&gt;</t>
4122 </list>
4123 </t>
4124 <t>Where &lt;volume&gt; should be replaced by the optional dotted
4125 floating point value, reflecting the new global volume parameter.
4126 This value might usually be in the range between 0.0 and 1.0, that
4127 is for attenuating the overall volume.</t>
4128
4129 <t>Possible Answers:</t>
4130 <t>
4131 <list>
4132 <t>"OK" -
4133 <list>
4134 <t>on success</t>
4135 </list>
4136 </t>
4137 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4138 <list>
4139 <t>if the global volume was set, but there are noteworthy
4140 issue(s) related, providing an appropriate warning code and
4141 warning message</t>
4142 </list>
4143 </t>
4144 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4145 <list>
4146 <t>in case it failed, providing an appropriate error code and error message</t>
4147 </list>
4148 </t>
4149 </list>
4150 </t>
4151 </section>
4152
4153 <section title="Getting global voice limit" anchor="GET VOICES">
4154 <t>The client can ask for the current global sampler-wide limit
4155 for maximum voices by sending the following command:</t>
4156 <t>