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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1362 - (show annotations) (download) (as text)
Sun Sep 30 21:33:26 2007 UTC (16 years, 6 months ago) by schoenebeck
File MIME type: text/xml
File size: 370194 byte(s)
- added new LSCP command "EDIT INSTRUMENT"

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

  ViewVC Help
Powered by ViewVC