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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

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

  ViewVC Help
Powered by ViewVC