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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1782 - (hide annotations) (download) (as text)
Tue Sep 30 02:16:41 2008 UTC (15 years, 6 months ago) by iliev
File MIME type: text/xml
File size: 402337 byte(s)
* updated the lscp spec
* code cleanup in InstrumentsDb

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

  ViewVC Help
Powered by ViewVC