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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2135 - (hide annotations) (download) (as text)
Thu Sep 30 20:00:43 2010 UTC (13 years, 6 months ago) by schoenebeck
File MIME type: text/xml
File size: 412867 byte(s)
* added and implemented a set of 19 new LSCP commands for controlling
  internal effects:
  - added LSCP command "GET AVAILABLE_EFFECTS"
  - added LSCP command "LIST AVAILABLE_EFFECTS"
  - added LSCP command "GET EFFECT INFO <effect-index>"
  - added LSCP command "CREATE EFFECT_INSTANCE <effect-index>"
  - added LSCP command
    "CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name>"
  - added LSCP command "DESTROY EFFECT_INSTANCE <effect-instance>"
  - added LSCP command "GET EFFECT_INSTANCES"
  - added LSCP command "LIST EFFECT_INSTANCES"
  - added LSCP command "GET EFFECT_INSTANCE INFO <effect-instance>"
  - added LSCP command "GET EFFECT_INSTANCE_INPUT_CONTROL INFO
    <effect-instance> <input-control>"
  - added LSCP command "SET EFFECT_INSTANCE_INPUT_CONTROL <effect-instance>
    <input-control> <value>"
  - added LSCP command "GET MASTER_EFFECT_CHAINS <audio-device>"
  - added LSCP command "LIST MASTER_EFFECT_CHAINS <audio-device>"
  - added LSCP command "ADD MASTER_EFFECT_CHAIN <audio-device>"
  - added LSCP command
    "REMOVE MASTER_EFFECT_CHAIN <audio-device> <effect-chain>"
  - added LSCP command
    "GET MASTER_EFFECT_CHAIN INFO <audio-device> <effect-chain>"
  - added LSCP command "APPEND MASTER_EFFECT_CHAIN EFFECT <audio-device>
    <effect-chain> <effect-instance>"
  - added LSCP command "INSERT MASTER_EFFECT_CHAIN EFFECT <audio-device>
    <effect-chain> <effect-instance> <effect-chain-pos>"
  - added LSCP command "REMOVE MASTER_EFFECT_CHAIN EFFECT <audio-device>
    <effect-chain> <effect-instance>"
* bumped version to 1.0.0.cvs7

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

  ViewVC Help
Powered by ViewVC