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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1391 - (show annotations) (download) (as text)
Sun Oct 7 19:50:28 2007 UTC (16 years, 5 months ago) by iliev
File MIME type: text/xml
File size: 376072 byte(s)
- updated the escape sequences list

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

  ViewVC Help
Powered by ViewVC