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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2138 - (show annotations) (download) (as text)
Mon Oct 4 22:11:53 2010 UTC (13 years, 5 months ago) by schoenebeck
File MIME type: text/xml
File size: 474992 byte(s)
* minor fixes regarding new LSCP effect commands
* updated LSCP specification document regarding new effect commands
* bumped version to 1.0.0.cvs9

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.5">
20 <front>
21 <title>LinuxSampler Control Protocol</title>
22 <author initials='C.S.' surname="Schoenebeck" fullname='C.
23 Schoenebeck'>
24 <organization>
25 Interessengemeinschaft Software Engineering e. V.
26 </organization>
27 <address>
28 <postal>
29 <street>Max-Planck-Str. 39</street>
30 <!-- <code>74081</code> -->
31 <city>74081 Heilbronn</city>
32 <country>Germany</country>
33 </postal>
34 <email>schoenebeck at software minus engineering dot org</email>
35 </address>
36 </author>
37 <date month="October" year="2010"/>
38 <workgroup>LinuxSampler Developers</workgroup>
39 <keyword>LSCP</keyword>
40 <abstract>
41 <t>The LinuxSampler Control Protocol (LSCP) is an
42 application-level protocol primarily intended for local and
43 remote controlling the LinuxSampler backend application, which is a
44 sophisticated server-like console application essentially playing
45 back audio samples and manipulating the samples in real time to
46 certain extent.</t>
47 </abstract>
48 </front>
49
50 <middle>
51 <section title="Requirements notation">
52 <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
53 "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
54 and "OPTIONAL" in this document are to be interpreted as
55 described in <xref target="RFC2119"/>.</t>
56
57 <t>This protocol is always case-sensitive if not explicitly
58 claimed the opposite.</t>
59
60 <t>In examples, "C:" and "S:" indicate lines sent by the client
61 (front-end) and server (LinuxSampler) respectively. Lines in
62 examples must be interpreted as every line being CRLF
63 terminated (carriage return character followed by line feed
64 character as defined in the ASCII standard <xref target="RFC20"/>),
65 thus the following example:</t>
66
67 <t>
68 <list>
69 <t>C: "some line"</t>
70 <t>&nbsp;&nbsp;&nbsp;"another line"</t>
71 </list>
72 </t>
73
74 <t>must actually be interpreted as client sending the following
75 message:</t>
76
77 <t>
78 <list>
79 <t>"some line&lt;CR&gt;&lt;LF&gt;another
80 line&lt;CR&gt;&lt;LF&gt;"</t>
81 </list>
82 </t>
83
84 <t>where &lt;CR&gt; symbolizes the carriage return character and
85 &lt;LF&gt; the line feed character as defined in the ASCII
86 standard.</t>
87
88 <t>Due to technical reasons, messages can arbitrary be
89 fragmented, means the following example:</t>
90
91 <t>
92 <list>
93 <t>S: "abcd"</t>
94 </list>
95 </t>
96
97 <t>could also happen to be sent in three messages like in the
98 following sequence scenario:</t>
99
100 <t>
101 <list style="symbols">
102 <t>server sending message "a"</t>
103 <t>followed by a delay (pause) with
104 arbitrary duration</t>
105 <t>followed by server sending message
106 "bcd&lt;CR&gt;"</t>
107 <t>again followed by a delay (pause) with arbitrary
108 duration</t>
109 <t>followed by server sending the message
110 "&lt;LF&gt;"</t>
111 </list>
112 </t>
113
114 <t>where again &lt;CR&gt; and &lt;LF&gt; symbolize the carriage
115 return and line feed characters respectively.</t>
116 </section>
117
118 <section title="Versioning of this specification" anchor="LSCP versioning">
119 <t>LSCP will certainly be extended and enhanced by-and-by. Each official
120 release of the LSCP specification will be tagged with a unique version
121 tuple. The version tuple consists at least of a major and minor version
122 number like:
123 </t>
124 <t>
125 <list>
126 <t>"1.2"</t>
127 </list>
128 </t>
129 <t>
130 In this example the major version number would be "1" and the minor
131 version number would be "2". Note that the version tuple might also
132 have more than two elements. The major version number defines a
133 group of backward compatible versions. That means a frontend is
134 compatible to the connected sampler if and only if the LSCP versions
135 to which each of the two parties complies to, match both of the
136 following rules:
137 </t>
138 <t>Compatibility:</t>
139 <t>
140 <list style="numbers">
141 <t>The frontend's LSCP major version and the sampler's LSCP
142 major version are exactly equal.</t>
143 <t>The frontend's LSCP minor version is less or equal than
144 the sampler's LSCP minor version.</t>
145 </list>
146 </t>
147 <t>
148 Compatibility can only be claimed if both rules are true.
149 The frontend can use the
150 <xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to
151 get the version of the LSCP specification the sampler complies with.
152 </t>
153 </section>
154
155 <section title="Introduction">
156 <t>LinuxSampler is a so called software sampler application
157 capable to playback audio samples from a computer's Random
158 Access Memory (RAM) as well as directly streaming it from disk.
159 LinuxSampler is designed to be modular. It provides several so
160 called "sampler engines" where each engine is specialized for a
161 certain purpose. LinuxSampler has virtual channels which will be
162 referred in this document as "sampler channels". The channels
163 are in such way virtual as they can be connected to an
164 arbitrary MIDI input method and arbitrary MIDI channel (e.g.
165 sampler channel 17 could be connected to an ALSA sequencer
166 device 64:0 and listening to MIDI channel 1 there). Each sampler
167 channel will be associated with an instance of one of the available
168 sampler engines (e.g. GigEngine, DLSEngine). The audio output of
169 each sampler channel can be routed to an arbitrary audio output
170 method (ALSA / JACK) and an arbitrary audio output channel
171 there.</t>
172 </section>
173
174 <section title="Focus of this protocol">
175 <t>Main focus of this protocol is to provide a way to configure
176 a running LinuxSampler instance and to retrieve information
177 about it. The focus of this protocol is not to provide a way to
178 control synthesis parameters or even to trigger or release
179 notes. Or in other words; the focus are those functionalities
180 which are not covered by MIDI or which may at most be handled
181 via MIDI System Exclusive Messages.</t>
182 </section>
183
184 <section title="Communication Overview">
185 <t>There are two distinct methods of communication between a
186 running instance of LinuxSampler and one or more control
187 applications, so called "front-ends": a simple request/response
188 communication method used by the clients to give commands to the
189 server as well as to inquire about server's status and a
190 subscribe/notify communication method used by the client to
191 subscribe to and receive notifications of certain events as they
192 happen on the server. The latter needs more effort to be
193 implemented in the front-end application. The two communication
194 methods will be described next.</t>
195
196 <section title="Request/response communication method">
197 <t>This simple communication method is based on
198 <xref target="RFC793">TCP</xref>. The
199 front-end application establishes a TCP connection to the
200 LinuxSampler instance on a certain host system. Then the
201 front-end application will send certain ASCII based commands
202 as defined in this document (every command line must be CRLF
203 terminated - see "Conventions used in this document" at the
204 beginning of this document) and the LinuxSampler application
205 will response after a certain process time with an
206 appropriate ASCII based answer, also as defined in this
207 document. So this TCP communication is simply based on query
208 and answer paradigm. That way LinuxSampler is only able to
209 answer on queries from front-ends, but not able to
210 automatically send messages to the client if it's not asked
211 to. The fronted should not reconnect to LinuxSampler for
212 every single command, instead it should keep the connection
213 established and simply resend message(s) for subsequent
214 commands. To keep information in the front-end up-to-date
215 the front-end has to periodically send new requests to get
216 the current information from the LinuxSampler instance. This
217 is often referred to as "polling". While polling is simple
218 to implement and may be OK to use in some cases, there may
219 be disadvantages to polling such as network traffic overhead
220 and information being out of date.
221 It is possible for a client or several clients to open more
222 than one connection to the server at the same time. It is
223 also possible to send more than one request to the server
224 at the same time but if those requests are sent over the
225 same connection server MUST execute them sequentially. Upon
226 executing a request server will produce a result set and
227 send it to the client. Each and every request made by the
228 client MUST result in a result set being sent back to the
229 client. No other data other than a result set may be sent by
230 a server to a client. No result set may be sent to a client
231 without the client sending request to the server first. On
232 any particular connection, result sets MUST be sent in their
233 entirety without being interrupted by other result sets. If
234 several requests got queued up at the server they MUST be
235 processed in the order they were received and result sets
236 MUST be sent back in the same order.</t>
237
238 <section title="Result format">
239 <t>Result set could be one of the following types:</t>
240 <t>
241 <list style="numbers">
242 <t>Normal</t>
243 <t>Warning</t>
244 <t>Error</t>
245 </list>
246 </t>
247 <t>Warning and Error result sets MUST be single line and
248 have the following format:</t>
249 <t>
250 <list style="symbols">
251 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;"</t>
252 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;"</t>
253 </list>
254 </t>
255 <t>Where &lt;warning-code&gt; and &lt;error-code&gt; are
256 numeric unique identifiers of the warning or error and
257 &lt;warning-message&gt; and &lt;error-message&gt; are
258 human readable descriptions of the warning or error
259 respectively.</t>
260 <t>Examples:</t>
261 <t>
262 <list>
263 <t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t>
264 <t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t>
265 </list>
266 </t>
267 <t>
268 <list>
269 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t>
270 <t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t>
271 </list>
272 </t>
273 <t>
274 <list>
275 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t>
276 <t>S: "ERR:9:There is no audio output device with index 123456."</t>
277 </list>
278 </t>
279 <t>Normal result sets could be:</t>
280 <t>
281 <list style="numbers">
282 <t>Empty</t>
283 <t>Single line</t>
284 <t>Multi-line</t>
285 </list>
286 </t>
287 <t> Empty result set is issued when the server only
288 needed to acknowledge the fact that the request was
289 received and it was processed successfully and no
290 additional information is available. This result set has
291 the following format:</t>
292 <t>
293 <list>
294 <t>"OK"</t>
295 </list>
296 </t>
297 <t>Example:</t>
298 <t>
299 <list>
300 <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t>
301 <t>S: "OK"</t>
302 </list>
303 </t>
304 <t>Single line result sets are command specific. One
305 example of a single line result set is an empty line.
306 Multi-line result sets are command specific and may
307 include one or more lines of information. They MUST
308 always end with the following line:</t>
309 <t>
310 <list>
311 <t>"."</t>
312 </list>
313 </t>
314 <t>Example:</t>
315 <t>
316 <list>
317 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
318 <t>S: "DRIVER: ALSA"</t>
319 <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
320 <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
321 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
322 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
323 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
324 <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
325 <t>&nbsp;&nbsp;&nbsp;"."</t>
326 </list>
327 </t>
328 <t>In addition to above mentioned formats, warnings and
329 empty result sets MAY be indexed. In this case, they
330 have the following formats respectively:</t>
331 <t>
332 <list style="symbols">
333 <t>"WRN[&lt;index&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;"</t>
334 <t>"OK[&lt;index&gt;]"</t>
335 </list>
336 </t>
337 <t>where &lt;index&gt; is command specific and is used
338 to indicate channel number that the result set was
339 related to or other integer value.</t>
340 <t>Each line of the result set MUST end with
341 &lt;CRLF&gt;.</t>
342 <t>Examples:</t>
343 <t>
344 <list>
345 <t>C: "ADD CHANNEL"</t>
346 <t>S: "OK[12]"</t>
347 </list>
348 </t>
349 <t>
350 <list>
351 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t>
352 <t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t>
353 </list>
354 </t>
355 </section>
356 </section>
357 <section title="Subscribe/notify communication method">
358 <t>This more sophisticated communication method is actually
359 only an extension of the simple request/response
360 communication method. The front-end still uses a TCP
361 connection and sends the same commands on the TCP
362 connection. Two extra commands are SUBSCRIBE and UNSUBSCRIBE
363 commands that allow a client to tell the server that it is
364 interested in receiving notifications about certain events
365 as they happen on the server. The SUBSCRIBE command has the
366 following syntax:</t>
367
368 <t>
369 <list>
370 <t>SUBSCRIBE &lt;event-id&gt;</t>
371 </list>
372 </t>
373
374 <t>where &lt;event-id&gt; will be replaced by the respective
375 event that client wants to subscribe to. Upon receiving such
376 request, server SHOULD respond with OK and start sending
377 EVENT notifications when a given even has occurred to the
378 front-end when an event has occurred. It MAY be possible
379 certain events may be sent before OK response during real
380 time nature of their generation. Event messages have the
381 following format:</t>
382
383 <t>
384 <list>
385 <t>NOTIFY:&lt;event-id&gt;:&lt;custom-event-data&gt;</t>
386 </list>
387 </t>
388
389 <t>where &lt;event-id&gt; uniquely identifies the event that
390 has occurred and &lt;custom-event-data&gt; is event
391 specific.</t>
392
393 <t>Several rules must be followed by the server when
394 generating events:</t>
395
396 <t>
397 <list style="numbers">
398 <t>Events MUST NOT be sent to any client who has not
399 issued an appropriate SUBSCRIBE command.</t>
400 <t>Events MUST only be sent using the same
401 connection that was used to subscribe to them.</t>
402 <t>When response is being sent to the client, event
403 MUST be inserted in the stream before or after the
404 response, but NOT in the middle. Same is true about
405 the response. It should never be inserted in the
406 middle of the event message as well as any other
407 response.</t>
408 </list>
409 </t>
410
411 <t>If the client is not interested in a particular event
412 anymore it MAY issue UNSUBSCRIBE command using the following
413 syntax:</t>
414
415 <t>
416 <list>
417 <t>UNSUBSCRIBE &lt;event-id&gt;</t>
418 </list>
419 </t>
420
421 <t>where &lt;event-id&gt; will be replace by the respective
422 event that client is no longer interested in receiving. For
423 a list of supported events see <xref target="events" />.</t>
424
425 <t>Example: the fill states of disk stream buffers have
426 changed on sampler channel 4 and the LinuxSampler instance
427 will react by sending the following message to all clients
428 who subscribed to this event:</t>
429
430 <t>
431 <list>
432 <t>NOTIFY:CHANNEL_BUFFER_FILL:4 [35]62%,[33]80%,[37]98%</t>
433 </list>
434 </t>
435
436 <t>Which means there are currently three active streams on
437 sampler channel 4, where the stream with ID "35" is filled
438 by 62%, stream with ID 33 is filled by 80% and stream with
439 ID 37 is filled by 98%.</t>
440
441 <t>Clients may choose to open more than one connection to
442 the server and use some connections to receive notifications
443 while using other connections to issue commands to the
444 back-end. This is entirely legal and up to the
445 implementation. This does not change the protocol in any way
446 and no special restrictions exist on the server to allow or
447 disallow this or to track what connections belong to what
448 front-ends. Server will listen on a single port, accept
449 multiple connections and support protocol described in this
450 specification in it's entirety on this single port on each
451 connection that it accepted.</t>
452
453 <t>Due to the fact that TCP is used for this communication,
454 dead peers will be detected automatically by the OS TCP
455 stack. While it may take a while to detect dead peers if no
456 traffic is being sent from server to client (TCP keep-alive
457 timer is set to 2 hours on many OSes) it will not be an
458 issue here as when notifications are sent by the server,
459 dead client will be detected quickly.</t>
460
461 <t>When connection is closed for any reason server MUST
462 forget all subscriptions that were made on this connection.
463 If client reconnects it MUST resubscribe to all events that
464 it wants to receive.</t>
465
466 </section>
467 </section>
468
469 <section title="Description for control commands" anchor="control_commands">
470 <t>This chapter will describe the available control commands
471 that can be sent on the TCP connection in detail. Some certain
472 commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref>
473 or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to
474 multiple-line responses. In this case LinuxSampler signals the
475 end of the response by a "." (single dot) line.</t>
476
477 <section title="Ignored lines and comments">
478 <t>White lines, that is lines which only contain space and
479 tabulator characters, and lines that start with a "#"
480 character are ignored, thus it's possible for example to
481 group commands and to place comments in a LSCP script
482 file.</t>
483 </section>
484
485 <section title="Configuring audio drivers">
486 <t>Instances of drivers in LinuxSampler are called devices.
487 You can use multiple audio devices simultaneously, e.g. to
488 output the sound of one sampler channel using the ALSA audio
489 output driver, and on another sampler channel you might want
490 to use the JACK audio output driver. For particular audio
491 output systems it's also possible to create several devices
492 of the same audio output driver, e.g. two separate ALSA
493 audio output devices for using two different sound cards at
494 the same time. This chapter describes all commands to
495 configure LinuxSampler's audio output devices and their
496 parameters.</t>
497
498 <t>Instead of defining commands and parameters for each
499 driver individually, all possible parameters, their meanings
500 and possible values have to be obtained at runtime. This
501 makes the protocol a bit abstract, but has the advantage,
502 that front-ends can be written independently of what drivers
503 are currently implemented and what parameters these drivers
504 are actually offering. This means front-ends can even handle
505 drivers which are implemented somewhere in future without
506 modifying the front-end at all.</t>
507
508 <t>Note: examples in this chapter showing particular
509 parameters of drivers are not meant as specification of the
510 drivers' parameters. Driver implementations in LinuxSampler
511 might have complete different parameter names and meanings
512 than shown in these examples or might change in future, so
513 these examples are only meant for showing how to retrieve
514 what parameters drivers are offering, how to retrieve their
515 possible values, etc.</t>
516
517 <section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS">
518 <t>Use the following command to get the number of
519 audio output drivers currently available for the
520 LinuxSampler instance:</t>
521 <t>
522 <list>
523 <t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
524 </list>
525 </t>
526 <t>Possible Answers:</t>
527 <t>
528 <list>
529 <t>LinuxSampler will answer by sending the
530 number of audio output drivers.</t>
531 </list>
532 </t>
533 <t>Example:</t>
534 <t>
535 <list>
536 <t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
537 <t>S: "2"</t>
538 </list>
539 </t>
540 </section>
541
542 <section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
543 <t>Use the following command to list all audio output
544 drivers currently available for the LinuxSampler
545 instance:</t>
546 <t>
547 <list>
548 <t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t>
549 </list>
550 </t>
551 <t>Possible Answers:</t>
552 <t>
553 <list>
554 <t>LinuxSampler will answer by sending comma
555 separated character strings, each symbolizing an
556 audio output driver.</t>
557 </list>
558 </t>
559 <t>Example:</t>
560 <t>
561 <list>
562 <t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t>
563 <t>S: "ALSA,JACK"</t>
564 </list>
565 </t>
566 </section>
567
568 <section title="Getting information about a specific audio
569 output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO">
570 <t>Use the following command to get detailed information
571 about a specific audio output driver:</t>
572 <t>
573 <list>
574 <t>GET AUDIO_OUTPUT_DRIVER INFO
575 &lt;audio-output-driver&gt;</t>
576 </list>
577 </t>
578 <t>Where &lt;audio-output-driver&gt; is the name of the
579 audio output driver, returned by the
580 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t>
581 <t>Possible Answers:</t>
582 <t>
583 <list>
584 <t>LinuxSampler will answer by sending a
585 &lt;CRLF&gt; separated list. Each answer line
586 begins with the information category name
587 followed by a colon and then a space character
588 &lt;SP&gt; and finally the info character string
589 to that info category. At the moment the
590 following information categories are
591 defined:</t>
592
593 <t>
594 <list>
595 <t>DESCRIPTION -
596 <list>
597 <t> character string describing the
598 audio output driver</t>
599 </list>
600 </t>
601
602 <t>VERSION -
603 <list>
604 <t>character string reflecting the
605 driver's version</t>
606 </list>
607 </t>
608
609 <t>PARAMETERS -
610 <list>
611 <t>comma separated list of all
612 parameters available for the given
613 audio output driver, at least
614 parameters 'channels', 'samplerate'
615 and 'active' are offered by all audio
616 output drivers</t>
617 </list>
618 </t>
619 </list>
620 </t>
621
622 <t>The mentioned fields above don't have to be
623 in particular order.</t>
624 </list>
625 </t>
626 <t>Example:</t>
627 <t>
628 <list>
629 <t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t>
630 <t>S: "DESCRIPTION: Advanced Linux Sound
631 Architecture"</t>
632 <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
633 <t>&nbsp;&nbsp;&nbsp;"PARAMETERS:
634 DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS,
635 FRAGMENTSIZE,CARD"</t>
636 <t>&nbsp;&nbsp;&nbsp;"."</t>
637 </list>
638 </t>
639 </section>
640
641 <section title="Getting information about specific audio
642 output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO">
643 <t>Use the following command to get detailed information
644 about a specific audio output driver parameter:</t>
645 <t>
646 <list>
647 <t>GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO &lt;audio&gt; &lt;prm&gt; [&lt;deplist&gt;]</t>
648 </list>
649 </t>
650 <t>Where &lt;audio&gt; is the name of the audio output
651 driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
652 "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command,
653 &lt;prm&gt; a specific parameter name for which information should be
654 obtained (as returned by the
655 <xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and
656 &lt;deplist&gt; is an optional list of parameters on which the sought
657 parameter &lt;prm&gt; depends on, &lt;deplist&gt; is a list of key-value
658 pairs in form of "key1=val1 key2=val2 ...", where character string values
659 are encapsulated into apostrophes ('). Arguments given with &lt;deplist&gt;
660 which are not dependency parameters of &lt;prm&gt; will be ignored, means
661 the front-end application can simply put all parameters into &lt;deplist&gt;
662 with the values already selected by the user.</t>
663 <t>Possible Answers:</t>
664 <t>
665 <list>
666 <t>LinuxSampler will answer by sending a
667 &lt;CRLF&gt; separated list.
668 Each answer line begins with the information category name
669 followed by a colon and then a space character &lt;SP&gt; and
670 finally
671 the info character string to that info category. There are
672 information which is always returned, independently of the
673 given driver parameter and there are optional information
674 which is only shown dependently to given driver parameter. At
675 the moment the following information categories are defined:</t>
676 </list>
677 </t>
678
679 <t>
680 <list>
681 <t>TYPE -
682 <list>
683 <t>either "BOOL" for boolean value(s) or
684 "INT" for integer
685 value(s) or "FLOAT" for dotted number(s) or "STRING" for
686 character string(s)
687 (always returned, no matter which driver parameter)</t>
688 </list>
689 </t>
690
691 <t>DESCRIPTION -
692 <list>
693 <t>arbitrary text describing the purpose of the parameter
694 (always returned, no matter which driver parameter)</t>
695 </list>
696 </t>
697
698 <t>MANDATORY -
699 <list>
700 <t>either true or false, defines if this parameter must be
701 given when the device is to be created with the
702 <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
703 command (always returned, no matter which driver parameter)</t>
704 </list>
705 </t>
706
707 <t>FIX -
708 <list>
709 <t>either true or false, if false then this parameter can
710 be changed at any time, once the device is created by
711 the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref>
712 command (always returned, no matter which driver parameter)</t>
713 </list>
714 </t>
715
716 <t>MULTIPLICITY -
717 <list>
718 <t>either true or false, defines if this parameter allows
719 only one value or a list of values, where true means
720 multiple values and false only a single value allowed
721 (always returned, no matter which driver parameter)</t>
722 </list>
723 </t>
724
725 <t>DEPENDS -
726 <list>
727 <t>comma separated list of parameters this parameter depends
728 on, means the values for fields 'DEFAULT', 'RANGE_MIN',
729 'RANGE_MAX' and 'POSSIBILITIES' might depend on these
730 listed parameters, for example assuming that an audio
731 driver (like the ALSA driver) offers parameters 'card'
732 and 'samplerate' then parameter 'samplerate' would
733 depend on 'card' because the possible values for
734 'samplerate' depends on the sound card which can be
735 chosen by the 'card' parameter
736 (optionally returned, dependent to driver parameter)</t>
737 </list>
738 </t>
739
740 <t>DEFAULT -
741 <list>
742 <t>reflects the default value for this parameter which is
743 used when the device is created and not explicitly
744 given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE">
745 'CREATE AUDIO_OUTPUT_DEVICE'</xref> command,
746 in case of MULTIPLCITY=true, this is a comma separated
747 list, that's why character strings are encapsulated into
748 apostrophes (')
749 (optionally returned, dependent to driver parameter)</t>
750 </list>
751 </t>
752
753 <t>RANGE_MIN -
754 <list>
755 <t>defines lower limit of the allowed value range for this
756 parameter, can be an integer value as well as a dotted
757 number, this parameter is often used in conjunction
758 with RANGE_MAX, but may also appear without
759 (optionally returned, dependent to driver parameter)</t>
760 </list>
761 </t>
762
763 <t>RANGE_MAX -
764 <list>
765 <t>defines upper limit of the allowed value range for this
766 parameter, can be an integer value as well as a dotted
767 number, this parameter is often used in conjunction with
768 RANGE_MIN, but may also appear without
769 (optionally returned, dependent to driver parameter)</t>
770 </list>
771 </t>
772
773 <t>POSSIBILITIES -
774 <list>
775 <t>comma separated list of possible values for this
776 parameter, character strings are encapsulated into
777 apostrophes
778 (optionally returned, dependent to driver parameter)</t>
779 </list>
780 </t>
781 </list>
782 </t>
783
784 <t>The mentioned fields above don't have to be in particular order.</t>
785
786 <t>Examples:</t>
787 <t>
788 <list>
789 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t>
790 <t>S: "DESCRIPTION: sound card to be used"</t>
791 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
792 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
793 <t>&nbsp;&nbsp;&nbsp;"FIX: true"</t>
794 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
795 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: '0,0'"</t>
796 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '0,0','1,0','2,0'"</t>
797 <t>&nbsp;&nbsp;&nbsp;"."</t>
798 </list>
799 </t>
800 <t>
801 <list>
802 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t>
803 <t>S: "DESCRIPTION: output sample rate in Hz"</t>
804 <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
805 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
806 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
807 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
808 <t>&nbsp;&nbsp;&nbsp;"DEPENDS: card"</t>
809 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"</t>
810 <t>&nbsp;&nbsp;&nbsp;"."</t>
811 </list>
812 </t>
813 <t>
814 <list>
815 <t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"</t>
816 <t>S: "DESCRIPTION: output sample rate in Hz"</t>
817 <t>&nbsp;&nbsp;&nbsp;"TYPE: INT"</t>
818 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
819 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
820 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
821 <t>&nbsp;&nbsp;&nbsp;"DEPENDS: card"</t>
822 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: 44100"</t>
823 <t>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 22050"</t>
824 <t>&nbsp;&nbsp;&nbsp;"RANGE_MAX: 96000"</t>
825 <t>&nbsp;&nbsp;&nbsp;"."</t>
826 </list>
827 </t>
828 </section>
829
830 <section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE">
831 <t>Use the following command to create a new audio output device for the desired audio output system:</t>
832
833 <t>
834 <list>
835 <t>CREATE AUDIO_OUTPUT_DEVICE &lt;audio-output-driver&gt; [&lt;param-list&gt;]</t>
836 </list>
837 </t>
838
839 <t>Where &lt;audio-output-driver&gt; should be replaced by the desired audio
840 output system as returned by the
841 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
842 command and &lt;param-list&gt; by an optional list of driver
843 specific parameters in form of "key1=val1 key2=val2 ...", where
844 character string values should be encapsulated into apostrophes (').
845 Note that there might be drivers which require parameter(s) to be
846 given with this command. Use the previously described commands in
847 this chapter to get this information.</t>
848
849 <t>Possible Answers:</t>
850 <t>
851 <list>
852 <t>"OK[&lt;device-id&gt;]" -
853 <list>
854 <t>in case the device was successfully created, where
855 &lt;device-id&gt; is the numerical ID of the new device</t>
856 </list>
857 </t>
858 <t>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
859 <list>
860 <t>in case the device was created successfully, where
861 &lt;device-id&gt; is the numerical ID of the new device, but there
862 are noteworthy issue(s) related (e.g. sound card doesn't
863 support given hardware parameters and the driver is using
864 fall-back values), providing an appropriate warning code and
865 warning message</t>
866 </list>
867 </t>
868 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
869 <list>
870 <t>in case it failed, providing an appropriate error code and error message</t>
871 </list>
872 </t>
873 </list>
874 </t>
875 <t>Examples:</t>
876 <t>
877 <list>
878 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t>
879 <t>S: "OK[0]"</t>
880 </list>
881 </t>
882 <t>
883 <list>
884 <t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"</t>
885 <t>S: "OK[1]"</t>
886 </list>
887 </t>
888 </section>
889
890 <section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE">
891 <t>Use the following command to destroy a created output device:</t>
892 <t>
893 <list>
894 <t>DESTROY AUDIO_OUTPUT_DEVICE &lt;device-id&gt;</t>
895 </list>
896 </t>
897 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
898 audio output device as given by the
899 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
900 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
901 command.</t>
902 <t>Possible Answers:</t>
903 <t>
904 <list>
905 <t>"OK" -
906 <list>
907 <t>in case the device was successfully destroyed</t>
908 </list>
909 </t>
910 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
911 <list>
912 <t>in case the device was destroyed successfully, but there are
913 noteworthy issue(s) related (e.g. an audio over ethernet
914 driver was unloaded but the other host might not be
915 informed about this situation), providing an appropriate
916 warning code and warning message</t>
917 </list>
918 </t>
919 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
920 <list>
921 <t>in case it failed, providing an appropriate error code and
922 error message</t>
923 </list>
924 </t>
925 </list>
926 </t>
927 <t>Example:</t>
928 <t>
929 <list>
930 <t>C: "DESTROY AUDIO_OUTPUT_DEVICE 0"</t>
931 <t>S: "OK"</t>
932 </list>
933 </t>
934 </section>
935
936 <section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES">
937 <t>Use the following command to count all created audio output devices:</t>
938 <t>
939 <list>
940 <t>GET AUDIO_OUTPUT_DEVICES</t>
941 </list>
942 </t>
943 <t>Possible Answers:</t>
944 <t>
945 <list>
946 <t>LinuxSampler will answer by sending the current number of all
947 audio output devices.</t>
948 </list>
949 </t>
950 <t>Example:</t>
951 <t>
952 <list>
953 <t>C: "GET AUDIO_OUTPUT_DEVICES"</t>
954 <t>S: "4"</t>
955 </list>
956 </t>
957 </section>
958
959 <section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES">
960 <t>Use the following command to list all created audio output devices:</t>
961 <t>
962 <list>
963 <t>LIST AUDIO_OUTPUT_DEVICES</t>
964 </list>
965 </t>
966 <t>Possible Answers:</t>
967 <t>
968 <list>
969 <t>LinuxSampler will answer by sending a comma separated list with
970 the numerical IDs of all audio output devices.</t>
971 </list>
972 </t>
973 <t>Example:</t>
974 <t>
975 <list>
976 <t>C: "LIST AUDIO_OUTPUT_DEVICES"</t>
977 <t>S: "0,1,4,5"</t>
978 </list>
979 </t>
980 </section>
981
982 <section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO">
983 <t>Use the following command to get current settings of a specific, created audio output device:</t>
984 <t>
985 <list>
986 <t>GET AUDIO_OUTPUT_DEVICE INFO &lt;device-id&gt;</t>
987 </list>
988 </t>
989 <t>Where &lt;device-id&gt; should be replaced by numerical ID
990 of the audio output device as e.g. returned by the
991 <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t>
992 <t>Possible Answers:</t>
993 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
994 Each answer line begins with the information category name
995 followed by a colon and then a space character &lt;SP&gt; and finally
996 the info character string to that info category. As some
997 parameters might allow multiple values, character strings are
998 encapsulated into apostrophes ('). At the moment the following
999 information categories are defined (independently of device):</t>
1000 <t>
1001 <list>
1002 <t>DRIVER -
1003 <list>
1004 <t>identifier of the used audio output driver, as also
1005 returned by the
1006 <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">
1007 "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref>
1008 command</t>
1009 </list>
1010 </t>
1011 <t>CHANNELS -
1012 <list>
1013 <t>amount of audio output channels this device currently
1014 offers</t>
1015 </list>
1016 </t>
1017 <t>SAMPLERATE -
1018 <list>
1019 <t>playback sample rate the device uses</t>
1020 </list>
1021 </t>
1022 <t>ACTIVE -
1023 <list>
1024 <t>either true or false, if false then the audio device is
1025 inactive and doesn't output any sound, nor do the
1026 sampler channels connected to this audio device render
1027 any audio</t>
1028 </list>
1029 </t>
1030 </list>
1031 </t>
1032 <t>The mentioned fields above don't have to be in particular
1033 order. The fields above are only those fields which are
1034 returned by all audio output devices. Every audio output driver
1035 might have its own, additional driver specific parameters (see
1036 <xref target="GET AUDIO_OUTPUT_DRIVER INFO" />)
1037 which are also returned by this command.</t>
1038 <t>Example:</t>
1039 <t>
1040 <list>
1041 <t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t>
1042 <t>S: "DRIVER: ALSA"</t>
1043 <t>&nbsp;&nbsp;&nbsp;"CHANNELS: 2"</t>
1044 <t>&nbsp;&nbsp;&nbsp;"SAMPLERATE: 44100"</t>
1045 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1046 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTS: 2"</t>
1047 <t>&nbsp;&nbsp;&nbsp;"FRAGMENTSIZE: 128"</t>
1048 <t>&nbsp;&nbsp;&nbsp;"CARD: '0,0'"</t>
1049 <t>&nbsp;&nbsp;&nbsp;"."</t>
1050 </list>
1051 </t>
1052 </section>
1053
1054
1055 <section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER">
1056 <t>Use the following command to alter a specific setting of a created audio output device:</t>
1057 <t>
1058 <list>
1059 <t>SET AUDIO_OUTPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;</t>
1060 </list>
1061 </t>
1062 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1063 audio output device as given by the
1064 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1065 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1066 command, &lt;key&gt; by the name of the parameter to change
1067 and &lt;value&gt; by the new value for this parameter.</t>
1068 <t>Possible Answers:</t>
1069 <t>
1070 <list>
1071 <t>"OK" -
1072 <list>
1073 <t>in case setting was successfully changed</t>
1074 </list>
1075 </t>
1076 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1077 <list>
1078 <t>in case setting was changed successfully, but there are
1079 noteworthy issue(s) related, providing an appropriate
1080 warning code and warning message</t>
1081 </list>
1082 </t>
1083 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1084 <list>
1085 <t>in case it failed, providing an appropriate error code and
1086 error message</t>
1087 </list>
1088 </t>
1089 </list>
1090 </t>
1091 <t>Example:</t>
1092 <t>
1093 <list>
1094 <t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t>
1095 <t>S: "OK"</t>
1096 </list>
1097 </t>
1098 </section>
1099
1100 <section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO">
1101 <t>Use the following command to get information about an audio channel:</t>
1102 <t>
1103 <list>
1104 <t>GET AUDIO_OUTPUT_CHANNEL INFO &lt;device-id&gt; &lt;audio-chan&gt;</t>
1105 </list>
1106 </t>
1107 <t>Where &lt;device-id&gt; is the numerical ID of the audio output device as given by the
1108 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1109 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1110 command and &lt;audio-chan&gt; the audio channel number.</t>
1111 <t>Possible Answers:</t>
1112 <t>
1113 <list>
1114 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1115 Each answer line begins with the information category name
1116 followed by a colon and then a space character &lt;SP&gt; and finally
1117 the info character string to that info category. At the moment
1118 the following information categories are defined:</t>
1119
1120 <t>
1121 <list>
1122 <t>NAME -
1123 <list>
1124 <t>arbitrary character string naming the channel, which
1125 doesn't have to be unique (always returned by all audio channels)</t>
1126 </list>
1127 </t>
1128 <t>IS_MIX_CHANNEL -
1129 <list>
1130 <t>either true or false, a mix-channel is not a real,
1131 independent audio channel, but a virtual channel which
1132 is mixed to another real channel, this mechanism is
1133 needed for sampler engines which need more audio
1134 channels than the used audio system might be able to offer
1135 (always returned by all audio channels)</t>
1136 </list>
1137 </t>
1138 <t>MIX_CHANNEL_DESTINATION -
1139 <list>
1140 <t>numerical ID (positive integer including 0)
1141 which reflects the real audio channel (of the same audio
1142 output device) this mix channel refers to, means where
1143 the audio signal actually will be routed / added to
1144 (only returned in case the audio channel is mix channel)</t>
1145 </list>
1146 </t>
1147 </list>
1148 </t>
1149 </list>
1150 </t>
1151
1152 <t>The mentioned fields above don't have to be in particular
1153 order. The fields above are only those fields which are
1154 generally returned for the described cases by all audio
1155 channels regardless of the audio driver. Every audio channel
1156 might have its own, additional driver and channel specific
1157 parameters.</t>
1158
1159 <t>Examples:</t>
1160
1161 <t>
1162 <list>
1163 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 0"</t>
1164 <t>S: "NAME: studio monitor left"</t>
1165 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1166 <t>&nbsp;&nbsp;&nbsp;"."</t>
1167 </list>
1168 </t>
1169
1170 <t>
1171 <list>
1172 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 1"</t>
1173 <t>S: "NAME: studio monitor right"</t>
1174 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1175 <t>&nbsp;&nbsp;&nbsp;"."</t>
1176 </list>
1177 </t>
1178
1179 <t>
1180 <list>
1181 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 0 2"</t>
1182 <t>S: "NAME: studio monitor left"</t>
1183 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: true"</t>
1184 <t>&nbsp;&nbsp;&nbsp;"MIX_CHANNEL_DESTINATION: 1"</t>
1185 <t>&nbsp;&nbsp;&nbsp;"."</t>
1186 </list>
1187 </t>
1188
1189 <t>
1190 <list>
1191 <t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t>
1192 <t>S: "NAME: 'ardour (left)'"</t>
1193 <t>&nbsp;&nbsp;&nbsp;"IS_MIX_CHANNEL: false"</t>
1194 <t>&nbsp;&nbsp;&nbsp;"JACK_BINDINGS: 'ardour:0'"</t>
1195 <t>&nbsp;&nbsp;&nbsp;"."</t>
1196 </list>
1197 </t>
1198 </section>
1199
1200 <section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO">
1201 <t>Use the following command to get detailed information about specific audio channel parameter:</t>
1202
1203 <t>
1204 <list>
1205 <t>GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO &lt;dev-id&gt; &lt;chan&gt; &lt;param&gt;</t>
1206 </list>
1207 </t>
1208
1209 <t>Where &lt;dev-id&gt; is the numerical ID of the audio output device as returned by the
1210 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1211 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1212 command, &lt;chan&gt; the audio channel number
1213 and &lt;param&gt; a specific channel parameter name for which information should
1214 be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO">
1215 "GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t>
1216 <t>Possible Answers:</t>
1217
1218 <t>
1219 <list>
1220 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1221 Each answer line begins with the information category name
1222 followed by a colon and then a space character &lt;SP&gt; and finally
1223 the info character string to that info category. There are
1224 information which is always returned, independently of the
1225 given channel parameter and there is optional information
1226 which is only shown dependently to the given audio channel. At
1227 the moment the following information categories are defined:</t>
1228 <t>
1229 <list>
1230 <t>TYPE -
1231 <list>
1232 <t>either "BOOL" for boolean value(s) or "INT" for integer
1233 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1234 character string(s)
1235 (always returned)</t>
1236 </list>
1237 </t>
1238 <t>DESCRIPTION -
1239 <list>
1240 <t>arbitrary text describing the purpose of the parameter (always returned)</t>
1241 </list>
1242 </t>
1243 <t>FIX -
1244 <list>
1245 <t>either true or false, if true then this parameter is
1246 read only, thus cannot be altered
1247 (always returned)</t>
1248 </list>
1249 </t>
1250 <t>MULTIPLICITY -
1251 <list>
1252 <t>either true or false, defines if this parameter allows
1253 only one value or a list of values, where true means
1254 multiple values and false only a single value allowed
1255 (always returned)</t>
1256 </list>
1257 </t>
1258 <t>RANGE_MIN -
1259 <list>
1260 <t>defines lower limit of the allowed value range for this
1261 parameter, can be an integer value as well as a dotted
1262 number, usually used in conjunction with 'RANGE_MAX',
1263 but may also appear without
1264 (optionally returned, dependent to driver and channel
1265 parameter)</t>
1266 </list>
1267 </t>
1268 <t>RANGE_MAX -
1269 <list>
1270 <t>defines upper limit of the allowed value range for this
1271 parameter, can be an integer value as well as a dotted
1272 number, usually used in conjunction with 'RANGE_MIN',
1273 but may also appear without
1274 (optionally returned, dependent to driver and channel
1275 parameter)</t>
1276 </list>
1277 </t>
1278 <t>POSSIBILITIES -
1279 <list>
1280 <t>comma separated list of possible values for this
1281 parameter, character strings are encapsulated into
1282 apostrophes
1283 (optionally returned, dependent to driver and channel
1284 parameter)</t>
1285 </list>
1286 </t>
1287 </list>
1288 </t>
1289 <t>The mentioned fields above don't have to be in particular order.</t>
1290 </list>
1291 </t>
1292 <t>Example:</t>
1293 <t>
1294 <list>
1295 <t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"</t>
1296 <t>S: "DESCRIPTION: bindings to other JACK clients"</t>
1297 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
1298 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1299 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
1300 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t>
1301 <t>&nbsp;&nbsp;&nbsp;"."</t>
1302 </list>
1303 </t>
1304 </section>
1305
1306 <section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER">
1307 <t>Use the following command to alter a specific setting of an audio output channel:</t>
1308 <t>
1309 <list>
1310 <t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER &lt;dev-id&gt; &lt;chn&gt; &lt;key&gt;=&lt;value&gt;</t>
1311 </list>
1312 </t>
1313 <t>Where &lt;dev-id&gt; should be replaced by the numerical ID of the audio output device as returned by the
1314 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
1315 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
1316 command, &lt;chn&gt; by the audio channel number, &lt;key&gt; by the name of the
1317 parameter to change and &lt;value&gt; by the new value for this parameter.</t>
1318 <t>Possible Answers:</t>
1319 <t>
1320 <list>
1321 <t>"OK" -
1322 <list>
1323 <t>in case setting was successfully changed</t>
1324 </list>
1325 </t>
1326 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1327 <list>
1328 <t>in case setting was changed successfully, but there are
1329 noteworthy issue(s) related, providing an appropriate
1330 warning code and warning message</t>
1331 </list>
1332 </t>
1333 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1334 <list>
1335 <t>in case it failed, providing an appropriate error code and
1336 error message</t>
1337 </list>
1338 </t>
1339 </list>
1340 </t>
1341 <t>Example:</t>
1342 <t>
1343 <list>
1344 <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"</t>
1345 <t>S: "OK"</t>
1346 </list>
1347 </t>
1348 <t>
1349 <list>
1350 <t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 NAME='monitor left'"</t>
1351 <t>S: "OK"</t>
1352 </list>
1353 </t>
1354 </section>
1355 </section>
1356
1357 <section title="Configuring MIDI input drivers">
1358 <t>Instances of drivers in LinuxSampler are called devices. You can use
1359 multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as
1360 MIDI input on one sampler channel and ALSA as MIDI input on another sampler
1361 channel. For particular MIDI input systems it's also possible to create
1362 several devices of the same MIDI input type. This chapter describes all
1363 commands to configure LinuxSampler's MIDI input devices and their parameters.</t>
1364
1365 <t>Instead of defining commands and parameters for each driver individually,
1366 all possible parameters, their meanings and possible values have to be obtained
1367 at runtime. This makes the protocol a bit abstract, but has the advantage, that
1368 front-ends can be written independently of what drivers are currently implemented
1369 and what parameters these drivers are actually offering. This means front-ends can
1370 even handle drivers which are implemented somewhere in future without modifying
1371 the front-end at all.</t>
1372
1373 <t>Commands for configuring MIDI input devices are pretty much the same as the
1374 commands for configuring audio output drivers, already described in the last
1375 chapter.</t>
1376
1377 <t>Note: examples in this chapter showing particular parameters of drivers are
1378 not meant as specification of the drivers' parameters. Driver implementations in
1379 LinuxSampler might have complete different parameter names and meanings than shown
1380 in these examples or might change in future, so these examples are only meant for
1381 showing how to retrieve what parameters drivers are offering, how to retrieve their
1382 possible values, etc.</t>
1383
1384 <section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS">
1385 <t>Use the following command to get the number of
1386 MIDI input drivers currently available for the
1387 LinuxSampler instance:</t>
1388 <t>
1389 <list>
1390 <t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t>
1391 </list>
1392 </t>
1393 <t>Possible Answers:</t>
1394 <t>
1395 <list>
1396 <t>LinuxSampler will answer by sending the
1397 number of available MIDI input drivers.</t>
1398 </list>
1399 </t>
1400 <t>Example:</t>
1401 <t>
1402 <list>
1403 <t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1404 <t>S: "2"</t>
1405 </list>
1406 </t>
1407 </section>
1408
1409 <section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1410 <t>Use the following command to list all MIDI input drivers currently available
1411 for the LinuxSampler instance:</t>
1412 <t>
1413 <list>
1414 <t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t>
1415 </list>
1416 </t>
1417 <t>Possible Answers:</t>
1418 <t>
1419 <list>
1420 <t>LinuxSampler will answer by sending comma separated character
1421 strings, each symbolizing a MIDI input driver.</t>
1422 </list>
1423 </t>
1424 <t>Example:</t>
1425 <t>
1426 <list>
1427 <t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t>
1428 <t>S: "ALSA,JACK"</t>
1429 </list>
1430 </t>
1431 </section>
1432
1433 <section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO">
1434 <t>Use the following command to get detailed information about a specific MIDI input driver:</t>
1435 <t>
1436 <list>
1437 <t>GET MIDI_INPUT_DRIVER INFO &lt;midi-input-driver&gt;</t>
1438 </list>
1439 </t>
1440 <t>Where &lt;midi-input-driver&gt; is the name of the MIDI input driver as returned
1441 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1442 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t>
1443 <t>Possible Answers:</t>
1444 <t>
1445 <list>
1446 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1447 Each answer line begins with the information category name
1448 followed by a colon and then a space character &lt;SP&gt; and finally
1449 the info character string to that info category. At the moment
1450 the following information categories are defined:</t>
1451
1452 <t>
1453 <list>
1454 <t>DESCRIPTION -
1455 <list>
1456 <t>arbitrary description text about the MIDI input driver</t>
1457 </list>
1458 </t>
1459 <t>VERSION -
1460 <list>
1461 <t>arbitrary character string regarding the driver's version</t>
1462 </list>
1463 </t>
1464 <t>PARAMETERS -
1465 <list>
1466 <t>comma separated list of all parameters available for the given MIDI input driver</t>
1467 </list>
1468 </t>
1469 </list>
1470 </t>
1471
1472 <t>The mentioned fields above don't have to be in particular order.</t>
1473 </list>
1474 </t>
1475
1476 <t>Example:</t>
1477
1478 <t>
1479 <list>
1480 <t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t>
1481 <t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t>
1482 <t>&nbsp;&nbsp;&nbsp;"VERSION: 1.0"</t>
1483 <t>&nbsp;&nbsp;&nbsp;"PARAMETERS: DRIVER,ACTIVE"</t>
1484 <t>&nbsp;&nbsp;&nbsp;"."</t>
1485 </list>
1486 </t>
1487 </section>
1488
1489 <section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO">
1490 <t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t>
1491 <t>
1492 <list>
1493 <t>GET MIDI_INPUT_DRIVER_PARAMETER INFO &lt;midit&gt; &lt;param&gt; [&lt;deplist&gt;]</t>
1494 </list>
1495 </t>
1496
1497 <t>Where &lt;midit&gt; is the name of the MIDI input driver as returned
1498 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1499 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, &lt;param&gt; a specific
1500 parameter name for which information should be obtained (as returned by the
1501 <xref target="GET MIDI_INPUT_DRIVER INFO">
1502 "GET MIDI_INPUT_DRIVER INFO"</xref> command) and &lt;deplist&gt; is an optional list
1503 of parameters on which the sought parameter &lt;param&gt; depends on,
1504 &lt;deplist&gt; is a key-value pair list in form of "key1=val1 key2=val2 ...",
1505 where character string values are encapsulated into apostrophes ('). Arguments
1506 given with &lt;deplist&gt; which are not dependency parameters of &lt;param&gt;
1507 will be ignored, means the front-end application can simply put all parameters
1508 in &lt;deplist&gt; with the values selected by the user.</t>
1509
1510 <t>Possible Answers:</t>
1511
1512 <t>LinuxSampler will answer by sending a &lt;CRLF> separated list.
1513 Each answer line begins with the information category name
1514 followed by a colon and then a space character &lt;SP> and finally
1515 the info character string to that info category. There is
1516 information which is always returned, independent of the
1517 given driver parameter and there is optional information
1518 which is only shown dependent to given driver parameter. At
1519 the moment the following information categories are defined:</t>
1520
1521 <t>
1522 <list>
1523 <t>TYPE -
1524 <list>
1525 <t>either "BOOL" for boolean value(s) or "INT" for integer
1526 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1527 character string(s)
1528 (always returned, no matter which driver parameter)</t>
1529 </list>
1530 </t>
1531
1532 <t>DESCRIPTION -
1533 <list>
1534 <t>arbitrary text describing the purpose of the parameter
1535 (always returned, no matter which driver parameter)</t>
1536 </list>
1537 </t>
1538
1539 <t>MANDATORY -
1540 <list>
1541 <t>either true or false, defines if this parameter must be
1542 given when the device is to be created with the
1543 <xref target="CREATE MIDI_INPUT_DEVICE">
1544 'CREATE MIDI_INPUT_DEVICE'</xref> command
1545 (always returned, no matter which driver parameter)</t>
1546 </list>
1547 </t>
1548
1549 <t>FIX -
1550 <list>
1551 <t>either true or false, if false then this parameter can
1552 be changed at any time, once the device is created by
1553 the <xref target="CREATE MIDI_INPUT_DEVICE">
1554 'CREATE MIDI_INPUT_DEVICE'</xref> command
1555 (always returned, no matter which driver parameter)</t>
1556 </list>
1557 </t>
1558
1559 <t>MULTIPLICITY -
1560 <list>
1561 <t>either true or false, defines if this parameter allows
1562 only one value or a list of values, where true means
1563 multiple values and false only a single value allowed
1564 (always returned, no matter which driver parameter)</t>
1565 </list>
1566 </t>
1567
1568 <t>DEPENDS -
1569 <list>
1570 <t>comma separated list of parameters this parameter depends
1571 on, means the values for fields 'DEFAULT', 'RANGE_MIN',
1572 'RANGE_MAX' and 'POSSIBILITIES' might depend on these
1573 listed parameters, for example assuming that an audio
1574 driver (like the ALSA driver) offers parameters 'card'
1575 and 'samplerate' then parameter 'samplerate' would
1576 depend on 'card' because the possible values for
1577 'samplerate' depends on the sound card which can be
1578 chosen by the 'card' parameter
1579 (optionally returned, dependent to driver parameter)</t>
1580 </list>
1581 </t>
1582
1583 <t>DEFAULT -
1584 <list>
1585 <t>reflects the default value for this parameter which is
1586 used when the device is created and not explicitly
1587 given with the <xref target="CREATE MIDI_INPUT_DEVICE">
1588 'CREATE MIDI_INPUT_DEVICE'</xref> command,
1589 in case of MULTIPLCITY=true, this is a comma separated
1590 list, that's why character strings are encapsulated into
1591 apostrophes (')
1592 (optionally returned, dependent to driver parameter)</t>
1593 </list>
1594 </t>
1595
1596 <t>RANGE_MIN -
1597 <list>
1598 <t>defines lower limit of the allowed value range for this
1599 parameter, can be an integer value as well as a dotted
1600 number, this parameter is often used in conjunction
1601 with RANGE_MAX, but may also appear without
1602 (optionally returned, dependent to driver parameter)</t>
1603 </list>
1604 </t>
1605
1606 <t>RANGE_MAX -
1607 <list>
1608 <t>defines upper limit of the allowed value range for this
1609 parameter, can be an integer value as well as a dotted
1610 number, this parameter is often used in conjunction with
1611 RANGE_MIN, but may also appear without
1612 (optionally returned, dependent to driver parameter)</t>
1613 </list>
1614 </t>
1615
1616 <t>POSSIBILITIES -
1617 <list>
1618 <t>comma separated list of possible values for this
1619 parameter, character strings are encapsulated into
1620 apostrophes
1621 (optionally returned, dependent to driver parameter)</t>
1622 </list>
1623 </t>
1624 </list>
1625 </t>
1626
1627 <t>The mentioned fields above don't have to be in particular order.</t>
1628
1629 <t>Example:</t>
1630 <t>
1631 <list>
1632 <t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t>
1633 <t>S: "DESCRIPTION: Whether device is enabled"</t>
1634 <t>&nbsp;&nbsp;&nbsp;"TYPE: BOOL"</t>
1635 <t>&nbsp;&nbsp;&nbsp;"MANDATORY: false"</t>
1636 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
1637 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: false"</t>
1638 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
1639 <t>&nbsp;&nbsp;&nbsp;"."</t>
1640 </list>
1641 </t>
1642 </section>
1643
1644 <section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE">
1645 <t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t>
1646 <t>
1647 <list>
1648 <t>CREATE MIDI_INPUT_DEVICE &lt;midi-input-driver&gt; [&lt;param-list&gt;]</t>
1649 </list>
1650 </t>
1651
1652 <t>Where &lt;midi-input-driver&gt; should be replaced by the desired MIDI input system as returned
1653 by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1654 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command and &lt;param-list&gt; by an
1655 optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where
1656 character string values should be encapsulated into apostrophes (').
1657 Note that there might be drivers which require parameter(s) to be
1658 given with this command. Use the previously described commands in
1659 this chapter to get that information.</t>
1660
1661 <t>Possible Answers:</t>
1662 <t>
1663 <list>
1664 <t>"OK[&lt;device-id&gt;]" -
1665 <list>
1666 <t>in case the device was successfully created, where
1667 &lt;device-id&gt; is the numerical ID of the new device</t>
1668 </list>
1669 </t>
1670 <t>"WRN[&lt;device-id&gt;]:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1671 <list>
1672 <t>in case the driver was loaded successfully, where
1673 &lt;device-id&gt; is the numerical ID of the new device, but
1674 there are noteworthy issue(s) related, providing an
1675 appropriate warning code and warning message</t>
1676 </list>
1677 </t>
1678 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1679 <list>
1680 <t>in case it failed, providing an appropriate error code and error message</t>
1681 </list>
1682 </t>
1683 </list>
1684 </t>
1685 <t>Example:</t>
1686 <t>
1687 <list>
1688 <t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t>
1689 <t>S: "OK[0]"</t>
1690 </list>
1691 </t>
1692 </section>
1693
1694 <section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE">
1695 <t>Use the following command to destroy a created MIDI input device:</t>
1696 <t>
1697 <list>
1698 <t>DESTROY MIDI_INPUT_DEVICE &lt;device-id&gt;</t>
1699 </list>
1700 </t>
1701 <t>Where &lt;device-id&gt; should be replaced by the device's numerical ID as returned by the
1702 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1703 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1704 command.</t>
1705 <t>Possible Answers:</t>
1706 <t>
1707 <list>
1708 <t>"OK" -
1709 <list>
1710 <t>in case the device was successfully destroyed</t>
1711 </list>
1712 </t>
1713 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1714 <list>
1715 <t>in case the device was destroyed, but there are noteworthy
1716 issue(s) related, providing an appropriate warning code and
1717 warning message</t>
1718 </list>
1719 </t>
1720 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1721 <list>
1722 <t>in case it failed, providing an appropriate error code and error message</t>
1723 </list>
1724 </t>
1725 </list>
1726 </t>
1727 <t>Example:</t>
1728 <t>
1729 <list>
1730 <t>C: "DESTROY MIDI_INPUT_DEVICE 0"</t>
1731 <t>S: "OK"</t>
1732 </list>
1733 </t>
1734 </section>
1735
1736 <section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES">
1737 <t>Use the following command to count all created MIDI input devices:</t>
1738 <t>
1739 <list>
1740 <t>GET MIDI_INPUT_DEVICES</t>
1741 </list>
1742 </t>
1743 <t>Possible Answers:</t>
1744 <t>
1745 <list>
1746 <t>LinuxSampler will answer by sending the current number of all
1747 MIDI input devices.</t>
1748 </list>
1749 </t>
1750 <t>Example:</t>
1751 <t>
1752 <list>
1753 <t>C: "GET MIDI_INPUT_DEVICES"</t>
1754 <t>S: "3"</t>
1755 </list>
1756 </t>
1757 </section>
1758
1759
1760 <section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES">
1761 <t>Use the following command to list all created MIDI input devices:</t>
1762 <t>
1763 <list>
1764 <t>LIST MIDI_INPUT_DEVICES</t>
1765 </list>
1766 </t>
1767 <t>Possible Answers:</t>
1768 <t>
1769 <list>
1770 <t>LinuxSampler will answer by sending a comma separated list
1771 with the numerical Ids of all created MIDI input devices.</t>
1772 </list>
1773 </t>
1774 <t>Examples:</t>
1775 <t>
1776 <list>
1777 <t>C: "LIST MIDI_INPUT_DEVICES"</t>
1778 <t>S: "0,1,2"</t>
1779 </list>
1780 </t>
1781 <t>
1782 <list>
1783 <t>C: "LIST MIDI_INPUT_DEVICES"</t>
1784 <t>S: "1,3"</t>
1785 </list>
1786 </t>
1787 </section>
1788
1789 <section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO">
1790 <t>Use the following command to get current settings of a specific, created MIDI input device:</t>
1791 <t>
1792 <list>
1793 <t>GET MIDI_INPUT_DEVICE INFO &lt;device-id&gt;</t>
1794 </list>
1795 </t>
1796 <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1797 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1798 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1799 command.</t>
1800 <t>Possible Answers:</t>
1801 <t>
1802 <list>
1803 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1804 Each answer line begins with the information category name
1805 followed by a colon and then a space character &lt;SP&gt; and finally
1806 the info character string to that info category. As some
1807 parameters might allow multiple values, character strings are
1808 encapsulated into apostrophes ('). At the moment the following
1809 information categories are defined (independent of driver):</t>
1810
1811 <t>
1812 <list>
1813 <t>DRIVER -
1814 <list>
1815 <t>identifier of the used MIDI input driver, as e.g.
1816 returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS">
1817 "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref>
1818 command</t>
1819 </list>
1820 </t>
1821 </list>
1822 <list>
1823 <t>ACTIVE -
1824 <list>
1825 <t>either true or false, if false then the MIDI device is
1826 inactive and doesn't listen to any incoming MIDI events
1827 and thus doesn't forward them to connected sampler
1828 channels</t>
1829 </list>
1830 </t>
1831 </list>
1832 </t>
1833 </list>
1834 </t>
1835
1836 <t>The mentioned fields above don't have to be in particular
1837 order. The fields above are only those fields which are
1838 returned by all MIDI input devices. Every MIDI input driver
1839 might have its own, additional driver specific parameters (see
1840 <xref target="GET MIDI_INPUT_DRIVER INFO">
1841 "GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned
1842 by this command.</t>
1843
1844 <t>Example:</t>
1845 <t>
1846 <list>
1847 <t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t>
1848 <t>S: "DRIVER: ALSA"</t>
1849 <t>&nbsp;&nbsp;&nbsp;"ACTIVE: true"</t>
1850 <t>&nbsp;&nbsp;&nbsp;"."</t>
1851 </list>
1852 </t>
1853 </section>
1854
1855 <section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER">
1856 <t>Use the following command to alter a specific setting of a created MIDI input device:</t>
1857 <t>
1858 <list>
1859 <t>SET MIDI_INPUT_DEVICE_PARAMETER &lt;device-id&gt; &lt;key&gt;=&lt;value&gt;</t>
1860 </list>
1861 </t>
1862
1863 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
1864 MIDI input device as returned by the
1865 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1866 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1867 command, &lt;key&gt; by the name of the parameter to change and
1868 &lt;value&gt; by the new value for this parameter.</t>
1869
1870 <t>Possible Answers:</t>
1871 <t>
1872 <list>
1873 <t>"OK" -
1874 <list>
1875 <t>in case setting was successfully changed</t>
1876 </list>
1877 </t>
1878 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
1879 <list>
1880 <t>in case setting was changed successfully, but there are
1881 noteworthy issue(s) related, providing an appropriate
1882 warning code and warning message</t>
1883 </list>
1884 </t>
1885 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
1886 <list>
1887 <t>in case it failed, providing an appropriate error code and error message</t>
1888 </list>
1889 </t>
1890 </list>
1891 </t>
1892 <t>Example:</t>
1893 <t>
1894 <list>
1895 <t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t>
1896 <t>S: "OK"</t>
1897 </list>
1898 </t>
1899 </section>
1900
1901 <section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO">
1902 <t>Use the following command to get information about a MIDI port:</t>
1903 <t>
1904 <list>
1905 <t>GET MIDI_INPUT_PORT INFO &lt;device-id&gt; &lt;midi-port&gt;</t>
1906 </list>
1907 </t>
1908 <t>Where &lt;device-id&gt; is the numerical ID of the MIDI input device as returned by the
1909 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1910 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1911 command and &lt;midi-port&gt; the MIDI input port number.</t>
1912 <t>Possible Answers:</t>
1913 <t>
1914 <list>
1915 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1916 Each answer line begins with the information category name
1917 followed by a colon and then a space character &lt;SP&gt; and finally
1918 the info character string to that info category. At the moment
1919 the following information categories are defined:</t>
1920
1921 <t>NAME -
1922 <list>
1923 <t>arbitrary character string naming the port</t>
1924 </list>
1925 </t>
1926 </list>
1927 </t>
1928
1929 <t>The field above is only the one which is returned by all MIDI
1930 ports regardless of the MIDI driver and port. Every MIDI port
1931 might have its own, additional driver and port specific
1932 parameters.</t>
1933
1934 <t>Example:</t>
1935 <t>
1936 <list>
1937 <t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t>
1938 <t>S: "NAME: 'Masterkeyboard'"</t>
1939 <t>&nbsp;&nbsp;&nbsp;"ALSA_SEQ_BINDINGS: '64:0'"</t>
1940 <t>&nbsp;&nbsp;&nbsp;"."</t>
1941 </list>
1942 </t>
1943 </section>
1944
1945 <section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO">
1946 <t>Use the following command to get detailed information about specific MIDI port parameter:</t>
1947 <t>
1948 <list>
1949 <t>GET MIDI_INPUT_PORT_PARAMETER INFO &lt;dev-id&gt; &lt;port&gt; &lt;param&gt;</t>
1950 </list>
1951 </t>
1952
1953 <t>Where &lt;dev-id&gt; is the numerical ID of the MIDI input device as returned by the
1954 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
1955 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
1956 command, &lt;port&gt; the MIDI port number and
1957 &lt;param&gt; a specific port parameter name for which information should be
1958 obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO">
1959 "GET MIDI_INPUT_PORT INFO"</xref> command).</t>
1960
1961 <t>Possible Answers:</t>
1962 <t>
1963 <list>
1964 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
1965 Each answer line begins with the information category name
1966 followed by a colon and then a space character &lt;SP&gt; and finally
1967 the info character string to that info category. There is
1968 information which is always returned, independently of the
1969 given channel parameter and there is optional information
1970 which are only shown dependently to the given MIDI port. At the
1971 moment the following information categories are defined:</t>
1972
1973 <t>TYPE -
1974 <list>
1975 <t>either "BOOL" for boolean value(s) or "INT" for integer
1976 value(s) or "FLOAT" for dotted number(s) or "STRING" for
1977 character string(s)
1978 (always returned)</t>
1979 </list>
1980 </t>
1981 <t>DESCRIPTION -
1982 <list>
1983 <t>arbitrary text describing the purpose of the parameter
1984 (always returned)</t>
1985 </list>
1986 </t>
1987 <t>FIX -
1988 <list>
1989 <t>either true or false, if true then this parameter is
1990 read only, thus cannot be altered
1991 (always returned)</t>
1992 </list>
1993 </t>
1994 <t>MULTIPLICITY -
1995 <list>
1996 <t>either true or false, defines if this parameter allows
1997 only one value or a list of values, where true means
1998 multiple values and false only a single value allowed
1999 (always returned)</t>
2000 </list>
2001 </t>
2002 <t>RANGE_MIN -
2003 <list>
2004 <t>defines lower limit of the allowed value range for this
2005 parameter, can be an integer value as well as a dotted
2006 number, this parameter is usually used in conjunction
2007 with 'RANGE_MAX' but may also appear without
2008 (optionally returned, dependent to driver and port
2009 parameter)</t>
2010 </list>
2011 </t>
2012 <t>RANGE_MAX -
2013 <list>
2014 <t>defines upper limit of the allowed value range for this
2015 parameter, can be an integer value as well as a dotted
2016 number, this parameter is usually used in conjunction
2017 with 'RANGE_MIN' but may also appear without
2018 (optionally returned, dependent to driver and port
2019 parameter)</t>
2020 </list>
2021 </t>
2022 <t>POSSIBILITIES -
2023 <list>
2024 <t>comma separated list of possible values for this
2025 parameter, character strings are encapsulated into
2026 apostrophes
2027 (optionally returned, dependent to device and port
2028 parameter)</t>
2029 </list>
2030 </t>
2031 </list>
2032 </t>
2033
2034 <t>The mentioned fields above don't have to be in particular order.</t>
2035
2036 <t>Example:</t>
2037 <t>
2038 <list>
2039 <t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 ALSA_SEQ_BINDINGS"</t>
2040 <t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t>
2041 <t>&nbsp;&nbsp;&nbsp;"TYPE: STRING"</t>
2042 <t>&nbsp;&nbsp;&nbsp;"FIX: false"</t>
2043 <t>&nbsp;&nbsp;&nbsp;"MULTIPLICITY: true"</t>
2044 <t>&nbsp;&nbsp;&nbsp;"POSSIBILITIES: '64:0','68:0','68:1'"</t>
2045 <t>&nbsp;&nbsp;&nbsp;"."</t>
2046 </list>
2047 </t>
2048 </section>
2049
2050 <section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER">
2051 <t>Use the following command to alter a specific setting of a MIDI input port:</t>
2052 <t>
2053 <list>
2054 <t>SET MIDI_INPUT_PORT_PARAMETER &lt;device-id&gt; &lt;port&gt; &lt;key&gt;=&lt;value&gt;</t>
2055 </list>
2056 </t>
2057
2058 <t>Where &lt;device-id&gt; should be replaced by the numerical ID of the
2059 MIDI device as returned by the
2060 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2061 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref>
2062 command, &lt;port&gt; by the MIDI port number, &lt;key&gt; by the name of
2063 the parameter to change and &lt;value&gt; by the new value for this
2064 parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes)
2065 for specifying no value for parameters allowing a list of values.</t>
2066
2067 <t>Possible Answers:</t>
2068 <t>
2069 <list>
2070 <t>"OK" -
2071 <list>
2072 <t>in case setting was successfully changed</t>
2073 </list>
2074 </t>
2075 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2076 <list>
2077 <t>in case setting was changed successfully, but there are
2078 noteworthy issue(s) related, providing an appropriate
2079 warning code and warning message</t>
2080 </list>
2081 </t>
2082 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2083 <list>
2084 <t>in case it failed, providing an appropriate error code and error message</t>
2085 </list>
2086 </t>
2087 </list>
2088 </t>
2089 <t>Example:</t>
2090 <t>
2091 <list>
2092 <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t>
2093 <t>S: "OK"</t>
2094 </list>
2095 </t>
2096 <t>
2097 <list>
2098 <t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t>
2099 <t>S: "OK"</t>
2100 </list>
2101 </t>
2102 </section>
2103 </section>
2104
2105 <section title="Configuring sampler channels">
2106 <t>The following commands describe how to add and remove sampler channels, associate a
2107 sampler channel with a sampler engine, load instruments and connect sampler channels to
2108 MIDI and audio devices.</t>
2109
2110 <section title="Loading an instrument" anchor="LOAD INSTRUMENT">
2111 <t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t>
2112 <t>
2113 <list>
2114 <t>LOAD INSTRUMENT [NON_MODAL] '&lt;filename&gt;' &lt;instr-index&gt; &lt;sampler-channel&gt;</t>
2115 </list>
2116 </t>
2117
2118 <t>Where &lt;filename&gt; is the name of the instrument file on the
2119 LinuxSampler instance's host system, &lt;instr-index&gt; the index of the
2120 instrument in the instrument file and &lt;sampler-channel> is the
2121 number of the sampler channel the instrument should be assigned to.
2122 Each sampler channel can only have one instrument.</t>
2123
2124 <t>Notice: since LSCP 1.2 the &lt;filename&gt; argument supports
2125 escape characters for special characters (see chapter
2126 "<xref target="character_set">Character Set and Escape Sequences</xref>"
2127 for details) and accordingly backslash characters in the filename
2128 MUST now be escaped as well!</t>
2129
2130 <t>The difference between regular and NON_MODAL versions of the command
2131 is that the regular command returns OK only after the instrument has been
2132 fully loaded and the channel is ready to be used while NON_MODAL version
2133 returns immediately and a background process is launched to load the instrument
2134 on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref>
2135 command can be used to obtain loading
2136 progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks
2137 such as making sure that the file could be read and it is of a proper format
2138 and SHOULD return ERR and SHOULD not launch the background process should any
2139 errors be detected at that point.</t>
2140
2141 <t>Possible Answers:</t>
2142 <t>
2143 <list>
2144 <t>"OK" -
2145 <list>
2146 <t>in case the instrument was successfully loaded</t>
2147 </list>
2148 </t>
2149 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2150 <list>
2151 <t>in case the instrument was loaded successfully, but there
2152 are noteworthy issue(s) related (e.g. Engine doesn't support
2153 one or more patch parameters provided by the loaded
2154 instrument file), providing an appropriate warning code and
2155 warning message</t>
2156 </list>
2157 </t>
2158 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2159 <list>
2160 <t>in case it failed, providing an appropriate error code and error message</t>
2161 </list>
2162 </t>
2163 </list>
2164 </t>
2165 <t>Example (Unix):</t>
2166 <t>
2167 <list>
2168 <t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t>
2169 <t>S: OK</t>
2170 </list>
2171 </t>
2172 <t>Example (Windows):</t>
2173 <t>
2174 <list>
2175 <t>C: LOAD INSTRUMENT 'D:/MySounds/cello.gig' 0 0</t>
2176 <t>S: OK</t>
2177 </list>
2178 </t>
2179 </section>
2180
2181 <section title="Loading a sampler engine" anchor="LOAD ENGINE">
2182 <t>A sampler engine type can be associated to a specific sampler
2183 channel by the following command:</t>
2184 <t>
2185 <list>
2186 <t>LOAD ENGINE &lt;engine-name&gt; &lt;sampler-channel&gt;</t>
2187 </list>
2188 </t>
2189
2190 <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2191 <xref target="LIST AVAILABLE_ENGINES">
2192 "LIST AVAILABLE_ENGINES"</xref> command and &lt;sampler-channel&gt;
2193 the sampler channel as returned by the
2194 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> or
2195 <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command where
2196 the engine type should be assigned to. This command should be issued
2197 after adding a new sampler channel and before any other control
2198 commands on the new sampler channel. It can also be used to change
2199 the engine type of a sampler channel. This command has (currently) no
2200 way to define or force if a new engine instance should be created and
2201 assigned to the given sampler channel or if an already existing
2202 instance of that engine type, shared with other sampler channels,
2203 should be used.</t>
2204
2205 <t>Possible Answers:</t>
2206 <t>
2207 <list>
2208 <t>"OK" -
2209 <list>
2210 <t>in case the engine was successfully deployed</t>
2211 </list>
2212 </t>
2213 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2214 <list>
2215 <t>in case the engine was deployed successfully, but there
2216 are noteworthy issue(s) related, providing an appropriate
2217 warning code and warning message</t>
2218 </list>
2219 </t>
2220 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2221 <list>
2222 <t>in case it failed, providing an appropriate error code and
2223 error message</t>
2224 </list>
2225 </t>
2226 </list>
2227 </t>
2228 <t>Example:</t>
2229 <t>
2230 <list>
2231 <t></t>
2232 </list>
2233 </t>
2234 </section>
2235
2236 <section title="Getting all created sampler channel count" anchor="GET CHANNELS">
2237 <t>The number of sampler channels can change on runtime. To get the
2238 current amount of sampler channels, the front-end can send the
2239 following command:</t>
2240 <t>
2241 <list>
2242 <t>GET CHANNELS</t>
2243 </list>
2244 </t>
2245 <t>Possible Answers:</t>
2246 <t>
2247 <list>
2248 <t>LinuxSampler will answer by returning the current number of sampler channels.</t>
2249 </list>
2250 </t>
2251 <t>Example:</t>
2252 <t>
2253 <list>
2254 <t>C: "GET CHANNELS"</t>
2255 <t>S: "12"</t>
2256 </list>
2257 </t>
2258 </section>
2259
2260 <section title="Getting all created sampler channel list" anchor="LIST CHANNELS">
2261 <t>The number of sampler channels can change on runtime. To get the
2262 current list of sampler channels, the front-end can send the
2263 following command:</t>
2264 <t>
2265 <list>
2266 <t>LIST CHANNELS</t>
2267 </list>
2268 </t>
2269 <t>Possible Answers:</t>
2270 <t>
2271 <list>
2272 <t>LinuxSampler will answer by returning a comma separated list
2273 with all sampler channels numerical IDs.</t>
2274 </list>
2275 </t>
2276 <t>Example:</t>
2277 <t>
2278 <list>
2279 <t>C: "LIST CHANNELS"</t>
2280 <t>S: "0,1,2,3,4,5,6,9,10,11,15,20"</t>
2281 </list>
2282 </t>
2283 </section>
2284
2285 <section title="Adding a new sampler channel" anchor="ADD CHANNEL">
2286 <t>A new sampler channel can be added to the end of the sampler
2287 channel list by sending the following command:</t>
2288 <t>
2289 <list>
2290 <t>ADD CHANNEL</t>
2291 </list>
2292 </t>
2293 <t>This will increment the sampler channel count by one and the new
2294 sampler channel will be appended to the end of the sampler channel
2295 list. The front-end should send the respective, related commands
2296 right after to e.g. load an engine, load an instrument and setting
2297 input, output method and eventually other commands to initialize
2298 the new channel. The front-end should use the sampler channel
2299 returned by the answer of this command to perform the previously
2300 recommended commands, to avoid race conditions e.g. with other
2301 front-ends that might also have sent an "ADD CHANNEL" command.</t>
2302 <t>Possible Answers:</t>
2303 <t>
2304 <list>
2305 <t>"OK[&lt;sampler-channel&gt;]" -
2306 <list>
2307 <t>in case a new sampler channel could be added, where
2308 &lt;sampler-channel&gt; reflects the channel number of the new
2309 created sampler channel which should be used to set up
2310 the sampler channel by sending subsequent initialization
2311 commands</t>
2312 </list>
2313 </t>
2314 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2315 <list>
2316 <t>in case a new channel was added successfully, but there are
2317 noteworthy issue(s) related, providing an appropriate
2318 warning code and warning message</t>
2319 </list>
2320 </t>
2321 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2322 <list>
2323 <t>in case it failed, providing an appropriate error code and
2324 error message</t>
2325 </list>
2326 </t>
2327 </list>
2328 </t>
2329 <t>Example:</t>
2330 <t>
2331 <list>
2332 <t></t>
2333 </list>
2334 </t>
2335 </section>
2336
2337 <section title="Removing a sampler channel" anchor="REMOVE CHANNEL">
2338 <t>A sampler channel can be removed by sending the following command:</t>
2339 <t>
2340 <list>
2341 <t>REMOVE CHANNEL &lt;sampler-channel&gt;</t>
2342 </list>
2343 </t>
2344
2345 <t>Where &lt;sampler-channel&gt; should be replaced by the
2346 number of the sampler channel as given by the
2347 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2348 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
2349 command. The channel numbers of all subsequent sampler channels
2350 remain the same.</t>
2351
2352 <t>Possible Answers:</t>
2353 <t>
2354 <list>
2355 <t>"OK" -
2356 <list>
2357 <t>in case the given sampler channel could be removed</t>
2358 </list>
2359 </t>
2360 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2361 <list>
2362 <t>in case the given channel was removed, but there are
2363 noteworthy issue(s) related, providing an appropriate
2364 warning code and warning message</t>
2365 </list>
2366 </t>
2367 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2368 <list>
2369 <t>in case it failed, providing an appropriate error code and
2370 error message</t>
2371 </list>
2372 </t>
2373 </list>
2374 </t>
2375 <t>Example:</t>
2376 <t>
2377 <list>
2378 <t></t>
2379 </list>
2380 </t>
2381 </section>
2382
2383 <section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES">
2384 <t>The front-end can ask for the number of available engines by sending the following command:</t>
2385 <t>
2386 <list>
2387 <t>GET AVAILABLE_ENGINES</t>
2388 </list>
2389 </t>
2390 <t>Possible Answers:</t>
2391 <t>
2392 <list>
2393 <t>LinuxSampler will answer by sending the number of available engines.</t>
2394 </list>
2395 </t>
2396 <t>Example:</t>
2397 <t>
2398 <list>
2399 <t>C: "GET AVAILABLE_ENGINES"</t>
2400 <t>S: "4"</t>
2401 </list>
2402 </t>
2403 </section>
2404
2405 <section title="Getting all available engines" anchor="LIST AVAILABLE_ENGINES">
2406 <t>The front-end can ask for a list of all available engines by sending the following command:</t>
2407 <t>
2408 <list>
2409 <t>LIST AVAILABLE_ENGINES</t>
2410 </list>
2411 </t>
2412 <t>Possible Answers:</t>
2413 <t>
2414 <list>
2415 <t>LinuxSampler will answer by sending a comma separated list
2416 of the engines' names encapsulated into apostrophes (').
2417 Engine names can consist of lower and upper cases,
2418 digits and underlines ("_" character).</t>
2419 </list>
2420 </t>
2421 <t>Example:</t>
2422 <t>
2423 <list>
2424 <t>C: "LIST AVAILABLE_ENGINES"</t>
2425 <t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t>
2426 </list>
2427 </t>
2428 </section>
2429
2430 <section title="Getting information about an engine" anchor="GET ENGINE INFO">
2431 <t>The front-end can ask for information about a specific engine by
2432 sending the following command:</t>
2433 <t>
2434 <list>
2435 <t>GET ENGINE INFO &lt;engine-name&gt;</t>
2436 </list>
2437 </t>
2438 <t>Where &lt;engine-name&gt; is an engine name as obtained by the
2439 <xref target="LIST AVAILABLE_ENGINES">
2440 "LIST AVAILABLE_ENGINES"</xref> command.</t>
2441 <t>Possible Answers:</t>
2442 <t>
2443 <list>
2444 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2445 Each answer line begins with the information category name
2446 followed by a colon and then a space character &lt;SP&gt; and finally
2447 the info character string to that info category. At the moment
2448 the following categories are defined:</t>
2449
2450 <t>
2451 <list>
2452 <t>DESCRIPTION -
2453 <list>
2454 <t>arbitrary description text about the engine
2455 (note that the character string may contain
2456 <xref target="character_set">escape sequences</xref>)</t>
2457 </list>
2458 </t>
2459 <t>VERSION -
2460 <list>
2461 <t>arbitrary character string regarding the engine's version</t>
2462 </list>
2463 </t>
2464 </list>
2465 </t>
2466 </list>
2467 </t>
2468
2469 <t>The mentioned fields above don't have to be in particular order.</t>
2470
2471 <t>Example:</t>
2472 <t>
2473 <list>
2474 <t>C: "GET ENGINE INFO JoesCustomEngine"</t>
2475 <t>S: "DESCRIPTION: this is Joe's custom sampler engine"</t>
2476 <t>&nbsp;&nbsp;&nbsp;"VERSION: testing-1.0"</t>
2477 <t>&nbsp;&nbsp;&nbsp;"."</t>
2478 </list>
2479 </t>
2480 </section>
2481
2482 <section title="Getting sampler channel information" anchor="GET CHANNEL INFO">
2483 <t>The front-end can ask for the current settings of a sampler channel
2484 by sending the following command:</t>
2485 <t>
2486 <list>
2487 <t>GET CHANNEL INFO &lt;sampler-channel&gt;</t>
2488 </list>
2489 </t>
2490 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2491 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2492 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2493 <t>Possible Answers:</t>
2494 <t>
2495 <list>
2496 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
2497 Each answer line begins with the settings category name
2498 followed by a colon and then a space character &lt;SP&gt; and finally
2499 the info character string to that setting category. At the
2500 moment the following categories are defined:</t>
2501
2502 <t>
2503 <list>
2504 <t>ENGINE_NAME -
2505 <list>
2506 <t>name of the engine that is associated with the sampler
2507 channel, "NONE" if there's no engine associated yet for
2508 this sampler channel</t>
2509 </list>
2510 </t>
2511 <t>AUDIO_OUTPUT_DEVICE -
2512 <list>
2513 <t>numerical ID of the audio output device which is
2514 currently connected to this sampler channel to output
2515 the audio signal, "-1" if there's no device
2516 connected to this sampler channel</t>
2517 </list>
2518 </t>
2519 <t>AUDIO_OUTPUT_CHANNELS -
2520 <list>
2521 <t>number of output channels the sampler channel offers
2522 (dependent to used sampler engine and loaded instrument)</t>
2523 </list>
2524 </t>
2525 <t>AUDIO_OUTPUT_ROUTING -
2526 <list>
2527 <t>comma separated list which reflects to which audio
2528 channel of the selected audio output device each
2529 sampler output channel is routed to, e.g. "0,3" would
2530 mean the engine's output channel 0 is routed to channel
2531 0 of the audio output device and the engine's output
2532 channel 1 is routed to the channel 3 of the audio
2533 output device</t>
2534 </list>
2535 </t>
2536 <t>INSTRUMENT_FILE -
2537 <list>
2538 <t>the file name of the loaded instrument, "NONE" if
2539 there's no instrument yet loaded for this sampler
2540 channel (note: since LSCP 1.2 this path may contain
2541 <xref target="character_set">escape sequences</xref>)</t>
2542 </list>
2543 </t>
2544 <t>INSTRUMENT_NR -
2545 <list>
2546 <t>the instrument index number of the loaded instrument,
2547 "-1" if there's no instrument loaded for this sampler
2548 channel</t>
2549 </list>
2550 </t>
2551 <t>INSTRUMENT_NAME -
2552 <list>
2553 <t>the instrument name of the loaded instrument
2554 (note: since LSCP 1.2 this character string may contain
2555 <xref target="character_set">escape sequences</xref>)</t>
2556 </list>
2557 </t>
2558 <t>INSTRUMENT_STATUS -
2559 <list>
2560 <t>Integer values 0 to 100 indicating loading progress
2561 percentage for the instrument. Negative
2562 value indicates a loading exception (also returns "-1" in case no
2563 instrument was yet to be loaded on the sampler channel).
2564 Value of 100 indicates that the instrument is fully
2565 loaded.</t>
2566 </list>
2567 </t>
2568 <t>MIDI_INPUT_DEVICE -
2569 <list>
2570 <t>numerical ID of the MIDI input device which is
2571 currently connected to this sampler channel to deliver
2572 MIDI input commands, "-1" if there's no device
2573 connected to this sampler channel</t>
2574 </list>
2575 </t>
2576 <t>MIDI_INPUT_PORT -
2577 <list>
2578 <t>port number of the MIDI input device (in case a
2579 MIDI device was already assigned to the sampler
2580 channel)</t>
2581 </list>
2582 </t>
2583 <t>MIDI_INPUT_CHANNEL -
2584 <list>
2585 <t>the MIDI input channel number this sampler channel
2586 should listen to or "ALL" to listen on all MIDI channels</t>
2587 </list>
2588 </t>
2589 <t>VOLUME -
2590 <list>
2591 <t>optionally dotted number for the channel volume factor
2592 (where a value &lt; 1.0 means attenuation and a value >
2593 1.0 means amplification)</t>
2594 </list>
2595 </t>
2596 <t>MUTE -
2597 <list>
2598 <t>Determines whether the channel is muted, "true" if the
2599 channel is muted, "false" if the channel is not muted, and
2600 "MUTED_BY_SOLO" if the channel is muted because of the
2601 presence of a solo channel and will be unmuted when
2602 there are no solo channels left</t>
2603 </list>
2604 </t>
2605 <t>SOLO -
2606 <list>
2607 <t>Determines whether this is a solo channel, "true" if
2608 the channel is a solo channel; "false" otherwise</t>
2609 </list>
2610 </t>
2611 <t>MIDI_INSTRUMENT_MAP -
2612 <list>
2613 <t>Determines to which MIDI instrument map this sampler
2614 channel is assigned to. Read chapter
2615 <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
2616 for a list of possible values.</t>
2617 </list>
2618 </t>
2619 </list>
2620 </t>
2621 </list>
2622 </t>
2623 <t>The mentioned fields above don't have to be in particular order.</t>
2624
2625 <t>Example:</t>
2626 <t>
2627 <list>
2628 <t>C: "GET CHANNEL INFO 34"</t>
2629 <t>S: "ENGINE_NAME: GigEngine"</t>
2630 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2631 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_DEVICE: 0"</t>
2632 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_CHANNELS: 2"</t>
2633 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 0,1"</t>
2634 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t>
2635 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
2636 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Fazioli Piano"</t>
2637 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_STATUS: 100"</t>
2638 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
2639 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
2640 <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
2641 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2642 <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
2643 <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
2644 <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
2645 <t>&nbsp;&nbsp;&nbsp;"."</t>
2646 </list>
2647 </t>
2648 </section>
2649
2650 <section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT">
2651 <t>The front-end can ask for the current number of active voices on a
2652 sampler channel by sending the following command:</t>
2653 <t>
2654 <list>
2655 <t>GET CHANNEL VOICE_COUNT &lt;sampler-channel&gt;</t>
2656 </list>
2657 </t>
2658 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2659 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2660 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2661
2662 <t>Possible Answers:</t>
2663 <t>
2664 <list>
2665 <t>LinuxSampler will answer by returning the number of active
2666 voices on that channel.</t>
2667 </list>
2668 </t>
2669 <t>Example:</t>
2670 <t>
2671 <list>
2672 <t></t>
2673 </list>
2674 </t>
2675 </section>
2676
2677 <section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT">
2678 <t>The front-end can ask for the current number of active disk streams
2679 on a sampler channel by sending the following command:</t>
2680 <t>
2681 <list>
2682 <t>GET CHANNEL STREAM_COUNT &lt;sampler-channel&gt;</t>
2683 </list>
2684 </t>
2685 <t>Where &lt;sampler-channel&gt; is the sampler channel number the front-end is interested in
2686 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2687 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2688
2689 <t>Possible Answers:</t>
2690 <t>
2691 <list>
2692 <t>LinuxSampler will answer by returning the number of active
2693 disk streams on that channel in case the engine supports disk
2694 streaming, if the engine doesn't support disk streaming it will
2695 return "NA" for not available.</t>
2696 </list>
2697 </t>
2698 <t>Example:</t>
2699 <t>
2700 <list>
2701 <t></t>
2702 </list>
2703 </t>
2704 </section>
2705
2706 <section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL">
2707 <t>The front-end can ask for the current fill state of all disk streams
2708 on a sampler channel by sending the following command:</t>
2709 <t>
2710 <list>
2711 <t>GET CHANNEL BUFFER_FILL BYTES &lt;sampler-channel&gt;</t>
2712 </list>
2713 </t>
2714 <t>to get the fill state in bytes or</t>
2715 <t>
2716 <list>
2717 <t>GET CHANNEL BUFFER_FILL PERCENTAGE &lt;sampler-channel&gt;</t>
2718 </list>
2719 </t>
2720 <t>to get the fill state in percent, where &lt;sampler-channel&gt; is the
2721 sampler channel number the front-end is interested in
2722 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2723 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
2724
2725 <t>Possible Answers:</t>
2726 <t>
2727 <list>
2728 <t>LinuxSampler will either answer by returning a comma separated
2729 string with the fill state of all disk stream buffers on that
2730 channel or an empty line if there are no active disk streams or
2731 "NA" for *not available* in case the engine which is deployed
2732 doesn't support disk streaming. Each entry in the answer list
2733 will begin with the stream's ID in brackets followed by the
2734 numerical representation of the fill size (either in bytes or
2735 percentage). Note: due to efficiency reasons the fill states in
2736 the response are not in particular order, thus the front-end has
2737 to sort them by itself if necessary.</t>
2738 </list>
2739 </t>
2740 <t>Examples:</t>
2741 <t>
2742 <list>
2743 <t>C: "GET CHANNEL BUFFER_FILL BYTES 4"</t>
2744 <t>S: "[115]420500,[116]510300,[75]110000,[120]230700"</t>
2745 </list>
2746
2747 <list>
2748 <t>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"</t>
2749 <t>S: "[115]90%,[116]98%,[75]40%,[120]62%"</t>
2750 </list>
2751
2752 <list>
2753 <t>C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"</t>
2754 <t>S: ""</t>
2755 </list>
2756 </t>
2757 </section>
2758
2759 <section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE">
2760 <t>The front-end can set the audio output device on a specific sampler
2761 channel by sending the following command:</t>
2762 <t>
2763 <list>
2764 <t>SET CHANNEL AUDIO_OUTPUT_DEVICE &lt;sampler-channel&gt; &lt;audio-device-id&gt;</t>
2765 </list>
2766 </t>
2767 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
2768 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2769 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
2770 &lt;audio-device-id&gt; is the numerical ID of the audio output device as given by the
2771 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
2772 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
2773 command.</t>
2774
2775 <t>Possible Answers:</t>
2776 <t>
2777 <list>
2778 <t>"OK" -
2779 <list>
2780 <t>on success</t>
2781 </list>
2782 </t>
2783 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2784 <list>
2785 <t>if audio output device was set, but there are noteworthy
2786 issue(s) related, providing an appropriate warning code and
2787 warning message</t>
2788 </list>
2789 </t>
2790 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2791 <list>
2792 <t>in case it failed, providing an appropriate error code and error message</t>
2793 </list>
2794 </t>
2795 </list>
2796 </t>
2797 <t>Examples:</t>
2798 <t>
2799 <list>
2800 <t></t>
2801 </list>
2802 </t>
2803 </section>
2804
2805 <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">
2806 <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2807
2808 <t>The front-end can alter the audio output type on a specific sampler
2809 channel by sending the following command:</t>
2810 <t>
2811 <list>
2812 <t>SET CHANNEL AUDIO_OUTPUT_TYPE &lt;sampler-channel&gt; &lt;audio-output-type&gt;</t>
2813 </list>
2814 </t>
2815 <t>Where &lt;audio-output-type&gt; is currently either "ALSA" or "JACK" and
2816 &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2817
2818 <t>Possible Answers:</t>
2819 <t>
2820 <list>
2821 <t>"OK" -
2822 <list>
2823 <t>on success</t>
2824 </list>
2825 </t>
2826 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2827 <list>
2828 <t>if audio output type was set, but there are noteworthy
2829 issue(s) related, providing an appropriate warning code and
2830 warning message</t>
2831 </list>
2832 </t>
2833 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2834 <list>
2835 <t>in case it failed, providing an appropriate error code and error message</t>
2836 </list>
2837 </t>
2838 </list>
2839 </t>
2840 <t>Examples:</t>
2841 <t>
2842 <list>
2843 <t></t>
2844 </list>
2845 </t>
2846 </section>
2847
2848 <section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL">
2849 <t>The front-end can alter the audio output channel on a specific
2850 sampler channel by sending the following command:</t>
2851 <t>
2852 <list>
2853 <t>SET CHANNEL AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;audio-out&gt; &lt;audio-in&gt;</t>
2854 </list>
2855 </t>
2856 <t>Where &lt;sampler-chan&gt; is the sampler channel number
2857 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2858 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, &lt;audio-out&gt; is the
2859 numerical ID of the sampler channel's audio output channel which should be
2860 rerouted and &lt;audio-in&gt; is the numerical ID of the audio channel of the selected audio
2861 output device where &lt;audio-out&gt; should be routed to.</t>
2862
2863 <t>Possible Answers:</t>
2864 <t>
2865 <list>
2866 <t>"OK" -
2867 <list>
2868 <t>on success</t>
2869 </list>
2870 </t>
2871 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2872 <list>
2873 <t>if audio output channel was set, but there are noteworthy
2874 issue(s) related, providing an appropriate warning code and
2875 warning message</t>
2876 </list>
2877 </t>
2878 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2879 <list>
2880 <t>in case it failed, providing an appropriate error code and error message</t>
2881 </list>
2882 </t>
2883 </list>
2884 </t>
2885 <t>Examples:</t>
2886 <t>
2887 <list>
2888 <t></t>
2889 </list>
2890 </t>
2891 </section>
2892
2893 <section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE">
2894 <t>The front-end can set the MIDI input device on a specific sampler
2895 channel by sending the following command:</t>
2896 <t>
2897 <list>
2898 <t>SET CHANNEL MIDI_INPUT_DEVICE &lt;sampler-channel&gt; &lt;midi-device-id&gt;</t>
2899 </list>
2900 </t>
2901 <t>Where &lt;sampler-channel&gt; is the sampler channel number
2902 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
2903 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command
2904 and &lt;midi-device-id&gt; is the numerical ID of the MIDI input device as returned by the
2905 <xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref>
2906 or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> command.</t>
2907
2908 <t>Possible Answers:</t>
2909 <t>
2910 <list>
2911 <t>"OK" -
2912 <list>
2913 <t>on success</t>
2914 </list>
2915 </t>
2916 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2917 <list>
2918 <t>if MIDI input device was set, but there are noteworthy
2919 issue(s) related, providing an appropriate warning code and
2920 warning message</t>
2921 </list>
2922 </t>
2923 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2924 <list>
2925 <t>in case it failed, providing an appropriate error code and error message</t>
2926 </list>
2927 </t>
2928 </list>
2929 </t>
2930 <t>Examples:</t>
2931 <t>
2932 <list>
2933 <t></t>
2934 </list>
2935 </t>
2936 </section>
2937
2938 <section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE">
2939 <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2940
2941 <t>The front-end can alter the MIDI input type on a specific sampler
2942 channel by sending the following command:</t>
2943 <t>
2944 <list>
2945 <t>SET CHANNEL MIDI_INPUT_TYPE &lt;sampler-channel&gt; &lt;midi-input-type&gt;</t>
2946 </list>
2947 </t>
2948 <t>Where &lt;midi-input-type&gt; is currently only "ALSA" and
2949 &lt;sampler-channel&gt; is the respective sampler channel number.</t>
2950
2951 <t>Possible Answers:</t>
2952 <t>
2953 <list>
2954 <t>"OK" -
2955 <list>
2956 <t>on success</t>
2957 </list>
2958 </t>
2959 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
2960 <list>
2961 <t>if MIDI input type was set, but there are noteworthy
2962 issue(s) related, providing an appropriate warning code and
2963 warning message</t>
2964 </list>
2965 </t>
2966 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
2967 <list>
2968 <t>in case it failed, providing an appropriate error code and error message</t>
2969 </list>
2970 </t>
2971 </list>
2972 </t>
2973 <t>Examples:</t>
2974 <t>
2975 <list>
2976 <t></t>
2977 </list>
2978 </t>
2979 </section>
2980
2981 <section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT">
2982 <t>The front-end can alter the MIDI input port on a specific sampler
2983 channel by sending the following command:</t>
2984 <t>
2985 <list>
2986 <t>SET CHANNEL MIDI_INPUT_PORT &lt;sampler-channel&gt; &lt;midi-input-port&gt;</t>
2987 </list>
2988 </t>
2989 <t>Where &lt;midi-input-port&gt; is a MIDI input port number of the
2990 MIDI input device connected to the sampler channel given by
2991 &lt;sampler-channel&gt;.</t>
2992
2993 <t>Possible Answers:</t>
2994 <t>
2995 <list>
2996 <t>"OK" -
2997 <list>
2998 <t>on success</t>
2999 </list>
3000 </t>
3001 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3002 <list>
3003 <t>if MIDI input port was set, but there are noteworthy
3004 issue(s) related, providing an appropriate warning code and
3005 warning message</t>
3006 </list>
3007 </t>
3008 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3009 <list>
3010 <t>in case it failed, providing an appropriate error code and error message</t>
3011 </list>
3012 </t>
3013 </list>
3014 </t>
3015 <t>Examples:</t>
3016 <t>
3017 <list>
3018 <t></t>
3019 </list>
3020 </t>
3021 </section>
3022
3023 <section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL">
3024 <t>The front-end can alter the MIDI channel a sampler channel should
3025 listen to by sending the following command:</t>
3026 <t>
3027 <list>
3028 <t>SET CHANNEL MIDI_INPUT_CHANNEL &lt;sampler-channel&gt; &lt;midi-input-chan&gt;</t>
3029 </list>
3030 </t>
3031 <t>Where &lt;midi-input-chan&gt; is the number of the new MIDI input channel where
3032 &lt;sampler-channel&gt; should listen to or "ALL" to listen on all 16 MIDI
3033 channels.</t>
3034
3035 <t>Possible Answers:</t>
3036 <t>
3037 <list>
3038 <t>"OK" -
3039 <list>
3040 <t>on success</t>
3041 </list>
3042 </t>
3043 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3044 <list>
3045 <t>if MIDI input channel was set, but there are noteworthy
3046 issue(s) related, providing an appropriate warning code and
3047 warning message</t>
3048 </list>
3049 </t>
3050 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3051 <list>
3052 <t>in case it failed, providing an appropriate error code and error message</t>
3053 </list>
3054 </t>
3055 </list>
3056 </t>
3057 <t>Examples:</t>
3058 <t>
3059 <list>
3060 <t></t>
3061 </list>
3062 </t>
3063 </section>
3064
3065 <section title="Setting channel volume" anchor="SET CHANNEL VOLUME">
3066 <t>The front-end can alter the volume of a sampler channel by sending
3067 the following command:</t>
3068 <t>
3069 <list>
3070 <t>SET CHANNEL VOLUME &lt;sampler-channel&gt; &lt;volume&gt;</t>
3071 </list>
3072 </t>
3073 <t>Where &lt;volume&gt; is an optionally dotted positive number (a value
3074 smaller than 1.0 means attenuation, whereas a value greater than
3075 1.0 means amplification) and &lt;sampler-channel&gt; defines the sampler
3076 channel where this volume factor should be set.</t>
3077
3078 <t>Possible Answers:</t>
3079 <t>
3080 <list>
3081 <t>"OK" -
3082 <list>
3083 <t>on success</t>
3084 </list>
3085 </t>
3086 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3087 <list>
3088 <t>if channel volume was set, but there are noteworthy
3089 issue(s) related, providing an appropriate warning code and
3090 warning message</t>
3091 </list>
3092 </t>
3093 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3094 <list>
3095 <t>in case it failed, providing an appropriate error code and error message</t>
3096 </list>
3097 </t>
3098 </list>
3099 </t>
3100 <t>Examples:</t>
3101 <t>
3102 <list>
3103 <t></t>
3104 </list>
3105 </t>
3106 </section>
3107
3108 <section title="Muting a sampler channel" anchor="SET CHANNEL MUTE">
3109 <t>The front-end can mute/unmute a specific sampler
3110 channel by sending the following command:</t>
3111 <t>
3112 <list>
3113 <t>SET CHANNEL MUTE &lt;sampler-channel&gt; &lt;mute&gt;</t>
3114 </list>
3115 </t>
3116 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3117 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3118 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3119 &lt;mute&gt; should be replaced either by "1" to mute the channel or "0"
3120 to unmute the channel.</t>
3121
3122 <t>Possible Answers:</t>
3123 <t>
3124 <list>
3125 <t>"OK" -
3126 <list>
3127 <t>on success</t>
3128 </list>
3129 </t>
3130 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3131 <list>
3132 <t>if the channel was muted/unmuted, but there are noteworthy
3133 issue(s) related, providing an appropriate warning code and
3134 warning message</t>
3135 </list>
3136 </t>
3137 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3138 <list>
3139 <t>in case it failed, providing an appropriate error code and error message</t>
3140 </list>
3141 </t>
3142 </list>
3143 </t>
3144 <t>Examples:</t>
3145 <t>
3146 <list>
3147 <t></t>
3148 </list>
3149 </t>
3150 </section>
3151
3152 <section title="Soloing a sampler channel" anchor="SET CHANNEL SOLO">
3153 <t>The front-end can solo/unsolo a specific sampler channel
3154 by sending the following command:</t>
3155 <t>
3156 <list>
3157 <t>SET CHANNEL SOLO &lt;sampler-channel&gt; &lt;solo&gt;</t>
3158 </list>
3159 </t>
3160 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3161 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3162 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3163 &lt;solo&gt; should be replaced either by "1" to solo the channel or "0"
3164 to unsolo the channel.</t>
3165
3166 <t>Possible Answers:</t>
3167 <t>
3168 <list>
3169 <t>"OK" -
3170 <list>
3171 <t>on success</t>
3172 </list>
3173 </t>
3174 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3175 <list>
3176 <t>if the channel was soloed/unsoloed, but there are noteworthy
3177 issue(s) related, providing an appropriate warning code and
3178 warning message</t>
3179 </list>
3180 </t>
3181 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3182 <list>
3183 <t>in case it failed, providing an appropriate error code and error message</t>
3184 </list>
3185 </t>
3186 </list>
3187 </t>
3188 <t>Examples:</t>
3189 <t>
3190 <list>
3191 <t></t>
3192 </list>
3193 </t>
3194 </section>
3195
3196 <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">
3197 <t>The front-end can assign a MIDI instrument map to a specific sampler channel
3198 by sending the following command:</t>
3199 <t>
3200 <list>
3201 <t>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;</t>
3202 </list>
3203 </t>
3204 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3205 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3206 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3207 &lt;map&gt; can have the following possibilites:</t>
3208 <t>
3209 <list>
3210 <t>"NONE" -
3211 <list>
3212 <t>This is the default setting. In this case
3213 the sampler channel is not assigned any MIDI
3214 instrument map and thus will ignore all MIDI
3215 program change messages.</t>
3216 </list>
3217 </t>
3218 <t>"DEFAULT" -
3219 <list>
3220 <t>The sampler channel will always use the
3221 default MIDI instrument map to handle MIDI
3222 program change messages.</t>
3223 </list>
3224 </t>
3225 <t>numeric ID -
3226 <list>
3227 <t>You can assign a specific MIDI instrument map
3228 by replacing &lt;map&gt; with the respective numeric
3229 ID of the MIDI instrument map as returned by the
3230 <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
3231 command. Once that map will be deleted, the sampler
3232 channel would fall back to "NONE".</t>
3233 </list>
3234 </t>
3235 </list>
3236 </t>
3237 <t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref>
3238 for details regarding MIDI instrument mapping.</t>
3239
3240 <t>Possible Answers:</t>
3241 <t>
3242 <list>
3243 <t>"OK" -
3244 <list>
3245 <t>on success</t>
3246 </list>
3247 </t>
3248 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3249 <list>
3250 <t>in case it failed, providing an appropriate error code and error message</t>
3251 </list>
3252 </t>
3253 </list>
3254 </t>
3255
3256 <t>Examples:</t>
3257 <t>
3258 <list>
3259 <t></t>
3260 </list>
3261 </t>
3262 </section>
3263
3264 <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3265 <t>The front-end can create an additional effect send on a specific sampler channel
3266 by sending the following command:</t>
3267 <t>
3268 <list>
3269 <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3270 </list>
3271 </t>
3272 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3273 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3274 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3275 sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3276 is a number between 0..127 defining the MIDI controller which can alter the
3277 effect send level and &lt;name&gt; is an optional argument defining a name
3278 for the effect send entity. The name does not have to be unique, but MUST be
3279 encapsulated into apostrophes and supports escape sequences as described in chapter
3280 "<xref target="character_set">Character Set and Escape Sequences</xref>".</t>
3281
3282 <t>By default, that is as initial routing, the effect send's audio channels
3283 are automatically routed to the last audio channels of the sampler channel's
3284 audio output device, that way you can i.e. first increase the amount of audio
3285 channels on the audio output device for having dedicated effect send output
3286 channels and when "CREATE FX_SEND" is called, those channels will automatically
3287 be picked. You can alter the destination channels however with
3288 <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3289 </t>
3290
3291 <t>Note: Create effect sends on a sampler channel only when needed, because having effect
3292 sends on a sampler channel will decrease runtime performance, because for implementing channel
3293 effect sends, separate (sampler channel local) audio buffers are needed to render and mix
3294 the voices and route the audio signal afterwards to the master outputs and effect send
3295 outputs (along with their respective effect send levels). A sampler channel without effect
3296 sends however can mix its voices directly into the audio output devices's audio buffers
3297 and is thus faster.
3298 </t>
3299
3300 <t>Possible Answers:</t>
3301 <t>
3302 <list>
3303 <t>"OK[&lt;fx-send-id&gt;]" -
3304 <list>
3305 <t>in case a new effect send could be added to the
3306 sampler channel, where &lt;fx-send-id&gt; reflects the
3307 unique ID of the newly created effect send entity</t>
3308 </list>
3309 </t>
3310 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3311 <list>
3312 <t>when a new effect send could not be added, i.e.
3313 due to invalid parameters</t>
3314 </list>
3315 </t>
3316 </list>
3317 </t>
3318
3319 <t>Examples:</t>
3320 <t>
3321 <list>
3322 <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
3323 <t>S: "OK[0]"</t>
3324 </list>
3325 </t>
3326 <t>
3327 <list>
3328 <t>C: "CREATE FX_SEND 0 93"</t>
3329 <t>S: "OK[1]"</t>
3330 </list>
3331 </t>
3332 </section>
3333
3334 <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
3335 <t>The front-end can remove an existing effect send on a specific sampler channel
3336 by sending the following command:</t>
3337 <t>
3338 <list>
3339 <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3340 </list>
3341 </t>
3342 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3343 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3344 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3345 sampler channel from which the effect send should be removed from and
3346 &lt;fx-send-id&gt; is the respective effect send number as returned by the
3347 <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3348 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3349
3350 <t>Possible Answers:</t>
3351 <t>
3352 <list>
3353 <t>"OK" -
3354 <list>
3355 <t>on success</t>
3356 </list>
3357 </t>
3358 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3359 <list>
3360 <t>in case it failed, providing an appropriate error code and
3361 error message</t>
3362 </list>
3363 </t>
3364 </list>
3365 </t>
3366
3367 <t>Example:</t>
3368 <t>
3369 <list>
3370 <t>C: "DESTROY FX_SEND 0 0"</t>
3371 <t>S: "OK"</t>
3372 </list>
3373 </t>
3374 </section>
3375
3376 <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
3377 <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3378 by sending the following command:</t>
3379 <t>
3380 <list>
3381 <t>GET FX_SENDS &lt;sampler-channel&gt;</t>
3382 </list>
3383 </t>
3384 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3385 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3386 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3387
3388 <t>Possible Answers:</t>
3389 <t>
3390 <list>
3391 <t>The sampler will answer by returning the number of effect
3392 sends on the given sampler channel.</t>
3393 </list>
3394 </t>
3395
3396 <t>Example:</t>
3397 <t>
3398 <list>
3399 <t>C: "GET FX_SENDS 0"</t>
3400 <t>S: "2"</t>
3401 </list>
3402 </t>
3403 </section>
3404
3405 <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
3406 <t>The front-end can ask for a list of effect sends on a specific sampler channel
3407 by sending the following command:</t>
3408 <t>
3409 <list>
3410 <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
3411 </list>
3412 </t>
3413 <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3414 number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3415 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3416
3417 <t>Possible Answers:</t>
3418 <t>
3419 <list>
3420 <t>The sampler will answer by returning a comma separated list
3421 with all effect sends' numerical IDs on the given sampler
3422 channel.</t>
3423 </list>
3424 </t>
3425
3426 <t>Examples:</t>
3427 <t>
3428 <list>
3429 <t>C: "LIST FX_SENDS 0"</t>
3430 <t>S: "0,1"</t>
3431 </list>
3432 </t>
3433 <t>
3434 <list>
3435 <t>C: "LIST FX_SENDS 1"</t>
3436 <t>S: ""</t>
3437 </list>
3438 </t>
3439 </section>
3440
3441 <section title="Getting effect send information" anchor="GET FX_SEND INFO">
3442 <t>The front-end can ask for the current settings of an effect send entity
3443 by sending the following command:</t>
3444 <t>
3445 <list>
3446 <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3447 </list>
3448 </t>
3449 <t>Where &lt;sampler-channel&gt; is the sampler channel number
3450 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3451 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3452 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3453 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3454 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
3455 </t>
3456
3457 <t>Possible Answers:</t>
3458 <t>
3459 <list>
3460 <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
3461 Each answer line begins with the settings category name
3462 followed by a colon and then a space character &lt;SP&gt; and finally
3463 the info character string to that setting category. At the
3464 moment the following categories are defined:</t>
3465
3466 <t>
3467 <list>
3468 <t>NAME -
3469 <list>
3470 <t>name of the effect send entity
3471 (note that this character string may contain
3472 <xref target="character_set">escape sequences</xref>)</t>
3473 </list>
3474 </t>
3475 <t>MIDI_CONTROLLER -
3476 <list>
3477 <t>a value between 0 and 127 reflecting the MIDI controller
3478 which is able to modify the effect send's send level</t>
3479 </list>
3480 </t>
3481 <t>LEVEL -
3482 <list>
3483 <t>optionally dotted number reflecting the effect send's
3484 current send level (where a value &lt; 1.0 means attenuation
3485 and a value > 1.0 means amplification)</t>
3486 </list>
3487 </t>
3488 <t>AUDIO_OUTPUT_ROUTING -
3489 <list>
3490 <t>comma separated list which reflects to which audio
3491 channel of the selected audio output device each
3492 effect send output channel is routed to, e.g. "0,3" would
3493 mean the effect send's output channel 0 is routed to channel
3494 0 of the audio output device and the effect send's output
3495 channel 1 is routed to the channel 3 of the audio
3496 output device (see
3497 <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3498 for details), if an internal send
3499 effect is assigned to the effect
3500 send, then this setting defines the
3501 audio channel routing to that
3502 effect instance respectively</t>
3503 </list>
3504 </t>
3505 <t>SEND_EFFECT -
3506 <list>
3507 <t>destination send effect chain ID
3508 and destination effect chain
3509 position, separated by comma in the
3510 form "&lt;effect-chain&gt;,&lt;chain-pos&gt;"
3511 or "NONE" if there is no send effect
3512 assigned to the effect send</t>
3513 </list>
3514 </t>
3515 </list>
3516 </t>
3517 </list>
3518 </t>
3519 <t>The mentioned fields above don't have to be in particular order.</t>
3520
3521 <t>Example:</t>
3522 <t>
3523 <list>
3524 <t>C: "GET FX_SEND INFO 0 0"</t>
3525 <t>S: "NAME: Reverb Send"</t>
3526 <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3527 <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3528 <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3529 <t>&nbsp;&nbsp;&nbsp;"."</t>
3530 </list>
3531 </t>
3532 </section>
3533
3534 <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3535 <t>The front-end can alter the current name of an effect
3536 send entity by sending the following command:</t>
3537 <t>
3538 <list>
3539 <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3540 </list>
3541 </t>
3542 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3543 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3544 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3545 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3546 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3547 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3548 &lt;name&gt; is the new name of the effect send entity, which
3549 does not have to be unique (name MUST be encapsulated into apostrophes
3550 and supports escape sequences as described in chapter
3551 "<xref target="character_set">Character Set and Escape Sequences</xref>").
3552 </t>
3553
3554 <t>Possible Answers:</t>
3555 <t>
3556 <list>
3557 <t>"OK" -
3558 <list>
3559 <t>on success</t>
3560 </list>
3561 </t>
3562 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3563 <list>
3564 <t>in case it failed, providing an appropriate error code and error message</t>
3565 </list>
3566 </t>
3567 </list>
3568 </t>
3569 <t>Example:</t>
3570 <t>
3571 <list>
3572 <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3573 <t>S: "OK"</t>
3574 </list>
3575 </t>
3576 </section>
3577
3578 <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3579 <t>The front-end can alter the destination of an effect send's audio channel on a specific
3580 sampler channel by sending the following command:</t>
3581 <t>
3582 <list>
3583 <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>
3584 </list>
3585 </t>
3586 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3587 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3588 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3589 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3590 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3591 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3592 &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3593 which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3594 the audio channel of the selected audio output device where &lt;audio-src&gt;
3595 should be routed to. If an internal send effect is assigned
3596 to the effect send, then this setting defines the audio
3597 channel routing to that effect instance respectively.</t>
3598
3599 <t>Note that effect sends can only route audio to the same audio output
3600 device as assigned to the effect send's sampler channel. Also note that an
3601 effect send entity does always have exactly as much audio channels as its
3602 sampler channel. So if the sampler channel is stereo, the effect send does
3603 have two audio channels as well. Also keep in mind that the amount of audio
3604 channels on a sampler channel might be dependant not only to the deployed
3605 sampler engine on the sampler channel, but also dependant to the instrument
3606 currently loaded. However you can (effectively) turn an i.e. stereo effect
3607 send into a mono one by simply altering its audio routing appropriately.</t>
3608
3609 <t>Possible Answers:</t>
3610 <t>
3611 <list>
3612 <t>"OK" -
3613 <list>
3614 <t>on success</t>
3615 </list>
3616 </t>
3617 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3618 <list>
3619 <t>if audio output channel was set, but there are noteworthy
3620 issue(s) related, providing an appropriate warning code and
3621 warning message</t>
3622 </list>
3623 </t>
3624 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3625 <list>
3626 <t>in case it failed, providing an appropriate error code and error message</t>
3627 </list>
3628 </t>
3629 </list>
3630 </t>
3631 <t>Example:</t>
3632 <t>
3633 <list>
3634 <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3635 <t>S: "OK"</t>
3636 </list>
3637 </t>
3638 </section>
3639
3640 <section title="Assigning destination effect to an effect send" anchor="SET FX_SEND SEND_EFFECT">
3641 <t>The front-end can (re-)assign a destination effect to an
3642 effect send by sending the following command:</t>
3643 <t>
3644 <list>
3645 <t>SET FX_SEND SEND_EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;</t>
3646 </list>
3647 </t>
3648 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3649 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3650 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3651 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3652 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3653 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3654 &lt;effect-chain&gt; by the numerical ID of the destination
3655 effect chain as returned by the
3656 <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
3657 or
3658 <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
3659 command and &lt;chain-pos&gt; reflects the exact effect
3660 chain position in the effect chain which hosts the actual
3661 destination effect.</t>
3662
3663 <t>Possible Answers:</t>
3664 <t>
3665 <list>
3666 <t>"OK" -
3667 <list>
3668 <t>on success</t>
3669 </list>
3670 </t>
3671 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3672 <list>
3673 <t>in case it failed, providing an appropriate error code and error message</t>
3674 </list>
3675 </t>
3676 </list>
3677 </t>
3678 <t>Example:</t>
3679 <t>
3680 <list>
3681 <t>C: "SET FX_SEND SEND_EFFECT 0 0 2 5"</t>
3682 <t>S: "OK"</t>
3683 </list>
3684 </t>
3685 </section>
3686
3687 <section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND SEND_EFFECT">
3688 <t>The front-end can (re-)assign a destination effect to an
3689 effect send by sending the following command:</t>
3690 <t>
3691 <list>
3692 <t>REMOVE FX_SEND SEND_EFFECT &lt;sampler-chan&gt; &lt;fx-send-id&gt;</t>
3693 </list>
3694 </t>
3695 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3696 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3697 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3698 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3699 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3700 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3701
3702 <t>After the destination effect has been removed from the
3703 effect send, the audio signal of the effect send will be
3704 routed directly to the audio output device, according to the
3705 audio channel routing setting of the effect send.
3706 </t>
3707
3708 <t>Possible Answers:</t>
3709 <t>
3710 <list>
3711 <t>"OK" -
3712 <list>
3713 <t>on success</t>
3714 </list>
3715 </t>
3716 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3717 <list>
3718 <t>in case it failed, providing an appropriate error code and error message</t>
3719 </list>
3720 </t>
3721 </list>
3722 </t>
3723 <t>Example:</t>
3724 <t>
3725 <list>
3726 <t>C: "REMOVE FX_SEND SEND_EFFECT 0 0"</t>
3727 <t>S: "OK"</t>
3728 </list>
3729 </t>
3730 </section>
3731
3732 <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3733 <t>The front-end can alter the MIDI controller of an effect
3734 send entity by sending the following command:</t>
3735 <t>
3736 <list>
3737 <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3738 </list>
3739 </t>
3740 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3741 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3742 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3743 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3744 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3745 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3746 &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3747 able to modify the effect send's send level.</t>
3748
3749 <t>Possible Answers:</t>
3750 <t>
3751 <list>
3752 <t>"OK" -
3753 <list>
3754 <t>on success</t>
3755 </list>
3756 </t>
3757 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3758 <list>
3759 <t>if MIDI controller was set, but there are noteworthy
3760 issue(s) related, providing an appropriate warning code and
3761 warning message</t>
3762 </list>
3763 </t>
3764 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3765 <list>
3766 <t>in case it failed, providing an appropriate error code and error message</t>
3767 </list>
3768 </t>
3769 </list>
3770 </t>
3771 <t>Example:</t>
3772 <t>
3773 <list>
3774 <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3775 <t>S: "OK"</t>
3776 </list>
3777 </t>
3778 </section>
3779
3780 <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3781 <t>The front-end can alter the current send level of an effect
3782 send entity by sending the following command:</t>
3783 <t>
3784 <list>
3785 <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3786 </list>
3787 </t>
3788 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3789 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3790 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3791 &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3792 as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3793 or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3794 &lt;volume&gt; is an optionally dotted positive number (a value
3795 smaller than 1.0 means attenuation, whereas a value greater than
3796 1.0 means amplification) reflecting the new send level.</t>
3797
3798 <t>Possible Answers:</t>
3799 <t>
3800 <list>
3801 <t>"OK" -
3802 <list>
3803 <t>on success</t>
3804 </list>
3805 </t>
3806 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3807 <list>
3808 <t>if new send level was set, but there are noteworthy
3809 issue(s) related, providing an appropriate warning code and
3810 warning message</t>
3811 </list>
3812 </t>
3813 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3814 <list>
3815 <t>in case it failed, providing an appropriate error code and error message</t>
3816 </list>
3817 </t>
3818 </list>
3819 </t>
3820 <t>Example:</t>
3821 <t>
3822 <list>
3823 <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3824 <t>S: "OK"</t>
3825 </list>
3826 </t>
3827 </section>
3828
3829 <section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA">
3830 <t>The front-end can send MIDI events to a specific sampler channel
3831 by sending the following command:</t>
3832 <t>
3833 <list>
3834 <t>SEND CHANNEL MIDI_DATA &lt;midi-msg&gt; &lt;sampler-chan&gt; &lt;arg1&gt; &lt;arg2&gt;</t>
3835 </list>
3836 </t>
3837 <t>Where &lt;sampler-chan&gt; is the sampler channel number
3838 as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3839 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3840 &lt;arg1&gt; and &lt;arg2&gt; arguments depend on the &lt;midi-msg&gt; argument, which
3841 specifies the MIDI message type. Currently, the following MIDI messages are supported:</t>
3842 <t>
3843 <list>
3844 <t>"NOTE_ON" -
3845 <list>
3846 <t>For turning on MIDI notes, where &lt;arg1&gt;
3847 specifies the key number and &lt;arg2&gt; the velocity
3848 as described in the MIDI specification.</t>
3849 </list>
3850 </t>
3851 <t>"NOTE_OFF" -
3852 <list>
3853 <t>For turning a currently playing MIDI note off, where &lt;arg1&gt;
3854 specifies the key number and &lt;arg2&gt; the velocity
3855 as described in the MIDI specification.</t>
3856 </list>
3857 </t>
3858 <t>"CC" -
3859 <list>
3860 <t>For changing a MIDI controller, where &lt;arg1&gt;
3861 specifies the controller number and &lt;arg2&gt; the
3862 new value of the controller as described in the Control
3863 Change section of the MIDI specification.</t>
3864 </list>
3865 </t>
3866 </list>
3867 </t>
3868 <t>CAUTION: This command is provided for implementations of virtual MIDI keyboards
3869 and no realtime guarantee whatsoever will be made!</t>
3870 <t>Possible Answers:</t>
3871 <t>
3872 <list>
3873 <t>"OK" -
3874 <list>
3875 <t>on success</t>
3876 </list>
3877 </t>
3878 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3879 <list>
3880 <t>in case it failed, providing an appropriate error code and error message</t>
3881 </list>
3882 </t>
3883 </list>
3884 </t>
3885 <t>Example:</t>
3886 <t>
3887 <list>
3888 <t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t>
3889 <t>S: "OK"</t>
3890 </list>
3891 </t>
3892 </section>
3893
3894 <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3895 <t>The front-end can reset a particular sampler channel by sending the following command:</t>
3896 <t>
3897 <list>
3898 <t>RESET CHANNEL &lt;sampler-channel&gt;</t>
3899 </list>
3900 </t>
3901 <t>
3902 Where &lt;sampler-channel&gt; defines the sampler channel to be reset.
3903 This will cause the engine on that sampler channel, its voices and
3904 eventually disk streams and all control and status variables to be
3905 reset.</t>
3906
3907 <t>Possible Answers:</t>
3908 <t>
3909 <list>
3910 <t>"OK" -
3911 <list>
3912 <t>on success</t>
3913 </list>
3914 </t>
3915 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3916 <list>
3917 <t>if channel was reset, but there are noteworthy issue(s)
3918 related, providing an appropriate warning code and warning
3919 message</t>
3920 </list>
3921 </t>
3922 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3923 <list>
3924 <t>in case it failed, providing an appropriate error code and
3925 error message</t>
3926 </list>
3927 </t>
3928 </list>
3929 </t>
3930 <t>Examples:</t>
3931 <t>
3932 <list>
3933 <t></t>
3934 </list>
3935 </t>
3936 </section>
3937 </section>
3938
3939 <section title="Controlling connection">
3940 <t>The following commands are used to control the connection to LinuxSampler.</t>
3941
3942 <section title="Register front-end for receiving event messages" anchor="SUBSCRIBE">
3943 <t>The front-end can register itself to the LinuxSampler application to
3944 be informed about noteworthy events by sending this command:</t>
3945 <t>
3946 <list>
3947 <t>SUBSCRIBE &lt;event-id&gt;</t>
3948 </list>
3949 </t>
3950 <t>where &lt;event-id&gt; will be replaced by the respective event that
3951 client wants to subscribe to.</t>
3952
3953 <t>Possible Answers:</t>
3954 <t>
3955 <list>
3956 <t>"OK" -
3957 <list>
3958 <t>on success</t>
3959 </list>
3960 </t>
3961 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3962 <list>
3963 <t>if registration succeeded, but there are noteworthy
3964 issue(s) related, providing an appropriate warning code and
3965 warning message</t>
3966 </list>
3967 </t>
3968 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3969 <list>
3970 <t>in case it failed, providing an appropriate error code and
3971 error message</t>
3972 </list>
3973 </t>
3974 </list>
3975 </t>
3976 <t>Examples:</t>
3977 <t>
3978 <list>
3979 <t></t>
3980 </list>
3981 </t>
3982 </section>
3983
3984 <section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE">
3985 <t>The front-end can unregister itself if it doesn't want to receive event
3986 messages anymore by sending the following command:</t>
3987 <t>
3988 <list>
3989 <t>UNSUBSCRIBE &lt;event-id&gt;</t>
3990 </list>
3991 </t>
3992 <t>Where &lt;event-id&gt; will be replaced by the respective event that
3993 client doesn't want to receive anymore.</t>
3994
3995 <t>Possible Answers:</t>
3996 <t>
3997 <list>
3998 <t>"OK" -
3999 <list>
4000 <t>on success</t>
4001 </list>
4002 </t>
4003 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4004 <list>
4005 <t>if unregistration succeeded, but there are noteworthy
4006 issue(s) related, providing an appropriate warning code and
4007 warning message</t>
4008 </list>
4009 </t>
4010 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4011 <list>
4012 <t>in case it failed, providing an appropriate error code and
4013 error message</t>
4014 </list>
4015 </t>
4016 </list>
4017 </t>
4018 <t>Examples:</t>
4019 <t>
4020 <list>
4021 <t></t>
4022 </list>
4023 </t>
4024 </section>
4025
4026 <section title="Enable or disable echo of commands" anchor="SET ECHO">
4027 <t>To enable or disable back sending of commands to the client the following command can be used:</t>
4028 <t>
4029 <list>
4030 <t>SET ECHO &lt;value&gt;</t>
4031 </list>
4032 </t>
4033 <t>Where &lt;value&gt; should be replaced either by "1" to enable echo mode
4034 or "0" to disable echo mode. When echo mode is enabled, all
4035 commands send to LinuxSampler will be immediately send back and
4036 after this echo the actual response to the command will be
4037 returned. Echo mode will only be altered for the client connection
4038 that issued the "SET ECHO" command, not globally for all client
4039 connections.</t>
4040
4041 <t>Possible Answers:</t>
4042 <t>
4043 <list>
4044 <t>"OK" -
4045 <list>
4046 <t>usually</t>
4047 </list>
4048 </t>
4049 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4050 <list>
4051 <t>on syntax error, e.g. non boolean value</t>
4052 </list>
4053 </t>
4054 </list>
4055 </t>
4056 <t>Examples:</t>
4057 <t>
4058 <list>
4059 <t></t>
4060 </list>
4061 </t>
4062 </section>
4063
4064 <section title="Close client connection" anchor="QUIT">
4065 <t>The client can close its network connection to LinuxSampler by sending the following command:</t>
4066 <t>
4067 <list>
4068 <t>QUIT</t>
4069 </list>
4070 </t>
4071 <t>This is probably more interesting for manual telnet connections to
4072 LinuxSampler than really useful for a front-end implementation.</t>
4073 </section>
4074 </section>
4075
4076 <section title="Global commands">
4077 <t>The following commands have global impact on the sampler.</t>
4078
4079 <section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT">
4080 <t>The front-end can ask for the current number of active voices on
4081 the sampler by sending the following command:</t>
4082 <t>
4083 <list>
4084 <t>GET TOTAL_VOICE_COUNT</t>
4085 </list>
4086 </t>
4087
4088 <t>Possible Answers:</t>
4089 <t>
4090 <list>
4091 <t>LinuxSampler will answer by returning the number of all active
4092 voices on the sampler.</t>
4093 </list>
4094 </t>
4095 </section>
4096
4097 <section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX">
4098 <t>The front-end can ask for the maximum number of active voices
4099 by sending the following command:</t>
4100 <t>
4101 <list>
4102 <t>GET TOTAL_VOICE_COUNT_MAX</t>
4103 </list>
4104 </t>
4105
4106 <t>Possible Answers:</t>
4107 <t>
4108 <list>
4109 <t>LinuxSampler will answer by returning the maximum number
4110 of active voices.</t>
4111 </list>
4112 </t>
4113 </section>
4114
4115 <section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT">
4116 <t>The front-end can ask for the current number of active disk streams on
4117 the sampler by sending the following command:</t>
4118 <t>
4119 <list>
4120 <t>GET TOTAL_STREAM_COUNT</t>
4121 </list>
4122 </t>
4123
4124 <t>Possible Answers:</t>
4125 <t>
4126 <list>
4127 <t>LinuxSampler will answer by returning the number of all active
4128 disk streams on the sampler.</t>
4129 </list>
4130 </t>
4131 </section>
4132
4133 <section title="Reset sampler" anchor="RESET">
4134 <t>The front-end can reset the whole sampler by sending the following command:</t>
4135 <t>
4136 <list>
4137 <t>RESET</t>
4138 </list>
4139 </t>
4140
4141 <t>Possible Answers:</t>
4142 <t>
4143 <list>
4144 <t>"OK" -
4145 <list>
4146 <t>always</t>
4147 </list>
4148 </t>
4149 </list>
4150 </t>
4151 <t>Examples:</t>
4152 <t>
4153 <list>
4154 <t></t>
4155 </list>
4156 </t>
4157 </section>
4158
4159 <section title="General sampler informations" anchor="GET SERVER INFO">
4160 <t>The client can ask for general informations about the LinuxSampler
4161 instance by sending the following command:</t>
4162 <t>
4163 <list>
4164 <t>GET SERVER INFO</t>
4165 </list>
4166 </t>
4167 <t>Possible Answers:</t>
4168 <t>
4169 <list>
4170 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4171 Each answer line begins with the information category name
4172 followed by a colon and then a space character &lt;SP&gt; and finally
4173 the info character string to that information category. At the
4174 moment the following categories are defined:
4175 </t>
4176 <t>
4177 <list>
4178 <t>DESCRIPTION -
4179 <list>
4180 <t>arbitrary textual description about the sampler
4181 (note that the character string may contain
4182 <xref target="character_set">escape sequences</xref>)</t>
4183 </list>
4184 </t>
4185 <t>VERSION -
4186 <list>
4187 <t>version of the sampler</t>
4188 </list>
4189 </t>
4190 <t>PROTOCOL_VERSION -
4191 <list>
4192 <t>version of the LSCP specification the sampler
4193 complies with (see <xref target="LSCP versioning" /> for details)</t>
4194 </list>
4195 </t>
4196 <t>INSTRUMENTS_DB_SUPPORT -
4197 <list>
4198 <t>either yes or no, specifies whether the
4199 sampler is build with instruments database support.</t>
4200 </list>
4201 </t>
4202 </list>
4203 </t>
4204 </list>
4205 </t>
4206 <t>The mentioned fields above don't have to be in particular order.
4207 Other fields might be added in future.</t>
4208 </section>
4209
4210 <section title="Getting global volume attenuation" anchor="GET VOLUME">
4211 <t>The client can ask for the current global sampler-wide volume
4212 attenuation by sending the following command:</t>
4213 <t>
4214 <list>
4215 <t>GET VOLUME</t>
4216 </list>
4217 </t>
4218 <t>Possible Answers:</t>
4219 <t>
4220 <list>
4221 <t>The sampler will always answer by returning the optional
4222 dotted floating point coefficient, reflecting the current
4223 global volume attenuation.
4224 </t>
4225 </list>
4226 </t>
4227 <t>Note: it is up to the respective sampler engine whether to obey
4228 that global volume parameter or not, but in general all engines SHOULD
4229 use this parameter.</t>
4230 </section>
4231
4232 <section title="Setting global volume attenuation" anchor="SET VOLUME">
4233 <t>The client can alter the current global sampler-wide volume
4234 attenuation by sending the following command:</t>
4235 <t>
4236 <list>
4237 <t>SET VOLUME &lt;volume&gt;</t>
4238 </list>
4239 </t>
4240 <t>Where &lt;volume&gt; should be replaced by the optional dotted
4241 floating point value, reflecting the new global volume parameter.
4242 This value might usually be in the range between 0.0 and 1.0, that
4243 is for attenuating the overall volume.</t>
4244
4245 <t>Possible Answers:</t>
4246 <t>
4247 <list>
4248 <t>"OK" -
4249 <list>
4250 <t>on success</t>
4251 </list>
4252 </t>
4253 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4254 <list>
4255 <t>if the global volume was set, but there are noteworthy
4256 issue(s) related, providing an appropriate warning code and
4257 warning message</t>
4258 </list>
4259 </t>
4260 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4261 <list>
4262 <t>in case it failed, providing an appropriate error code and error message</t>
4263 </list>
4264 </t>
4265 </list>
4266 </t>
4267 </section>
4268
4269 <section title="Getting global voice limit" anchor="GET VOICES">
4270 <t>The client can ask for the current global sampler-wide limit
4271 for maximum voices by sending the following command:</t>
4272 <t>
4273 <list>
4274 <t>GET VOICES</t>
4275 </list>
4276 </t>
4277 <t>Possible Answers:</t>
4278 <t>
4279 <list>
4280 <t>LinuxSampler will answer by returning the number for
4281 the current limit of maximum voices.</t>
4282 </list>
4283 </t>
4284
4285 <t>The voice limit setting defines how many voices should maximum
4286 be processed by the sampler at the same time. If the user
4287 triggers new notes which would exceed that voice limit, the
4288 sampler engine will react by stealing old voices for those
4289 newly triggered notes. Note that the amount of voices triggered
4290 by a new note can be larger than one and is dependent to the
4291 respective instrument and probably further criterias.</t>
4292 </section>
4293
4294 <section title="Setting global voice limit" anchor="SET VOICES">
4295 <t>The client can alter the current global sampler-wide limit
4296 for maximum voices by sending the following command:</t>
4297 <t>
4298 <list>
4299 <t>SET VOICES &lt;max-voices&gt;</t>
4300 </list>
4301 </t>
4302 <t>Where &lt;max-voices&gt; should be replaced by the integer
4303 value, reflecting the new global amount limit of maximum voices.
4304 This value has to be larger than 0.</t>
4305
4306 <t>Possible Answers:</t>
4307 <t>
4308 <list>
4309 <t>"OK" -
4310 <list>
4311 <t>on success</t>
4312 </list>
4313 </t>
4314 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4315 <list>
4316 <t>if the voice limit was set, but there are noteworthy
4317 issue(s) related, providing an appropriate warning code and
4318 warning message</t>
4319 </list>
4320 </t>
4321 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4322 <list>
4323 <t>in case it failed, providing an appropriate error code and error message</t>
4324 </list>
4325 </t>
4326 </list>
4327 </t>
4328
4329 <t>Note: the given value will be passed to all sampler engine instances.
4330 The total amount of maximum voices on the running system might thus
4331 be as big as the given value multiplied by the current amount of engine
4332 instances.</t>
4333
4334 <t>Caution: when adjusting the voice limit, you SHOULD also
4335 adjust the disk stream limit respectively and vice versa.</t>
4336 </section>
4337
4338 <section title="Getting global disk stream limit" anchor="GET STREAMS">
4339 <t>The client can ask for the current global sampler-wide limit
4340 for maximum disk streams by sending the following command:</t>
4341 <t>
4342 <list>
4343 <t>GET STREAMS</t>
4344 </list>
4345 </t>
4346 <t>Possible Answers:</t>
4347 <t>
4348 <list>
4349 <t>LinuxSampler will answer by returning the number for
4350 the current limit of maximum disk streams.</t>
4351 </list>
4352 </t>
4353
4354 <t>The disk stream limit setting defines how many disk streams should
4355 maximum be processed by a sampler engine at the same time. The
4356 higher this value, the more memory (RAM) will be occupied, since
4357 every disk streams allocates a certain buffer size for being able
4358 to perform its streaming operations.</t>
4359 </section>
4360
4361 <section title="Setting global disk stream limit" anchor="SET STREAMS">
4362 <t>The client can alter the current global sampler-wide limit
4363 for maximum disk streams by sending the following command:</t>
4364 <t>
4365 <list>
4366 <t>SET STREAMS &lt;max-streams&gt;</t>
4367 </list>
4368 </t>
4369 <t>Where &lt;max-streams&gt; should be replaced by the integer
4370 value, reflecting the new global amount limit of maximum disk streams.
4371 This value has to be positive.</t>
4372
4373 <t>Possible Answers:</t>
4374 <t>
4375 <list>
4376 <t>"OK" -
4377 <list>
4378 <t>on success</t>
4379 </list>
4380 </t>
4381 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4382 <list>
4383 <t>if the disk stream limit was set, but there are noteworthy
4384 issue(s) related, providing an appropriate warning code and
4385 warning message</t>
4386 </list>
4387 </t>
4388 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4389 <list>
4390 <t>in case it failed, providing an appropriate error code and error message</t>
4391 </list>
4392 </t>
4393 </list>
4394 </t>
4395
4396 <t>Note: the given value will be passed to all sampler engine instances.
4397 The total amount of maximum disk streams on the running system might
4398 thus be as big as the given value multiplied by the current amount of
4399 engine instances.</t>
4400
4401 <t>Caution: when adjusting the disk stream limit, you SHOULD also
4402 adjust the voice limit respectively and vice versa.</t>
4403 </section>
4404
4405 </section>
4406
4407
4408 <section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping">
4409 <t>The MIDI protocol provides a way to switch between instruments
4410 by sending so called MIDI bank select and MIDI program change
4411 messages which are essentially just numbers. The following commands
4412 allow to actually map arbitrary MIDI bank select / program change
4413 numbers with real instruments.</t>
4414 <t>The sampler allows to manage an arbitrary amount of MIDI
4415 instrument maps which define which instrument to load on
4416 which MIDI program change message.</t>
4417 <t>By default, that is when the sampler is launched, there is no
4418 map, thus the sampler will simply ignore all program change
4419 messages. The front-end has to explicitly create at least one
4420 map, add entries to the map and tell the respective sampler
4421 channel(s) which MIDI instrument map to use, so the sampler
4422 knows how to react on a given program change message on the
4423 respective sampler channel, that is by switching to the
4424 respectively defined engine type and loading the respective
4425 instrument. See command
4426 <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
4427 for how to assign a MIDI instrument map to a sampler channel.</t>
4428 <t>Also note per MIDI specification a bank select message does not
4429 cause to switch to another instrument. Instead when receiving a
4430 bank select message the bank value will be stored and a subsequent
4431 program change message (which may occur at any time) will finally
4432 cause the sampler to switch to the respective instrument as
4433 reflected by the current MIDI instrument map.</t>
4434
4435 <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP">
4436 <t>The front-end can add a new MIDI instrument map by sending
4437 the following command:</t>
4438 <t>
4439 <list>
4440 <t>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]</t>
4441 </list>
4442 </t>
4443 <t>Where &lt;name&gt; is an optional argument allowing to
4444 assign a custom name to the new map. MIDI instrument Map
4445 names do not have to be unique, but MUST be encapsulated
4446 into apostrophes and support escape sequences as described
4447 in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>".
4448 </t>
4449
4450 <t>Possible Answers:</t>
4451 <t>
4452 <list>
4453 <t>"OK[&lt;map&gt;]" -
4454 <list>
4455 <t>in case a new MIDI instrument map could
4456 be added, where &lt;map&gt; reflects the
4457 unique ID of the newly created MIDI
4458 instrument map</t>
4459 </list>
4460 </t>
4461 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4462 <list>
4463 <t>when a new map could not be created, which
4464 might never occur in practice</t>
4465 </list>
4466 </t>
4467 </list>
4468 </t>
4469
4470 <t>Examples:</t>
4471 <t>
4472 <list>
4473 <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t>
4474 <t>S: "OK[0]"</t>
4475 </list>
4476 </t>
4477 <t>
4478 <list>
4479 <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t>
4480 <t>S: "OK[1]"</t>
4481 </list>
4482 </t>
4483 <t>
4484 <list>
4485 <t>C: "ADD MIDI_INSTRUMENT_MAP"</t>
4486 <t>S: "OK[5]"</t>
4487 </list>
4488 </t>
4489 </section>
4490
4491 <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">
4492 <t>The front-end can delete a particular MIDI instrument map
4493 by sending the following command:</t>
4494 <t>
4495 <list>
4496 <t>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;</t>
4497 </list>
4498 </t>
4499 <t>Where &lt;map&gt; reflects the unique ID of the map to delete
4500 as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4501 command.</t>
4502 <t>The front-end can delete all MIDI instrument maps by
4503 sending the following command:</t>
4504 <t>
4505 <list>
4506 <t>REMOVE MIDI_INSTRUMENT_MAP ALL</t>
4507 </list>
4508 </t>
4509
4510 <t>Possible Answers:</t>
4511 <t>
4512 <list>
4513 <t>"OK" -
4514 <list>
4515 <t>in case the map(s) could be deleted</t>
4516 </list>
4517 </t>
4518 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4519 <list>
4520 <t>when the given map does not exist</t>
4521 </list>
4522 </t>
4523 </list>
4524 </t>
4525
4526 <t>Examples:</t>
4527 <t>
4528 <list>
4529 <t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t>
4530 <t>S: "OK"</t>
4531 </list>
4532 </t>
4533 <t>
4534 <list>
4535 <t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t>
4536 <t>S: "OK"</t>
4537 </list>
4538 </t>
4539 </section>
4540
4541 <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">
4542 <t>The front-end can retrieve the current amount of MIDI
4543 instrument maps by sending the following command:</t>
4544 <t>
4545 <list>
4546 <t>GET MIDI_INSTRUMENT_MAPS</t>
4547 </list>
4548 </t>
4549
4550 <t>Possible Answers:</t>
4551 <t>
4552 <list>
4553 <t>The sampler will answer by returning the current
4554 number of MIDI instrument maps.</t>
4555 </list>
4556 </t>
4557
4558 <t>Example:</t>
4559 <t>
4560 <list>
4561 <t>C: "GET MIDI_INSTRUMENT_MAPS"</t>
4562 <t>S: "2"</t>
4563 </list>
4564 </t>
4565 </section>
4566
4567 <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">
4568 <t>The number of MIDI instrument maps can change on runtime. To get the
4569 current list of MIDI instrument maps, the front-end can send the
4570 following command:</t>
4571 <t>
4572 <list>
4573 <t>LIST MIDI_INSTRUMENT_MAPS</t>
4574 </list>
4575 </t>
4576 <t>Possible Answers:</t>
4577 <t>
4578 <list>
4579 <t>The sampler will answer by returning a comma separated list
4580 with all MIDI instrument maps' numerical IDs.</t>
4581 </list>
4582 </t>
4583 <t>Example:</t>
4584 <t>
4585 <list>
4586 <t>C: "LIST MIDI_INSTRUMENT_MAPS"</t>
4587 <t>S: "0,1,5,12"</t>
4588 </list>
4589 </t>
4590 </section>
4591
4592 <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">
4593 <t>The front-end can ask for the current settings of a MIDI
4594 instrument map by sending the following command:</t>
4595 <t>
4596 <list>
4597 <t>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;</t>
4598 </list>
4599 </t>
4600 <t>Where &lt;map&gt; is the numerical ID of the map the
4601 front-end is interested in as returned by the
4602 <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4603 command.</t>
4604
4605 <t>Possible Answers:</t>
4606 <t>
4607 <list>
4608 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4609 Each answer line begins with the settings category name
4610 followed by a colon and then a space character &lt;SP&gt; and finally
4611 the info character string to that setting category. At the
4612 moment the following categories are defined:</t>
4613
4614 <t>
4615 <list>
4616 <t>NAME -
4617 <list>
4618 <t>custom name of the given map,
4619 which does not have to be unique
4620 (note that this character string may contain
4621 <xref target="character_set">escape sequences</xref>)</t>
4622 </list>
4623 </t>
4624 <t>DEFAULT -
4625 <list>
4626 <t>either true or false,
4627 defines whether this map is the default map</t>
4628 </list>
4629 </t>
4630 </list>
4631 </t>
4632 </list>
4633 </t>
4634 <t>The mentioned fields above don't have to be in particular order.</t>
4635
4636 <t>Example:</t>
4637 <t>
4638 <list>
4639 <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4640 <t>S: "NAME: Standard Map"</t>
4641 <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4642 <t>&nbsp;&nbsp;&nbsp;"."</t>
4643 </list>
4644 </t>
4645 </section>
4646
4647 <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">
4648 <t>The front-end can alter the custom name of a MIDI
4649 instrument map by sending the following command:</t>
4650 <t>
4651 <list>
4652 <t>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;</t>
4653 </list>
4654 </t>
4655 <t>Where &lt;map&gt; is the numerical ID of the map and
4656 &lt;name&gt; the new custom name of the map, which does not
4657 have to be unique (name MUST be encapsulated into apostrophes
4658 and supports escape sequences as described in chapter
4659 "<xref target="character_set">Character Set and Escape Sequences</xref>").
4660 </t>
4661
4662 <t>Possible Answers:</t>
4663 <t>
4664 <list>
4665 <t>"OK" -
4666 <list>
4667 <t>on success</t>
4668 </list>
4669 </t>
4670 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4671 <list>
4672 <t>in case the given map does not exist</t>
4673 </list>
4674 </t>
4675 </list>
4676 </t>
4677
4678 <t>Example:</t>
4679 <t>
4680 <list>
4681 <t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t>
4682 <t>S: "OK"</t>
4683 </list>
4684 </t>
4685 </section>
4686
4687 <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
4688 <t>The front-end can create a new or replace an existing entry
4689 in a sampler's MIDI instrument map by sending the following
4690 command:</t>
4691 <t>
4692 <list>
4693 <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4694 &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4695 &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4696 [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
4697 </list>
4698 </t>
4699 <t>Where &lt;map&gt; is the numeric ID of the map to alter,
4700 &lt;midi_bank&gt; is an integer value between
4701 0..16383 reflecting the MIDI bank select index,
4702 &lt;midi_prog&gt; an
4703 integer value between 0..127 reflecting the MIDI program change
4704 index, &lt;engine_name&gt; a sampler engine name as returned by
4705 the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4706 command (not encapsulated into apostrophes), &lt;filename&gt; the name
4707 of the instrument's file to be deployed (encapsulated into apostrophes,
4708 supporting escape sequences as described in chapter
4709 "<xref target="character_set">Character Set and Escape Sequences</xref>"),
4710 &lt;instrument_index&gt; the index (integer value) of the instrument
4711 within the given file, &lt;volume_value&gt; reflects the master
4712 volume of the instrument as optionally dotted number (where a
4713 value &lt; 1.0 means attenuation and a value > 1.0 means
4714 amplification). This parameter easily allows to adjust the
4715 volume of all intruments within a custom instrument map
4716 without having to adjust their instrument files. The
4717 OPTIONAL &lt;instr_load_mode&gt; argument defines the life
4718 time of the instrument, that is when the instrument should
4719 be loaded, when freed and has exactly the following
4720 possibilities:</t>
4721 <t>
4722 <list>
4723 <t>"ON_DEMAND" -
4724 <list>
4725 <t>The instrument will be loaded when needed,
4726 that is when demanded by at least one sampler
4727 channel. It will immediately be freed from memory
4728 when not needed by any sampler channel anymore.</t>
4729 </list>
4730 </t>
4731 <t>"ON_DEMAND_HOLD" -
4732 <list>
4733 <t>The instrument will be loaded when needed,
4734 that is when demanded by at least one sampler
4735 channel. It will be kept in memory even when
4736 not needed by any sampler channel anymore.
4737 Instruments with this mode are only freed
4738 when the sampler is reset or all mapping
4739 entries with this mode (and respective
4740 instrument) are explicitly changed to
4741 "ON_DEMAND" and no sampler channel is using
4742 the instrument anymore.</t>
4743 </list>
4744 </t>
4745 <t>"PERSISTENT" -
4746 <list>
4747 <t>The instrument will immediately be loaded
4748 into memory when this mapping
4749 command is sent and the instrument is kept all
4750 the time. Instruments with this mode are
4751 only freed when the sampler is reset or all
4752 mapping entries with this mode (and
4753 respective instrument) are explicitly
4754 changed to "ON_DEMAND" and no sampler
4755 channel is using the instrument anymore.</t>
4756 </list>
4757 </t>
4758 <t>not supplied -
4759 <list>
4760 <t>In case there is no &lt;instr_load_mode&gt;
4761 argument given, it will be up to the
4762 InstrumentManager to decide which mode to use.
4763 Usually it will use "ON_DEMAND" if an entry
4764 for the given instrument does not exist in
4765 the InstrumentManager's list yet, otherwise
4766 if an entry already exists, it will simply
4767 stick with the mode currently reflected by
4768 the already existing entry, that is it will
4769 not change the mode.</t>
4770 </list>
4771 </t>
4772 </list>
4773 </t>
4774 <t>
4775 The &lt;instr_load_mode&gt; argument thus allows to define an
4776 appropriate strategy (low memory consumption vs. fast
4777 instrument switching) for each instrument individually. Note, the
4778 following restrictions apply to this argument: "ON_DEMAND_HOLD" and
4779 "PERSISTENT" have to be supported by the respective sampler engine
4780 (which is technically the case when the engine provides an
4781 InstrumentManager for its format). If this is not the case the
4782 argument will automatically fall back to the default value
4783 "ON_DEMAND". Also the load mode of one instrument may
4784 automatically change the laod mode of other instrument(s), i.e.
4785 because the instruments are part of the same file and the
4786 engine does not allow a way to manage load modes for them
4787 individually. Due to this, in case the frontend shows the
4788 load modes of entries, the frontend should retrieve the actual
4789 mode by i.e. sending
4790 <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4791 command(s). Finally the OPTIONAL &lt;name&gt; argument allows to set a custom name
4792 (encapsulated into apostrophes, supporting escape sequences as described in chapter
4793 "<xref target="character_set">Character Set and Escape Sequences</xref>") for the
4794 mapping entry, useful for frontends for displaying an appropriate name for
4795 mapped instruments (using
4796 <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4797 </t>
4798 <t>
4799 By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4800 completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4801 however causes the respective "MAP MIDI_INSTRUMENT" command to return
4802 immediately, that is to let the sampler establish the mapping in the
4803 background. So this argument might be especially useful for mappings with
4804 a "PERSISTENT" type, because these have to load the respective instruments
4805 immediately and might thus block for a very long time. It is recommended
4806 however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4807 because it has the following drawbacks: as "NON_MODAL" instructions return
4808 immediately, they may not necessarily return an error i.e. when the given
4809 instrument file turns out to be corrupt, beside that subsequent commands
4810 in a LSCP instruction sequence might fail, because mandatory mappings are
4811 not yet completed.
4812 </t>
4813
4814 <t>Possible Answers:</t>
4815 <t>
4816 <list>
4817 <t>"OK" -
4818 <list>
4819 <t>usually</t>
4820 </list>
4821 </t>
4822 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4823 <list>
4824 <t>when the given map or engine does not exist or a value
4825 is out of range</t>
4826 </list>
4827 </t>
4828 </list>
4829 </t>
4830
4831 <t>Examples:</t>
4832 <t>
4833 <list>
4834 <t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
4835 <t>S: "OK"</t>
4836 </list>
4837 </t>
4838 <t>
4839 <list>
4840 <t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
4841 <t>S: "OK"</t>
4842 </list>
4843 </t>
4844 <t>
4845 <list>
4846 <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
4847 <t>S: "OK"</t>
4848 <t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
4849 <t>S: "OK"</t>
4850 </list>
4851 </t>
4852 <t>
4853 <list>
4854 <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4855 <t>S: "OK"</t>
4856 </list>
4857 </t>
4858 </section>
4859
4860 <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
4861 <t>The front-end can query the amount of currently existing
4862 entries in a MIDI instrument map by sending the following
4863 command:</t>
4864 <t>
4865 <list>
4866 <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
4867 </list>
4868 </t>
4869 <t>The front-end can query the amount of currently existing
4870 entries in all MIDI instrument maps by sending the following
4871 command:</t>
4872 <t>
4873 <list>
4874 <t>GET MIDI_INSTRUMENTS ALL</t>
4875 </list>
4876 </t>
4877 <t>Possible Answers:</t>
4878 <t>
4879 <list>
4880 <t>The sampler will answer by sending the current number of
4881 entries in the MIDI instrument map(s).</t>
4882 </list>
4883 </t>
4884
4885 <t>Example:</t>
4886 <t>
4887 <list>
4888 <t>C: "GET MIDI_INSTRUMENTS 0"</t>
4889 <t>S: "234"</t>
4890 </list>
4891 </t>
4892 <t>
4893 <list>
4894 <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
4895 <t>S: "954"</t>
4896 </list>
4897 </t>
4898 </section>
4899
4900 <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">
4901 <t>The front-end can query a list of all currently existing
4902 entries in a certain MIDI instrument map by sending the following
4903 command:</t>
4904 <t>
4905 <list>
4906 <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
4907 </list>
4908 </t>
4909 <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
4910 <t>The front-end can query a list of all currently existing
4911 entries of all MIDI instrument maps by sending the following
4912 command:</t>
4913 <t>
4914 <list>
4915 <t>LIST MIDI_INSTRUMENTS ALL</t>
4916 </list>
4917 </t>
4918
4919 <t>Possible Answers:</t>
4920 <t>
4921 <list>
4922 <t>The sampler will answer by sending a comma separated
4923 list of map ID - MIDI bank - MIDI program triples, where
4924 each triple is encapsulated into curly braces. The
4925 list is returned in one single line. Each triple
4926 just reflects the key of the respective map entry,
4927 thus subsequent
4928 <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4929 command(s) are necessary to retrieve detailed informations
4930 about each entry.</t>
4931 </list>
4932 </t>
4933
4934 <t>Example:</t>
4935 <t>
4936 <list>
4937 <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
4938 <t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t>
4939 </list>
4940 </t>
4941 </section>
4942
4943 <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
4944 <t>The front-end can delete an entry from a MIDI instrument
4945 map by sending the following command:</t>
4946 <t>
4947 <list>
4948 <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4949 </list>
4950 </t>
4951 <t>
4952 Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4953 &lt;midi_bank&gt; is an integer value between 0..16383
4954 reflecting the MIDI bank value and
4955 &lt;midi_prog&gt; an integer value between
4956 0..127 reflecting the MIDI program value of the map's entrie's key
4957 index triple.
4958 </t>
4959
4960 <t>Possible Answers:</t>
4961 <t>
4962 <list>
4963 <t>"OK" -
4964 <list>
4965 <t>usually</t>
4966 </list>
4967 </t>
4968 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4969 <list>
4970 <t>when index out of bounds</t>
4971 </list>
4972 </t>
4973 </list>
4974 </t>
4975
4976 <t>Example:</t>
4977 <t>
4978 <list>
4979 <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
4980 <t>S: "OK"</t>
4981 </list>
4982 </t>
4983 </section>
4984
4985 <section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO">
4986 <t>The front-end can retrieve the current settings of a certain
4987 instrument map entry by sending the following command:</t>
4988 <t>
4989 <list>
4990 <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4991 </list>
4992 </t>
4993 <t>
4994 Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4995 &lt;midi_bank&gt; is an integer value between 0..16383
4996 reflecting the MIDI bank value, &lt;midi_bank&gt;
4997 and &lt;midi_prog&gt; an integer value between
4998 0..127 reflecting the MIDI program value of the map's entrie's key
4999 index triple.
5000 </t>
5001
5002 <t>Possible Answers:</t>
5003 <t>
5004 <list>
5005 <t>LinuxSampler will answer by sending a &lt;CRLF&gt;
5006 separated list. Each answer line begins with the
5007 information category name followed by a colon and then
5008 a space character &lt;SP&gt; and finally the info
5009 character string to that info category. At the moment
5010 the following categories are defined:</t>
5011 <t>"NAME" -
5012 <list>
5013 <t>Name for this MIDI instrument map entry (if defined).
5014 This name shall be used by frontends for displaying a
5015 name for this mapped instrument. It can be set and
5016 changed with the
5017 <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref>
5018 command and does not have to be unique.
5019 (note that this character string may contain
5020 <xref target="character_set">escape sequences</xref>)</t>
5021 </list>
5022 </t>
5023 <t>"ENGINE_NAME" -
5024 <list>
5025 <t>Name of the engine to be deployed for this
5026 instrument.</t>
5027 </list>
5028 </t>
5029 <t>"INSTRUMENT_FILE" -
5030 <list>
5031 <t>File name of the instrument
5032 (note that this path may contain
5033 <xref target="character_set">escape sequences</xref>).</t>
5034 </list>
5035 </t>
5036 <t>"INSTRUMENT_NR" -
5037 <list>
5038 <t>Index of the instrument within the file.</t>
5039 </list>
5040 </t>
5041 <t>"INSTRUMENT_NAME" -
5042 <list>
5043 <t>Name of the loaded instrument as reflected by its file.
5044 In contrast to the "NAME" field, the "INSTRUMENT_NAME" field
5045 cannot be changed (note that this character string may contain
5046 <xref target="character_set">escape sequences</xref>).</t>
5047 </list>
5048 </t>
5049 <t>"LOAD_MODE" -
5050 <list>
5051 <t>Life time of instrument
5052 (see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t>
5053 </list>
5054 </t>
5055 <t>"VOLUME" -
5056 <list>
5057 <t>master volume of the instrument as optionally
5058 dotted number (where a value &lt; 1.0 means attenuation
5059 and a value > 1.0 means amplification)</t>
5060 </list>
5061 </t>
5062 <t>The mentioned fields above don't have to be in particular order.</t>
5063 </list>
5064 </t>
5065
5066 <t>Example:</t>
5067 <t>
5068 <list>
5069 <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
5070 <t>S: "NAME: Drums for Foo Song"</t>
5071 <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
5072 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
5073 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5074 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NAME: Joe's Drumkit"</t>
5075 <t>&nbsp;&nbsp;&nbsp;"LOAD_MODE: PERSISTENT"</t>
5076 <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
5077 <t>&nbsp;&nbsp;&nbsp;"."</t>
5078 </list>
5079 </t>
5080 </section>
5081
5082 <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
5083 <t>The front-end can clear a whole MIDI instrument map, that
5084 is delete all its entries by sending the following command:</t>
5085 <t>
5086 <list>
5087 <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
5088 </list>
5089 </t>
5090 <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
5091 <t>The front-end can clear all MIDI instrument maps, that
5092 is delete all entries of all maps by sending the following
5093 command:</t>
5094 <t>
5095 <list>
5096 <t>CLEAR MIDI_INSTRUMENTS ALL</t>
5097 </list>
5098 </t>
5099 <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
5100 maps, only their entries, thus the map's settings like
5101 custom name will be preservevd.</t>
5102
5103 <t>Possible Answers:</t>
5104 <t>
5105 <list>
5106 <t>"OK" -
5107 <list>
5108 <t>always</t>
5109 </list>
5110 </t>
5111 </list>
5112 </t>
5113
5114 <t>Examples:</t>
5115 <t>
5116 <list>
5117 <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
5118 <t>S: "OK"</t>
5119 </list>
5120 </t>
5121 <t>
5122 <list>
5123 <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
5124 <t>S: "OK"</t>
5125 </list>
5126 </t>
5127 </section>
5128 </section>
5129
5130
5131 <section title="Managing Instruments Database" anchor="Managing Instruments Database">
5132 <t>The following commands describe how to use and manage
5133 the instruments database.</t>
5134 <t>Notice:</t>
5135 <t>
5136 <list>
5137 <t>All command arguments representing a path or
5138 instrument/directory name support escape sequences as described in chapter
5139 "<xref target="character_set">Character Set and Escape Sequences</xref>".
5140 </t>
5141 <t>All occurrences of a forward slash in instrument and directory
5142 names are escaped with its hex (\x2f) or octal (\057) escape sequence.
5143 </t>
5144 </list>
5145 </t>
5146
5147 <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
5148 <t>The front-end can add a new instrument directory to the
5149 instruments database by sending the following command:</t>
5150 <t>
5151 <list>
5152 <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
5153 </list>
5154 </t>
5155 <t>Where &lt;dir&gt; is the absolute path name of the directory
5156 to be created (encapsulated into apostrophes).</t>
5157
5158 <t>Possible Answers:</t>
5159 <t>
5160 <list>
5161 <t>"OK" -
5162 <list>
5163 <t>on success</t>
5164 </list>
5165 </t>
5166 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5167 <list>
5168 <t>when the directory could not be created, which
5169 can happen if the directory already exists or the
5170 name contains not allowed symbols</t>
5171 </list>
5172 </t>
5173 </list>
5174 </t>
5175
5176 <t>Examples:</t>
5177 <t>
5178 <list>
5179 <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
5180 <t>S: "OK"</t>
5181 </list>
5182 </t>
5183 </section>
5184
5185 <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
5186 <t>The front-end can delete a particular instrument directory
5187 from the instruments database by sending the following command:</t>
5188 <t>
5189 <list>
5190 <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
5191 </list>
5192 </t>
5193 <t>Where &lt;dir&gt; is the absolute path name of the directory
5194 to delete. The optional FORCE argument can be used to
5195 force the deletion of a non-empty directory and all its content.</t>
5196
5197 <t>Possible Answers:</t>
5198 <t>
5199 <list>
5200 <t>"OK" -
5201 <list>
5202 <t>if the directory is deleted successfully</t>
5203 </list>
5204 </t>
5205 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5206 <list>
5207 <t>if the given directory does not exist, or
5208 if trying to delete a non-empty directory,
5209 without using the FORCE argument.</t>
5210 </list>
5211 </t>
5212 </list>
5213 </t>
5214
5215 <t>Examples:</t>
5216 <t>
5217 <list>
5218 <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
5219 <t>S: "OK"</t>
5220 </list>
5221 </t>
5222 </section>
5223
5224 <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
5225 <t>The front-end can retrieve the current amount of
5226 directories in a specific directory by sending the following command:</t>
5227 <t>
5228 <list>
5229 <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
5230 </list>
5231 </t>
5232 <t>Where &lt;dir&gt; should be replaced by the absolute path
5233 name of the directory. If RECURSIVE is specified, the number of
5234 all directories, including those located in subdirectories of the
5235 specified directory, will be returned.</t>
5236
5237 <t>Possible Answers:</t>
5238 <t>
5239 <list>
5240 <t>The current number of instrument directories
5241 in the specified directory.</t>
5242 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5243 <list>
5244 <t>if the given directory does not exist.</t>
5245 </list>
5246 </t>
5247 </list>
5248 </t>
5249
5250 <t>Example:</t>
5251 <t>
5252 <list>
5253 <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
5254 <t>S: "2"</t>
5255 </list>
5256 </t>
5257 </section>
5258
5259 <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
5260 <t>The front-end can retrieve the current list of directories
5261 in specific directory by sending the following command:</t>
5262 <t>
5263 <list>
5264 <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
5265 </list>
5266 </t>
5267 <t>Where &lt;dir&gt; should be replaced by the absolute path
5268 name of the directory. If RECURSIVE is specified, the absolute path names
5269 of all directories, including those located in subdirectories of the
5270 specified directory, will be returned.</t>
5271
5272 <t>Possible Answers:</t>
5273 <t>
5274 <list>
5275 <t>A comma separated list of all instrument directories
5276 (encapsulated into apostrophes) in the specified directory.</t>
5277 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5278 <list>
5279 <t>if the given directory does not exist.</t>
5280 </list>
5281 </t>
5282 </list>
5283 </t>
5284 <t>Example:</t>
5285 <t>
5286 <list>
5287 <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
5288 <t>S: "'Piano Collection','Percussion Collection'"</t>
5289 </list>
5290 </t>
5291 <t>
5292 <list>
5293 <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
5294 <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
5295 </list>
5296 </t>
5297 </section>
5298
5299 <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
5300 <t>The front-end can ask for the current settings of an
5301 instrument directory by sending the following command:</t>
5302 <t>
5303 <list>
5304 <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
5305 </list>
5306 </t>
5307 <t>Where &lt;dir&gt; should be replaced by the absolute path
5308 name of the directory the front-end is interested in.</t>
5309
5310 <t>Possible Answers:</t>
5311 <t>
5312 <list>
5313 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5314 Each answer line begins with the settings category name
5315 followed by a colon and then a space character &lt;SP&gt; and finally
5316 the info character string to that setting category. At the
5317 moment the following categories are defined:</t>
5318
5319 <t>
5320 <list>
5321 <t>DESCRIPTION -
5322 <list>
5323 <t>A brief description of the directory content.
5324 Note that the character string may contain
5325 <xref target="character_set">escape sequences</xref>.</t>
5326 </list>
5327 </t>
5328 <t>CREATED -
5329 <list>
5330 <t>The creation date and time of the directory,
5331 represented in "YYYY-MM-DD HH:MM:SS" format</t>
5332 </list>
5333 </t>
5334 <t>MODIFIED -
5335 <list>
5336 <t>The date and time of the last modification of the
5337 directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
5338 </list>
5339 </t>
5340 </list>
5341 </t>
5342 </list>
5343 </t>
5344 <t>The mentioned fields above don't have to be in particular order.</t>
5345
5346 <t>Example:</t>
5347 <t>
5348 <list>
5349 <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
5350 <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
5351 <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5352 <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5353 <t>&nbsp;&nbsp;&nbsp;"."</t>
5354 </list>
5355 </t>
5356 </section>
5357
5358 <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
5359 <t>The front-end can alter the name of a specific
5360 instrument directory by sending the following command:</t>
5361 <t>
5362 <list>
5363 <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
5364 </list>
5365 </t>
5366 <t>Where &lt;dir&gt; is the absolute path name of the directory and
5367 &lt;name&gt; is the new name for that directory.</t>
5368
5369 <t>Possible Answers:</t>
5370 <t>
5371 <list>
5372 <t>"OK" -
5373 <list>
5374 <t>on success</t>
5375 </list>
5376 </t>
5377 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5378 <list>
5379 <t>in case the given directory does not exists,
5380 or if a directory with name equal to the new
5381 name already exists.</t>
5382 </list>
5383 </t>
5384 </list>
5385 </t>
5386
5387 <t>Example:</t>
5388 <t>
5389 <list>
5390 <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
5391 <t>S: "OK"</t>
5392 </list>
5393 </t>
5394 </section>
5395
5396 <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
5397 <t>The front-end can move a specific
5398 instrument directory by sending the following command:</t>
5399 <t>
5400 <list>
5401 <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5402 </list>
5403 </t>
5404 <t>Where &lt;dir&gt; is the absolute path name of the directory
5405 to move and &lt;dst&gt; is the location where the directory will
5406 be moved to.</t>
5407
5408 <t>Possible Answers:</t>
5409 <t>
5410 <list>
5411 <t>"OK" -
5412 <list>
5413 <t>on success</t>
5414 </list>
5415 </t>
5416 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5417 <list>
5418 <t>in case a given directory does not exists,
5419 or if a directory with name equal to the name
5420 of the specified directory already exists in
5421 the destination directory. Error is also thrown
5422 when trying to move a directory to a subdirectory
5423 of itself.</t>
5424 </list>
5425 </t>
5426 </list>
5427 </t>
5428
5429 <t>Example:</t>
5430 <t>
5431 <list>
5432 <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5433 <t>S: "OK"</t>
5434 </list>
5435 </t>
5436 </section>
5437
5438 <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5439 <t>The front-end can copy a specific
5440 instrument directory by sending the following command:</t>
5441 <t>
5442 <list>
5443 <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5444 </list>
5445 </t>
5446 <t>Where &lt;dir&gt; is the absolute path name of the directory
5447 to copy and &lt;dst&gt; is the location where the directory will
5448 be copied to.</t>
5449
5450 <t>Possible Answers:</t>
5451 <t>
5452 <list>
5453 <t>"OK" -
5454 <list>
5455 <t>on success</t>
5456 </list>
5457 </t>
5458 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5459 <list>
5460 <t>in case a given directory does not exists,
5461 or if a directory with name equal to the name
5462 of the specified directory already exists in
5463 the destination directory. Error is also thrown
5464 when trying to copy a directory to a subdirectory
5465 of itself.</t>
5466 </list>
5467 </t>
5468 </list>
5469 </t>
5470
5471 <t>Example:</t>
5472 <t>
5473 <list>
5474 <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5475 <t>S: "OK"</t>
5476 </list>
5477 </t>
5478 </section>
5479
5480 <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5481 <t>The front-end can alter the description of a specific
5482 instrument directory by sending the following command:</t>
5483 <t>
5484 <list>
5485 <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5486 </list>
5487 </t>
5488 <t>Where &lt;dir&gt; is the absolute path name of the directory and
5489 &lt;desc&gt; is the new description for the directory
5490 (encapsulated into apostrophes, supporting escape sequences as described in chapter
5491 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5492
5493 <t>Possible Answers:</t>
5494 <t>
5495 <list>
5496 <t>"OK" -
5497 <list>
5498 <t>on success</t>
5499 </list>
5500 </t>
5501 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5502 <list>
5503 <t>in case the given directory does not exists.</t>
5504 </list>
5505 </t>
5506 </list>
5507 </t>
5508
5509 <t>Example:</t>
5510 <t>
5511 <list>
5512 <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5513 <t>S: "OK"</t>
5514 </list>
5515 </t>
5516 </section>
5517
5518 <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5519 <t>The front-end can search for directories
5520 in specific directory by sending the following command:</t>
5521 <t>
5522 <list>
5523 <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5524 </list>
5525 </t>
5526 <t>Where &lt;dir&gt; should be replaced by the absolute path
5527 name of the directory to search in. If NON_RECURSIVE is specified, the
5528 directories located in subdirectories of the specified directory will not
5529 be searched. &lt;criteria-list&gt; is a list of search criterias
5530 in form of "key1=val1 key2=val2 ...". The following criterias are
5531 allowed:</t>
5532 <t>
5533 <t>NAME='&lt;search-string&gt;'
5534 <list>
5535 <t>Restricts the search to directories, which names
5536 satisfy the supplied search string (encapsulated into apostrophes,
5537 supporting escape sequences as described in chapter
5538 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5539 </list>
5540 </t>
5541
5542 <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5543 <list>
5544 <t>Restricts the search to directories, which creation
5545 date satisfies the specified period, where &lt;date-after&gt;
5546 and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5547 If &lt;date-after&gt; is omitted the search is restricted to
5548 directories created before &lt;date-before&gt;. If
5549 &lt;date-before&gt; is omitted, the search is restricted
5550 to directories created after &lt;date-after&gt;.</t>
5551 </list>
5552 </t>
5553
5554 <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5555 <list>
5556 <t>Restricts the search to directories, which
5557 date of last modification satisfies the specified period, where
5558 &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5559 format. If &lt;date-after&gt; is omitted the search is restricted to
5560 directories, which are last modified before &lt;date-before&gt;. If
5561 &lt;date-before&gt; is omitted, the search is restricted to directories,
5562 which are last modified after &lt;date-after&gt;.</t>
5563 </list>
5564 </t>
5565
5566 <t>DESCRIPTION='&lt;search-string&gt;'
5567 <list>
5568 <t>Restricts the search to directories with description
5569 that satisfies the supplied search string
5570 (encapsulated into apostrophes, supporting escape
5571 sequences as described in chapter
5572 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
5573 </list>
5574 </t>
5575 </t>
5576
5577 <t>Where &lt;search-string&gt; is either a regular expression, or a
5578 word list separated with spaces for OR search and with '+' for AND search.</t>
5579
5580 <t>Possible Answers:</t>
5581 <t>
5582 <list>
5583 <t>A comma separated list with the absolute path names (encapsulated into
5584 apostrophes) of all directories in the specified directory that satisfy
5585 the supplied search criterias.</t>
5586 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5587 <list>
5588 <t>if the given directory does not exist.</t>
5589 </list>
5590 </t>
5591 </list>
5592 </t>
5593 <t>Example:</t>
5594 <t>
5595 <list>
5596 <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5597 <t>S: "'/Piano Collection'"</t>
5598 </list>
5599 </t>
5600 <t>
5601 <list>
5602 <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5603 <t>S: "'/Piano Collection','/Percussions'"</t>
5604 </list>
5605 </t>
5606 </section>
5607
5608 <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5609 <t>The front-end can add one or more instruments
5610 to the instruments database by sending the following command:</t>
5611 <t>
5612 <list>
5613 <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;[ FILE_AS_DIR]] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5614 </list>
5615 </t>
5616 <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5617 (encapsulated into apostrophes) in the instruments database in which
5618 only the new instruments (that are not already in the database) will
5619 be added, &lt;file_path&gt; is the absolute path name of a file or
5620 directory in the file system (encapsulated into apostrophes). In case
5621 an instrument file is supplied, only the instruments in the specified
5622 file will be added to the instruments database. If the optional
5623 &lt;instr_index&gt; (the index of the instrument within the given file)
5624 is supplied too, then only the specified instrument will be added.
5625 In case a directory is supplied, the instruments in that directory
5626 will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5627 when a directory is provided as &lt;file_path&gt; and specifies how the
5628 scanning will be done and has exactly the following possibilities:</t>
5629 <t>
5630 <list>
5631 <t>"RECURSIVE" -
5632 <list>
5633 <t>All instruments will be processed, including those
5634 in the subdirectories, and the respective subdirectory
5635 tree structure will be recreated in the instruments
5636 database</t>
5637 </list>
5638 </t>
5639 <t>"NON_RECURSIVE" -
5640 <list>
5641 <t>Only the instruments in the specified directory
5642 will be added, the instruments in the subdirectories
5643 will not be processed.</t>
5644 </list>
5645 </t>
5646 <t>"FLAT" -
5647 <list>
5648 <t>All instruments will be processed, including those
5649 in the subdirectories, but the respective subdirectory
5650 structure will not be recreated in the instruments
5651 database. All instruments will be added directly in
5652 the specified database directory.</t>
5653 </list>
5654 </t>
5655 </list>
5656 </t>
5657
5658 <t> If FILE_AS_DIR argument is supplied, all instruments in an instrument
5659 file will be added to a separate directory in the instruments database, which
5660 name will be the name of the instrument file with the file extension stripped off.
5661 </t>
5662 <t>The difference between regular and NON_MODAL versions of the command
5663 is that the regular command returns when the scanning is finished
5664 while NON_MODAL version returns immediately and a background process is launched.
5665 The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5666 command can be used to monitor the scanning progress.</t>
5667
5668 <t>Possible Answers:</t>
5669 <t>
5670 <list>
5671 <t>"OK" -
5672 <list>
5673 <t>on success when NON_MODAL is not supplied</t>
5674 </list>
5675 </t>
5676 <t>"OK[&lt;job-id&gt;]" -
5677 <list>
5678 <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5679 is a numerical ID used to obtain status information about the job progress.
5680 See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5681 </t>
5682 </list>
5683 </t>
5684 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5685 <list>
5686 <t>if an invalid path is specified.</t>
5687 </list>
5688 </t>
5689 </list>
5690 </t>
5691
5692 <t>Examples:</t>
5693 <t>
5694 <list>
5695 <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5696 <t>S: "OK"</t>
5697 </list>
5698 </t>
5699 </section>
5700
5701 <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5702 <t>The front-end can remove a particular instrument
5703 from the instruments database by sending the following command:</t>
5704 <t>
5705 <list>
5706 <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5707 </list>
5708 </t>
5709 <t>Where &lt;instr_path&gt; is the absolute path name
5710 (in the instruments database) of the instrument to remove.</t>
5711
5712 <t>Possible Answers:</t>
5713 <t>
5714 <list>
5715 <t>"OK" -
5716 <list>
5717 <t>if the instrument is removed successfully</t>
5718 </list>
5719 </t>
5720 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5721 <list>
5722 <t>if the given path does not exist or
5723 is a directory.</t>
5724 </list>
5725 </t>
5726 </list>
5727 </t>
5728
5729 <t>Examples:</t>
5730 <t>
5731 <list>
5732 <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5733 <t>S: "OK"</t>
5734 </list>
5735 </t>
5736 </section>
5737
5738 <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5739 <t>The front-end can retrieve the current amount of
5740 instruments in a specific directory by sending the following command:</t>
5741 <t>
5742 <list>
5743 <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5744 </list>
5745 </t>
5746 <t>Where &lt;dir&gt; should be replaced by the absolute path name
5747 of the directory. If RECURSIVE is specified, the number of all
5748 instruments, including those located in subdirectories of the
5749 specified directory, will be returned.</t>
5750
5751 <t>Possible Answers:</t>
5752 <t>
5753 <list>
5754 <t>The current number of instruments
5755 in the specified directory.</t>
5756 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5757 <list>
5758 <t>if the given directory does not exist.</t>
5759 </list>
5760 </t>
5761 </list>
5762 </t>
5763
5764 <t>Example:</t>
5765 <t>
5766 <list>
5767 <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5768 <t>S: "2"</t>
5769 </list>
5770 </t>
5771 </section>
5772
5773 <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5774 <t>The front-end can retrieve the current list of instruments
5775 in specific directory by sending the following command:</t>
5776 <t>
5777 <list>
5778 <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5779 </list>
5780 </t>
5781 <t>Where &lt;dir&gt; should be replaced by the absolute path
5782 name of the directory. If RECURSIVE is specified, the absolute path
5783 names of all instruments, including those located in subdirectories
5784 of the specified directory, will be returned.</t>
5785
5786 <t>Possible Answers:</t>
5787 <t>
5788 <list>
5789 <t>A comma separated list of all instruments
5790 (encapsulated into apostrophes) in the specified directory.</t>
5791 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5792 <list>
5793 <t>if the given directory does not exist.</t>
5794 </list>
5795 </t>
5796 </list>
5797 </t>
5798 <t>Example:</t>
5799 <t>
5800 <list>
5801 <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5802 <t>S: "'Bosendorfer 290','Steinway D'"</t>
5803 </list>
5804 </t>
5805 <t>
5806 <list>
5807 <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5808 <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5809 </list>
5810 </t>
5811 </section>
5812
5813 <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5814 <t>The front-end can ask for the current settings of an
5815 instrument by sending the following command:</t>
5816 <t>
5817 <list>
5818 <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5819 </list>
5820 </t>
5821 <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5822 name of the instrument the front-end is interested in.</t>
5823
5824 <t>Possible Answers:</t>
5825 <t>
5826 <list>
5827 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5828 Each answer line begins with the settings category name
5829 followed by a colon and then a space character &lt;SP&gt; and finally
5830 the info character string to that setting category. At the
5831 moment the following categories are defined:</t>
5832
5833 <t>
5834 <list>
5835 <t>INSTRUMENT_FILE -
5836 <list>
5837 <t>File name of the instrument.
5838 Note that the character string may contain
5839 <xref target="character_set">escape sequences</xref>.</t>
5840 </list>
5841 </t>
5842 <t>INSTRUMENT_NR -
5843 <list>
5844 <t>Index of the instrument within the file.</t>
5845 </list>
5846 </t>
5847 <t>FORMAT_FAMILY -
5848 <list>
5849 <t>The format family of the instrument.</t>
5850 </list>
5851 </t>
5852 <t>FORMAT_VERSION -
5853 <list>
5854 <t>The format version of the instrument.</t>
5855 </list>
5856 </t>
5857 <t>SIZE -
5858 <list>
5859 <t>The size of the instrument in bytes.</t>
5860 </list>
5861 </t>
5862 <t>CREATED -
5863 <list>
5864 <t>The date and time when the instrument is added
5865 in the instruments database, represented in
5866 "YYYY-MM-DD HH:MM:SS" format</t>
5867 </list>
5868 </t>
5869 <t>MODIFIED -
5870 <list>
5871 <t>The date and time of the last modification of the
5872 instrument's database settings, represented in
5873 "YYYY-MM-DD HH:MM:SS" format</t>
5874 </list>
5875 </t>
5876 <t>DESCRIPTION -
5877 <list>
5878 <t>A brief description of the instrument.
5879 Note that the character string may contain
5880 <xref target="character_set">escape sequences</xref>.</t>
5881 </list>
5882 </t>
5883 <t>IS_DRUM -
5884 <list>
5885 <t>either true or false, determines whether the
5886 instrument is a drumkit or a chromatic instrument</t>
5887 </list>
5888 </t>
5889 <t>PRODUCT -
5890 <list>
5891 <t>The product title of the instrument.
5892 Note that the character string may contain
5893 <xref target="character_set">escape sequences</xref>.</t>
5894 </list>
5895 </t>
5896 <t>ARTISTS -
5897 <list>
5898 <t>Lists the artist names.
5899 Note that the character string may contain
5900 <xref target="character_set">escape sequences</xref>.</t>
5901 </list>
5902 </t>
5903 <t>KEYWORDS -
5904 <list>
5905 <t>Provides a list of keywords that refer to the instrument.
5906 Keywords are separated with semicolon and blank.
5907 Note that the character string may contain
5908 <xref target="character_set">escape sequences</xref>.</t>
5909 </list>
5910 </t>
5911 </list>
5912 </t>
5913 </list>
5914 </t>
5915 <t>The mentioned fields above don't have to be in particular order.</t>
5916
5917 <t>Example:</t>
5918 <t>
5919 <list>
5920 <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5921 <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5922 <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5923 <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5924 <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5925 <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5926 <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5927 <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5928 <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5929 <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5930 <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5931 <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5932 <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5933 <t>&nbsp;&nbsp;&nbsp;"."</t>
5934 </list>
5935 </t>
5936 </section>
5937
5938 <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5939 <t>The front-end can alter the name of a specific
5940 instrument by sending the following command:</t>
5941 <t>
5942 <list>
5943 <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5944 </list>
5945 </t>
5946 <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5947 &lt;name&gt; is the new name for that instrument.</t>
5948
5949 <t>Possible Answers:</t>
5950 <t>
5951 <list>
5952 <t>"OK" -
5953 <list>
5954 <t>on success</t>
5955 </list>
5956 </t>
5957 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5958 <list>
5959 <t>in case the given instrument does not exists,
5960 or if an instrument with name equal to the new
5961 name already exists.</t>
5962 </list>
5963 </t>
5964 </list>
5965 </t>
5966
5967 <t>Example:</t>
5968 <t>
5969 <list>
5970 <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5971 <t>S: "OK"</t>
5972 </list>
5973 </t>
5974 </section>
5975
5976 <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5977 <t>The front-end can move a specific instrument to another directory by
5978 sending the following command:</t>
5979 <t>
5980 <list>
5981 <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5982 </list>
5983 </t>
5984 <t>Where &lt;instr&gt; is the absolute path name of the instrument
5985 to move and &lt;dst&gt; is the directory where the instrument will
5986 be moved to.</t>
5987
5988 <t>Possible Answers:</t>
5989 <t>
5990 <list>
5991 <t>"OK" -
5992 <list>
5993 <t>on success</t>
5994 </list>
5995 </t>
5996 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5997 <list>
5998 <t>in case the given instrument does not exists,
5999 or if an instrument with name equal to the name of the
6000 specified instrument already exists in the destination
6001 directory.</t>
6002 </list>
6003 </t>
6004 </list>
6005 </t>
6006
6007 <t>Example:</t>
6008 <t>
6009 <list>
6010 <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
6011 <t>S: "OK"</t>
6012 </list>
6013 </t>
6014 </section>
6015
6016 <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
6017 <t>The front-end can copy a specific instrument to another directory by
6018 sending the following command:</t>
6019 <t>
6020 <list>
6021 <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
6022 </list>
6023 </t>
6024 <t>Where &lt;instr&gt; is the absolute path name of the instrument
6025 to copy and &lt;dst&gt; is the directory where the instrument will
6026 be copied to.</t>
6027
6028 <t>Possible Answers:</t>
6029 <t>
6030 <list>
6031 <t>"OK" -
6032 <list>
6033 <t>on success</t>
6034 </list>
6035 </t>
6036 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6037 <list>
6038 <t>in case the given instrument does not exists,
6039 or if an instrument with name equal to the name of the
6040 specified instrument already exists in the destination
6041 directory.</t>
6042 </list>
6043 </t>
6044 </list>
6045 </t>
6046
6047 <t>Example:</t>
6048 <t>
6049 <list>
6050 <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
6051 <t>S: "OK"</t>
6052 </list>
6053 </t>
6054 </section>
6055
6056 <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
6057 <t>The front-end can alter the description of a specific
6058 instrument by sending the following command:</t>
6059 <t>
6060 <list>
6061 <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
6062 </list>
6063 </t>
6064 <t>Where &lt;instr&gt; is the absolute path name of the instrument and
6065 &lt;desc&gt; is the new description for the instrument
6066 (encapsulated into apostrophes, supporting escape sequences as described in chapter
6067 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6068
6069 <t>Possible Answers:</t>
6070 <t>
6071 <list>
6072 <t>"OK" -
6073 <list>
6074 <t>on success</t>
6075 </list>
6076 </t>
6077 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6078 <list>
6079 <t>in case the given instrument does not exists.</t>
6080 </list>
6081 </t>
6082 </list>
6083 </t>
6084
6085 <t>Example:</t>
6086 <t>
6087 <list>
6088 <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
6089 <t>S: "OK"</t>
6090 </list>
6091 </t>
6092 </section>
6093
6094 <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
6095 <t>The front-end can search for instruments
6096 in specific directory by sending the following command:</t>
6097 <t>
6098 <list>
6099 <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
6100 </list>
6101 </t>
6102 <t>Where &lt;dir&gt; should be replaced by the absolute path
6103 name of the directory to search in. If NON_RECURSIVE is specified, the
6104 directories located in subdirectories of the specified directory will not
6105 be searched. &lt;criteria-list&gt; is a list of search criterias
6106 in form of "key1=val1 key2=val2 ...". The following criterias are
6107 allowed:</t>
6108 <t>
6109 <t>NAME='&lt;search-string&gt;'
6110 <list>
6111 <t>Restricts the search to instruments, which names
6112 satisfy the supplied search string (encapsulated into apostrophes,
6113 supporting escape sequences as described in chapter
6114 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6115 </list>
6116 </t>
6117
6118 <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
6119 <list>
6120 <t>Restricts the search to instruments, which
6121 size is in the specified range. If &lt;min&gt; is omitted,
6122 the search results are restricted to instruments with size less then
6123 or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
6124 search is restricted to instruments with size greater then
6125 or equal to &lt;min&gt;.</t>
6126 </list>
6127 </t>
6128
6129 <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
6130 <list>
6131 <t>Restricts the search to instruments, which creation
6132 date satisfies the specified period, where &lt;date-after&gt;
6133 and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
6134 If &lt;date-after&gt; is omitted the search is restricted to
6135 instruments created before &lt;date-before&gt;. If
6136 &lt;date-before&gt; is omitted, the search is restricted
6137 to instruments created after &lt;date-after&gt;.</t>
6138 </list>
6139 </t>
6140
6141 <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
6142 <list>
6143 <t>Restricts the search to instruments, which
6144 date of last modification satisfies the specified period, where
6145 &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
6146 format. If &lt;date-after&gt; is omitted the search is restricted to
6147 instruments, which are last modified before &lt;date-before&gt;. If
6148 &lt;date-before&gt; is omitted, the search is restricted to instruments,
6149 which are last modified after &lt;date-after&gt;.</t>
6150 </list>
6151 </t>
6152
6153 <t>DESCRIPTION='&lt;search-string&gt;'
6154 <list>
6155 <t>Restricts the search to instruments with description
6156 that satisfies the supplied search string (encapsulated into apostrophes,
6157 supporting escape sequences as described in chapter
6158 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6159 </list>
6160 </t>
6161
6162 <t>PRODUCT='&lt;search-string&gt;'
6163 <list>
6164 <t>Restricts the search to instruments with product info
6165 that satisfies the supplied search string (encapsulated into apostrophes,
6166 supporting escape sequences as described in chapter
6167 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6168 </list>
6169 </t>
6170
6171 <t>ARTISTS='&lt;search-string&gt;'
6172 <list>
6173 <t>Restricts the search to instruments with artists info
6174 that satisfies the supplied search string (encapsulated into apostrophes,
6175 supporting escape sequences as described in chapter
6176 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6177 </list>
6178 </t>
6179
6180 <t>KEYWORDS='&lt;search-string&gt;'
6181 <list>
6182 <t>Restricts the search to instruments with keyword list
6183 that satisfies the supplied search string (encapsulated into apostrophes,
6184 supporting escape sequences as described in chapter
6185 "<xref target="character_set">Character Set and Escape Sequences</xref>").</t>
6186 </list>
6187 </t>
6188
6189 <t>IS_DRUM=true | false
6190 <list>
6191 <t>Either true or false. Restricts the search to
6192 drum kits or chromatic instruments.</t>
6193 </list>
6194 </t>
6195
6196 <t>FORMAT_FAMILIES='&lt;format-list&gt;'
6197 <list>
6198 <t>Restricts the search to instruments of the supplied format families,
6199 where &lt;format-list&gt; is a comma separated list of format families.</t>
6200 </list>
6201 </t>
6202 </t>
6203
6204 <t>Where &lt;search-string&gt; is either a regular expression, or a
6205 word list separated with spaces for OR search and with '+' for AND search.</t>
6206
6207 <t>Possible Answers:</t>
6208 <t>
6209 <list>
6210 <t>A comma separated list with the absolute path names (encapsulated into
6211 apostrophes) of all instruments in the specified directory that satisfy
6212 the supplied search criterias.</t>
6213 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6214 <list>
6215 <t>if the given directory does not exist.</t>
6216 </list>
6217 </t>
6218 </list>
6219 </t>
6220 <t>Example:</t>
6221 <t>
6222 <list>
6223 <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
6224 <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
6225 </list>
6226 </t>
6227 <t>
6228 <list>
6229 <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
6230 <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
6231 </list>
6232 </t>
6233 </section>
6234
6235 <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
6236 <t>The front-end can ask for the current status of a
6237 particular database instruments job by sending the following command:</t>
6238 <t>
6239 <list>
6240 <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
6241 </list>
6242 </t>
6243 <t>Where &lt;job-id&gt; should be replaced by the numerical ID
6244 of the job the front-end is interested in.</t>
6245
6246 <t>Possible Answers:</t>
6247 <t>
6248 <list>
6249 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6250 Each answer line begins with the settings category name
6251 followed by a colon and then a space character &lt;SP&gt; and finally
6252 the info character string to that setting category. At the
6253 moment the following categories are defined:</t>
6254
6255 <t>
6256 <list>
6257 <t>FILES_TOTAL -
6258 <list>
6259 <t>The total number of files scheduled for scanning</t>
6260 </list>
6261 </t>
6262 <t>FILES_SCANNED -
6263 <list>
6264 <t>The current number of scanned files</t>
6265 </list>
6266 </t>
6267 <t>SCANNING -
6268 <list>
6269 <t>The absolute path name of the file which is currently
6270 being scanned</t>
6271 </list>
6272 </t>
6273 <t>STATUS -
6274 <list>
6275 <t>An integer value between 0 and 100 indicating the
6276 scanning progress percentage of the file which is
6277 currently being scanned</t>
6278 </list>
6279 </t>
6280 </list>
6281 </t>
6282 </list>
6283 </t>
6284 <t>The mentioned fields above don't have to be in particular order.</t>
6285
6286 <t>Example:</t>
6287 <t>
6288 <list>
6289 <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
6290 <t>S: "FILES_TOTAL: 12"</t>
6291 <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
6292 <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
6293 <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
6294 <t>&nbsp;&nbsp;&nbsp;"."</t>
6295 </list>
6296 </t>
6297 </section>
6298
6299 <section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB">
6300 <t>The front-end can remove all instruments and directories and re-create
6301 the instruments database structure (e.g., in case of a database corruption)
6302 by sending the following command:</t>
6303 <t>
6304 <list>
6305 <t>FORMAT INSTRUMENTS_DB</t>
6306 </list>
6307 </t>
6308
6309 <t>Possible Answers:</t>
6310 <t>
6311 <list>
6312 <t>"OK" -
6313 <list>
6314 <t>on success</t>
6315 </list>
6316 </t>
6317 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6318 <list>
6319 <t>If the formatting of the instruments database
6320 failed.</t>
6321 </list>
6322 </t>
6323 </list>
6324 </t>
6325 </section>
6326
6327 <section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES">
6328 <t>The front-end can retrieve the list of all instrument files in the instruments database
6329 that don't exist in the filesystem by sending the following command:</t>
6330 <t>
6331 <list>
6332 <t>FIND LOST DB_INSTRUMENT_FILES</t>
6333 </list>
6334 </t>
6335
6336 <t>Possible Answers:</t>
6337 <t>
6338 <list>
6339 <t>A comma separated list with the absolute path names
6340 (encapsulated into apostrophes) of all lost instrument files.</t>
6341 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6342 <list>
6343 <t>in case it failed, providing an appropriate error code and error message.</t>
6344 </list>
6345 </t>
6346 </list>
6347 </t>
6348 <t>Example:</t>
6349 <t>
6350 <list>
6351 <t>C: "FIND LOST DB_INSTRUMENT_FILES"</t>
6352 <t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t>
6353 </list>
6354 </t>
6355 </section>
6356
6357 <section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH">
6358 <t>The front-end can substitute all occurrences of an instrument file
6359 in the instruments database with a new one by sending the following command:</t>
6360 <t>
6361 <list>
6362 <t>SET DB_INSTRUMENT FILE_PATH &lt;old_path&gt; &lt;new_path&gt;</t>
6363 </list>
6364 </t>
6365 <t>Where &lt;old_path&gt; is the absolute path name of the instrument file
6366 to substitute with &lt;new_path&gt;.</t>
6367
6368 <t>Possible Answers:</t>
6369 <t>
6370 <list>
6371 <t>"OK" -
6372 <list>
6373 <t>on success</t>
6374 </list>
6375 </t>
6376 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6377 <list>
6378 <t>in case it failed, providing an appropriate error code and error message.</t>
6379 </list>
6380 </t>
6381 </list>
6382 </t>
6383
6384 <t>Example:</t>
6385 <t>
6386 <list>
6387 <t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t>
6388 <t>S: "OK"</t>
6389 </list>
6390 </t>
6391 </section>
6392
6393 </section>
6394
6395
6396
6397 <section title="Editing Instruments" anchor="editing_instruments">
6398 <t>The sampler allows to edit instruments while playing with the
6399 sampler by spawning an external (3rd party) instrument editor
6400 application for a given instrument. The 3rd party instrument
6401 editor applications have to place a respective plugin DLL file
6402 into the sampler's plugins directory. The sampler will
6403 automatically try to load all plugin DLLs in that directory on
6404 startup and only on startup!</t>
6405 <t>At the moment there is only one command for this feature set,
6406 but this will most probably change in future.</t>
6407
6408 <section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT">
6409 <t>The front-end can request to open an appropriate instrument
6410 editor application by sending the following command:</t>
6411 <t>
6412 <list>
6413 <t>EDIT CHANNEL INSTRUMENT &lt;sampler-channel&gt;</t>
6414 </list>
6415 </t>
6416 <t>Where &lt;sampler-channel&gt; should be replaced by the
6417 number of the sampler channel as given by the
6418 <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
6419 or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref>
6420 command.</t>
6421
6422 <t>The sampler will try to ask all registered instrument
6423 editors (or to be more specific: their sampler plugins)
6424 whether they are capable to handle the instrument on the
6425 given sampler channel. The sampler will simply use the first
6426 instrument editor application which replied with a positive
6427 answer and spawn that instrument editor application within
6428 the sampler's process and provide that application access
6429 to the instrument's data structures, so both applications
6430 can share and access the same instruments data at the same
6431 time, thus allowing to immediately hear changes with the
6432 sampler made by the instrument editor.</t>
6433
6434 <t>Note: consequently instrument editors are always spawned
6435 locally on the same machine where the sampler is running
6436 on!</t>
6437
6438 <t>Possible Answers:</t>
6439 <t>
6440 <list>
6441 <t>"OK" -
6442 <list>
6443 <t>when an appropriate instrument editor was
6444 launched</t>
6445 </list>
6446 </t>
6447 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6448 <list>
6449 <t>when an appropriate instrument editor was
6450 launched, but there are noteworthy issues</t>
6451 </list>
6452 </t>
6453 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6454 <list>
6455 <t>when an appropriate instrument editor
6456 could not be launched</t>
6457 </list>
6458 </t>
6459 </list>
6460 </t>
6461
6462 <t>Examples:</t>
6463 <t>
6464 <list>
6465 <t>C: "EDIT CHANNEL INSTRUMENT 0"</t>
6466 <t>S: "OK"</t>
6467 </list>
6468 </t>
6469 </section>
6470 </section>
6471
6472 <section title="Managing Files" anchor="file_management">
6473 <t>You can query detailed informations about files located
6474 at the same system where the sampler instance is running on.
6475 Using this command set allows to retrieve file informations
6476 even remotely from another machine.</t>
6477
6478 <section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS">
6479 <t>The front-end can retrieve the amount of instruments
6480 within a given instrument file by sending the
6481 following command:</t>
6482 <t>
6483 <list>
6484 <t>GET FILE INSTRUMENTS &lt;filename&gt;</t>
6485 </list>
6486 </t>
6487 <t>Where &lt;filename&gt; is the name of the instrument
6488 file (encapsulated into apostrophes, supporting escape
6489 sequences as described in chapter
6490 "<xref target="character_set">Character Set and Escape
6491 Sequences</xref>").</t>
6492
6493 <t>The sampler will try to ask all sampler engines,
6494 whether they support the given file and ask the first
6495 engine with a positive answer for the amount of
6496 instruments.</t>
6497
6498 <t>Possible Answers:</t>
6499 <t>
6500 <list>
6501 <t>On success, the sampler will answer by
6502 returning the amount of instruments.
6503 </t>
6504 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6505 <list>
6506 <t>if the file could not be handled</t>
6507 </list>
6508 </t>
6509 </list>
6510 </t>
6511
6512 <t>Examples:</t>
6513 <t>
6514 <list>
6515 <t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6516 <t>S: "10"</t>
6517 </list>
6518 </t>
6519 </section>
6520
6521 <section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS">
6522 <t>The front-end can retrieve a list of all instruments
6523 within a given instrument file by sending the
6524 following command:</t>
6525 <t>
6526 <list>
6527 <t>LIST FILE INSTRUMENTS &lt;filename&gt;</t>
6528 </list>
6529 </t>
6530 <t>Where &lt;filename&gt; is the name of the instrument
6531 file (encapsulated into apostrophes, supporting escape
6532 sequences as described in chapter
6533 "<xref target="character_set">Character Set and Escape
6534 Sequences</xref>").</t>
6535
6536 <t>The sampler will try to ask all sampler engines,
6537 whether they support the given file and ask the first
6538 engine with a positive answer for a list of IDs for the
6539 instruments in the given file.</t>
6540
6541 <t>Possible Answers:</t>
6542 <t>
6543 <list>
6544 <t>On success, the sampler will answer by
6545 returning a comma separated list of
6546 instrument IDs.
6547 </t>
6548 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6549 <list>
6550 <t>if the file could not be handled</t>
6551 </list>
6552 </t>
6553 </list>
6554 </t>
6555
6556 <t>Examples:</t>
6557 <t>
6558 <list>
6559 <t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t>
6560 <t>S: "0,1,2,3,4,5,6,7,8,9"</t>
6561 </list>
6562 </t>
6563 </section>
6564
6565 <section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO">
6566 <t>The front-end can retrieve detailed informations
6567 about a specific instrument within a given instrument
6568 file by sending the following command:</t>
6569 <t>
6570 <list>
6571 <t>GET FILE INSTRUMENT INFO &lt;filename&gt;
6572 &lt;instr-id&gt;</t>
6573 </list>
6574 </t>
6575 <t>Where &lt;filename&gt; is the name of the instrument
6576 file (encapsulated into apostrophes, supporting escape
6577 sequences as described in chapter
6578 "<xref target="character_set">Character Set and Escape
6579 Sequences</xref>") and &lt;instr-id&gt; is the numeric
6580 instrument ID as returned by the
6581 <xref target="LIST FILE INSTRUMENTS">
6582 "LIST FILE INSTRUMENTS"</xref> command.</t>
6583
6584 <t>The sampler will try to ask all sampler engines,
6585 whether they support the given file and ask the first
6586 engine with a positive answer for informations about the
6587 specific instrument in the given file.</t>
6588
6589 <t>Possible Answers:</t>
6590 <t>
6591 <list>
6592 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6593 Each answer line begins with the settings category name
6594 followed by a colon and then a space character &lt;SP&gt; and finally
6595 the info character string to that setting category. At the
6596 moment the following categories are defined:</t>
6597
6598 <t>
6599 <list>
6600 <t>NAME -
6601 <list>
6602 <t>name of the instrument as
6603 stored in the instrument file</t>
6604 </list>
6605 </t>
6606 <t>FORMAT_FAMILY -
6607 <list>
6608 <t>name of the sampler format
6609 of the given instrument</t>
6610 </list>
6611 </t>
6612 <t>FORMAT_VERSION -
6613 <list>
6614 <t>version of the sampler format
6615 the instrumen is stored as</t>
6616 </list>
6617 </t>
6618 <t>PRODUCT -
6619 <list>
6620 <t>official product name of the
6621 instrument as stored in the file
6622 </t>
6623 </list>
6624 </t>
6625 <t>ARTISTS -
6626 <list>
6627 <t>artists / sample library
6628 vendor of the instrument</t>
6629 </list>
6630 </t>
6631 <t>KEY_BINDINGS -
6632 <list>
6633 <t>comma separated list of integer values representing
6634 the instrument's key mapping in the range between 0 .. 127,
6635 reflecting the analog meaning of the MIDI specification.</t>
6636 </list>
6637 </t>
6638 <t>KEYSWITCH_BINDINGS -
6639 <list>
6640 <t>comma separated list of integer values representing
6641 the instrument's keyswitch mapping in the range between 0 .. 127,
6642 reflecting the analog meaning of the MIDI specification.</t>
6643 </list>
6644 </t>
6645 </list>
6646 </t>
6647 </list>
6648 </t>
6649 <t>The mentioned fields above don't have to be in particular order.</t>
6650
6651 <t>Example:</t>
6652 <t>
6653 <list>
6654 <t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t>
6655 <t>S: "NAME: Lunatic Loops"</t>
6656 <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
6657 <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 3"</t>
6658 <t>&nbsp;&nbsp;&nbsp;"PRODUCT: The Backbone Bongo Beats"</t>
6659 <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Jimmy the Fish"</t>
6660 <t>&nbsp;&nbsp;&nbsp;"."</t>
6661 </list>
6662 </t>
6663 </section>
6664 </section>
6665 <section title="Managing Effects" anchor="effects">
6666 <t>Audio effects (e.g. reverb, delay, compression) can be
6667 applied to the audio signals generated by the sampler. The
6668 sampler usually provides a set of internal audio effects for
6669 this task. The exact set of effects depends on the availability
6670 of third party effect plugins installed on the system where the
6671 sampler runs on.</t>
6672 <t>At the moment only "send effects" are supported. Support for
6673 "insert effects" and "master effects" is planned to be added at
6674 a later point.</t>
6675 <t>The following commands allow to retrieve the set of internal
6676 effects available to the sampler, detailed informations about
6677 those effects and to create and destroy instances of such
6678 effects. After an instance of an effect is created, the effect
6679 instance can be inserted into the audio signal path of the
6680 sampler, e.g. as send effect.</t>
6681 <t>The sampler allows to create an arbitrary amount of so called
6682 send effect chains. Each effect chain can host an arbitrary
6683 amount of effect instances. The output of the first effect
6684 instance in an effect chain is fed to the input of the second
6685 effect instance of the chain and so on. So effects in one chain
6686 are processed sequentially. Send effect chains however are
6687 processed in parallel to other send effect chains. Audio signals
6688 of sampler channels are fed to send effects by creating FX sends
6689 to the respective sampler channel and assigning a destination
6690 send effect to that FX by using the
6691 <xref target="SET FX_SEND SEND_EFFECT">"SET FX_SEND SEND_EFFECT"</xref>
6692 command. The latter allows to route the FX send to the beginning
6693 of a send effect chain, as well as directly to any other
6694 position of the send effect chain.</t>
6695
6696 <section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS">
6697 <t>The front-end can retrieve the amount of internal
6698 effects, available to the sampler by sending
6699 the following command:</t>
6700 <t>
6701 <list>
6702 <t>GET AVAILABLE_EFFECTS</t>
6703 </list>
6704 </t>
6705
6706 <t>Possible Answers:</t>
6707 <t>
6708 <list>
6709 <t>The sampler will answer by returning the current
6710 number of effects available to the sampler.</t>
6711 </list>
6712 </t>
6713
6714 <t>Examples:</t>
6715 <t>
6716 <list>
6717 <t>C: "GET AVAILABLE_EFFECTS"</t>
6718 <t>S: "129"</t>
6719 </list>
6720 </t>
6721 </section>
6722
6723 <section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS">
6724 <t>The set of available internal effects can change at
6725 runtime. The front-end can retrieve the list of internal
6726 effects, available to the sampler by sending the following
6727 command:</t>
6728 <t>
6729 <list>
6730 <t>LIST AVAILABLE_EFFECTS</t>
6731 </list>
6732 </t>
6733
6734 <t>Possible Answers:</t>
6735 <t>
6736 <list>
6737 <t>The sampler will answer by returning a comma
6738 separated list with numerical IDs of effects. Note:
6739 the numercial ID of an effect is generated by the
6740 sampler for the current moment. The numerical ID of
6741 the same effect can change at runtime, e.g. when the
6742 user requests a rescan of available effect plugins.
6743 </t>
6744 </list>
6745 </t>
6746 <t>Example:</t>
6747 <t>
6748 <list>
6749 <t>C: "LIST AVAILABLE_EFFECTS"</t>
6750 <t>S: "5,6,7,120,121,122,123,124"</t>
6751 </list>
6752 </t>
6753 </section>
6754
6755 <section title="Retrieving general information about an effect" anchor="GET EFFECT INFO">
6756 <t>The front-end can ask for general informations about an
6757 effect by sending the following command:</t>
6758 <t>
6759 <list>
6760 <t>GET EFFECT INFO &lt;effect-index&gt;</t>
6761 </list>
6762 </t>
6763 <t>Where &lt;effect-index&gt; is the numerical ID of an
6764 effect as returned by the
6765 <xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref>
6766 command.</t>
6767 <t>Possible Answers:</t>
6768 <t>
6769 <list>
6770 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
6771 Each answer line begins with the effect information
6772 category name, followed by a colon and then a space
6773 character &lt;SP&gt; and finally the info character
6774 string to that effect information category. At the
6775 moment the following categories are defined:</t>
6776 <t>
6777 <list>
6778 <t>SYSTEM -
6779 <list>
6780 <t>name of the effect plugin system
6781 the effect is based on
6782 (e.g. "LADSPA")</t>
6783 </list>
6784 </t>
6785 <t>MODULE -
6786 <list>
6787 <t>module of the effect plugin
6788 system that contains this effect,
6789 the module is usually the
6790 dynamic-linked library (DLL)
6791 filename of the effect plugin,
6792 including full path (note that this
6793 filename may contain
6794 <xref target="character_set">escape sequences</xref>)</t>
6795 </list>
6796 </t>
6797 <t>NAME -
6798 <list>
6799 <t>character string defining the
6800 unique name of the effect within its
6801 module (note that the character
6802 string may contain
6803 <xref target="character_set">escape sequences</xref>)</t>
6804 </list>
6805 </t>
6806 <t>DESCRIPTION -
6807 <list>
6808 <t>human readable name of the
6809 effect, intended to be displayed in
6810 user interfaces (note that the
6811 character string may contain
6812 <xref target="character_set">escape sequences</xref>)</t>
6813 </list>
6814 </t>
6815 </list>
6816 </t>
6817 </list>
6818 </t>
6819 <t>The mentioned fields above don't have to be in particular order.</t>
6820
6821 <t>Example:</t>
6822 <t>
6823 <list>
6824 <t>C: "GET EFFECT INFO 121"</t>
6825 <t>S: "SYSTEM: LADSPA"</t>
6826 <t>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t>
6827 <t>&nbsp;&nbsp;&nbsp;"NAME: lowpass_iir"</t>
6828 <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Glame Lowpass Filter"</t>
6829 <t>&nbsp;&nbsp;&nbsp;"."</t>
6830 </list>
6831 </t>
6832 </section>
6833
6834 <section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE">
6835 <t>The front-end can spawn an instance of the desired
6836 effect by sending the following command:</t>
6837 <t>
6838 <list>
6839 <t>CREATE EFFECT_INSTANCE &lt;effect-system&gt; &lt;module&gt; &lt;effect-name&gt;</t>
6840 </list>
6841 </t>
6842 <t>Where &lt;effect-system&gt; is the "SYSTEM" field,
6843 &lt;module&gt; the "MODULE" field and &lt;effect-name&gt;
6844 the "NAME" field as returned by the
6845 <xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref>
6846 command. The filename of argument &lt;module&gt; and the
6847 character string of argument &lt;effect-name&gt; may contain
6848 <xref target="character_set">escape sequences</xref>.</t>
6849
6850 <t>The sampler will try to load the requested effect and to
6851 create an instance of it. To allow loading the same effect
6852 on a different machine, probably even running a completely
6853 different operating system (e.g. Linux vs. Windows), the
6854 sampler tries to match &lt;module&gt; "softly". That means
6855 it first tries to find an effect that exactly matches the
6856 given &lt;module&gt; argument. If there is no exact match,
6857 the sampler will try to lower the restrictions on matching
6858 the &lt;module&gt; argument more and more, e.g. by ignoring
6859 upper / lower case differences and by ignoring the path of
6860 the DLL filename and file extension. If there is still no
6861 match at the end, the sampler will try to ignore the
6862 &lt;module&gt; argument completely and as a last resort
6863 search for an effect that only matches the given
6864 &lt;effect-system&gt; and &lt;effect-name&gt; arguments.</t>
6865
6866 <t>Possible Answers:</t>
6867 <t>
6868 <list>
6869 <t>"OK[&lt;effect-instance&gt;]" -
6870 <list>
6871 <t>in case the effect instance was
6872 successfully created, where
6873 &lt;effect-instance&gt; is the numerical ID
6874 of the new effect instance</t>
6875 </list>
6876 </t>
6877 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6878 <list>
6879 <t>in case the effect instance was spawned
6880 successfully, but there are noteworthy
6881 issue(s) related, providing an appropriate
6882 warning code and warning message</t>
6883 </list>
6884 </t>
6885 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6886 <list>
6887 <t>if the effect could not be instantiated</t>
6888 </list>
6889 </t>
6890 </list>
6891 </t>
6892
6893 <t>Examples:</t>
6894 <t>
6895 <list>
6896 <t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t>
6897 <t>S: "OK[0]"</t>
6898 </list>
6899 </t>
6900 </section>
6901
6902 <section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)">
6903 <t>The front-end can spawn an instance of the desired
6904 effect by sending the following command:</t>
6905 <t>
6906 <list>
6907 <t>CREATE EFFECT_INSTANCE &lt;effect-index&gt;</t>
6908 </list>
6909 </t>
6910 <t>Where &lt;effect-index&gt; is the numerical ID of the
6911 effect as returned by the
6912 <xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref>
6913 command.</t>
6914
6915 <t>The sampler will try to load the requested effect and to
6916 create an instance of it.</t>
6917
6918 <t>Note: Since the numerical ID of a certain effect can
6919 change at any time, you should not use this command in
6920 LSCP files to restore a certain effect at a later time! To
6921 store a sampler session including all its effects, use the
6922 <xref target="CREATE EFFECT_INSTANCE">portable text-based
6923 version of "CREATE EFFECT_INSTANCE"</xref> instead! This
6924 allows to restore a sampler session with all its effects
6925 also on other machines, possibly even running a completely
6926 different operating system (e.g. Linux vs. Windows), with
6927 different plugin directories or plugin DLL names.</t>
6928
6929 <t>Possible Answers:</t>
6930 <t>
6931 <list>
6932 <t>"OK[&lt;effect-instance&gt;]" -
6933 <list>
6934 <t>in case the effect instance was
6935 successfully created, where
6936 &lt;effect-instance&gt; is the numerical ID
6937 of the new effect instance</t>
6938 </list>
6939 </t>
6940 <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
6941 <list>
6942 <t>in case the effect instance was spawned
6943 successfully, but there are noteworthy
6944 issue(s) related, providing an appropriate
6945 warning code and warning message</t>
6946 </list>
6947 </t>
6948 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6949 <list>
6950 <t>if the effect could not be instantiated</t>
6951 </list>
6952 </t>
6953 </list>
6954 </t>
6955
6956 <t>Examples:</t>
6957 <t>
6958 <list>
6959 <t>C: "CREATE EFFECT_INSTANCE 72"</t>
6960 <t>S: "OK[5]"</t>
6961 </list>
6962 </t>
6963 </section>
6964
6965 <section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE">
6966 <t>The front-end can destroy an unusued effect instance and
6967 thus freeing it from memory by sending the following command:</t>
6968 <t>
6969 <list>
6970 <t>DESTROY EFFECT_INSTANCE &lt;effect-instance&gt;</t>
6971 </list>
6972 </t>
6973 <t>Where &lt;effect-instance&gt; is the numerical ID of the
6974 effect instance as returned by the
6975 <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
6976 <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
6977 command.</t>
6978
6979 <t>The effect instance can only be destroyed if it's not
6980 used in any part of the sampler's audio signal path anymore.
6981 If the effect instance is still in use somewhere, trying to
6982 destroy the effect instance will result in an error
6983 message.</t>
6984
6985 <t>Possible Answers:</t>
6986 <t>
6987 <list>
6988 <t>"OK" -
6989 <list>
6990 <t>in case the effect instance was successfully destroyed</t>
6991 </list>
6992 </t>
6993 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
6994 <list>
6995 <t>in case it failed, providing an appropriate error code and
6996 error message</t>
6997 </list>
6998 </t>
6999 </list>
7000 </t>
7001
7002 <t>Examples:</t>
7003 <t>
7004 <list>
7005 <t>C: "DESTROY EFFECT_INSTANCE 5"</t>
7006 <t>S: "OK"</t>
7007 </list>
7008 </t>
7009 </section>
7010
7011 <section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES">
7012 <t>The front-end can retrieve the current amount of effect
7013 instances by sending the following command:</t>
7014 <t>
7015 <list>
7016 <t>GET EFFECT_INSTANCES</t>
7017 </list>
7018 </t>
7019
7020 <t>Possible Answers:</t>
7021 <t>
7022 <list>
7023 <t>The sampler will answer by returning the current
7024 number of effect instances created and not yet
7025 destroyed in the current sampler session.</t>
7026 </list>
7027 </t>
7028
7029 <t>Examples:</t>
7030 <t>
7031 <list>
7032 <t>C: "GET EFFECT_INSTANCES"</t>
7033 <t>S: "14"</t>
7034 </list>
7035 </t>
7036 </section>
7037
7038 <section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES">
7039 <t>The front-end can retrieve the current list of effect
7040 instances by sending the following command:</t>
7041 <t>
7042 <list>
7043 <t>LIST EFFECT_INSTANCES</t>
7044 </list>
7045 </t>
7046
7047 <t>Possible Answers:</t>
7048 <t>
7049 <list>
7050 <t>The sampler will answer by returning a comma
7051 separated list with numerical IDs of effects
7052 instances.
7053 </t>
7054 </list>
7055 </t>
7056 <t>Example:</t>
7057 <t>
7058 <list>
7059 <t>C: "LIST EFFECT_INSTANCES"</t>
7060 <t>S: "9,11,14,15,16,17,25"</t>
7061 </list>
7062 </t>
7063 </section>
7064
7065 <section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO">
7066 <t>The front-end can ask for the current informations about
7067 a particular effect instance by sending the following command:</t>
7068 <t>
7069 <list>
7070 <t>GET EFFECT_INSTANCE INFO &lt;effect-instance&gt;</t>
7071 </list>
7072 </t>
7073 <t>Where &lt;effect-instance&gt; is the numerical ID of an
7074 effect instance as returned by the
7075 <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref>
7076 or
7077 <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7078 command.</t>
7079
7080 <t>Possible Answers:</t>
7081 <t>
7082 <list>
7083 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7084 Each answer line begins with the information
7085 category name, followed by a colon and then a space
7086 character &lt;SP&gt; and finally the info character
7087 string to that information category. At the
7088 moment the following categories are defined:</t>
7089 <t>
7090 <list>
7091 <t>SYSTEM -
7092 <list>
7093 <t>name of the effect plugin system
7094 the effect is based on
7095 (e.g. "LADSPA")</t>
7096 </list>
7097 </t>
7098 <t>MODULE -
7099 <list>
7100 <t>module of the effect plugin
7101 system that contains this effect,
7102 the module is usually the
7103 dynamic-linked library (DLL)
7104 filename of the effect plugin,
7105 including full path (note that this
7106 filename may contain
7107 <xref target="character_set">escape sequences</xref>)</t>
7108 </list>
7109 </t>
7110 <t>NAME -
7111 <list>
7112 <t>character string defining the
7113 unique name of the effect within its
7114 module (note that the character
7115 string may contain
7116 <xref target="character_set">escape sequences</xref>)</t>
7117 </list>
7118 </t>
7119 <t>DESCRIPTION -
7120 <list>
7121 <t>human readable name of the
7122 effect, intended to be displayed in
7123 user interfaces (note that the
7124 character string may contain
7125 <xref target="character_set">escape sequences</xref>)</t>
7126 </list>
7127 </t>
7128 <t>INPUT_CONTROLS -
7129 <list>
7130 <t>amount of input controls the
7131 effect instance provides, to allow
7132 controlling the effect parameters in
7133 realtime</t>
7134 </list>
7135 </t>
7136 </list>
7137 </t>
7138 </list>
7139 </t>
7140 <t>The mentioned fields above don't have to be in particular order.</t>
7141
7142 <t>Example:</t>
7143 <t>
7144 <list>
7145 <t>C: "GET EFFECT_INSTANCE INFO 3"</t>
7146 <t>S: "SYSTEM: LADSPA"</t>
7147 <t>&nbsp;&nbsp;&nbsp;"MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t>
7148 <t>&nbsp;&nbsp;&nbsp;"NAME: modDelay"</t>
7149 <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Modulatable delay"</t>
7150 <t>&nbsp;&nbsp;&nbsp;"INPUT_CONTROLS: 1"</t>
7151 <t>&nbsp;&nbsp;&nbsp;"."</t>
7152 </list>
7153 </t>
7154 </section>
7155
7156 <section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO">
7157 <t>Effects typically provide a certain set of effect
7158 parameters which can be altered by the user in realtime
7159 (e.g. depth of a reverb effect, duration of a delay effect,
7160 dry / wet signal ratio). Those controllable effect parameters
7161 are called "input controls". The front-end can ask for the
7162 current informations of an effect instance's input control
7163 by sending the following command:</t>
7164 <t>
7165 <list>
7166 <t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO &lt;effect-instance&gt; &lt;input-control&gt;</t>
7167 </list>
7168 </t>
7169 <t>Where &lt;effect-instance&gt; is the numerical ID of an
7170 effect instance as returned by the
7171 <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref>
7172 or
7173 <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7174 command and &lt;input-control&gt; is the index of the input
7175 control within the numerical bounds as returned by the
7176 "INPUT_CONTROLS" field of the
7177 <xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref>
7178 command.</t>
7179
7180 <t>Possible Answers:</t>
7181 <t>
7182 <list>
7183 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7184 Each answer line begins with the information
7185 category name, followed by a colon and then a space
7186 character &lt;SP&gt; and finally the info character
7187 string to that information category. There are
7188 information categories which are always returned,
7189 independent of the respective effect parameter and
7190 there are optional information categories
7191 which are only shown for certain effect parameters.
7192 At the moment the following categories are defined:</t>
7193 <t>
7194 <list>
7195 <t>DESCRIPTION -
7196 <list>
7197 <t>(always returned)
7198 human readable name of the
7199 effect parameter, intended to be
7200 displayed in user interfaces (note
7201 that the character string may
7202 contain <xref target="character_set">escape sequences</xref>)</t>
7203 </list>
7204 </t>
7205 <t>VALUE -
7206 <list>
7207 <t>
7208 (always returned)
7209 current (optional dotted)
7210 floating point value of this effect
7211 parameter</t>
7212 </list>
7213 </t>
7214 <t>RANGE_MIN -
7215 <list>
7216 <t>
7217 (optionally returned)
7218 minimum allowed value for this
7219 effect parameter</t>
7220 </list>
7221 </t>
7222 <t>RANGE_MAX -
7223 <list>
7224 <t>
7225 (optionally returned)
7226 maximum allowed value for this
7227 effect parameter</t>
7228 </list>
7229 </t>
7230 <t>POSSIBILITIES -
7231 <list>
7232 <t>
7233 (optionally returned)
7234 comma separated list of
7235 (optional dotted) floating point
7236 numbers, reflecting the exact set of
7237 possible values for this effect
7238 parameter</t>
7239 </list>
7240 </t>
7241 <t>DEFAULT -
7242 <list>
7243 <t>
7244 (optionally returned)
7245 default value of this effect
7246 parameter</t>
7247 </list>
7248 </t>
7249 </list>
7250 </t>
7251 </list>
7252 </t>
7253 <t>The mentioned fields above don't have to be in particular order.</t>
7254
7255 <t>Example:</t>
7256 <t>
7257 <list>
7258 <t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t>
7259 <t>S: "SYSTEM: LADSPA"</t>
7260 <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: Base delay (s)"</t>
7261 <t>&nbsp;&nbsp;&nbsp;"VALUE: 0.500"</t>
7262 <t>&nbsp;&nbsp;&nbsp;"RANGE_MIN: 0.000"</t>
7263 <t>&nbsp;&nbsp;&nbsp;"."</t>
7264 </list>
7265 </t>
7266 </section>
7267
7268 <section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE">
7269 <t>The front-end can alter the current value of an effect
7270 parameter by sending the following command:</t>
7271 <t>
7272 <list>
7273 <t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE &lt;effect-instance&gt; &lt;input-control&gt; &lt;value&gt;</t>
7274 </list>
7275 </t>
7276 <t>Where &lt;effect-instance&gt; is the numerical ID of the
7277 effect instance as returned by the
7278 <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7279 <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7280 command, &lt;input-control&gt; is the index of the input
7281 control within the numerical bounds as returned by the
7282 "INPUT_CONTROLS" field of the
7283 <xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref>
7284 command and &lt;value&gt; is the new (optional dotted)
7285 floating point value for this effect parameter.</t>
7286
7287 <t>Possible Answers:</t>
7288 <t>
7289 <list>
7290 <t>"OK" -
7291 <list>
7292 <t>in case the effect was altered successfully</t>
7293 </list>
7294 </t>
7295 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7296 <list>
7297 <t>in case it failed, providing an appropriate error code and
7298 error message</t>
7299 </list>
7300 </t>
7301 </list>
7302 </t>
7303
7304 <t>Examples:</t>
7305 <t>
7306 <list>
7307 <t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t>
7308 <t>S: "OK"</t>
7309 </list>
7310 </t>
7311 </section>
7312
7313 <section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS">
7314 <t>The front-end can retrieve the current amount of send
7315 effect chains of an audio output device by sending the
7316 following command:</t>
7317 <t>
7318 <list>
7319 <t>GET SEND_EFFECT_CHAINS &lt;audio-device&gt;</t>
7320 </list>
7321 </t>
7322 <t>Where &lt;audio-device&gt; should be replaced by the
7323 numerical ID of the audio output device as given by the
7324 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7325 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7326 command.</t>
7327
7328 <t>Possible Answers:</t>
7329 <t>
7330 <list>
7331 <t>The sampler will answer by returning the current
7332 number of send effect chains of the supplied audio
7333 output device.</t>
7334 </list>
7335 </t>
7336
7337 <t>Examples:</t>
7338 <t>
7339 <list>
7340 <t>C: "GET SEND_EFFECT_CHAINS 0"</t>
7341 <t>S: "4"</t>
7342 </list>
7343 </t>
7344 </section>
7345
7346 <section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS">
7347 <t>The front-end can retrieve the current list of send
7348 effect chains of an audio output device by sending the
7349 following command:</t>
7350 <t>
7351 <list>
7352 <t>LIST SEND_EFFECT_CHAINS &lt;audio-device&gt;</t>
7353 </list>
7354 </t>
7355 <t>Where &lt;audio-device&gt; should be replaced by the
7356 numerical ID of the audio output device as given by the
7357 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7358 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7359 command.</t>
7360
7361 <t>Possible Answers:</t>
7362 <t>
7363 <list>
7364 <t>The sampler will answer by returning a comma
7365 separated list with numerical IDs of send effect
7366 chains of the supplied audio output device.
7367 </t>
7368 </list>
7369 </t>
7370
7371 <t>Examples:</t>
7372 <t>
7373 <list>
7374 <t>C: "LIST SEND_EFFECT_CHAINS 0"</t>
7375 <t>S: "3,4,7"</t>
7376 </list>
7377 </t>
7378 </section>
7379
7380 <section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN">
7381 <t>The front-end can add a send effect chain by sending the
7382 following command:</t>
7383 <t>
7384 <list>
7385 <t>ADD SEND_EFFECT_CHAIN &lt;audio-device&gt;</t>
7386 </list>
7387 </t>
7388 <t>Where &lt;audio-device&gt; should be replaced by the
7389 numerical ID of the audio output device as given by the
7390 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7391 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7392 command.</t>
7393
7394 <t>Possible Answers:</t>
7395 <t>
7396 <list>
7397 <t>"OK[&lt;effect-chain&gt;]" -
7398 <list>
7399 <t>in case the send effect chain was
7400 added successfully, where
7401 &lt;effect-chain&gt; is the numerical ID
7402 of the new send effect chain</t>
7403 </list>
7404 </t>
7405 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7406 <list>
7407 <t>if the send effect chain could not be added</t>
7408 </list>
7409 </t>
7410 </list>
7411 </t>
7412
7413 <t>Examples:</t>
7414 <t>
7415 <list>
7416 <t>C: "ADD SEND_EFFECT_CHAIN 0"</t>
7417 <t>S: "OK[2]"</t>
7418 </list>
7419 </t>
7420 </section>
7421
7422 <section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN">
7423 <t>The front-end can remove a send effect chain by sending
7424 the following command:</t>
7425 <t>
7426 <list>
7427 <t>REMOVE SEND_EFFECT_CHAIN &lt;audio-device&gt; &lt;effect-chain&gt;</t>
7428 </list>
7429 </t>
7430 <t>Where &lt;audio-device&gt; should be replaced by the
7431 numerical ID of the audio output device as given by the
7432 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7433 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7434 command and &lt;effect-chain&gt; by the numerical ID as
7435 returned by the
7436 <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7437 or
7438 <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7439 command.</t>
7440
7441 <t>Possible Answers:</t>
7442 <t>
7443 <list>
7444 <t>"OK" -
7445 <list>
7446 <t>in case the send effect chain was
7447 removed successfully</t>
7448 </list>
7449 </t>
7450 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7451 <list>
7452 <t>if the send effect chain could not be removed</t>
7453 </list>
7454 </t>
7455 </list>
7456 </t>
7457
7458 <t>Examples:</t>
7459 <t>
7460 <list>
7461 <t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t>
7462 <t>S: "OK"</t>
7463 </list>
7464 </t>
7465 </section>
7466
7467 <section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO">
7468 <t>The front-end can ask for informations of a send effect
7469 chain by sending the following command:</t>
7470 <t>
7471 <list>
7472 <t>GET SEND_EFFECT_CHAIN INFO &lt;audio-device&gt; &lt;effect-chain&gt;</t>
7473 </list>
7474 </t>
7475 <t>Where &lt;audio-device&gt; should be replaced by the
7476 numerical ID of the audio output device as given by the
7477 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7478 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7479 command and &lt;effect-chain&gt; by the numerical ID as
7480 returned by the
7481 <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7482 or
7483 <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7484 command.</t>
7485
7486 <t>Possible Answers:</t>
7487 <t>
7488 <list>
7489 <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
7490 Each answer line begins with the information
7491 category name, followed by a colon and then a space
7492 character &lt;SP&gt; and finally the info character
7493 string to that information category.
7494 At the moment the following categories are defined:</t>
7495 <t>
7496 <list>
7497 <t>EFFECT_COUNT -
7498 <list>
7499 <t>amount of effects in this send
7500 effect chain</t>
7501 </list>
7502 </t>
7503 <t>EFFECT_SEQUENCE -
7504 <list>
7505 <t>comma separated list of the
7506 numerical IDs of the effect
7507 instances in this send effect chain,
7508 in the order as they are procssed in
7509 the effect chain</t>
7510 </list>
7511 </t>
7512 </list>
7513 </t>
7514 </list>
7515 </t>
7516 <t>The mentioned fields above don't have to be in particular order.</t>
7517
7518 <t>Example:</t>
7519 <t>
7520 <list>
7521 <t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t>
7522 <t>S: "EFFECT_COUNT: 3"</t>
7523 <t>&nbsp;&nbsp;&nbsp;"EFFECT_SEQUENCE: 31,4,7"</t>
7524 <t>&nbsp;&nbsp;&nbsp;"."</t>
7525 </list>
7526 </t>
7527 </section>
7528
7529 <section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT">
7530 <t>The front-end can add an unused effect instance to the
7531 end of a send effect chain by sending the following command:</t>
7532 <t>
7533 <list>
7534 <t>APPEND SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;effect-instance&gt;</t>
7535 </list>
7536 </t>
7537 <t>Where &lt;audio-device&gt; should be replaced by the
7538 numerical ID of the audio output device as given by the
7539 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7540 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7541 command and &lt;effect-chain&gt; by the numerical ID as
7542 returned by the
7543 <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7544 or
7545 <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7546 command and &lt;effect-instance&gt; as returned by the
7547 <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7548 <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7549 command.</t>
7550 <t>Only unused effect instances can be added to the effect
7551 chain. Trying to add an effect instance which is already in
7552 use somewhere in the audio signal path of the sampler will
7553 result in an error.</t>
7554
7555 <t>Possible Answers:</t>
7556 <t>
7557 <list>
7558 <t>"OK" -
7559 <list>
7560 <t>in case the effect instance was
7561 added successfully to the chain</t>
7562 </list>
7563 </t>
7564 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7565 <list>
7566 <t>if the effect instance could not be added</t>
7567 </list>
7568 </t>
7569 </list>
7570 </t>
7571
7572 <t>Examples:</t>
7573 <t>
7574 <list>
7575 <t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t>
7576 <t>S: "OK"</t>
7577 </list>
7578 </t>
7579 </section>
7580
7581 <section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT">
7582 <t>The front-end can add an unused effect instance to a
7583 certain position of a send effect chain by sending the
7584 following command:</t>
7585 <t>
7586 <list>
7587 <t>INSERT SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt; &lt;effect-instance&gt;</t>
7588 </list>
7589 </t>
7590 <t>Where &lt;audio-device&gt; should be replaced by the
7591 numerical ID of the audio output device as given by the
7592 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7593 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7594 command, &lt;effect-chain&gt; by the numerical ID as
7595 returned by the
7596 <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7597 or
7598 <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7599 command, &lt;effect-instance&gt; as returned by the
7600 <xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or
7601 <xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref>
7602 command and &lt;chain-pos&gt; the exact position of the
7603 effect chain where the supplied effect shall be inserted
7604 to.</t>
7605 <t>Only unused effect instances can be added to the effect
7606 chain. Trying to add an effect instance which is already in
7607 use somewhere in the audio signal path of the sampler will
7608 result in an error.</t>
7609
7610 <t>Possible Answers:</t>
7611 <t>
7612 <list>
7613 <t>"OK" -
7614 <list>
7615 <t>in case the effect instance was
7616 added successfully to the chain</t>
7617 </list>
7618 </t>
7619 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7620 <list>
7621 <t>if the effect instance could not be added</t>
7622 </list>
7623 </t>
7624 </list>
7625 </t>
7626
7627 <t>Examples:</t>
7628 <t>
7629 <list>
7630 <t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t>
7631 <t>S: "OK"</t>
7632 </list>
7633 </t>
7634 </section>
7635
7636 <section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT">
7637 <t>The front-end can remove an effect instance from a
7638 certain position of a send effect chain by sending the
7639 following command:</t>
7640 <t>
7641 <list>
7642 <t>REMOVE SEND_EFFECT_CHAIN EFFECT &lt;audio-device&gt; &lt;effect-chain&gt; &lt;chain-pos&gt;</t>
7643 </list>
7644 </t>
7645 <t>Where &lt;audio-device&gt; should be replaced by the
7646 numerical ID of the audio output device as given by the
7647 <xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref>
7648 or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref>
7649 command, &lt;effect-chain&gt; by the numerical ID as
7650 returned by the
7651 <xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref>
7652 or
7653 <xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref>
7654 command and &lt;chain-pos&gt; the exact position of the
7655 effect instance to be removed from the effect chain.</t>
7656
7657 <t>Possible Answers:</t>
7658 <t>
7659 <list>
7660 <t>"OK" -
7661 <list>
7662 <t>in case the effect instance was
7663 removed successfully</t>
7664 </list>
7665 </t>
7666 <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
7667 <list>
7668 <t>if the effect instance could not be removed</t>
7669 </list>
7670 </t>
7671 </list>
7672 </t>
7673
7674 <t>Examples:</t>
7675 <t>
7676 <list>
7677 <t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t>
7678 <t>S: "OK"</t>
7679 </list>
7680 </t>
7681 </section>
7682
7683 </section>
7684 </section>
7685
7686 <section title="Command Syntax" anchor="command_syntax">
7687 <t>The grammar of the control protocol as descibed in <xref target="control_commands"/>
7688 is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>)
7689 where applicable.
7690 </t>
7691 <!--
7692 This section is automatically generated by scripts/update_grammar.pl
7693 from src/network/lscp.y (yacc input file). Do not modify this section
7694 manually !
7695 -->
7696 <!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! -->
7697
7698 <t>input =
7699 <list>
7700 <t>line LF
7701 </t>
7702 <t>/ line CR LF
7703 </t>
7704 </list>
7705 </t>
7706 <t>line =
7707 <list>
7708 <t>/* epsilon (empty line ignored) */
7709 </t>
7710 <t>/ comment
7711 </t>
7712 <t>/ command
7713 </t>
7714 <t>/ error
7715 </t>
7716 </list>
7717 </t>
7718 <t>comment =
7719 <list>
7720 <t>'#'
7721 </t>
7722 <t>/ comment '#'
7723 </t>
7724 <t>/ comment SP
7725 </t>
7726 <t>/ comment number
7727 </t>
7728 <t>/ comment string
7729 </t>
7730 </list>
7731 </t>
7732 <t>command =
7733 <list>
7734 <t>ADD SP add_instruction
7735 </t>
7736 <t>/ MAP SP map_instruction
7737 </t>
7738 <t>/ UNMAP SP unmap_instruction
7739 </t>
7740 <t>/ GET SP get_instruction
7741 </t>
7742 <t>/ CREATE SP create_instruction
7743 </t>
7744 <t>/ DESTROY SP destroy_instruction
7745 </t>
7746 <t>/ LIST SP list_instruction
7747 </t>
7748 <t>/ LOAD SP load_instruction
7749 </t>
7750 <t>/ REMOVE SP remove_instruction
7751 </t>
7752 <t>/ SET SP set_instruction
7753 </t>
7754 <t>/ SUBSCRIBE SP subscribe_event
7755 </t>
7756 <t>/ UNSUBSCRIBE SP unsubscribe_event
7757 </t>
7758 <t>/ RESET SP reset_instruction
7759 </t>
7760 <t>/ CLEAR SP clear_instruction
7761 </t>
7762 <t>/ FIND SP find_instruction
7763 </t>
7764 <t>/ MOVE SP move_instruction
7765 </t>
7766 <t>/ COPY SP copy_instruction
7767 </t>
7768 <t>/ EDIT SP edit_instruction
7769 </t>
7770 <t>/ FORMAT SP format_instruction
7771 </t>
7772 <t>/ SEND SP send_instruction
7773 </t>
7774 <t>/ APPEND SP append_instruction
7775 </t>
7776 <t>/ INSERT SP insert_instruction
7777 </t>
7778 <t>/ RESET
7779 </t>
7780 <t>/ QUIT
7781 </t>
7782 </list>
7783 </t>
7784 <t>add_instruction =
7785 <list>
7786 <t>CHANNEL
7787 </t>
7788 <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
7789 </t>
7790 <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
7791 </t>
7792 <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename
7793 </t>
7794 <t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename
7795 </t>
7796 <t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename
7797 </t>
7798 <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename
7799 </t>
7800 <t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index
7801 </t>
7802 <t>/ DB_INSTRUMENTS SP db_path SP filename
7803 </t>
7804 <t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index
7805 </t>
7806 <t>/ MIDI_INSTRUMENT_MAP
7807 </t>
7808 <t>/ MIDI_INSTRUMENT_MAP SP map_name
7809 </t>
7810 <t>/ SEND_EFFECT_CHAIN SP device_index
7811 </t>
7812 </list>
7813 </t>
7814 <t>subscribe_event =
7815 <list>
7816 <t>AUDIO_OUTPUT_DEVICE_COUNT
7817 </t>
7818 <t>/ AUDIO_OUTPUT_DEVICE_INFO
7819 </t>
7820 <t>/ MIDI_INPUT_DEVICE_COUNT
7821 </t>
7822 <t>/ MIDI_INPUT_DEVICE_INFO
7823 </t>
7824 <t>/ CHANNEL_COUNT
7825 </t>
7826 <t>/ CHANNEL_MIDI
7827 </t>
7828 <t>/ DEVICE_MIDI
7829 </t>
7830 <t>/ VOICE_COUNT
7831 </t>
7832 <t>/ STREAM_COUNT
7833 </t>
7834 <t>/ BUFFER_FILL
7835 </t>
7836 <t>/ CHANNEL_INFO
7837 </t>
7838 <t>/ FX_SEND_COUNT
7839 </t>
7840 <t>/ FX_SEND_INFO
7841 </t>
7842 <t>/ MIDI_INSTRUMENT_MAP_COUNT
7843 </t>
7844 <t>/ MIDI_INSTRUMENT_MAP_INFO
7845 </t>
7846 <t>/ MIDI_INSTRUMENT_COUNT
7847 </t>
7848 <t>/ MIDI_INSTRUMENT_INFO
7849 </t>
7850 <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
7851 </t>
7852 <t>/ DB_INSTRUMENT_DIRECTORY_INFO
7853 </t>
7854 <t>/ DB_INSTRUMENT_COUNT
7855 </t>
7856 <t>/ DB_INSTRUMENT_INFO
7857 </t>
7858 <t>/ DB_INSTRUMENTS_JOB_INFO
7859 </t>
7860 <t>/ MISCELLANEOUS
7861 </t>
7862 <t>/ TOTAL_STREAM_COUNT
7863 </t>
7864 <t>/ TOTAL_VOICE_COUNT
7865 </t>
7866 <t>/ GLOBAL_INFO
7867 </t>
7868 </list>
7869 </t>
7870 <t>unsubscribe_event =
7871 <list>
7872 <t>AUDIO_OUTPUT_DEVICE_COUNT
7873 </t>
7874 <t>/ AUDIO_OUTPUT_DEVICE_INFO
7875 </t>
7876 <t>/ MIDI_INPUT_DEVICE_COUNT
7877 </t>
7878 <t>/ MIDI_INPUT_DEVICE_INFO
7879 </t>
7880 <t>/ CHANNEL_COUNT
7881 </t>
7882 <t>/ CHANNEL_MIDI
7883 </t>
7884 <t>/ DEVICE_MIDI
7885 </t>
7886 <t>/ VOICE_COUNT
7887 </t>
7888 <t>/ STREAM_COUNT
7889 </t>
7890 <t>/ BUFFER_FILL
7891 </t>
7892 <t>/ CHANNEL_INFO
7893 </t>
7894 <t>/ FX_SEND_COUNT
7895 </t>
7896 <t>/ FX_SEND_INFO
7897 </t>
7898 <t>/ MIDI_INSTRUMENT_MAP_COUNT
7899 </t>
7900 <t>/ MIDI_INSTRUMENT_MAP_INFO
7901 </t>
7902 <t>/ MIDI_INSTRUMENT_COUNT
7903 </t>
7904 <t>/ MIDI_INSTRUMENT_INFO
7905 </t>
7906 <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
7907 </t>
7908 <t>/ DB_INSTRUMENT_DIRECTORY_INFO
7909 </t>
7910 <t>/ DB_INSTRUMENT_COUNT
7911 </t>
7912 <t>/ DB_INSTRUMENT_INFO
7913 </t>
7914 <t>/ DB_INSTRUMENTS_JOB_INFO
7915 </t>
7916 <t>/ MISCELLANEOUS
7917 </t>
7918 <t>/ TOTAL_STREAM_COUNT
7919 </t>
7920 <t>/ TOTAL_VOICE_COUNT
7921 </t>
7922 <t>/ GLOBAL_INFO
7923 </t>
7924 </list>
7925 </t>
7926 <t>map_instruction =
7927 <list>
7928 <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
7929 </t>
7930 <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
7931 </t>
7932 <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
7933 </t>
7934 <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
7935 </t>
7936 </list>
7937 </t>
7938 <t>unmap_instruction =
7939 <list>
7940 <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
7941 </t>
7942 </list>
7943 </t>
7944 <t>remove_instruction =
7945 <list>
7946 <t>CHANNEL SP sampler_channel
7947 </t>
7948 <t>/ MIDI_INSTRUMENT_MAP SP midi_map
7949 </t>
7950 <t>/ MIDI_INSTRUMENT_MAP SP ALL
7951 </t>
7952 <t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain
7953 </t>
7954 <t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos
7955 </t>
7956 <t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id
7957 </t>
7958 <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
7959 </t>
7960 <t>/ DB_INSTRUMENT_DIRECTORY SP db_path
7961 </t>
7962 <t>/ DB_INSTRUMENT SP db_path
7963 </t>
7964 </list>
7965 </t>
7966 <t>get_instruction =
7967 <list>
7968 <t>AVAILABLE_ENGINES
7969 </t>
7970 <t>/ AVAILABLE_EFFECTS
7971 </t>
7972 <t>/ EFFECT_INSTANCES
7973 </t>
7974 <t>/ EFFECT SP INFO SP effect_index
7975 </t>
7976 <t>/ EFFECT_INSTANCE SP INFO SP effect_instance
7977 </t>
7978 <t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control
7979 </t>
7980 <t>/ SEND_EFFECT_CHAINS SP device_index
7981 </t>
7982 <t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain
7983 </t>
7984 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
7985 </t>
7986 <t>/ MIDI_INPUT_DRIVER SP INFO SP string
7987 </t>
7988 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string
7989 </t>
7990 <t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
7991 </t>
7992 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
7993 </t>
7994 <t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string
7995 </t>
7996 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string
7997 </t>
7998 <t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list
7999 </t>
8000 <t>/ AUDIO_OUTPUT_DEVICES
8001 </t>
8002 <t>/ MIDI_INPUT_DEVICES
8003 </t>
8004 <t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number
8005 </t>
8006 <t>/ MIDI_INPUT_DEVICE SP INFO SP number
8007 </t>
8008 <t>/ MIDI_INPUT_PORT SP INFO SP number SP number
8009 </t>
8010 <t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string
8011 </t>
8012 <t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number
8013 </t>
8014 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string
8015 </t>
8016 <t>/ CHANNELS
8017 </t>
8018 <t>/ CHANNEL SP INFO SP sampler_channel
8019 </t>
8020 <t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel
8021 </t>
8022 <t>/ CHANNEL SP STREAM_COUNT SP sampler_channel
8023 </t>
8024 <t>/ CHANNEL SP VOICE_COUNT SP sampler_channel
8025 </t>
8026 <t>/ ENGINE SP INFO SP engine_name
8027 </t>
8028 <t>/ SERVER SP INFO
8029 </t>
8030 <t>/ TOTAL_STREAM_COUNT
8031 </t>
8032 <t>/ TOTAL_VOICE_COUNT
8033 </t>
8034 <t>/ TOTAL_VOICE_COUNT_MAX
8035 </t>
8036 <t>/ MIDI_INSTRUMENTS SP midi_map
8037 </t>
8038 <t>/ MIDI_INSTRUMENTS SP ALL
8039 </t>
8040 <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
8041 </t>
8042 <t>/ MIDI_INSTRUMENT_MAPS
8043 </t>
8044 <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
8045 </t>
8046 <t>/ FX_SENDS SP sampler_channel
8047 </t>
8048 <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
8049 </t>
8050 <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
8051 </t>
8052 <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
8053 </t>
8054 <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path
8055 </t>
8056 <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
8057 </t>
8058 <t>/ DB_INSTRUMENTS SP db_path
8059 </t>
8060 <t>/ DB_INSTRUMENT SP INFO SP db_path
8061 </t>
8062 <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
8063 </t>
8064 <t>/ VOLUME
8065 </t>
8066 <t>/ VOICES
8067 </t>
8068 <t>/ STREAMS
8069 </t>
8070 <t>/ FILE SP INSTRUMENTS SP filename
8071 </t>
8072 <t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
8073 </t>
8074 </list>
8075 </t>
8076 <t>set_instruction =
8077 <list>
8078 <t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
8079 </t>
8080 <t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list
8081 </t>
8082 <t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list
8083 </t>
8084 <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE
8085 </t>
8086 <t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list
8087 </t>
8088 <t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value
8089 </t>
8090 <t>/ CHANNEL SP set_chan_instruction
8091 </t>
8092 <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
8093 </t>
8094 <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
8095 </t>
8096 <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
8097 </t>
8098 <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
8099 </t>
8100 <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
8101 </t>
8102 <t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos
8103 </t>
8104 <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped
8105 </t>
8106 <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped
8107 </t>
8108 <t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped
8109 </t>
8110 <t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped
8111 </t>
8112 <t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename
8113 </t>
8114 <t>/ ECHO SP boolean
8115 </t>
8116 <t>/ VOLUME SP volume_value
8117 </t>
8118 <t>/ VOICES SP number
8119 </t>
8120 <t>/ STREAMS SP number
8121 </t>
8122 </list>
8123 </t>
8124 <t>create_instruction =
8125 <list>
8126 <t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list
8127 </t>
8128 <t>/ AUDIO_OUTPUT_DEVICE SP string
8129 </t>
8130 <t>/ MIDI_INPUT_DEVICE SP string SP key_val_list
8131 </t>
8132 <t>/ MIDI_INPUT_DEVICE SP string
8133 </t>
8134 <t>/ FX_SEND SP sampler_channel SP midi_ctrl
8135 </t>
8136 <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
8137 </t>
8138 <t>/ EFFECT_INSTANCE SP effect_index
8139 </t>
8140 <t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name
8141 </t>
8142 </list>
8143 </t>
8144 <t>reset_instruction =
8145 <list>
8146 <t>CHANNEL SP sampler_channel
8147 </t>
8148 </list>
8149 </t>
8150 <t>clear_instruction =
8151 <list>
8152 <t>MIDI_INSTRUMENTS SP midi_map
8153 </t>
8154 <t>/ MIDI_INSTRUMENTS SP ALL
8155 </t>
8156 </list>
8157 </t>
8158 <t>find_instruction =
8159 <list>
8160 <t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list
8161 </t>
8162 <t>/ DB_INSTRUMENTS SP db_path SP query_val_list
8163 </t>
8164 <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list
8165 </t>
8166 <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list
8167 </t>
8168 <t>/ LOST SP DB_INSTRUMENT_FILES
8169 </t>
8170 </list>
8171 </t>
8172 <t>move_instruction =
8173 <list>
8174 <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8175 </t>
8176 <t>/ DB_INSTRUMENT SP db_path SP db_path
8177 </t>
8178 </list>
8179 </t>
8180 <t>copy_instruction =
8181 <list>
8182 <t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path
8183 </t>
8184 <t>/ DB_INSTRUMENT SP db_path SP db_path
8185 </t>
8186 </list>
8187 </t>
8188 <t>destroy_instruction =
8189 <list>
8190 <t>AUDIO_OUTPUT_DEVICE SP number
8191 </t>
8192 <t>/ MIDI_INPUT_DEVICE SP number
8193 </t>
8194 <t>/ FX_SEND SP sampler_channel SP fx_send_id
8195 </t>
8196 <t>/ EFFECT_INSTANCE SP number
8197 </t>
8198 </list>
8199 </t>
8200 <t>load_instruction =
8201 <list>
8202 <t>INSTRUMENT SP load_instr_args
8203 </t>
8204 <t>/ ENGINE SP load_engine_args
8205 </t>
8206 </list>
8207 </t>
8208 <t>append_instruction =
8209 <list>
8210 <t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance
8211 </t>
8212 </list>
8213 </t>
8214 <t>insert_instruction =
8215 <list>
8216 <t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance
8217 </t>
8218 </list>
8219 </t>
8220 <t>set_chan_instruction =
8221 <list>
8222 <t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index
8223 </t>
8224 <t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index
8225 </t>
8226 <t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name
8227 </t>
8228 <t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index
8229 </t>
8230 <t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index
8231 </t>
8232 <t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index
8233 </t>
8234 <t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index
8235 </t>
8236 <t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name
8237 </t>
8238 <t>/ VOLUME SP sampler_channel SP volume_value
8239 </t>
8240 <t>/ MUTE SP sampler_channel SP boolean
8241 </t>
8242 <t>/ SOLO SP sampler_channel SP boolean
8243 </t>
8244 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
8245 </t>
8246 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
8247 </t>
8248 <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
8249 </t>
8250 </list>
8251 </t>
8252 <t>edit_instruction =
8253 <list>
8254 <t>CHANNEL SP INSTRUMENT SP sampler_channel
8255 </t>
8256 </list>
8257 </t>
8258 <t>format_instruction =
8259 <list>
8260 <t>INSTRUMENTS_DB
8261 </t>
8262 </list>
8263 </t>
8264 <t>modal_arg =
8265 <list>
8266 <t>/* epsilon (empty argument) */
8267 </t>
8268 <t>/ NON_MODAL SP
8269 </t>
8270 </list>
8271 </t>
8272 <t>key_val_list =
8273 <list>
8274 <t>string '=' param_val_list
8275 </t>
8276 <t>/ key_val_list SP string '=' param_val_list
8277 </t>
8278 </list>
8279 </t>
8280 <t>buffer_size_type =
8281 <list>
8282 <t>BYTES
8283 </t>
8284 <t>/ PERCENTAGE
8285 </t>
8286 </list>
8287 </t>
8288 <t>list_instruction =
8289 <list>
8290 <t>AUDIO_OUTPUT_DEVICES
8291 </t>
8292 <t>/ MIDI_INPUT_DEVICES
8293 </t>
8294 <t>/ CHANNELS
8295 </t>
8296 <t>/ AVAILABLE_ENGINES
8297 </t>
8298 <t>/ AVAILABLE_EFFECTS
8299 </t>
8300 <t>/ EFFECT_INSTANCES
8301 </t>
8302 <t>/ SEND_EFFECT_CHAINS SP number
8303 </t>
8304 <t>/ AVAILABLE_MIDI_INPUT_DRIVERS
8305 </t>
8306 <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
8307 </t>
8308 <t>/ MIDI_INSTRUMENTS SP midi_map
8309 </t>
8310 <t>/ MIDI_INSTRUMENTS SP ALL
8311 </t>
8312 <t>/ MIDI_INSTRUMENT_MAPS
8313 </t>
8314 <t>/ FX_SENDS SP sampler_channel
8315 </t>
8316 <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
8317 </t>
8318 <t>/ DB_INSTRUMENT_DIRECTORIES SP db_path
8319 </t>
8320 <t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path
8321 </t>
8322 <t>/ DB_INSTRUMENTS SP db_path
8323 </t>
8324 <t>/ FILE SP INSTRUMENTS SP filename
8325 </t>
8326 </list>
8327 </t>
8328 <t>send_instruction =
8329 <list>
8330 <t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number
8331 </t>
8332 </list>
8333 </t>
8334 <t>load_instr_args =
8335 <list>
8336 <t>filename SP instrument_index SP sampler_channel
8337 </t>
8338 <t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel
8339 </t>
8340 </list>
8341 </t>
8342 <t>load_engine_args =
8343 <list>
8344 <t>engine_name SP sampler_channel
8345 </t>
8346 </list>
8347 </t>
8348 <t>instr_load_mode =
8349 <list>
8350 <t>ON_DEMAND
8351 </t>
8352 <t>/ ON_DEMAND_HOLD
8353 </t>
8354 <t>/ PERSISTENT
8355 </t>
8356 </list>
8357 </t>
8358 <t>effect_instance =
8359 <list>
8360 <t>number
8361 </t>
8362 </list>
8363 </t>
8364 <t>device_index =
8365 <list>
8366 <t>number
8367 </t>
8368 </list>
8369 </t>
8370 <t>audio_channel_index =
8371 <list>
8372 <t>number
8373 </t>
8374 </list>
8375 </t>
8376 <t>audio_output_type_name =
8377 <list>
8378 <t>string
8379 </t>
8380 </list>
8381 </t>
8382 <t>midi_input_port_index =
8383 <list>
8384 <t>number
8385 </t>
8386 </list>
8387 </t>
8388 <t>midi_input_channel_index =
8389 <list>
8390 <t>number
8391 </t>
8392 <t>/ ALL
8393 </t>
8394 </list>
8395 </t>
8396 <t>midi_input_type_name =
8397 <list>
8398 <t>string
8399 </t>
8400 </list>
8401 </t>
8402 <t>midi_map =
8403 <list>
8404 <t>number
8405 </t>
8406 </list>
8407 </t>
8408 <t>midi_bank =
8409 <list>
8410 <t>number
8411 </t>
8412 </list>
8413 </t>
8414 <t>midi_prog =
8415 <list>
8416 <t>number
8417 </t>
8418 </list>
8419 </t>
8420 <t>midi_ctrl =
8421 <list>
8422 <t>number
8423 </t>
8424 </list>
8425 </t>
8426 <t>volume_value =
8427 <list>
8428 <t>dotnum
8429 </t>
8430 <t>/ number
8431 </t>
8432 </list>
8433 </t>
8434 <t>control_value =
8435 <list>
8436 <t>real
8437 </t>
8438 </list>
8439 </t>
8440 <t>sampler_channel =
8441 <list>
8442 <t>number
8443 </t>
8444 </list>
8445 </t>
8446 <t>instrument_index =
8447 <list>
8448 <t>number
8449 </t>
8450 </list>
8451 </t>
8452 <t>fx_send_id =
8453 <list>
8454 <t>number
8455 </t>
8456 </list>
8457 </t>
8458 <t>engine_name =
8459 <list>
8460 <t>string
8461 </t>
8462 </list>
8463 </t>
8464 <t>filename =
8465 <list>
8466 <t>path
8467 </t>
8468 </list>
8469 </t>
8470 <t>db_path =
8471 <list>
8472 <t>path
8473 </t>
8474 </list>
8475 </t>
8476 <t>map_name =
8477 <list>
8478 <t>stringval_escaped
8479 </t>
8480 </list>
8481 </t>
8482 <t>entry_name =
8483 <list>
8484 <t>stringval_escaped
8485 </t>
8486 </list>
8487 </t>
8488 <t>fx_send_name =
8489 <list>
8490 <t>stringval_escaped
8491 </t>
8492 </list>
8493 </t>
8494 <t>effect_name =
8495 <list>
8496 <t>stringval_escaped
8497 </t>
8498 </list>
8499 </t>
8500 <t>effect_index =
8501 <list>
8502 <t>number
8503 </t>
8504 </list>
8505 </t>
8506 <t>effect_chain =
8507 <list>
8508 <t>number
8509 </t>
8510 </list>
8511 </t>
8512 <t>chain_pos =
8513 <list>
8514 <t>number
8515 </t>
8516 </list>
8517 </t>
8518 <t>input_control =
8519 <list>
8520 <t>number
8521 </t>
8522 </list>
8523 </t>
8524 <t>param_val_list =
8525 <list>
8526 <t>param_val
8527 </t>
8528 <t>/ param_val_list','param_val
8529 </t>
8530 </list>
8531 </t>
8532
8533 <t>param_val =
8534 <list>
8535 <t>string
8536 </t>
8537 <t>/ stringval
8538 </t>
8539 <t>/ number
8540 </t>
8541 <t>/ dotnum
8542 </t>
8543 </list>
8544 </t>
8545 <t>query_val_list =
8546 <list>
8547 <t>string '=' query_val
8548 </t>
8549 <t>/ query_val_list SP string '=' query_val
8550 </t>
8551 </list>
8552 </t>
8553 <t>query_val =
8554 <list>
8555 <t>text_escaped
8556 </t>
8557 <t>/ stringval_escaped
8558 </t>
8559 </list>
8560 </t>
8561 <t>scan_mode =
8562 <list>
8563 <t>RECURSIVE
8564 </t>
8565 <t>/ NON_RECURSIVE
8566 </t>
8567 <t>/ FLAT
8568 </t>
8569 </list>
8570 </t>
8571 <t>effect_system =
8572 <list>
8573 <t>string
8574 </t>
8575 </list>
8576 </t>
8577 <t>module =
8578 <list>
8579 <t>filename
8580 </t>
8581 </list>
8582 </t>
8583
8584 <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
8585
8586 <section title="Character Set and Escape Sequences" anchor="character_set">
8587 <t>Older versions of this protocol up to and including v1.1 only
8588 supported the standard ASCII character set (ASCII code 0 - 127)
8589 <xref target="RFC20"/>, all younger versions of this protocol
8590 however support the Extended ASCII character set (ASCII code
8591 0 - 255). The same group of younger protocols also support
8592 escape sequences, but only for certain, explicitly declared
8593 parts of the protocol. The supported escape sequences are
8594 defined as follows:</t>
8595 <texttable>
8596 <ttcol>ASCII Character Sequence</ttcol>
8597 <ttcol>Translated into (Name)</ttcol>
8598 <c>\n</c> <c>new line</c>
8599 <c>\r</c> <c>carriage return</c>
8600 <c>\f</c> <c>form feed</c>
8601 <c>\t</c> <c>horizontal tab</c>
8602 <c>\v</c> <c>vertical tab</c>
8603 <c>\'</c> <c>apostrophe</c>
8604 <c>\"</c> <c>quotation mark</c>
8605 <c>\\</c> <c>backslash</c>
8606 <c>\OOO</c> <c>three digit octal ASCII code of the character</c>
8607 <c>\xHH</c> <c>two digit hex ASCII code of the character</c>
8608 </texttable>
8609 <t>Notice: due to the transition of certain parts of the
8610 protocol which now support escape sequences, a slight backward
8611 incompatibility to protocols version v1.1 and younger has been
8612 introduced. The only difference is that in parts of the protocol
8613 where escape characters are now supported, a backslash characters
8614 MUST be escaped as well (that is as double backslash), whereas
8615 in the old versions a single backslash was sufficient.</t>
8616
8617 <t>The following LSCP commands support escape sequences as part
8618 of their filename / path based arguments and / or may contain
8619 a filename / path with escape sequences in their response:
8620 <list>
8621 <t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t>
8622 <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
8623 <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
8624 <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
8625 <t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t>
8626 <t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t>
8627 <t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
8628 <t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t>
8629 <t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t>
8630 <t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t>
8631 <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
8632 <t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t>
8633 <t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t>
8634 <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
8635 <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
8636 <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
8637 <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
8638 <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
8639 <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
8640 <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
8641 <t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t>
8642 <t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t>
8643 <t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t>
8644 <t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t>
8645 <t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t>
8646 <t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t>
8647 <t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t>
8648 <t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t>
8649 <t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t>
8650 <t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t>
8651 <t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t>
8652 <t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t>
8653 </list>
8654 Note that the forward slash character ('/') has a special meaning in
8655 filename / path based arguments: it acts as separator of the nodes in
8656 the path, thus if a directory- or filename includes a forward slash
8657 (not intended as path node separator), you MUST escape that slash
8658 either with the respective hex escape sequence ("\x2f") or with the
8659 respective octal escape sequence ("\057").
8660 </t>
8661
8662 <t>
8663 Note for Windows: file path arguments in LSCP are expected
8664 to use forward slashes as directory node separator similar
8665 to Unix based operating systems. In contrast to Unix however
8666 a Windows typical drive character is expected to be
8667 prefixed to the path. That is an original Windows file path
8668 like "D:\Sounds\My.gig" would become in LSCP:
8669 "D:/Sounds/My.gig".
8670 </t>
8671
8672 <t>
8673 The following LSCP commands even support escape sequences as
8674 part of at least one of their text-based arguments (i.e. entity name,
8675 description) and / or may contain escape sequences in at least one of
8676 their text-based fields in their response:
8677 <list>
8678 <t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t>
8679 <t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t>
8680 <t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t>
8681 <t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t>
8682 <t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t>
8683 <t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t>
8684 <t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t>
8685 <t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t>
8686 <t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t>
8687 <t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t>
8688 <t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t>
8689 <t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t>
8690 <t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t>
8691 <t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t>
8692 <t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t>
8693 <t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t>
8694 <t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t>
8695 <t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t>
8696 <t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t>
8697 <t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t>
8698 <t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t>
8699 <t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t>
8700 </list>
8701 Please note that these lists are manually maintained. If you
8702 find a command that also supports escape sequences we forgot to
8703 mention here, please report it!
8704 </t>
8705 </section>
8706 </section>
8707
8708 <section title="Events" anchor="events">
8709 <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
8710
8711 <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
8712 <t>Client may want to be notified when the total number of audio output devices on the
8713 back-end changes by issuing the following command:</t>
8714 <t>
8715 <list>
8716 <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
8717 </list>
8718 </t>
8719 <t>Server will start sending the following notification messages:</t>
8720 <t>
8721 <list>
8722 <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
8723 </list>
8724 </t>
8725 <t>where &lt;devices&gt; will be replaced by the new number
8726 of audio output devices.</t>
8727 </section>
8728
8729 <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
8730 <t>Client may want to be notified when changes were made to audio output devices on the
8731 back-end by issuing the following command:</t>
8732 <t>
8733 <list>
8734 <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
8735 </list>
8736 </t>
8737 <t>Server will start sending the following notification messages:</t>
8738 <t>
8739 <list>
8740 <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
8741 </list>
8742 </t>
8743 <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
8744 which settings has been changed. The front-end will have to send
8745 the respective command to actually get the audio output device info. Because these messages
8746 will be triggered by LSCP commands issued by other clients rather than real
8747 time events happening on the server, it is believed that an empty notification
8748 message is sufficient here.</t>
8749 </section>
8750
8751 <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
8752 <t>Client may want to be notified when the total number of MIDI input devices on the
8753 back-end changes by issuing the following command:</t>
8754 <t>
8755 <list>
8756 <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
8757 </list>
8758 </t>
8759 <t>Server will start sending the following notification messages:</t>
8760 <t>
8761 <list>
8762 <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
8763 </list>
8764 </t>
8765 <t>where &lt;devices&gt; will be replaced by the new number
8766 of MIDI input devices.</t>
8767 </section>
8768
8769 <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
8770 <t>Client may want to be notified when changes were made to MIDI input devices on the
8771 back-end by issuing the following command:</t>
8772 <t>
8773 <list>
8774 <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
8775 </list>
8776 </t>
8777 <t>Server will start sending the following notification messages:</t>
8778 <t>
8779 <list>
8780 <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
8781 </list>
8782 </t>
8783 <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
8784 which settings has been changed. The front-end will have to send
8785 the respective command to actually get the MIDI input device info. Because these messages
8786 will be triggered by LSCP commands issued by other clients rather than real
8787 time events happening on the server, it is believed that an empty notification
8788 message is sufficient here.</t>
8789 </section>
8790
8791 <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
8792 <t>Client may want to be notified when the total number of channels on the
8793 back-end changes by issuing the following command:</t>
8794 <t>
8795 <list>
8796 <t>SUBSCRIBE CHANNEL_COUNT</t>
8797 </list>
8798 </t>
8799 <t>Server will start sending the following notification messages:</t>
8800 <t>
8801 <list>
8802 <t>"NOTIFY:CHANNEL_COUNT:&lt;channels&gt;"</t>
8803 </list>
8804 </t>
8805 <t>where &lt;channels&gt; will be replaced by the new number
8806 of sampler channels.</t>
8807 </section>
8808
8809 <section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI">
8810 <t>Client may want to be notified when MIDI data arrive on sampler channels on
8811 back-end side, by issuing the following command:</t>
8812 <t>
8813 <list>
8814 <t>SUBSCRIBE CHANNEL_MIDI</t>
8815 </list>
8816 </t>
8817 <t>Server will start sending one of the the following notification messages:</t>
8818 <t>
8819 <list>
8820 <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
8821 <t>"NOTIFY:CHANNEL_MIDI:&lt;channel-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
8822 </list>
8823 </t>
8824 <t>where &lt;channel-id&gt; will be replaced by the ID of the sampler channel where the MIDI
8825 data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
8826 0 .. 127, reflecting the analog meaning of the MIDI specification.
8827 </t>
8828 <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
8829 delivered by this mechanism! With other words: events could be lost at any time!
8830 This restriction was made to keep the RT-safeness of the backend's MIDI and audio
8831 thread unaffected by this feature.</t>
8832 </section>
8833
8834 <section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI">
8835 <t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t>
8836 <t>
8837 <list>
8838 <t>SUBSCRIBE DEVICE_MIDI</t>
8839 </list>
8840 </t>
8841 <t>Server will start sending one of the the following notification messages:</t>
8842 <t>
8843 <list>
8844 <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_ON &lt;note&gt; &lt;velocity&gt;"</t>
8845 <t>"NOTIFY:DEVICE_MIDI:&lt;device-id&gt; &lt;port-id&gt; NOTE_OFF &lt;note&gt; &lt;velocity&gt;"</t>
8846 </list>
8847 </t>
8848 <t>where &lt;device-id&gt; &lt;port-id&gt; will be replaced
8849 by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI
8850 data arrived. &lt;note&gt; and &lt;velocity&gt; are integer values in the range between
8851 0 .. 127, reflecting the analog meaning of the MIDI specification.
8852 </t>
8853 <t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all
8854 delivered by this mechanism! With other words: events could be lost at any time!
8855 This restriction was made to keep the RT-safeness of the backend's MIDI and audio
8856 thread unaffected by this feature.</t>
8857 </section>
8858
8859 <section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT">
8860 <t>Client may want to be notified when the number of voices on the
8861 back-end changes by issuing the following command:</t>
8862 <t>
8863 <list>
8864 <t>SUBSCRIBE VOICE_COUNT</t>
8865 </list>
8866 </t>
8867 <t>Server will start sending the following notification messages:</t>
8868 <t>
8869 <list>
8870 <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
8871 </list>
8872 </t>
8873 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
8874 voice count change occurred and &lt;voices&gt; by the new number of
8875 active voices on that channel.</t>
8876 </section>
8877
8878 <section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT">
8879 <t>Client may want to be notified when the number of streams on the back-end
8880 changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t>
8881 <t>
8882 <list>
8883 <t>SUBSCRIBE STREAM_COUNT</t>
8884 </list>
8885 </t>
8886 <t>Server will start sending the following notification messages:</t>
8887 <t>
8888 <list>
8889 <t>"NOTIFY:STREAM_COUNT:&lt;sampler-channel&gt; &lt;streams&gt;"</t>
8890 </list>
8891 </t>
8892 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
8893 stream count change occurred and &lt;streams&gt; by the new number of
8894 active disk streams on that channel.</t>
8895 </section>
8896
8897 <section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL">
8898 <t>Client may want to be notified when the buffer fill state of a disk stream
8899 on the back-end changes by issuing the following command:</t>
8900 <t>
8901 <list>
8902 <t>SUBSCRIBE BUFFER_FILL</t>
8903 </list>
8904 </t>
8905 <t>Server will start sending the following notification messages:</t>
8906 <t>
8907 <list>
8908 <t>"NOTIFY:BUFFER_FILL:&lt;sampler-channel&gt; &lt;fill-data&gt;"</t>
8909 </list>
8910 </t>
8911 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
8912 buffer fill state change occurred on and &lt;fill-data&gt; will be replaced by the
8913 buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" />
8914 as if the <xref target="GET CHANNEL BUFFER_FILL">
8915 "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
8916 </section>
8917
8918 <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
8919 <t>Client may want to be notified when changes were made to sampler channels on the
8920 back-end by issuing the following command:</t>
8921 <t>
8922 <list>
8923 <t>SUBSCRIBE CHANNEL_INFO</t>
8924 </list>
8925 </t>
8926 <t>Server will start sending the following notification messages:</t>
8927 <t>
8928 <list>
8929 <t>"NOTIFY:CHANNEL_INFO:&lt;sampler-channel&gt;"</t>
8930 </list>
8931 </t>
8932 <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
8933 channel info change occurred. The front-end will have to send
8934 the respective command to actually get the channel info. Because these messages
8935 will be triggered by LSCP commands issued by other clients rather than real
8936 time events happening on the server, it is believed that an empty notification
8937 message is sufficient here.</t>
8938 </section>
8939
8940 <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
8941 <t>Client may want to be notified when the number of effect sends on
8942 a particular sampler channel is changed by issuing the following command:</t>
8943 <t>
8944 <list>
8945 <t>SUBSCRIBE FX_SEND_COUNT</t>
8946 </list>
8947 </t>
8948 <t>Server will start sending the following notification messages:</t>
8949 <t>
8950 <list>
8951 <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
8952 </list>
8953 </t>
8954 <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
8955 channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
8956 be replaced by the new number of effect sends on that channel.</t>
8957 </section>
8958
8959 <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
8960 <t>Client may want to be notified when changes were made to effect sends on a
8961 a particular sampler channel by issuing the following command:</t>
8962 <t>
8963 <list>
8964 <t>SUBSCRIBE FX_SEND_INFO</t>
8965 </list>
8966 </t>
8967 <t>Server will start sending the following notification messages:</t>
8968 <t>
8969 <list>
8970 <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
8971 </list>
8972 </t>
8973 <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
8974 channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
8975 be replaced by the numerical ID of the changed effect send.</t>
8976 </section>
8977
8978 <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
8979 <t>Client may want to be notified when the total number of voices on the
8980 back-end changes by issuing the following command:</t>
8981 <t>
8982 <list>
8983 <t>SUBSCRIBE TOTAL_VOICE_COUNT</t>
8984 </list>
8985 </t>
8986 <t>Server will start sending the following notification messages:</t>
8987 <t>
8988 <list>
8989 <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
8990 </list>
8991 </t>
8992 <t>where &lt;voices&gt; will be replaced by the new number of
8993 all currently active voices.</t>
8994 </section>
8995
8996 <section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT">
8997 <t>Client may want to be notified when the total number of disk streams on the
8998 back-end changes by issuing the following command:</t>
8999 <t>
9000 <list>
9001 <t>SUBSCRIBE TOTAL_STREAM_COUNT</t>
9002 </list>
9003 </t>
9004 <t>Server will start sending the following notification messages:</t>
9005 <t>
9006 <list>
9007 <t>"NOTIFY:TOTAL_STREAM_COUNT:&lt;streams&gt;"</t>
9008 </list>
9009 </t>
9010 <t>where &lt;streams&gt; will be replaced by the new number of
9011 all currently active disk streams.</t>
9012 </section>
9013
9014 <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
9015 <t>Client may want to be notified when the number of MIDI instrument maps on the
9016 back-end changes by issuing the following command:</t>
9017 <t>
9018 <list>
9019 <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
9020 </list>
9021 </t>
9022 <t>Server will start sending the following notification messages:</t>
9023 <t>
9024 <list>
9025 <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
9026 </list>
9027 </t>
9028 <t>where &lt;maps&gt; will be replaced by the new number
9029 of MIDI instrument maps.</t>
9030 </section>
9031
9032 <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
9033 <t>Client may want to be notified when changes were made to MIDI instrument maps on the
9034 back-end by issuing the following command:</t>
9035 <t>
9036 <list>
9037 <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
9038 </list>
9039 </t>
9040 <t>Server will start sending the following notification messages:</t>
9041 <t>
9042 <list>
9043 <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
9044 </list>
9045 </t>
9046 <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
9047 for which information changes occurred. The front-end will have to send
9048 the respective command to actually get the MIDI instrument map info. Because these messages
9049 will be triggered by LSCP commands issued by other clients rather than real
9050 time events happening on the server, it is believed that an empty notification
9051 message is sufficient here.</t>
9052 </section>
9053
9054 <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
9055 <t>Client may want to be notified when the number of MIDI instrument maps on the
9056 back-end changes by issuing the following command:</t>
9057 <t>
9058 <list>
9059 <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
9060 </list>
9061 </t>
9062 <t>Server will start sending the following notification messages:</t>
9063 <t>
9064 <list>
9065 <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
9066 </list>
9067 </t>
9068 <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
9069 the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
9070 the new number of MIDI instruments in the specified map.</t>
9071 </section>
9072
9073 <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
9074 <t>Client may want to be notified when changes were made to MIDI instruments on the
9075 back-end by issuing the following command:</t>
9076 <t>
9077 <list>
9078 <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
9079 </list>
9080 </t>
9081 <t>Server will start sending the following notification messages:</t>
9082 <t>
9083 <list>
9084 <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
9085 </list>
9086 </t>
9087 <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
9088 in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
9089 the location of the changed MIDI instrument in the map. The front-end will have to send
9090 the respective command to actually get the MIDI instrument info. Because these messages
9091 will be triggered by LSCP commands issued by other clients rather than real
9092 time events happening on the server, it is believed that an empty notification
9093 message is sufficient here.</t>
9094 </section>
9095
9096 <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
9097 <t>Client may want to be notified when changes to the global settings
9098 of the sampler were made by issuing the following command:</t>
9099 <t>
9100 <list>
9101 <t>SUBSCRIBE GLOBAL_INFO</t>
9102 </list>
9103 </t>
9104 <t>Server will start sending the following types of notification messages:</t>
9105 <t>
9106 <list>
9107 <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
9108 golbal volume of the sampler is changed, where &lt;volume&gt; will be
9109 replaced by the optional dotted floating point value, reflecting the
9110 new global volume parameter.</t>
9111 </list>
9112 <list>
9113 <t>"NOTIFY:GLOBAL_INFO:VOICES &lt;max-voices&gt;" - Notifies that the
9114 golbal limit of the sampler for maximum voices is changed, where
9115 &lt;max-voices&gt; will be an integer value, reflecting the
9116 new global voice limit parameter.</t>
9117 </list>
9118 <list>
9119 <t>"NOTIFY:GLOBAL_INFO:STREAMS &lt;max-streams&gt;" - Notifies that the
9120 golbal limit of the sampler for maximum disk streams is changed, where
9121 &lt;max-streams&gt; will be an integer value, reflecting the
9122 new global disk streams limit parameter.</t>
9123 </list>
9124 </t>
9125 </section>
9126
9127 <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
9128 <t>Client may want to be notified when the number of instrument
9129 directories in a particular directory in the instruments database
9130 is changed by issuing the following command:</t>
9131 <t>
9132 <list>
9133 <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
9134 </list>
9135 </t>
9136 <t>Server will start sending the following notification messages:</t>
9137 <t>
9138 <list>
9139 <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
9140 </list>
9141 </t>
9142 <t>where &lt;dir-path&gt; will be replaced by the absolute path
9143 name of the directory in the instruments database,
9144 in which the number of directories is changed.</t>
9145 <t>Note that when a non-empty directory is removed, this event
9146 is not sent for the subdirectories in that directory.</t>
9147 </section>
9148
9149 <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
9150 <t>Client may want to be notified when changes were made to directories
9151 in the instruments database by issuing the following command:</t>
9152 <t>
9153 <list>
9154 <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
9155 </list>
9156 </t>
9157 <t>Server will start sending the following notification messages:</t>
9158 <t>
9159 <list>
9160 <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
9161 </list>
9162 </t>
9163 <t>where &lt;dir-path&gt; will be replaced by the absolute path name
9164 of the directory, for which information changes occurred. The front-end will have to send
9165 the respective command to actually get the updated directory info. Because these messages
9166 will be triggered by LSCP commands issued by other clients rather than real
9167 time events happening on the server, it is believed that an empty notification
9168 message is sufficient here.</t>
9169 <t>
9170 <list>
9171 <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
9172 </list>
9173 </t>
9174 <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
9175 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
9176 the new name of the directory, encapsulated into apostrophes.</t>
9177 </section>
9178
9179 <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
9180 <t>Client may want to be notified when the number of instruments
9181 in a particular directory in the instruments database
9182 is changed by issuing the following command:</t>
9183 <t>
9184 <list>
9185 <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
9186 </list>
9187 </t>
9188 <t>Server will start sending the following notification messages:</t>
9189 <t>
9190 <list>
9191 <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
9192 </list>
9193 </t>
9194 <t>where &lt;dir-path&gt; will be replaced by the absolute path
9195 name of the directory in the instruments database,
9196 in which the number of instruments is changed.</t>
9197 <t>Note that when a non-empty directory is removed, this event
9198 is not sent for the instruments in that directory.</t>
9199 </section>
9200
9201 <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
9202 <t>Client may want to be notified when changes were made to instruments
9203 in the instruments database by issuing the following command:</t>
9204 <t>
9205 <list>
9206 <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
9207 </list>
9208 </t>
9209 <t>Server will start sending the following notification messages:</t>
9210 <t>
9211 <list>
9212 <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
9213 </list>
9214 </t>
9215 <t>where &lt;instr-path&gt; will be replaced by the absolute path name
9216 of the instrument, which settings are changed. The front-end will have to send
9217 the respective command to actually get the updated directory info. Because these messages
9218 will be triggered by LSCP commands issued by other clients rather than real
9219 time events happening on the server, it is believed that an empty notification
9220 message is sufficient here.</t>
9221 <t>
9222 <list>
9223 <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
9224 </list>
9225 </t>
9226 <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
9227 (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
9228 the new name of the instrument, encapsulated into apostrophes.</t>
9229 </section>
9230
9231 <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
9232 <t>Client may want to be notified when the status of particular database
9233 instruments job is changed by issuing the following command:</t>
9234 <t>
9235 <list>
9236 <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
9237 </list>
9238 </t>
9239 <t>Server will start sending the following notification messages:</t>
9240 <t>
9241 <list>
9242 <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
9243 </list>
9244 </t>
9245 <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
9246 which status is changed. The front-end will have to send the respective
9247 command to actually get the status info. Because these messages
9248 will be triggered by LSCP commands issued by other clients rather than real
9249 time events happening on the server, it is believed that an empty notification
9250 message is sufficient here.</t>
9251 </section>
9252
9253 <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
9254 <t>Client may want to be notified of miscellaneous and debugging events occurring at
9255 the server by issuing the following command:</t>
9256 <t>
9257 <list>
9258 <t>SUBSCRIBE MISCELLANEOUS</t>
9259 </list>
9260 </t>
9261 <t>Server will start sending the following notification messages:</t>
9262 <t>
9263 <list>
9264 <t>"NOTIFY:MISCELLANEOUS:&lt;string&gt;"</t>
9265 </list>
9266 </t>
9267 <t>where &lt;string&gt; will be replaced by whatever data server
9268 wants to send to the client. Client MAY display this data to the
9269 user AS IS to facilitate debugging.</t>
9270 </section>
9271 </section>
9272
9273 <section title="Security Considerations">
9274 <t>As there is so far no method of authentication and authorization
9275 defined and so not required for a client applications to succeed to
9276 connect, running LinuxSampler might be a security risk for the host
9277 system the LinuxSampler instance is running on.</t>
9278 </section>
9279
9280 <section title="Acknowledgments">
9281 <t>This document has benefited greatly from the comments of the
9282 following people, discussed on the LinuxSampler developer's mailing
9283 list:</t>
9284 <t>
9285 <list>
9286 <t>Rui Nuno Capela</t>
9287 <t>Vladimir Senkov</t>
9288 <t>Mark Knecht</t>
9289 <t>Grigor Iliev</t>
9290 </list>
9291 </t>
9292 </section>
9293
9294 </middle>
9295
9296 <back>
9297 <references>
9298 <reference anchor="RFC2119">
9299 <front>
9300 <title>Key words for use in RFCs to Indicate Requirement Levels</title>
9301 <author initials="S." surname="Bradner" fullname="Scott Bradner">
9302 <organization>Harvard University</organization>
9303 </author>
9304 <date year="1997"></date>
9305 </front>
9306 <seriesInfo name="RFC" value="2119" />
9307 </reference>
9308 <reference anchor="RFC793">
9309 <front>
9310 <title>TRANSMISSION CONTROL PROTOCOL</title>
9311 <author>
9312 <organization>Defense Advanced Research Projects Agency</organization>
9313 </author>
9314 <date year="1981"></date>
9315 </front>
9316 <seriesInfo name="RFC" value="793" />
9317 </reference>
9318 <reference anchor="RFC2234">
9319 <front>
9320 <title>Augmented BNF for Syntax Specifications</title>
9321 <author initials="D.H." surname="Crocker" fullname="David H. Crocker">
9322 <organization>Internet Mail Consortium</organization>
9323 </author>
9324 <author initials="P." surname="Overell" fullname="Paul Overell">
9325 <organization>Demon Internet Ltd</organization>
9326 </author>
9327 <date year="1997"></date>
9328 </front>
9329 <seriesInfo name="RFC" value="2234" />
9330 </reference>
9331 <reference anchor="RFC20">
9332 <front>
9333 <title>ASCII format for Network Interchange</title>
9334 <author>
9335 <organization>UCLA</organization>
9336 </author>
9337 <date year="1969"></date>
9338 </front>
9339 <seriesInfo name="RFC" value="20" />
9340 </reference>
9341 </references>
9342 </back>
9343
9344 </rfc>

  ViewVC Help
Powered by ViewVC