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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1541 - (hide annotations) (download) (as text)
Tue Dec 4 18:09:26 2007 UTC (16 years, 3 months ago) by iliev
File MIME type: text/xml
File size: 380301 byte(s)
- Added support for monitoring the total number of active disk streams
  (new LSCP commands: GET TOTAL_STREAM_COUNT,
  SUBSCRIBE TOTAL_STREAM_COUNT, UNSUBSCRIBE TOTAL_STREAM_COUNT)

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

  ViewVC Help
Powered by ViewVC