11 |
<?rfc symrefs="yes" ?> |
<?rfc symrefs="yes" ?> |
12 |
<?rfc sortrefs="yes"?> |
<?rfc sortrefs="yes"?> |
13 |
<?rfc iprnotified="no" ?> |
<?rfc iprnotified="no" ?> |
|
<?rfc strict="yes" ?> |
|
14 |
|
|
15 |
<rfc category="std" ipr="full2026" docName="lscp.txt"> |
<!-- FIXME: next attribute should actually be "yes", temporarily disbled due |
16 |
|
to an annoying "missing Normative/Informative References" error message --> |
17 |
|
<?rfc strict="no" ?> |
18 |
|
|
19 |
|
<rfc category="std" ipr="full3978" docName="LSCP 1.5"> |
20 |
<front> |
<front> |
21 |
<title>LinuxSampler Control Protocol</title> |
<title>LinuxSampler Control Protocol</title> |
22 |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
<author initials='C.S.' surname="Schoenebeck" fullname='C. |
34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="June" year="2004"/> |
<date month="October" year="2010"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
41 |
<t>The LinuxSampler Control Protocol (LSCP) is an |
<t>The LinuxSampler Control Protocol (LSCP) is an |
42 |
application-level protocol primarily intended for local and |
application-level protocol primarily intended for local and |
43 |
remote controlling the LinuxSampler main application, which is a |
remote controlling the LinuxSampler backend application, which is a |
44 |
sophisticated console application essentially playing back audio |
sophisticated server-like console application essentially playing |
45 |
samples and manipulating the samples in real time to certain |
back audio samples and manipulating the samples in real time to |
46 |
extent.</t> |
certain extent.</t> |
47 |
</abstract> |
</abstract> |
48 |
</front> |
</front> |
49 |
|
|
61 |
(front-end) and server (LinuxSampler) respectively. Lines in |
(front-end) and server (LinuxSampler) respectively. Lines in |
62 |
examples must be interpreted as every line being CRLF |
examples must be interpreted as every line being CRLF |
63 |
terminated (carriage return character followed by line feed |
terminated (carriage return character followed by line feed |
64 |
character as defined in the ASCII standard), thus the following |
character as defined in the ASCII standard <xref target="RFC20"/>), |
65 |
example:</t> |
thus the following example:</t> |
66 |
|
|
67 |
<t> |
<t> |
68 |
<list> |
<list> |
115 |
return and line feed characters respectively.</t> |
return and line feed characters respectively.</t> |
116 |
</section> |
</section> |
117 |
|
|
118 |
|
<section title="Versioning of this specification" anchor="LSCP versioning"> |
119 |
|
<t>LSCP will certainly be extended and enhanced by-and-by. Each official |
120 |
|
release of the LSCP specification will be tagged with a unique version |
121 |
|
tuple. The version tuple consists at least of a major and minor version |
122 |
|
number like: |
123 |
|
</t> |
124 |
|
<t> |
125 |
|
<list> |
126 |
|
<t>"1.2"</t> |
127 |
|
</list> |
128 |
|
</t> |
129 |
|
<t> |
130 |
|
In this example the major version number would be "1" and the minor |
131 |
|
version number would be "2". Note that the version tuple might also |
132 |
|
have more than two elements. The major version number defines a |
133 |
|
group of backward compatible versions. That means a frontend is |
134 |
|
compatible to the connected sampler if and only if the LSCP versions |
135 |
|
to which each of the two parties complies to, match both of the |
136 |
|
following rules: |
137 |
|
</t> |
138 |
|
<t>Compatibility:</t> |
139 |
|
<t> |
140 |
|
<list style="numbers"> |
141 |
|
<t>The frontend's LSCP major version and the sampler's LSCP |
142 |
|
major version are exactly equal.</t> |
143 |
|
<t>The frontend's LSCP minor version is less or equal than |
144 |
|
the sampler's LSCP minor version.</t> |
145 |
|
</list> |
146 |
|
</t> |
147 |
|
<t> |
148 |
|
Compatibility can only be claimed if both rules are true. |
149 |
|
The frontend can use the |
150 |
|
<xref target="GET SERVER INFO">"GET SERVER INFO"</xref> command to |
151 |
|
get the version of the LSCP specification the sampler complies with. |
152 |
|
</t> |
153 |
|
</section> |
154 |
|
|
155 |
<section title="Introduction"> |
<section title="Introduction"> |
156 |
<t>LinuxSampler is a so called software sampler application |
<t>LinuxSampler is a so called software sampler application |
157 |
capable to playback audio samples from a computer's Random |
capable to playback audio samples from a computer's Random |
162 |
referred in this document as "sampler channels". The channels |
referred in this document as "sampler channels". The channels |
163 |
are in such way virtual as they can be connected to an |
are in such way virtual as they can be connected to an |
164 |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
165 |
sampler channel 17 could be connected to an Alsa sequencer |
sampler channel 17 could be connected to an ALSA sequencer |
166 |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
167 |
engine will be assigned an own instance of one of the available |
channel will be associated with an instance of one of the available |
168 |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
169 |
each sampler channel can be routed to an arbitrary audio output |
each sampler channel can be routed to an arbitrary audio output |
170 |
method (Alsa / Jack) and an arbitrary audio output channel |
method (ALSA / JACK) and an arbitrary audio output channel |
171 |
there.</t> |
there.</t> |
172 |
</section> |
</section> |
173 |
|
|
194 |
methods will be described next.</t> |
methods will be described next.</t> |
195 |
|
|
196 |
<section title="Request/response communication method"> |
<section title="Request/response communication method"> |
197 |
<t>This simple communication method is based on TCP. The |
<t>This simple communication method is based on |
198 |
|
<xref target="RFC793">TCP</xref>. The |
199 |
front-end application establishes a TCP connection to the |
front-end application establishes a TCP connection to the |
200 |
LinuxSampler instance on a certain host system. Then the |
LinuxSampler instance on a certain host system. Then the |
201 |
front-end application will send certain ASCII based commands |
front-end application will send certain ASCII based commands |
257 |
<warning-message> and <error-message> are |
<warning-message> and <error-message> are |
258 |
human readable descriptions of the warning or error |
human readable descriptions of the warning or error |
259 |
respectively.</t> |
respectively.</t> |
260 |
|
<t>Examples:</t> |
261 |
|
<t> |
262 |
|
<list> |
263 |
|
<t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t> |
264 |
|
<t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t> |
265 |
|
</list> |
266 |
|
</t> |
267 |
|
<t> |
268 |
|
<list> |
269 |
|
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t> |
270 |
|
<t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t> |
271 |
|
</list> |
272 |
|
</t> |
273 |
|
<t> |
274 |
|
<list> |
275 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t> |
276 |
|
<t>S: "ERR:9:There is no audio output device with index 123456."</t> |
277 |
|
</list> |
278 |
|
</t> |
279 |
<t>Normal result sets could be:</t> |
<t>Normal result sets could be:</t> |
280 |
<t> |
<t> |
281 |
<list style="numbers"> |
<list style="numbers"> |
294 |
<t>"OK"</t> |
<t>"OK"</t> |
295 |
</list> |
</list> |
296 |
</t> |
</t> |
297 |
|
<t>Example:</t> |
298 |
|
<t> |
299 |
|
<list> |
300 |
|
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t> |
301 |
|
<t>S: "OK"</t> |
302 |
|
</list> |
303 |
|
</t> |
304 |
<t>Single line result sets are command specific. One |
<t>Single line result sets are command specific. One |
305 |
example of a single line result set is an empty line. |
example of a single line result set is an empty line. |
306 |
Multi-line result sets are command specific and may |
Multi-line result sets are command specific and may |
311 |
<t>"."</t> |
<t>"."</t> |
312 |
</list> |
</list> |
313 |
</t> |
</t> |
314 |
|
<t>Example:</t> |
315 |
|
<t> |
316 |
|
<list> |
317 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
318 |
|
<t>S: "DRIVER: ALSA"</t> |
319 |
|
<t> "CHANNELS: 2"</t> |
320 |
|
<t> "SAMPLERATE: 44100"</t> |
321 |
|
<t> "ACTIVE: true"</t> |
322 |
|
<t> "FRAGMENTS: 2"</t> |
323 |
|
<t> "FRAGMENTSIZE: 128"</t> |
324 |
|
<t> "CARD: '0,0'"</t> |
325 |
|
<t> "."</t> |
326 |
|
</list> |
327 |
|
</t> |
328 |
<t>In addition to above mentioned formats, warnings and |
<t>In addition to above mentioned formats, warnings and |
329 |
empty result sets MAY be indexed. In this case, they |
empty result sets MAY be indexed. In this case, they |
330 |
have the following formats respectively:</t> |
have the following formats respectively:</t> |
339 |
related to or other integer value.</t> |
related to or other integer value.</t> |
340 |
<t>Each line of the result set MUST end with |
<t>Each line of the result set MUST end with |
341 |
<CRLF>.</t> |
<CRLF>.</t> |
342 |
|
<t>Examples:</t> |
343 |
|
<t> |
344 |
|
<list> |
345 |
|
<t>C: "ADD CHANNEL"</t> |
346 |
|
<t>S: "OK[12]"</t> |
347 |
|
</list> |
348 |
|
</t> |
349 |
|
<t> |
350 |
|
<list> |
351 |
|
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t> |
352 |
|
<t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t> |
353 |
|
</list> |
354 |
|
</t> |
355 |
</section> |
</section> |
356 |
</section> |
</section> |
357 |
<section title="Subscribe/notify communication method"> |
<section title="Subscribe/notify communication method"> |
420 |
|
|
421 |
<t>where <event-id> will be replace by the respective |
<t>where <event-id> will be replace by the respective |
422 |
event that client is no longer interested in receiving. For |
event that client is no longer interested in receiving. For |
423 |
a list of supported events see chapter 6.</t> |
a list of supported events see <xref target="events" />.</t> |
424 |
|
|
425 |
<t>Example: the fill states of disk stream buffers have |
<t>Example: the fill states of disk stream buffers have |
426 |
changed on sampler channel 4 and the LinuxSampler instance |
changed on sampler channel 4 and the LinuxSampler instance |
466 |
</section> |
</section> |
467 |
</section> |
</section> |
468 |
|
|
469 |
<section title="Description for control commands"> |
<section title="Description for control commands" anchor="control_commands"> |
470 |
<t>This chapter will describe the available control commands |
<t>This chapter will describe the available control commands |
471 |
that can be sent on the TCP connection in detail. Some certain |
that can be sent on the TCP connection in detail. Some certain |
472 |
commands (e.g. "GET CHANNEL INFO" or "GET ENGINE INFO") lead to |
commands (e.g. <xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref> |
473 |
|
or <xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref>) lead to |
474 |
multiple-line responses. In this case LinuxSampler signals the |
multiple-line responses. In this case LinuxSampler signals the |
475 |
end of the response by a "." (single dot) line.</t> |
end of the response by a "." (single dot) line.</t> |
476 |
|
|
485 |
<section title="Configuring audio drivers"> |
<section title="Configuring audio drivers"> |
486 |
<t>Instances of drivers in LinuxSampler are called devices. |
<t>Instances of drivers in LinuxSampler are called devices. |
487 |
You can use multiple audio devices simultaneously, e.g. to |
You can use multiple audio devices simultaneously, e.g. to |
488 |
output the sound of one sampler channel using the Alsa audio |
output the sound of one sampler channel using the ALSA audio |
489 |
output driver, and on another sampler channel you might want |
output driver, and on another sampler channel you might want |
490 |
to use the Jack audio output driver. For particular audio |
to use the JACK audio output driver. For particular audio |
491 |
output systems it's also possible to create several devices |
output systems it's also possible to create several devices |
492 |
of the same audio output driver, e.g. two separate Alsa |
of the same audio output driver, e.g. two separate ALSA |
493 |
audio output devices for using two different sound cards at |
audio output devices for using two different sound cards at |
494 |
the same time. This chapter describes all commands to |
the same time. This chapter describes all commands to |
495 |
configure LinuxSampler's audio output devices and their |
configure LinuxSampler's audio output devices and their |
514 |
what parameters drivers are offering, how to retrieve their |
what parameters drivers are offering, how to retrieve their |
515 |
possible values, etc.</t> |
possible values, etc.</t> |
516 |
|
|
517 |
<section title="Getting all available audio output drivers"> |
<section title="Getting amount of available audio output drivers" anchor="GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
518 |
|
<t>Use the following command to get the number of |
519 |
|
audio output drivers currently available for the |
520 |
|
LinuxSampler instance:</t> |
521 |
|
<t> |
522 |
|
<list> |
523 |
|
<t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
524 |
|
</list> |
525 |
|
</t> |
526 |
|
<t>Possible Answers:</t> |
527 |
|
<t> |
528 |
|
<list> |
529 |
|
<t>LinuxSampler will answer by sending the |
530 |
|
number of audio output drivers.</t> |
531 |
|
</list> |
532 |
|
</t> |
533 |
|
<t>Example:</t> |
534 |
|
<t> |
535 |
|
<list> |
536 |
|
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
537 |
|
<t>S: "2"</t> |
538 |
|
</list> |
539 |
|
</t> |
540 |
|
</section> |
541 |
|
|
542 |
|
<section title="Getting all available audio output drivers" anchor="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
543 |
<t>Use the following command to list all audio output |
<t>Use the following command to list all audio output |
544 |
drivers currently available for the LinuxSampler |
drivers currently available for the LinuxSampler |
545 |
instance:</t> |
instance:</t> |
546 |
<t> |
<t> |
547 |
<list> |
<list> |
548 |
<t>GET AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
<t>LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS</t> |
549 |
</list> |
</list> |
550 |
</t> |
</t> |
551 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
559 |
<t>Example:</t> |
<t>Example:</t> |
560 |
<t> |
<t> |
561 |
<list> |
<list> |
562 |
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
<t>C: "LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
563 |
<t>S: "Alsa,Jack"</t> |
<t>S: "ALSA,JACK"</t> |
564 |
</list> |
</list> |
565 |
</t> |
</t> |
566 |
</section> |
</section> |
567 |
|
|
568 |
<section title="Getting information about a specific audio |
<section title="Getting information about a specific audio |
569 |
output driver"> |
output driver" anchor="GET AUDIO_OUTPUT_DRIVER INFO"> |
570 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
571 |
about a specific audio output driver:</t> |
about a specific audio output driver:</t> |
572 |
<t> |
<t> |
576 |
</list> |
</list> |
577 |
</t> |
</t> |
578 |
<t>Where <audio-output-driver> is the name of the |
<t>Where <audio-output-driver> is the name of the |
579 |
audio output driver, returned by the "GET |
audio output driver, returned by the |
580 |
AVAILABLE_AUDIO_OUTPUT_DRIVERS" command.</t> |
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command.</t> |
581 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
582 |
<t> |
<t> |
583 |
<list> |
<list> |
626 |
<t>Example:</t> |
<t>Example:</t> |
627 |
<t> |
<t> |
628 |
<list> |
<list> |
629 |
<t>C: "GET AUDIO_OUTPUT_DRIVER INFO Alsa"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t> |
630 |
<t>S: "DESCRIPTION: Advanced Linux Sound |
<t>S: "DESCRIPTION: Advanced Linux Sound |
631 |
Architecture"</t> |
Architecture"</t> |
632 |
<t> "VERSION: 1.0"</t> |
<t> "VERSION: 1.0"</t> |
633 |
<t> "PARAMETERS: |
<t> "PARAMETERS: |
634 |
driver,channels,samplerate,active,fragments, |
DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS, |
635 |
fragmentsize,card"</t> |
FRAGMENTSIZE,CARD"</t> |
636 |
<t> "."</t> |
<t> "."</t> |
637 |
</list> |
</list> |
638 |
</t> |
</t> |
639 |
</section> |
</section> |
640 |
|
|
641 |
<section title="Getting information about specific audio |
<section title="Getting information about specific audio |
642 |
output driver parameter"> |
output driver parameter" anchor="GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO"> |
643 |
<t>Use the following command to get detailed information |
<t>Use the following command to get detailed information |
644 |
about a specific audio output driver parameter:</t> |
about a specific audio output driver parameter:</t> |
645 |
<t> |
<t> |
648 |
</list> |
</list> |
649 |
</t> |
</t> |
650 |
<t>Where <audio> is the name of the audio output |
<t>Where <audio> is the name of the audio output |
651 |
driver as returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" command, |
driver as returned by the <xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
652 |
|
"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> command, |
653 |
<prm> a specific parameter name for which information should be |
<prm> a specific parameter name for which information should be |
654 |
obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO" command) and |
obtained (as returned by the |
655 |
|
<xref target="GET AUDIO_OUTPUT_DRIVER INFO">"GET AUDIO_OUTPUT_DRIVER INFO"</xref> command) and |
656 |
<deplist> is an optional list of parameters on which the sought |
<deplist> is an optional list of parameters on which the sought |
657 |
parameter <prm> depends on, <deplist> is a list of key-value |
parameter <prm> depends on, <deplist> is a list of key-value |
658 |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
pairs in form of "key1=val1 key2=val2 ...", where character string values |
664 |
<t> |
<t> |
665 |
<list> |
<list> |
666 |
<t>LinuxSampler will answer by sending a |
<t>LinuxSampler will answer by sending a |
667 |
&lz;CRLF> separated list. |
<CRLF> separated list. |
668 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
669 |
followed by a colon and then a space character <SP> and |
followed by a colon and then a space character <SP> and |
670 |
finally |
finally |
699 |
<list> |
<list> |
700 |
<t>either true or false, defines if this parameter must be |
<t>either true or false, defines if this parameter must be |
701 |
given when the device is to be created with the |
given when the device is to be created with the |
702 |
'CREATE AUDIO_OUTPUT_DEVICE' command |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref> |
703 |
(always returned, no matter which driver parameter)</t> |
command (always returned, no matter which driver parameter)</t> |
704 |
</list> |
</list> |
705 |
</t> |
</t> |
706 |
|
|
708 |
<list> |
<list> |
709 |
<t>either true or false, if false then this parameter can |
<t>either true or false, if false then this parameter can |
710 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
711 |
the 'CREATE AUDIO_OUTPUT_DEVICE' command |
the <xref target="CREATE AUDIO_OUTPUT_DEVICE">'CREATE AUDIO_OUTPUT_DEVICE'</xref> |
712 |
(always returned, no matter which driver parameter)</t> |
command (always returned, no matter which driver parameter)</t> |
713 |
</list> |
</list> |
714 |
</t> |
</t> |
715 |
|
|
724 |
|
|
725 |
<t>DEPENDS - |
<t>DEPENDS - |
726 |
<list> |
<list> |
727 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
728 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
729 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
730 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
731 |
driver (like the Alsa driver) offers parameters 'card' |
driver (like the ALSA driver) offers parameters 'card' |
732 |
and 'samplerate' then parameter 'samplerate' would |
and 'samplerate' then parameter 'samplerate' would |
733 |
depend on 'card' because the possible values for |
depend on 'card' because the possible values for |
734 |
'samplerate' depends on the sound card which can be |
'samplerate' depends on the sound card which can be |
741 |
<list> |
<list> |
742 |
<t>reflects the default value for this parameter which is |
<t>reflects the default value for this parameter which is |
743 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
744 |
given with the 'CREATE AUDIO_OUTPUT_DEVICE' command, |
given with the <xref target="CREATE AUDIO_OUTPUT_DEVICE"> |
745 |
|
'CREATE AUDIO_OUTPUT_DEVICE'</xref> command, |
746 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
747 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
748 |
apostrophes (') |
apostrophes (') |
770 |
</list> |
</list> |
771 |
</t> |
</t> |
772 |
|
|
773 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
774 |
<list> |
<list> |
775 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
776 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
786 |
<t>Examples:</t> |
<t>Examples:</t> |
787 |
<t> |
<t> |
788 |
<list> |
<list> |
789 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa card"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t> |
790 |
<t>S: "DESCRIPTION: sound card to be used"</t> |
<t>S: "DESCRIPTION: sound card to be used"</t> |
791 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
792 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
793 |
<t> "FIX: true"</t> |
<t> "FIX: true"</t> |
794 |
<t> "MULTIPLICITY: false"</t> |
<t> "MULTIPLICITY: false"</t> |
795 |
<t> "DEFAULT: '0,0'"</t> |
<t> "DEFAULT: '0,0'"</t> |
796 |
<t> "POSSIBILITES: '0,0','1,0','2,0'"</t> |
<t> "POSSIBILITIES: '0,0','1,0','2,0'"</t> |
797 |
<t> "."</t> |
<t> "."</t> |
798 |
</list> |
</list> |
799 |
</t> |
</t> |
800 |
<t> |
<t> |
801 |
<list> |
<list> |
802 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t> |
803 |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
804 |
<t> "TYPE: INT"</t> |
<t> "TYPE: INT"</t> |
805 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
812 |
</t> |
</t> |
813 |
<t> |
<t> |
814 |
<list> |
<list> |
815 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate card='0,0'"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE CARD='0,0'"</t> |
816 |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
817 |
<t> "TYPE: INT"</t> |
<t> "TYPE: INT"</t> |
818 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
827 |
</t> |
</t> |
828 |
</section> |
</section> |
829 |
|
|
830 |
<section title="Creating an audio output device"> |
<section title="Creating an audio output device" anchor="CREATE AUDIO_OUTPUT_DEVICE"> |
831 |
<t>Use the following command to create a new audio output device for the desired audio output system:</t> |
<t>Use the following command to create a new audio output device for the desired audio output system:</t> |
832 |
|
|
833 |
<t> |
<t> |
837 |
</t> |
</t> |
838 |
|
|
839 |
<t>Where <audio-output-driver> should be replaced by the desired audio |
<t>Where <audio-output-driver> should be replaced by the desired audio |
840 |
output system and <param-list> by an optional list of driver |
output system as returned by the |
841 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS">"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
842 |
|
command and <param-list> by an optional list of driver |
843 |
specific parameters in form of "key1=val1 key2=val2 ...", where |
specific parameters in form of "key1=val1 key2=val2 ...", where |
844 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
845 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
875 |
<t>Examples:</t> |
<t>Examples:</t> |
876 |
<t> |
<t> |
877 |
<list> |
<list> |
878 |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa"</t> |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t> |
879 |
<t>S: "OK[0]"</t> |
<t>S: "OK[0]"</t> |
880 |
</list> |
</list> |
881 |
</t> |
</t> |
882 |
<t> |
<t> |
883 |
<list> |
<list> |
884 |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa card='2,0' samplerate=96000"</t> |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA CARD='2,0' SAMPLERATE=96000"</t> |
885 |
<t>S: "OK[1]"</t> |
<t>S: "OK[1]"</t> |
886 |
</list> |
</list> |
887 |
</t> |
</t> |
888 |
</section> |
</section> |
889 |
|
|
890 |
<section title="Destroying an audio output device"> |
<section title="Destroying an audio output device" anchor="DESTROY AUDIO_OUTPUT_DEVICE"> |
891 |
<t>Use the following command to destroy a created output device:</t> |
<t>Use the following command to destroy a created output device:</t> |
892 |
<t> |
<t> |
893 |
<list> |
<list> |
895 |
</list> |
</list> |
896 |
</t> |
</t> |
897 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
898 |
audio output device as given by the "CREATE AUDIO_OUTPUT_DEVICE" or |
audio output device as given by the |
899 |
"GET AUDIO_OUTPUT_DEVICES" command.</t> |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
900 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
901 |
|
command.</t> |
902 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
903 |
<t> |
<t> |
904 |
<list> |
<list> |
933 |
</t> |
</t> |
934 |
</section> |
</section> |
935 |
|
|
936 |
<section title="Getting all created audio output device count"> |
<section title="Getting all created audio output device count" anchor="GET AUDIO_OUTPUT_DEVICES"> |
937 |
<t>Use the following command to count all created audio output devices:</t> |
<t>Use the following command to count all created audio output devices:</t> |
938 |
<t> |
<t> |
939 |
<list> |
<list> |
956 |
</t> |
</t> |
957 |
</section> |
</section> |
958 |
|
|
959 |
<section title="Getting all created audio output device list"> |
<section title="Getting all created audio output device list" anchor="LIST AUDIO_OUTPUT_DEVICES"> |
960 |
<t>Use the following command to list all created audio output devices:</t> |
<t>Use the following command to list all created audio output devices:</t> |
961 |
<t> |
<t> |
962 |
<list> |
<list> |
979 |
</t> |
</t> |
980 |
</section> |
</section> |
981 |
|
|
982 |
<section title="Getting current settings of an audio output device"> |
<section title="Getting current settings of an audio output device" anchor="GET AUDIO_OUTPUT_DEVICE INFO"> |
983 |
<t>Use the following command to get current settings of a specific, created audio output device:</t> |
<t>Use the following command to get current settings of a specific, created audio output device:</t> |
984 |
<t> |
<t> |
985 |
<list> |
<list> |
986 |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
987 |
</list> |
</list> |
988 |
</t> |
</t> |
989 |
<t>Where <device-id> should be replaced by be numerical ID |
<t>Where <device-id> should be replaced by numerical ID |
990 |
of the audio output device as e.g. returned by the |
of the audio output device as e.g. returned by the |
991 |
"GET AUDIO_OUTPUT_DEVICES" command.</t> |
<xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> command.</t> |
992 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
993 |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
994 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
999 |
information categories are defined (independently of device):</t> |
information categories are defined (independently of device):</t> |
1000 |
<t> |
<t> |
1001 |
<list> |
<list> |
1002 |
<t>driver - |
<t>DRIVER - |
1003 |
<list> |
<list> |
1004 |
<t>identifier of the used audio output driver, as also |
<t>identifier of the used audio output driver, as also |
1005 |
returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" |
returned by the |
1006 |
|
<xref target="LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"> |
1007 |
|
"LIST AVAILABLE_AUDIO_OUTPUT_DRIVERS"</xref> |
1008 |
command</t> |
command</t> |
1009 |
</list> |
</list> |
1010 |
</t> |
</t> |
1011 |
<t>channels - |
<t>CHANNELS - |
1012 |
<list> |
<list> |
1013 |
<t>amount of audio output channels this device currently |
<t>amount of audio output channels this device currently |
1014 |
offers</t> |
offers</t> |
1015 |
</list> |
</list> |
1016 |
</t> |
</t> |
1017 |
<t>samplerate - |
<t>SAMPLERATE - |
1018 |
<list> |
<list> |
1019 |
<t>playback sample rate the device uses</t> |
<t>playback sample rate the device uses</t> |
1020 |
</list> |
</list> |
1021 |
</t> |
</t> |
1022 |
<t>active - |
<t>ACTIVE - |
1023 |
<list> |
<list> |
1024 |
<t>either true or false, if false then the audio device is |
<t>either true or false, if false then the audio device is |
1025 |
inactive and doesn't output any sound, nor do the |
inactive and doesn't output any sound, nor do the |
1033 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
1034 |
returned by all audio output devices. Every audio output driver |
returned by all audio output devices. Every audio output driver |
1035 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
1036 |
"GET AUDIO_OUTPUT_DRIVER INFO" command) which are also returned |
<xref target="GET AUDIO_OUTPUT_DRIVER INFO" />) |
1037 |
by this command.</t> |
which are also returned by this command.</t> |
1038 |
<t>Example:</t> |
<t>Example:</t> |
1039 |
<t> |
<t> |
1040 |
<list> |
<list> |
1041 |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
1042 |
<t>S: "driver: Alsa"</t> |
<t>S: "DRIVER: ALSA"</t> |
1043 |
<t> "channels: 2"</t> |
<t> "CHANNELS: 2"</t> |
1044 |
<t> "samplerate: 44100"</t> |
<t> "SAMPLERATE: 44100"</t> |
1045 |
<t> "active: true"</t> |
<t> "ACTIVE: true"</t> |
1046 |
<t> "fragments: 2"</t> |
<t> "FRAGMENTS: 2"</t> |
1047 |
<t> "fragmentsize: 128"</t> |
<t> "FRAGMENTSIZE: 128"</t> |
1048 |
<t> "card: '0,0'"</t> |
<t> "CARD: '0,0'"</t> |
1049 |
<t> "."</t> |
<t> "."</t> |
1050 |
</list> |
</list> |
1051 |
</t> |
</t> |
1052 |
</section> |
</section> |
1053 |
|
|
1054 |
|
|
1055 |
<section title="Changing settings of audio output devices"> |
<section title="Changing settings of audio output devices" anchor="SET AUDIO_OUTPUT_DEVICE_PARAMETER"> |
1056 |
<t>Use the following command to alter a specific setting of a created audio output device:</t> |
<t>Use the following command to alter a specific setting of a created audio output device:</t> |
1057 |
<t> |
<t> |
1058 |
<list> |
<list> |
1060 |
</list> |
</list> |
1061 |
</t> |
</t> |
1062 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
1063 |
audio output device, <key> by the name of the parameter to change |
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, <key> by the name of the parameter to change |
1067 |
and <value> by the new value for this parameter.</t> |
and <value> by the new value for this parameter.</t> |
1068 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1069 |
<t> |
<t> |
1091 |
<t>Example:</t> |
<t>Example:</t> |
1092 |
<t> |
<t> |
1093 |
<list> |
<list> |
1094 |
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 fragmentsize=128"</t> |
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t> |
1095 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1096 |
</list> |
</list> |
1097 |
</t> |
</t> |
1098 |
</section> |
</section> |
1099 |
|
|
1100 |
<section title="Getting information about an audio channel"> |
<section title="Getting information about an audio channel" anchor="GET AUDIO_OUTPUT_CHANNEL INFO"> |
1101 |
<t>Use the following command to get information about an audio channel:</t> |
<t>Use the following command to get information about an audio channel:</t> |
1102 |
<t> |
<t> |
1103 |
<list> |
<list> |
1104 |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
<t>GET AUDIO_OUTPUT_CHANNEL INFO <device-id> <audio-chan></t> |
1105 |
</list> |
</list> |
1106 |
</t> |
</t> |
1107 |
<t>Where <device-id> is the numerical ID of the audio output device |
<t>Where <device-id> is the numerical ID of the audio output device as given by the |
1108 |
and <audio-chan> the audio channel number.</t> |
<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 <audio-chan> the audio channel number.</t> |
1111 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1112 |
<t> |
<t> |
1113 |
<list> |
<list> |
1137 |
</t> |
</t> |
1138 |
<t>MIX_CHANNEL_DESTINATION - |
<t>MIX_CHANNEL_DESTINATION - |
1139 |
<list> |
<list> |
1140 |
<t>reflects the real audio channel (of the same audio |
<t>numerical ID (positive integer including 0) |
1141 |
|
which reflects the real audio channel (of the same audio |
1142 |
output device) this mix channel refers to, means where |
output device) this mix channel refers to, means where |
1143 |
the audio signal actually will be routed / added to |
the audio signal actually will be routed / added to |
1144 |
(only returned in case the audio channel is mix channel)</t> |
(only returned in case the audio channel is mix channel)</t> |
1191 |
<t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t> |
<t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t> |
1192 |
<t>S: "NAME: 'ardour (left)'"</t> |
<t>S: "NAME: 'ardour (left)'"</t> |
1193 |
<t> "IS_MIX_CHANNEL: false"</t> |
<t> "IS_MIX_CHANNEL: false"</t> |
1194 |
<t> "jack_bindings: 'ardour:0'"</t> |
<t> "JACK_BINDINGS: 'ardour:0'"</t> |
1195 |
<t> "."</t> |
<t> "."</t> |
1196 |
</list> |
</list> |
1197 |
</t> |
</t> |
1198 |
</section> |
</section> |
1199 |
|
|
1200 |
<section title="Getting information about specific audio channel parameter"> |
<section title="Getting information about specific audio channel parameter" anchor="GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO"> |
1201 |
<t>Use the following command to get detailed information about specific audio channel parameter:</t> |
<t>Use the following command to get detailed information about specific audio channel parameter:</t> |
1202 |
|
|
1203 |
<t> |
<t> |
1206 |
</list> |
</list> |
1207 |
</t> |
</t> |
1208 |
|
|
1209 |
<t>Where <dev-id> is the numerical ID of the audio output device as returned |
<t>Where <dev-id> is the numerical ID of the audio output device as returned by the |
1210 |
by the "GET AUDIO_OUTPUT_DEVICES" command, <chan> the audio channel number |
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
1211 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
1212 |
|
command, <chan> the audio channel number |
1213 |
and <param> a specific channel parameter name for which information should |
and <param> a specific channel parameter name for which information should |
1214 |
be obtained (as returned by the "GET AUDIO_OUTPUT_CHANNEL INFO" command).</t> |
be obtained (as returned by the <xref target="GET AUDIO_OUTPUT_CHANNEL INFO"> |
1215 |
|
"GET AUDIO_OUTPUT_CHANNEL INFO"</xref> command).</t> |
1216 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1217 |
|
|
1218 |
<t> |
<t> |
1275 |
parameter)</t> |
parameter)</t> |
1276 |
</list> |
</list> |
1277 |
</t> |
</t> |
1278 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1279 |
<list> |
<list> |
1280 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1281 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1292 |
<t>Example:</t> |
<t>Example:</t> |
1293 |
<t> |
<t> |
1294 |
<list> |
<list> |
1295 |
<t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 jack_bindings"</t> |
<t>C: "GET AUDIO_OUTPUT_CHANNEL_PARAMETER INFO 1 0 JACK_BINDINGS"</t> |
1296 |
<t>S: "DESCRIPTION: bindings to other Jack clients"</t> |
<t>S: "DESCRIPTION: bindings to other JACK clients"</t> |
1297 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
1298 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
1299 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
1300 |
<t> "POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
<t> "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
1301 |
<t> "."</t> |
<t> "."</t> |
1302 |
</list> |
</list> |
1303 |
</t> |
</t> |
1304 |
</section> |
</section> |
1305 |
|
|
1306 |
<section title="Changing settings of audio output channels"> |
<section title="Changing settings of audio output channels" anchor="SET AUDIO_OUTPUT_CHANNEL_PARAMETER"> |
1307 |
<t>Use the following command to alter a specific setting of an audio output channel:</t> |
<t>Use the following command to alter a specific setting of an audio output channel:</t> |
1308 |
<t> |
<t> |
1309 |
<list> |
<list> |
1310 |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
<t>SET AUDIO_OUTPUT_CHANNEL_PARAMETER <dev-id> <chn> <key>=<value></t> |
1311 |
</list> |
</list> |
1312 |
</t> |
</t> |
1313 |
<t>Where <dev-id> should be replaced by the numerical ID of the audio |
<t>Where <dev-id> should be replaced by the numerical ID of the audio output device as returned by the |
1314 |
device, <chn> by the audio channel number, <key> by the name of the |
<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, <chn> by the audio channel number, <key> by the name of the |
1317 |
parameter to change and <value> by the new value for this parameter.</t> |
parameter to change and <value> by the new value for this parameter.</t> |
1318 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1319 |
<t> |
<t> |
1341 |
<t>Example:</t> |
<t>Example:</t> |
1342 |
<t> |
<t> |
1343 |
<list> |
<list> |
1344 |
<t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 jack_bindings='PCM:0'"</t> |
<t>C: "SET AUDIO_OUTPUT_CHANNEL PARAMETER 0 0 JACK_BINDINGS='PCM:0'"</t> |
1345 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1346 |
</list> |
</list> |
1347 |
</t> |
</t> |
1357 |
<section title="Configuring MIDI input drivers"> |
<section title="Configuring MIDI input drivers"> |
1358 |
<t>Instances of drivers in LinuxSampler are called devices. You can use |
<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 |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
1360 |
MIDI input on one sampler channel and Alsa as MIDI input on another sampler |
MIDI input on one sampler channel and ALSA as MIDI input on another sampler |
1361 |
channel. For particular MIDI input systems it's also possible to create |
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 |
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> |
commands to configure LinuxSampler's MIDI input devices and their parameters.</t> |
1381 |
showing how to retrieve what parameters drivers are offering, how to retrieve their |
showing how to retrieve what parameters drivers are offering, how to retrieve their |
1382 |
possible values, etc.</t> |
possible values, etc.</t> |
1383 |
|
|
1384 |
<section title="Getting all available MIDI input drivers"> |
<section title="Getting amount of available MIDI input drivers" anchor="GET AVAILABLE_MIDI_INPUT_DRIVERS"> |
1385 |
|
<t>Use the following command to get the number of |
1386 |
|
MIDI input drivers currently available for the |
1387 |
|
LinuxSampler instance:</t> |
1388 |
|
<t> |
1389 |
|
<list> |
1390 |
|
<t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t> |
1391 |
|
</list> |
1392 |
|
</t> |
1393 |
|
<t>Possible Answers:</t> |
1394 |
|
<t> |
1395 |
|
<list> |
1396 |
|
<t>LinuxSampler will answer by sending the |
1397 |
|
number of available MIDI input drivers.</t> |
1398 |
|
</list> |
1399 |
|
</t> |
1400 |
|
<t>Example:</t> |
1401 |
|
<t> |
1402 |
|
<list> |
1403 |
|
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
1404 |
|
<t>S: "2"</t> |
1405 |
|
</list> |
1406 |
|
</t> |
1407 |
|
</section> |
1408 |
|
|
1409 |
|
<section title="Getting all available MIDI input drivers" anchor="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1410 |
<t>Use the following command to list all MIDI input drivers currently available |
<t>Use the following command to list all MIDI input drivers currently available |
1411 |
for the LinuxSampler instance:</t> |
for the LinuxSampler instance:</t> |
1412 |
<t> |
<t> |
1413 |
<list> |
<list> |
1414 |
<t>GET AVAILABLE_MIDI_INPUT_DRIVERS</t> |
<t>LIST AVAILABLE_MIDI_INPUT_DRIVERS</t> |
1415 |
</list> |
</list> |
1416 |
</t> |
</t> |
1417 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1424 |
<t>Example:</t> |
<t>Example:</t> |
1425 |
<t> |
<t> |
1426 |
<list> |
<list> |
1427 |
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
<t>C: "LIST AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
1428 |
<t>S: "Alsa,Jack"</t> |
<t>S: "ALSA,JACK"</t> |
1429 |
</list> |
</list> |
1430 |
</t> |
</t> |
1431 |
</section> |
</section> |
1432 |
|
|
1433 |
<section title="Getting information about a specific MIDI input driver"> |
<section title="Getting information about a specific MIDI input driver" anchor="GET MIDI_INPUT_DRIVER INFO"> |
1434 |
<t>Use the following command to get detailed information about a specific MIDI input driver:</t> |
<t>Use the following command to get detailed information about a specific MIDI input driver:</t> |
1435 |
<t> |
<t> |
1436 |
<list> |
<list> |
1437 |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
<t>GET MIDI_INPUT_DRIVER INFO <midi-input-driver></t> |
1438 |
</list> |
</list> |
1439 |
</t> |
</t> |
1440 |
<t>Where <midi-input-driver> is the name of the MIDI input driver.</t> |
<t>Where <midi-input-driver> is the name of the MIDI input driver as returned |
1441 |
|
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1442 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command.</t> |
1443 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1444 |
<t> |
<t> |
1445 |
<list> |
<list> |
1477 |
|
|
1478 |
<t> |
<t> |
1479 |
<list> |
<list> |
1480 |
<t>C: "GET MIDI_INPUT_DRIVER INFO Alsa"</t> |
<t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t> |
1481 |
<t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t> |
<t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t> |
1482 |
<t> "VERSION: 1.0"</t> |
<t> "VERSION: 1.0"</t> |
1483 |
<t> "PARAMETERS: driver,active"</t> |
<t> "PARAMETERS: DRIVER,ACTIVE"</t> |
1484 |
<t> "."</t> |
<t> "."</t> |
1485 |
</list> |
</list> |
1486 |
</t> |
</t> |
1487 |
</section> |
</section> |
1488 |
|
|
1489 |
<section title="Getting information about specific MIDI input driver parameter"> |
<section title="Getting information about specific MIDI input driver parameter" anchor="GET MIDI_INPUT_DRIVER_PARAMETER INFO"> |
1490 |
<t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t> |
<t>Use the following command to get detailed information about a specific parameter of a specific MIDI input driver:</t> |
1491 |
<t> |
<t> |
1492 |
<list> |
<list> |
1494 |
</list> |
</list> |
1495 |
</t> |
</t> |
1496 |
|
|
1497 |
<t>Where <midi-t> is the name of the MIDI input driver as returned |
<t>Where <midit> is the name of the MIDI input driver as returned |
1498 |
by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" command, <param> a specific |
by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1499 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> command, <param> a specific |
1500 |
parameter name for which information should be obtained (as returned by the |
parameter name for which information should be obtained (as returned by the |
1501 |
"GET MIDI_INPUT_DRIVER INFO" command) and <deplist> is an optional list |
<xref target="GET MIDI_INPUT_DRIVER INFO"> |
1502 |
|
"GET MIDI_INPUT_DRIVER INFO"</xref> command) and <deplist> is an optional list |
1503 |
of parameters on which the sought parameter <param> depends on, |
of parameters on which the sought parameter <param> depends on, |
1504 |
<deplist> is a key-value pair list in form of "key1=val1 key2=val2 ...", |
<deplist> is a key-value pair list in form of "key1=val1 key2=val2 ...", |
1505 |
where character string values are encapsulated into apostrophes ('). Arguments |
where character string values are encapsulated into apostrophes ('). Arguments |
1540 |
<list> |
<list> |
1541 |
<t>either true or false, defines if this parameter must be |
<t>either true or false, defines if this parameter must be |
1542 |
given when the device is to be created with the |
given when the device is to be created with the |
1543 |
'CREATE MIDI_INPUT_DEVICE' command |
<xref target="CREATE MIDI_INPUT_DEVICE"> |
1544 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command |
1545 |
(always returned, no matter which driver parameter)</t> |
(always returned, no matter which driver parameter)</t> |
1546 |
</list> |
</list> |
1547 |
</t> |
</t> |
1550 |
<list> |
<list> |
1551 |
<t>either true or false, if false then this parameter can |
<t>either true or false, if false then this parameter can |
1552 |
be changed at any time, once the device is created by |
be changed at any time, once the device is created by |
1553 |
the 'CREATE MIDI_INPUT_DEVICE' command |
the <xref target="CREATE MIDI_INPUT_DEVICE"> |
1554 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command |
1555 |
(always returned, no matter which driver parameter)</t> |
(always returned, no matter which driver parameter)</t> |
1556 |
</list> |
</list> |
1557 |
</t> |
</t> |
1567 |
|
|
1568 |
<t>DEPENDS - |
<t>DEPENDS - |
1569 |
<list> |
<list> |
1570 |
<t>comma separated list of paramters this parameter depends |
<t>comma separated list of parameters this parameter depends |
1571 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
1572 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
1573 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
1574 |
driver (like the Alsa driver) offers parameters 'card' |
driver (like the ALSA driver) offers parameters 'card' |
1575 |
and 'samplerate' then parameter 'samplerate' would |
and 'samplerate' then parameter 'samplerate' would |
1576 |
depend on 'card' because the possible values for |
depend on 'card' because the possible values for |
1577 |
'samplerate' depends on the sound card which can be |
'samplerate' depends on the sound card which can be |
1584 |
<list> |
<list> |
1585 |
<t>reflects the default value for this parameter which is |
<t>reflects the default value for this parameter which is |
1586 |
used when the device is created and not explicitly |
used when the device is created and not explicitly |
1587 |
given with the 'CREATE MIDI_INPUT_DEVICE' command, |
given with the <xref target="CREATE MIDI_INPUT_DEVICE"> |
1588 |
|
'CREATE MIDI_INPUT_DEVICE'</xref> command, |
1589 |
in case of MULTIPLCITY=true, this is a comma separated |
in case of MULTIPLCITY=true, this is a comma separated |
1590 |
list, that's why character strings are encapsulated into |
list, that's why character strings are encapsulated into |
1591 |
apostrophes (') |
apostrophes (') |
1613 |
</list> |
</list> |
1614 |
</t> |
</t> |
1615 |
|
|
1616 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1617 |
<list> |
<list> |
1618 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1619 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1629 |
<t>Example:</t> |
<t>Example:</t> |
1630 |
<t> |
<t> |
1631 |
<list> |
<list> |
1632 |
<t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO Alsa active"</t> |
<t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t> |
1633 |
<t>S: "DESCRIPTION: Whether device is enabled"</t> |
<t>S: "DESCRIPTION: Whether device is enabled"</t> |
1634 |
<t> "TYPE: BOOL"</t> |
<t> "TYPE: BOOL"</t> |
1635 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
1641 |
</t> |
</t> |
1642 |
</section> |
</section> |
1643 |
|
|
1644 |
<section title="Creating a MIDI input device"> |
<section title="Creating a MIDI input device" anchor="CREATE MIDI_INPUT_DEVICE"> |
1645 |
<t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t> |
<t>Use the following command to create a new MIDI input device for the desired MIDI input system:</t> |
1646 |
<t> |
<t> |
1647 |
<list> |
<list> |
1649 |
</list> |
</list> |
1650 |
</t> |
</t> |
1651 |
|
|
1652 |
<t>Where <midi-input-driver> should be replaced by the desired MIDI input system and <param-list> by an |
<t>Where <midi-input-driver> 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 <param-list> by an |
1655 |
optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where |
optional list of driver specific parameters in form of "key1=val1 key2=val2 ...", where |
1656 |
character string values should be encapsulated into apostrophes ('). |
character string values should be encapsulated into apostrophes ('). |
1657 |
Note that there might be drivers which require parameter(s) to be |
Note that there might be drivers which require parameter(s) to be |
1685 |
<t>Example:</t> |
<t>Example:</t> |
1686 |
<t> |
<t> |
1687 |
<list> |
<list> |
1688 |
<t>C: "CREATE MIDI_INPUT_DEVICE Alsa"</t> |
<t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t> |
1689 |
<t>S: "OK[0]"</t> |
<t>S: "OK[0]"</t> |
1690 |
</list> |
</list> |
1691 |
</t> |
</t> |
1692 |
</section> |
</section> |
1693 |
|
|
1694 |
<section title="Destroying a MIDI input device"> |
<section title="Destroying a MIDI input device" anchor="DESTROY MIDI_INPUT_DEVICE"> |
1695 |
<t>Use the following command to destroy a created MIDI input device:</t> |
<t>Use the following command to destroy a created MIDI input device:</t> |
1696 |
<t> |
<t> |
1697 |
<list> |
<list> |
1698 |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
<t>DESTROY MIDI_INPUT_DEVICE <device-id></t> |
1699 |
</list> |
</list> |
1700 |
</t> |
</t> |
1701 |
<t>Where <device-id> should be replaced by the device's numerical ID.</t> |
<t>Where <device-id> should be replaced by the device's numerical ID as returned by the |
1702 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1703 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1704 |
|
command.</t> |
1705 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1706 |
<t> |
<t> |
1707 |
<list> |
<list> |
1733 |
</t> |
</t> |
1734 |
</section> |
</section> |
1735 |
|
|
1736 |
<section title="Getting all created MIDI input device count"> |
<section title="Getting all created MIDI input device count" anchor="GET MIDI_INPUT_DEVICES"> |
1737 |
<t>Use the following command to count all created MIDI input devices:</t> |
<t>Use the following command to count all created MIDI input devices:</t> |
1738 |
<t> |
<t> |
1739 |
<list> |
<list> |
1757 |
</section> |
</section> |
1758 |
|
|
1759 |
|
|
1760 |
<section title="Getting all created MIDI input device list"> |
<section title="Getting all created MIDI input device list" anchor="LIST MIDI_INPUT_DEVICES"> |
1761 |
<t>Use the following command to list all created MIDI input devices:</t> |
<t>Use the following command to list all created MIDI input devices:</t> |
1762 |
<t> |
<t> |
1763 |
<list> |
<list> |
1786 |
</t> |
</t> |
1787 |
</section> |
</section> |
1788 |
|
|
1789 |
<section title="Getting current settings of a MIDI input device"> |
<section title="Getting current settings of a MIDI input device" anchor="GET MIDI_INPUT_DEVICE INFO"> |
1790 |
<t>Use the following command to get current settings of a specific, created MIDI input device:</t> |
<t>Use the following command to get current settings of a specific, created MIDI input device:</t> |
1791 |
<t> |
<t> |
1792 |
<list> |
<list> |
1793 |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
<t>GET MIDI_INPUT_DEVICE INFO <device-id></t> |
1794 |
</list> |
</list> |
1795 |
</t> |
</t> |
1796 |
<t>Where <device-id> is the numerical ID of the MIDI input device.</t> |
<t>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
1797 |
|
<xref target="CREATE MIDI_INPUT_DEVICE">"CREATE MIDI_INPUT_DEVICE"</xref> |
1798 |
|
or <xref target="LIST MIDI_INPUT_DEVICES">"LIST MIDI_INPUT_DEVICES"</xref> |
1799 |
|
command.</t> |
1800 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1801 |
<t> |
<t> |
1802 |
<list> |
<list> |
1813 |
<t>DRIVER - |
<t>DRIVER - |
1814 |
<list> |
<list> |
1815 |
<t>identifier of the used MIDI input driver, as e.g. |
<t>identifier of the used MIDI input driver, as e.g. |
1816 |
returned by the "GET AVAILABLE_MIDI_INPUT_DRIVERS" |
returned by the <xref target="LIST AVAILABLE_MIDI_INPUT_DRIVERS"> |
1817 |
|
"LIST AVAILABLE_MIDI_INPUT_DRIVERS"</xref> |
1818 |
command</t> |
command</t> |
1819 |
</list> |
</list> |
1820 |
</t> |
</t> |
1837 |
order. The fields above are only those fields which are |
order. The fields above are only those fields which are |
1838 |
returned by all MIDI input devices. Every MIDI input driver |
returned by all MIDI input devices. Every MIDI input driver |
1839 |
might have its own, additional driver specific parameters (see |
might have its own, additional driver specific parameters (see |
1840 |
"GET MIDI_INPUT_DRIVER INFO" command) which are also returned |
<xref target="GET MIDI_INPUT_DRIVER INFO"> |
1841 |
|
"GET MIDI_INPUT_DRIVER INFO"</xref> command) which are also returned |
1842 |
by this command.</t> |
by this command.</t> |
1843 |
|
|
1844 |
<t>Example:</t> |
<t>Example:</t> |
1845 |
<t> |
<t> |
1846 |
<list> |
<list> |
1847 |
<t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t> |
<t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t> |
1848 |
<t>S: "driver: Alsa"</t> |
<t>S: "DRIVER: ALSA"</t> |
1849 |
<t> "active: true"</t> |
<t> "ACTIVE: true"</t> |
1850 |
<t> "."</t> |
<t> "."</t> |
1851 |
</list> |
</list> |
1852 |
</t> |
</t> |
1853 |
</section> |
</section> |
1854 |
|
|
1855 |
<section title="Changing settings of audio output devices"> |
<section title="Changing settings of MIDI input devices" anchor="SET MIDI_INPUT_DEVICE_PARAMETER"> |
1856 |
<t>Use the following command to alter a specific setting of a created MIDI input device:</t> |
<t>Use the following command to alter a specific setting of a created MIDI input device:</t> |
1857 |
<t> |
<t> |
1858 |
<list> |
<list> |
1861 |
</t> |
</t> |
1862 |
|
|
1863 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
1864 |
MIDI input device, <key> by the name of the parameter to change and |
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, <key> by the name of the parameter to change and |
1868 |
<value> by the new value for this parameter.</t> |
<value> by the new value for this parameter.</t> |
1869 |
|
|
1870 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1892 |
<t>Example:</t> |
<t>Example:</t> |
1893 |
<t> |
<t> |
1894 |
<list> |
<list> |
1895 |
<t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t> |
<t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t> |
1896 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1897 |
</list> |
</list> |
1898 |
</t> |
</t> |
1899 |
</section> |
</section> |
1900 |
|
|
1901 |
<section title="Getting information about a MIDI port"> |
<section title="Getting information about a MIDI port" anchor="GET MIDI_INPUT_PORT INFO"> |
1902 |
<t>Use the following command to get information about a MIDI port:</t> |
<t>Use the following command to get information about a MIDI port:</t> |
1903 |
<t> |
<t> |
1904 |
<list> |
<list> |
1905 |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
<t>GET MIDI_INPUT_PORT INFO <device-id> <midi-port></t> |
1906 |
</list> |
</list> |
1907 |
</t> |
</t> |
1908 |
<t>Where <device-id> is the numerical ID of the MIDI input device |
<t>Where <device-id> is the numerical ID of the MIDI input device as returned by the |
1909 |
and <midi-port> the MIDI input port number.</t> |
<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 <midi-port> the MIDI input port number.</t> |
1912 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1913 |
<t> |
<t> |
1914 |
<list> |
<list> |
1935 |
<t> |
<t> |
1936 |
<list> |
<list> |
1937 |
<t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t> |
<t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t> |
1938 |
<t>S: "name: 'Masterkeyboard'"</t> |
<t>S: "NAME: 'Masterkeyboard'"</t> |
1939 |
<t> "alsa_seq_bindings: '64:0'"</t> |
<t> "ALSA_SEQ_BINDINGS: '64:0'"</t> |
1940 |
<t> "."</t> |
<t> "."</t> |
1941 |
</list> |
</list> |
1942 |
</t> |
</t> |
1943 |
</section> |
</section> |
1944 |
|
|
1945 |
<section title="Getting information about specific MIDI port parameter"> |
<section title="Getting information about specific MIDI port parameter" anchor="GET MIDI_INPUT_PORT_PARAMETER INFO"> |
1946 |
<t>Use the following command to get detailed information about specific MIDI port parameter:</t> |
<t>Use the following command to get detailed information about specific MIDI port parameter:</t> |
1947 |
<t> |
<t> |
1948 |
<list> |
<list> |
1950 |
</list> |
</list> |
1951 |
</t> |
</t> |
1952 |
|
|
1953 |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned |
<t>Where <dev-id> is the numerical ID of the MIDI input device as returned by the |
1954 |
by the "GET MIDI_INPUT_DEVICES" command, <port> the MIDI port number and |
<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, <port> the MIDI port number and |
1957 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
1958 |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
obtained (as returned by the <xref target="GET MIDI_INPUT_PORT INFO"> |
1959 |
|
"GET MIDI_INPUT_PORT INFO"</xref> command).</t> |
1960 |
|
|
1961 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
1962 |
<t> |
<t> |
2019 |
parameter)</t> |
parameter)</t> |
2020 |
</list> |
</list> |
2021 |
</t> |
</t> |
2022 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
2023 |
<list> |
<list> |
2024 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
2025 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
2036 |
<t>Example:</t> |
<t>Example:</t> |
2037 |
<t> |
<t> |
2038 |
<list> |
<list> |
2039 |
<t>C: "GET MIDI_INPUT_PORT_PARAMETER INFO 0 0 alsa_seq_bindings"</t> |
<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> |
<t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t> |
2041 |
<t>"TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
2042 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
2043 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
2044 |
<t> "POSSIBILITES: '64:0','68:0','68:1'"</t> |
<t> "POSSIBILITIES: '64:0','68:0','68:1'"</t> |
2045 |
<t> "."</t> |
<t> "."</t> |
2046 |
</list> |
</list> |
2047 |
</t> |
</t> |
2048 |
</section> |
</section> |
2049 |
|
|
2050 |
<section title="Changing settings of MIDI input ports"> |
<section title="Changing settings of MIDI input ports" anchor="SET MIDI_INPUT_PORT_PARAMETER"> |
2051 |
<t>Use the following command to alter a specific setting of a MIDI input port:</t> |
<t>Use the following command to alter a specific setting of a MIDI input port:</t> |
2052 |
<t> |
<t> |
2053 |
<list> |
<list> |
2056 |
</t> |
</t> |
2057 |
|
|
2058 |
<t>Where <device-id> should be replaced by the numerical ID of the |
<t>Where <device-id> should be replaced by the numerical ID of the |
2059 |
MIDI device, <port> by the MIDI port number, <key> by the name of |
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, <port> by the MIDI port number, <key> by the name of |
2063 |
the parameter to change and <value> by the new value for this |
the parameter to change and <value> by the new value for this |
2064 |
parameter.</t> |
parameter (encapsulated into apostrophes) or NONE (not encapsulated into apostrophes) |
2065 |
|
for specifying no value for parameters allowing a list of values.</t> |
2066 |
|
|
2067 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2068 |
<t> |
<t> |
2089 |
<t>Example:</t> |
<t>Example:</t> |
2090 |
<t> |
<t> |
2091 |
<list> |
<list> |
2092 |
<t></t> |
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS='20:0'"</t> |
2093 |
|
<t>S: "OK"</t> |
2094 |
|
</list> |
2095 |
|
</t> |
2096 |
|
<t> |
2097 |
|
<list> |
2098 |
|
<t>C: "SET MIDI_INPUT_PORT_PARAMETER 0 0 ALSA_SEQ_BINDINGS=NONE"</t> |
2099 |
|
<t>S: "OK"</t> |
2100 |
</list> |
</list> |
2101 |
</t> |
</t> |
2102 |
</section> |
</section> |
2103 |
</section> |
</section> |
2104 |
|
|
2105 |
<section title="Configuring sampler channels"> |
<section title="Configuring sampler channels"> |
2106 |
<t>The following commands describe how to add and remove sampler channels, deploy |
<t>The following commands describe how to add and remove sampler channels, associate a |
2107 |
sampler engines, load instruments and connect sampler channels to MIDI and audio devices.</t> |
sampler channel with a sampler engine, load instruments and connect sampler channels to |
2108 |
|
MIDI and audio devices.</t> |
2109 |
|
|
2110 |
<section title="Loading an instrument"> |
<section title="Loading an instrument" anchor="LOAD INSTRUMENT"> |
2111 |
<t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t> |
<t>An instrument file can be loaded and assigned to a sampler channel by one of the following commands:</t> |
2112 |
<t> |
<t> |
2113 |
<list> |
<list> |
2121 |
number of the sampler channel the instrument should be assigned to. |
number of the sampler channel the instrument should be assigned to. |
2122 |
Each sampler channel can only have one instrument.</t> |
Each sampler channel can only have one instrument.</t> |
2123 |
|
|
2124 |
|
<t>Notice: since LSCP 1.2 the <filename> argument supports |
2125 |
|
escape characters for special characters (see chapter |
2126 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>" |
2127 |
|
for details) and accordingly backslash characters in the filename |
2128 |
|
MUST now be escaped as well!</t> |
2129 |
|
|
2130 |
<t>The difference between regular and NON_MODAL versions of the command |
<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 |
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 |
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 |
returns immediately and a background process is launched to load the instrument |
2134 |
on the channel. GET CHANNEL INFO command can be used to obtain loading |
on the channel. The <xref target="GET CHANNEL INFO">GET CHANNEL INFO</xref> |
2135 |
|
command can be used to obtain loading |
2136 |
progress from INSTRUMENT_STATUS field. LOAD command will perform sanity checks |
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 |
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 |
and SHOULD return ERR and SHOULD not launch the background process should any |
2162 |
</t> |
</t> |
2163 |
</list> |
</list> |
2164 |
</t> |
</t> |
2165 |
<t>Example:</t> |
<t>Example (Unix):</t> |
2166 |
<t> |
<t> |
2167 |
<list> |
<list> |
2168 |
<t></t> |
<t>C: LOAD INSTRUMENT '/home/joe/gigs/cello.gig' 0 0</t> |
2169 |
|
<t>S: OK</t> |
2170 |
|
</list> |
2171 |
|
</t> |
2172 |
|
<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> |
</list> |
2178 |
</t> |
</t> |
2179 |
</section> |
</section> |
2180 |
|
|
2181 |
<section title="Loading a sampler engine"> |
<section title="Loading a sampler engine" anchor="LOAD ENGINE"> |
2182 |
<t>A sample engine can be deployed and assigned to a specific sampler |
<t>A sampler engine type can be associated to a specific sampler |
2183 |
channel by the following command:</t> |
channel by the following command:</t> |
2184 |
<t> |
<t> |
2185 |
<list> |
<list> |
2187 |
</list> |
</list> |
2188 |
</t> |
</t> |
2189 |
|
|
2190 |
<t>Where <engine-name> is usually the C++ class name of the engine |
<t>Where <engine-name> is an engine name as obtained by the |
2191 |
implementation and <sampler-channel> the sampler channel the |
<xref target="LIST AVAILABLE_ENGINES"> |
2192 |
deployed engine should be assigned to. Even if the respective |
"LIST AVAILABLE_ENGINES"</xref> command and <sampler-channel> |
2193 |
sampler channel has already a deployed engine with that engine |
the sampler channel as returned by the |
2194 |
name, a new engine instance will be assigned to the sampler channel.</t> |
<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 |
|
|
2205 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2206 |
<t> |
<t> |
2233 |
</t> |
</t> |
2234 |
</section> |
</section> |
2235 |
|
|
2236 |
<section title="Getting all created sampler channel count"> |
<section title="Getting all created sampler channel count" anchor="GET CHANNELS"> |
2237 |
<t>The number of sampler channels can change on runtime. To get the |
<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 |
current amount of sampler channels, the front-end can send the |
2239 |
following command:</t> |
following command:</t> |
2257 |
</t> |
</t> |
2258 |
</section> |
</section> |
2259 |
|
|
2260 |
<section title="Getting all created sampler channel list"> |
<section title="Getting all created sampler channel list" anchor="LIST CHANNELS"> |
2261 |
<t>The number of sampler channels can change on runtime. To get the |
<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 |
current list of sampler channels, the front-end can send the |
2263 |
following command:</t> |
following command:</t> |
2282 |
</t> |
</t> |
2283 |
</section> |
</section> |
2284 |
|
|
2285 |
<section title="Adding a new sampler channel"> |
<section title="Adding a new sampler channel" anchor="ADD CHANNEL"> |
2286 |
<t>A new sampler channel can be added to the end of the sampler |
<t>A new sampler channel can be added to the end of the sampler |
2287 |
channel list by sending the following command:</t> |
channel list by sending the following command:</t> |
2288 |
<t> |
<t> |
2306 |
<list> |
<list> |
2307 |
<t>in case a new sampler channel could be added, where |
<t>in case a new sampler channel could be added, where |
2308 |
<sampler-channel> reflects the channel number of the new |
<sampler-channel> reflects the channel number of the new |
2309 |
created sampler channel which should the be used to set up |
created sampler channel which should be used to set up |
2310 |
the sampler channel by sending subsequent intialization |
the sampler channel by sending subsequent initialization |
2311 |
commands</t> |
commands</t> |
2312 |
</list> |
</list> |
2313 |
</t> |
</t> |
2334 |
</t> |
</t> |
2335 |
</section> |
</section> |
2336 |
|
|
2337 |
<section title="Removing a sampler channel"> |
<section title="Removing a sampler channel" anchor="REMOVE CHANNEL"> |
2338 |
<t>A sampler channel can be removed by sending the following command:</t> |
<t>A sampler channel can be removed by sending the following command:</t> |
2339 |
<t> |
<t> |
2340 |
<list> |
<list> |
2342 |
</list> |
</list> |
2343 |
</t> |
</t> |
2344 |
|
|
2345 |
<t>This will decrement the sampler channel count by one and also |
<t>Where <sampler-channel> should be replaced by the |
2346 |
decrement the channel numbers of all subsequent sampler channels by |
number of the sampler channel as given by the |
2347 |
one.</t> |
<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 |
|
|
2352 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2353 |
<t> |
<t> |
2380 |
</t> |
</t> |
2381 |
</section> |
</section> |
2382 |
|
|
2383 |
<section title="Getting all available engines"> |
<section title="Getting amount of available engines" anchor="GET AVAILABLE_ENGINES"> |
2384 |
<t>The front-end can ask for all available engines by sending the following command:</t> |
<t>The front-end can ask for the number of available engines by sending the following command:</t> |
2385 |
<t> |
<t> |
2386 |
<list> |
<list> |
2387 |
<t>GET AVAILABLE_ENGINES</t> |
<t>GET AVAILABLE_ENGINES</t> |
2390 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2391 |
<t> |
<t> |
2392 |
<list> |
<list> |
2393 |
<t>LinuxSampler will answer by sending a comma separated character |
<t>LinuxSampler will answer by sending the number of available engines.</t> |
|
string of the engines' C++ class names.</t> |
|
2394 |
</list> |
</list> |
2395 |
</t> |
</t> |
2396 |
<t>Example:</t> |
<t>Example:</t> |
2397 |
<t> |
<t> |
2398 |
<list> |
<list> |
2399 |
<t>C: "GET AVAILABLE_ENGINES"</t> |
<t>C: "GET AVAILABLE_ENGINES"</t> |
2400 |
<t>S: "GigEngine,AkaiEngine,DLSEngine,JoesCustomEngine"</t> |
<t>S: "4"</t> |
2401 |
</list> |
</list> |
2402 |
</t> |
</t> |
2403 |
</section> |
</section> |
2404 |
|
|
2405 |
<section title="Getting information about an engine"> |
<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 |
|
<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 |
|
</list> |
2420 |
|
</t> |
2421 |
|
<t>Example:</t> |
2422 |
|
<t> |
2423 |
|
<list> |
2424 |
|
<t>C: "LIST AVAILABLE_ENGINES"</t> |
2425 |
|
<t>S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"</t> |
2426 |
|
</list> |
2427 |
|
</t> |
2428 |
|
</section> |
2429 |
|
|
2430 |
|
<section title="Getting information about an engine" anchor="GET ENGINE INFO"> |
2431 |
<t>The front-end can ask for information about a specific engine by |
<t>The front-end can ask for information about a specific engine by |
2432 |
sending the following command:</t> |
sending the following command:</t> |
2433 |
<t> |
<t> |
2435 |
<t>GET ENGINE INFO <engine-name></t> |
<t>GET ENGINE INFO <engine-name></t> |
2436 |
</list> |
</list> |
2437 |
</t> |
</t> |
2438 |
<t>Where <engine-name> is usually the C++ class name of the engine implementation.</t> |
<t>Where <engine-name> is an engine name as obtained by the |
2439 |
|
<xref target="LIST AVAILABLE_ENGINES"> |
2440 |
|
"LIST AVAILABLE_ENGINES"</xref> command.</t> |
2441 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2442 |
<t> |
<t> |
2443 |
<list> |
<list> |
2444 |
<t>LinuxSampler will answer by sending <> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
2445 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
2446 |
followed by a colon and then a space character <SP> and finally |
followed by a colon and then a space character <SP> and finally |
2447 |
the info character string to that info category. At the moment |
the info character string to that info category. At the moment |
2451 |
<list> |
<list> |
2452 |
<t>DESCRIPTION - |
<t>DESCRIPTION - |
2453 |
<list> |
<list> |
2454 |
<t>arbitrary description text about the engine</t> |
<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 |
</list> |
</list> |
2458 |
</t> |
</t> |
2459 |
<t>VERSION - |
<t>VERSION - |
2479 |
</t> |
</t> |
2480 |
</section> |
</section> |
2481 |
|
|
2482 |
<section title="Getting sampler channel information"> |
<section title="Getting sampler channel information" anchor="GET CHANNEL INFO"> |
2483 |
<t>The front-end can ask for the current settings of a sampler channel |
<t>The front-end can ask for the current settings of a sampler channel |
2484 |
by sending the following command:</t> |
by sending the following command:</t> |
2485 |
<t> |
<t> |
2487 |
<t>GET CHANNEL INFO <sampler-channel></t> |
<t>GET CHANNEL INFO <sampler-channel></t> |
2488 |
</list> |
</list> |
2489 |
</t> |
</t> |
2490 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> 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 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2494 |
<t> |
<t> |
2495 |
<list> |
<list> |
2503 |
<list> |
<list> |
2504 |
<t>ENGINE_NAME - |
<t>ENGINE_NAME - |
2505 |
<list> |
<list> |
2506 |
<t>name of the engine that is deployed on the sampler |
<t>name of the engine that is associated with the sampler |
2507 |
channel, "NONE" if there's no engine deployed yet for |
channel, "NONE" if there's no engine associated yet for |
2508 |
this sampler channel</t> |
this sampler channel</t> |
2509 |
</list> |
</list> |
2510 |
</t> |
</t> |
2512 |
<list> |
<list> |
2513 |
<t>numerical ID of the audio output device which is |
<t>numerical ID of the audio output device which is |
2514 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
2515 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
2516 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2517 |
</list> |
</list> |
2518 |
</t> |
</t> |
2537 |
<list> |
<list> |
2538 |
<t>the file name of the loaded instrument, "NONE" if |
<t>the file name of the loaded instrument, "NONE" if |
2539 |
there's no instrument yet loaded for this sampler |
there's no instrument yet loaded for this sampler |
2540 |
channel</t> |
channel (note: since LSCP 1.2 this path may contain |
2541 |
|
<xref target="character_set">escape sequences</xref>)</t> |
2542 |
</list> |
</list> |
2543 |
</t> |
</t> |
2544 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
2545 |
<list> |
<list> |
2546 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument, |
2547 |
|
"-1" if there's no instrument loaded for this sampler |
2548 |
|
channel</t> |
2549 |
|
</list> |
2550 |
|
</t> |
2551 |
|
<t>INSTRUMENT_NAME - |
2552 |
|
<list> |
2553 |
|
<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 |
</list> |
</list> |
2557 |
</t> |
</t> |
2558 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2559 |
<list> |
<list> |
2560 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>Integer values 0 to 100 indicating loading progress |
2561 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
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 |
loaded.</t> |
loaded.</t> |
2566 |
</list> |
</list> |
2567 |
</t> |
</t> |
2569 |
<list> |
<list> |
2570 |
<t>numerical ID of the MIDI input device which is |
<t>numerical ID of the MIDI input device which is |
2571 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
2572 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
2573 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2574 |
</list> |
</list> |
2575 |
</t> |
</t> |
2576 |
<t>MIDI_INPUT_PORT - |
<t>MIDI_INPUT_PORT - |
2577 |
<list> |
<list> |
2578 |
<t>port number of the MIDI input device</t> |
<t>port number of the MIDI input device (in case a |
2579 |
|
MIDI device was already assigned to the sampler |
2580 |
|
channel)</t> |
2581 |
</list> |
</list> |
2582 |
</t> |
</t> |
2583 |
<t>MIDI_INPUT_CHANNEL - |
<t>MIDI_INPUT_CHANNEL - |
2589 |
<t>VOLUME - |
<t>VOLUME - |
2590 |
<list> |
<list> |
2591 |
<t>optionally dotted number for the channel volume factor |
<t>optionally dotted number for the channel volume factor |
2592 |
(where a value < 1.0 means attenuation and a value > |
(where a value < 1.0 means attenuation and a value > |
2593 |
1.0 means amplification)</t> |
1.0 means amplification)</t> |
2594 |
</list> |
</list> |
2595 |
</t> |
</t> |
2596 |
|
<t>MUTE - |
2597 |
|
<list> |
2598 |
|
<t>Determines whether the channel is muted, "true" if the |
2599 |
|
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 |
|
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 |
|
<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 |
</list> |
</list> |
2620 |
</t> |
</t> |
2621 |
</list> |
</list> |
2633 |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
2634 |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
2635 |
<t> "INSTRUMENT_NR: 0"</t> |
<t> "INSTRUMENT_NR: 0"</t> |
2636 |
|
<t> "INSTRUMENT_NAME: Fazioli Piano"</t> |
2637 |
<t> "INSTRUMENT_STATUS: 100"</t> |
<t> "INSTRUMENT_STATUS: 100"</t> |
2638 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
2639 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
2640 |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
<t> "MIDI_INPUT_CHANNEL: 5"</t> |
2641 |
|
<t> "VOLUME: 1.0"</t> |
2642 |
|
<t> "MUTE: false"</t> |
2643 |
|
<t> "SOLO: false"</t> |
2644 |
|
<t> "MIDI_INSTRUMENT_MAP: NONE"</t> |
2645 |
<t> "."</t> |
<t> "."</t> |
2646 |
</list> |
</list> |
2647 |
</t> |
</t> |
2648 |
</section> |
</section> |
2649 |
|
|
2650 |
<section title="Current number of active voices"> |
<section title="Current number of active voices" anchor="GET CHANNEL VOICE_COUNT"> |
2651 |
<t>The front-end can ask for the current number of active voices on a |
<t>The front-end can ask for the current number of active voices on a |
2652 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2653 |
<t> |
<t> |
2655 |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
<t>GET CHANNEL VOICE_COUNT <sampler-channel></t> |
2656 |
</list> |
</list> |
2657 |
</t> |
</t> |
2658 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> 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 |
|
|
2662 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2663 |
<t> |
<t> |
2674 |
</t> |
</t> |
2675 |
</section> |
</section> |
2676 |
|
|
2677 |
<section title="Current number of active disk streams"> |
<section title="Current number of active disk streams" anchor="GET CHANNEL STREAM_COUNT"> |
2678 |
<t>The front-end can ask for the current number of active disk streams |
<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> |
on a sampler channel by sending the following command:</t> |
2680 |
<t> |
<t> |
2682 |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
<t>GET CHANNEL STREAM_COUNT <sampler-channel></t> |
2683 |
</list> |
</list> |
2684 |
</t> |
</t> |
2685 |
<t>Where <sampler-channel> is the sampler channel number the front-end is interested in.</t> |
<t>Where <sampler-channel> 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 |
|
|
2689 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2690 |
<t> |
<t> |
2703 |
</t> |
</t> |
2704 |
</section> |
</section> |
2705 |
|
|
2706 |
<section title="Current fill state of disk stream buffers"> |
<section title="Current fill state of disk stream buffers" anchor="GET CHANNEL BUFFER_FILL"> |
2707 |
<t>The front-end can ask for the current fill state of all disk streams |
<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> |
on a sampler channel by sending the following command:</t> |
2709 |
<t> |
<t> |
2718 |
</list> |
</list> |
2719 |
</t> |
</t> |
2720 |
<t>to get the fill state in percent, where <sampler-channel> is the |
<t>to get the fill state in percent, where <sampler-channel> is the |
2721 |
sampler channel number the front-end is interested in.</t> |
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 |
|
|
2725 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2726 |
<t> |
<t> |
2756 |
</t> |
</t> |
2757 |
</section> |
</section> |
2758 |
|
|
2759 |
<section title="Setting audio output device"> |
<section title="Setting audio output device" anchor="SET CHANNEL AUDIO_OUTPUT_DEVICE"> |
2760 |
<t>The front-end can set the audio output device on a specific sampler |
<t>The front-end can set the audio output device on a specific sampler |
2761 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2762 |
<t> |
<t> |
2764 |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
<t>SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <audio-device-id></t> |
2765 |
</list> |
</list> |
2766 |
</t> |
</t> |
2767 |
<t>Where <audio-device-id> is the numerical ID of the audio output |
<t>Where <sampler-channel> is the respective sampler channel |
2768 |
device and <sampler-channel> is the respective sampler channel |
number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2769 |
number.</t> |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and |
2770 |
|
<audio-device-id> 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 |
|
|
2775 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2776 |
<t> |
<t> |
2802 |
</t> |
</t> |
2803 |
</section> |
</section> |
2804 |
|
|
2805 |
<section title="Setting audio output type"> |
<section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE"> |
2806 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2807 |
|
|
2808 |
<t>The front-end can alter the audio output type on a specific sampler |
<t>The front-end can alter the audio output type on a specific sampler |
2812 |
<t>SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type></t> |
<t>SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type></t> |
2813 |
</list> |
</list> |
2814 |
</t> |
</t> |
2815 |
<t>Where <audio-output-type> is currently either "Alsa" or "Jack" and |
<t>Where <audio-output-type> is currently either "ALSA" or "JACK" and |
2816 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
2817 |
|
|
2818 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2845 |
</t> |
</t> |
2846 |
</section> |
</section> |
2847 |
|
|
2848 |
<section title="Setting audio output channel"> |
<section title="Setting audio output channel" anchor="SET CHANNEL AUDIO_OUTPUT_CHANNEL"> |
2849 |
<t>The front-end can alter the audio output channel on a specific |
<t>The front-end can alter the audio output channel on a specific |
2850 |
sampler channel by sending the following command:</t> |
sampler channel by sending the following command:</t> |
2851 |
<t> |
<t> |
2853 |
<t>SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> <audio-in></t> |
<t>SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-chan> <audio-out> <audio-in></t> |
2854 |
</list> |
</list> |
2855 |
</t> |
</t> |
2856 |
<t>Where <sampler-chan> is the sampler channel, <audio-out> is the |
<t>Where <sampler-chan> is the sampler channel number |
2857 |
sampler channel's audio output channel which should be |
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
2858 |
rerouted and <audio-in> the audio channel of the selected audio |
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, <audio-out> is the |
2859 |
|
numerical ID of the sampler channel's audio output channel which should be |
2860 |
|
rerouted and <audio-in> is the numerical ID of the audio channel of the selected audio |
2861 |
output device where <audio-out> should be routed to.</t> |
output device where <audio-out> should be routed to.</t> |
2862 |
|
|
2863 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2890 |
</t> |
</t> |
2891 |
</section> |
</section> |
2892 |
|
|
2893 |
<section title="Setting MIDI input device"> |
<section title="Setting MIDI input device" anchor="SET CHANNEL MIDI_INPUT_DEVICE"> |
2894 |
<t>The front-end can set the MIDI input device on a specific sampler |
<t>The front-end can set the MIDI input device on a specific sampler |
2895 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2896 |
<t> |
<t> |
2898 |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
<t>SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <midi-device-id></t> |
2899 |
</list> |
</list> |
2900 |
</t> |
</t> |
2901 |
<t></t> |
<t>Where <sampler-channel> 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 <midi-device-id> 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 |
|
|
2908 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2909 |
<t> |
<t> |
2935 |
</t> |
</t> |
2936 |
</section> |
</section> |
2937 |
|
|
2938 |
<section title="Setting MIDI input type"> |
<section title="Setting MIDI input type" anchor="SET CHANNEL MIDI_INPUT_TYPE"> |
2939 |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
<t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t> |
2940 |
|
|
2941 |
<t>The front-end can alter the MIDI input type on a specific sampler |
<t>The front-end can alter the MIDI input type on a specific sampler |
2945 |
<t>SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type></t> |
<t>SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type></t> |
2946 |
</list> |
</list> |
2947 |
</t> |
</t> |
2948 |
<t>Where <midi-input-type> is currently only "Alsa" and |
<t>Where <midi-input-type> is currently only "ALSA" and |
2949 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
2950 |
|
|
2951 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2978 |
</t> |
</t> |
2979 |
</section> |
</section> |
2980 |
|
|
2981 |
<section title="Setting MIDI input port"> |
<section title="Setting MIDI input port" anchor="SET CHANNEL MIDI_INPUT_PORT"> |
2982 |
<t>The front-end can alter the input MIDI port on a specific sampler |
<t>The front-end can alter the MIDI input port on a specific sampler |
2983 |
channel by sending the following command:</t> |
channel by sending the following command:</t> |
2984 |
<t> |
<t> |
2985 |
<list> |
<list> |
3007 |
</t> |
</t> |
3008 |
<t>"ERR:<error-code>:<error-message>" - |
<t>"ERR:<error-code>:<error-message>" - |
3009 |
<list> |
<list> |
3010 |
<t>in case it failed, providing an appropriate error code and error messag</t> |
<t>in case it failed, providing an appropriate error code and error message</t> |
3011 |
</list> |
</list> |
3012 |
</t> |
</t> |
3013 |
</list> |
</list> |
3020 |
</t> |
</t> |
3021 |
</section> |
</section> |
3022 |
|
|
3023 |
<section title="Setting MIDI input channel"> |
<section title="Setting MIDI input channel" anchor="SET CHANNEL MIDI_INPUT_CHANNEL"> |
3024 |
<t>The front-end can alter the MIDI channel a sampler channel should |
<t>The front-end can alter the MIDI channel a sampler channel should |
3025 |
listen to by sending the following command:</t> |
listen to by sending the following command:</t> |
3026 |
<t> |
<t> |
3028 |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
<t>SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan></t> |
3029 |
</list> |
</list> |
3030 |
</t> |
</t> |
3031 |
<t>Where <midi-input-chan> is the new MIDI input channel where |
<t>Where <midi-input-chan> is the number of the new MIDI input channel where |
3032 |
<sampler-channel> should listen to or "ALL" to listen on all 16 MIDI |
<sampler-channel> should listen to or "ALL" to listen on all 16 MIDI |
3033 |
channels.</t> |
channels.</t> |
3034 |
|
|
3062 |
</t> |
</t> |
3063 |
</section> |
</section> |
3064 |
|
|
3065 |
<section title="Setting channel volume"> |
<section title="Setting channel volume" anchor="SET CHANNEL VOLUME"> |
3066 |
<t>The front-end can alter the volume of a sampler channel by sending |
<t>The front-end can alter the volume of a sampler channel by sending |
3067 |
the following command:</t> |
the following command:</t> |
3068 |
<t> |
<t> |
3105 |
</t> |
</t> |
3106 |
</section> |
</section> |
3107 |
|
|
3108 |
<section title="Resetting a sampler channel"> |
<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 <sampler-channel> <mute></t> |
3114 |
|
</list> |
3115 |
|
</t> |
3116 |
|
<t>Where <sampler-channel> 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 |
|
<mute> 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:<warning-code>:<warning-message>" - |
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:<error-code>:<error-message>" - |
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 <sampler-channel> <solo></t> |
3158 |
|
</list> |
3159 |
|
</t> |
3160 |
|
<t>Where <sampler-channel> 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 |
|
<solo> 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:<warning-code>:<warning-message>" - |
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:<error-code>:<error-message>" - |
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 |
|
<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 <sampler-channel> <map></t> |
3202 |
|
</list> |
3203 |
|
</t> |
3204 |
|
<t>Where <sampler-channel> 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 |
|
<map> 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 <map> 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:<error-code>:<error-message>" - |
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 |
|
<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 <sampler-channel> <midi-ctrl> [<name>]</t> |
3270 |
|
</list> |
3271 |
|
</t> |
3272 |
|
<t>Where <sampler-channel> 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, <midi-ctrl> |
3276 |
|
is a number between 0..127 defining the MIDI controller which can alter the |
3277 |
|
effect send level and <name> is an optional argument defining a name |
3278 |
|
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 |
|
|
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[<fx-send-id>]" - |
3304 |
|
<list> |
3305 |
|
<t>in case a new effect send could be added to the |
3306 |
|
sampler channel, where <fx-send-id> reflects the |
3307 |
|
unique ID of the newly created effect send entity</t> |
3308 |
|
</list> |
3309 |
|
</t> |
3310 |
|
<t>"ERR:<error-code>:<error-message>" - |
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 |
|
<t> |
3327 |
|
<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 <sampler-channel> <fx-send-id></t> |
3340 |
|
</list> |
3341 |
|
</t> |
3342 |
|
<t>Where <sampler-channel> 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 |
|
<fx-send-id> 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:<error-code>:<error-message>" - |
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 <sampler-channel></t> |
3382 |
|
</list> |
3383 |
|
</t> |
3384 |
|
<t>Where <sampler-channel> 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 <sampler-channel></t> |
3411 |
|
</list> |
3412 |
|
</t> |
3413 |
|
<t>Where <sampler-channel> 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 <sampler-channel> <fx-send-id></t> |
3447 |
|
</list> |
3448 |
|
</t> |
3449 |
|
<t>Where <sampler-channel> 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 |
|
<fx-send-id> 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 <CRLF> separated list. |
3461 |
|
Each answer line begins with the settings category name |
3462 |
|
followed by a colon and then a space character <SP> 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 |
|
<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 |
|
</list> |
3474 |
|
</t> |
3475 |
|
<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 < 1.0 means attenuation |
3485 |
|
and a value > 1.0 means amplification)</t> |
3486 |
|
</list> |
3487 |
|
</t> |
3488 |
|
<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), if an internal send |
3499 |
|
effect is assigned to the effect |
3500 |
|
send, then this setting defines the |
3501 |
|
audio channel routing to that |
3502 |
|
effect instance respectively</t> |
3503 |
|
</list> |
3504 |
|
</t> |
3505 |
|
<t>EFFECT - |
3506 |
|
<list> |
3507 |
|
<t>destination send effect chain ID |
3508 |
|
and destination effect chain |
3509 |
|
position, separated by comma in the |
3510 |
|
form "<effect-chain>,<chain-pos>" |
3511 |
|
or "NONE" if there is no send effect |
3512 |
|
assigned to the effect send</t> |
3513 |
|
</list> |
3514 |
|
</t> |
3515 |
|
</list> |
3516 |
|
</t> |
3517 |
|
</list> |
3518 |
|
</t> |
3519 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
3520 |
|
|
3521 |
|
<t>Example:</t> |
3522 |
|
<t> |
3523 |
|
<list> |
3524 |
|
<t>C: "GET FX_SEND INFO 0 0"</t> |
3525 |
|
<t>S: "NAME: Reverb Send"</t> |
3526 |
|
<t> "MIDI_CONTROLLER: 91"</t> |
3527 |
|
<t> "LEVEL: 0.3"</t> |
3528 |
|
<t> "AUDIO_OUTPUT_ROUTING: 2,3"</t> |
3529 |
|
<t> "EFFECT: NONE"</t> |
3530 |
|
<t> "."</t> |
3531 |
|
</list> |
3532 |
|
</t> |
3533 |
|
<t> |
3534 |
|
<list> |
3535 |
|
<t>C: "GET FX_SEND INFO 0 1"</t> |
3536 |
|
<t>S: "NAME: Delay Send (Internal)"</t> |
3537 |
|
<t> "MIDI_CONTROLLER: 93"</t> |
3538 |
|
<t> "LEVEL: 0.51"</t> |
3539 |
|
<t> "AUDIO_OUTPUT_ROUTING: 1,2"</t> |
3540 |
|
<t> "EFFECT: 2,0"</t> |
3541 |
|
<t> "."</t> |
3542 |
|
</list> |
3543 |
|
</t> |
3544 |
|
</section> |
3545 |
|
|
3546 |
|
<section title="Changing effect send's name" anchor="SET FX_SEND NAME"> |
3547 |
|
<t>The front-end can alter the current name of an effect |
3548 |
|
send entity by sending the following command:</t> |
3549 |
|
<t> |
3550 |
|
<list> |
3551 |
|
<t>SET FX_SEND NAME <sampler-chan> <fx-send-id> <name></t> |
3552 |
|
</list> |
3553 |
|
</t> |
3554 |
|
<t>Where <sampler-chan> is the sampler channel number |
3555 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3556 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3557 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3558 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3559 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3560 |
|
<name> is the new name of the effect send entity, which |
3561 |
|
does not have to be unique (name MUST be encapsulated into apostrophes |
3562 |
|
and supports escape sequences as described in chapter |
3563 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
3564 |
|
</t> |
3565 |
|
|
3566 |
|
<t>Possible Answers:</t> |
3567 |
|
<t> |
3568 |
|
<list> |
3569 |
|
<t>"OK" - |
3570 |
|
<list> |
3571 |
|
<t>on success</t> |
3572 |
|
</list> |
3573 |
|
</t> |
3574 |
|
<t>"ERR:<error-code>:<error-message>" - |
3575 |
|
<list> |
3576 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3577 |
|
</list> |
3578 |
|
</t> |
3579 |
|
</list> |
3580 |
|
</t> |
3581 |
|
<t>Example:</t> |
3582 |
|
<t> |
3583 |
|
<list> |
3584 |
|
<t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t> |
3585 |
|
<t>S: "OK"</t> |
3586 |
|
</list> |
3587 |
|
</t> |
3588 |
|
</section> |
3589 |
|
|
3590 |
|
<section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL"> |
3591 |
|
<t>The front-end can alter the destination of an effect send's audio channel on a specific |
3592 |
|
sampler channel by sending the following command:</t> |
3593 |
|
<t> |
3594 |
|
<list> |
3595 |
|
<t>SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst></t> |
3596 |
|
</list> |
3597 |
|
</t> |
3598 |
|
<t>Where <sampler-chan> is the sampler channel number |
3599 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3600 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3601 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3602 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3603 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3604 |
|
<audio-src> is the numerical ID of the effect send's audio channel |
3605 |
|
which should be rerouted and <audio-dst> is the numerical ID of |
3606 |
|
the audio channel of the selected audio output device where <audio-src> |
3607 |
|
should be routed to. If an internal send effect is assigned |
3608 |
|
to the effect send, then this setting defines the audio |
3609 |
|
channel routing to that effect instance respectively.</t> |
3610 |
|
|
3611 |
|
<t>Note that effect sends can only route audio to the same audio output |
3612 |
|
device as assigned to the effect send's sampler channel. Also note that an |
3613 |
|
effect send entity does always have exactly as much audio channels as its |
3614 |
|
sampler channel. So if the sampler channel is stereo, the effect send does |
3615 |
|
have two audio channels as well. Also keep in mind that the amount of audio |
3616 |
|
channels on a sampler channel might be dependant not only to the deployed |
3617 |
|
sampler engine on the sampler channel, but also dependant to the instrument |
3618 |
|
currently loaded. However you can (effectively) turn an i.e. stereo effect |
3619 |
|
send into a mono one by simply altering its audio routing appropriately.</t> |
3620 |
|
|
3621 |
|
<t>Possible Answers:</t> |
3622 |
|
<t> |
3623 |
|
<list> |
3624 |
|
<t>"OK" - |
3625 |
|
<list> |
3626 |
|
<t>on success</t> |
3627 |
|
</list> |
3628 |
|
</t> |
3629 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3630 |
|
<list> |
3631 |
|
<t>if audio output channel was set, but there are noteworthy |
3632 |
|
issue(s) related, providing an appropriate warning code and |
3633 |
|
warning message</t> |
3634 |
|
</list> |
3635 |
|
</t> |
3636 |
|
<t>"ERR:<error-code>:<error-message>" - |
3637 |
|
<list> |
3638 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3639 |
|
</list> |
3640 |
|
</t> |
3641 |
|
</list> |
3642 |
|
</t> |
3643 |
|
<t>Example:</t> |
3644 |
|
<t> |
3645 |
|
<list> |
3646 |
|
<t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t> |
3647 |
|
<t>S: "OK"</t> |
3648 |
|
</list> |
3649 |
|
</t> |
3650 |
|
</section> |
3651 |
|
|
3652 |
|
<section title="Assigning destination effect to an effect send" anchor="SET FX_SEND EFFECT"> |
3653 |
|
<t>The front-end can (re-)assign a destination effect to an |
3654 |
|
effect send by sending the following command:</t> |
3655 |
|
<t> |
3656 |
|
<list> |
3657 |
|
<t>SET FX_SEND EFFECT <sampler-chan> <fx-send-id> <effect-chain> <chain-pos></t> |
3658 |
|
</list> |
3659 |
|
</t> |
3660 |
|
<t>Where <sampler-chan> is the sampler channel number |
3661 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3662 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3663 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3664 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3665 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command, |
3666 |
|
<effect-chain> by the numerical ID of the destination |
3667 |
|
effect chain as returned by the |
3668 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
3669 |
|
or |
3670 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
3671 |
|
command and <chain-pos> reflects the exact effect |
3672 |
|
chain position in the effect chain which hosts the actual |
3673 |
|
destination effect.</t> |
3674 |
|
|
3675 |
|
<t>Possible Answers:</t> |
3676 |
|
<t> |
3677 |
|
<list> |
3678 |
|
<t>"OK" - |
3679 |
|
<list> |
3680 |
|
<t>on success</t> |
3681 |
|
</list> |
3682 |
|
</t> |
3683 |
|
<t>"ERR:<error-code>:<error-message>" - |
3684 |
|
<list> |
3685 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3686 |
|
</list> |
3687 |
|
</t> |
3688 |
|
</list> |
3689 |
|
</t> |
3690 |
|
<t>Example:</t> |
3691 |
|
<t> |
3692 |
|
<list> |
3693 |
|
<t>C: "SET FX_SEND EFFECT 0 0 2 5"</t> |
3694 |
|
<t>S: "OK"</t> |
3695 |
|
</list> |
3696 |
|
</t> |
3697 |
|
</section> |
3698 |
|
|
3699 |
|
<section title="Removing destination effect from an effect send" anchor="REMOVE FX_SEND EFFECT"> |
3700 |
|
<t>The front-end can (re-)assign a destination effect to an |
3701 |
|
effect send by sending the following command:</t> |
3702 |
|
<t> |
3703 |
|
<list> |
3704 |
|
<t>REMOVE FX_SEND EFFECT <sampler-chan> <fx-send-id></t> |
3705 |
|
</list> |
3706 |
|
</t> |
3707 |
|
<t>Where <sampler-chan> is the sampler channel number |
3708 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3709 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3710 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3711 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3712 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t> |
3713 |
|
|
3714 |
|
<t>After the destination effect has been removed from the |
3715 |
|
effect send, the audio signal of the effect send will be |
3716 |
|
routed directly to the audio output device, according to the |
3717 |
|
audio channel routing setting of the effect send. |
3718 |
|
</t> |
3719 |
|
|
3720 |
|
<t>Possible Answers:</t> |
3721 |
|
<t> |
3722 |
|
<list> |
3723 |
|
<t>"OK" - |
3724 |
|
<list> |
3725 |
|
<t>on success</t> |
3726 |
|
</list> |
3727 |
|
</t> |
3728 |
|
<t>"ERR:<error-code>:<error-message>" - |
3729 |
|
<list> |
3730 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3731 |
|
</list> |
3732 |
|
</t> |
3733 |
|
</list> |
3734 |
|
</t> |
3735 |
|
<t>Example:</t> |
3736 |
|
<t> |
3737 |
|
<list> |
3738 |
|
<t>C: "REMOVE FX_SEND EFFECT 0 0"</t> |
3739 |
|
<t>S: "OK"</t> |
3740 |
|
</list> |
3741 |
|
</t> |
3742 |
|
</section> |
3743 |
|
|
3744 |
|
<section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER"> |
3745 |
|
<t>The front-end can alter the MIDI controller of an effect |
3746 |
|
send entity by sending the following command:</t> |
3747 |
|
<t> |
3748 |
|
<list> |
3749 |
|
<t>SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl></t> |
3750 |
|
</list> |
3751 |
|
</t> |
3752 |
|
<t>Where <sampler-chan> is the sampler channel number |
3753 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3754 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3755 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3756 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3757 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3758 |
|
<midi-ctrl> reflects the MIDI controller which shall be |
3759 |
|
able to modify the effect send's send level.</t> |
3760 |
|
|
3761 |
|
<t>Possible Answers:</t> |
3762 |
|
<t> |
3763 |
|
<list> |
3764 |
|
<t>"OK" - |
3765 |
|
<list> |
3766 |
|
<t>on success</t> |
3767 |
|
</list> |
3768 |
|
</t> |
3769 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3770 |
|
<list> |
3771 |
|
<t>if MIDI controller was set, but there are noteworthy |
3772 |
|
issue(s) related, providing an appropriate warning code and |
3773 |
|
warning message</t> |
3774 |
|
</list> |
3775 |
|
</t> |
3776 |
|
<t>"ERR:<error-code>:<error-message>" - |
3777 |
|
<list> |
3778 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3779 |
|
</list> |
3780 |
|
</t> |
3781 |
|
</list> |
3782 |
|
</t> |
3783 |
|
<t>Example:</t> |
3784 |
|
<t> |
3785 |
|
<list> |
3786 |
|
<t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t> |
3787 |
|
<t>S: "OK"</t> |
3788 |
|
</list> |
3789 |
|
</t> |
3790 |
|
</section> |
3791 |
|
|
3792 |
|
<section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL"> |
3793 |
|
<t>The front-end can alter the current send level of an effect |
3794 |
|
send entity by sending the following command:</t> |
3795 |
|
<t> |
3796 |
|
<list> |
3797 |
|
<t>SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume></t> |
3798 |
|
</list> |
3799 |
|
</t> |
3800 |
|
<t>Where <sampler-chan> is the sampler channel number |
3801 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3802 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3803 |
|
<fx-send-id> reflects the numerical ID of the effect send entity |
3804 |
|
as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref> |
3805 |
|
or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and |
3806 |
|
<volume> is an optionally dotted positive number (a value |
3807 |
|
smaller than 1.0 means attenuation, whereas a value greater than |
3808 |
|
1.0 means amplification) reflecting the new send level.</t> |
3809 |
|
|
3810 |
|
<t>Possible Answers:</t> |
3811 |
|
<t> |
3812 |
|
<list> |
3813 |
|
<t>"OK" - |
3814 |
|
<list> |
3815 |
|
<t>on success</t> |
3816 |
|
</list> |
3817 |
|
</t> |
3818 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
3819 |
|
<list> |
3820 |
|
<t>if new send level was set, but there are noteworthy |
3821 |
|
issue(s) related, providing an appropriate warning code and |
3822 |
|
warning message</t> |
3823 |
|
</list> |
3824 |
|
</t> |
3825 |
|
<t>"ERR:<error-code>:<error-message>" - |
3826 |
|
<list> |
3827 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3828 |
|
</list> |
3829 |
|
</t> |
3830 |
|
</list> |
3831 |
|
</t> |
3832 |
|
<t>Example:</t> |
3833 |
|
<t> |
3834 |
|
<list> |
3835 |
|
<t>C: "SET FX_SEND LEVEL 0 0 0.15"</t> |
3836 |
|
<t>S: "OK"</t> |
3837 |
|
</list> |
3838 |
|
</t> |
3839 |
|
</section> |
3840 |
|
|
3841 |
|
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
3842 |
|
<t>The front-end can send MIDI events to a specific sampler channel |
3843 |
|
by sending the following command:</t> |
3844 |
|
<t> |
3845 |
|
<list> |
3846 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
3847 |
|
</list> |
3848 |
|
</t> |
3849 |
|
<t>Where <sampler-chan> is the sampler channel number |
3850 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3851 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3852 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
3853 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
3854 |
|
<t> |
3855 |
|
<list> |
3856 |
|
<t>"NOTE_ON" - |
3857 |
|
<list> |
3858 |
|
<t>For turning on MIDI notes, where <arg1> |
3859 |
|
specifies the key number and <arg2> the velocity |
3860 |
|
as described in the MIDI specification.</t> |
3861 |
|
</list> |
3862 |
|
</t> |
3863 |
|
<t>"NOTE_OFF" - |
3864 |
|
<list> |
3865 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
3866 |
|
specifies the key number and <arg2> the velocity |
3867 |
|
as described in the MIDI specification.</t> |
3868 |
|
</list> |
3869 |
|
</t> |
3870 |
|
<t>"CC" - |
3871 |
|
<list> |
3872 |
|
<t>For changing a MIDI controller, where <arg1> |
3873 |
|
specifies the controller number and <arg2> the |
3874 |
|
new value of the controller as described in the Control |
3875 |
|
Change section of the MIDI specification.</t> |
3876 |
|
</list> |
3877 |
|
</t> |
3878 |
|
</list> |
3879 |
|
</t> |
3880 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
3881 |
|
and no realtime guarantee whatsoever will be made!</t> |
3882 |
|
<t>Possible Answers:</t> |
3883 |
|
<t> |
3884 |
|
<list> |
3885 |
|
<t>"OK" - |
3886 |
|
<list> |
3887 |
|
<t>on success</t> |
3888 |
|
</list> |
3889 |
|
</t> |
3890 |
|
<t>"ERR:<error-code>:<error-message>" - |
3891 |
|
<list> |
3892 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3893 |
|
</list> |
3894 |
|
</t> |
3895 |
|
</list> |
3896 |
|
</t> |
3897 |
|
<t>Example:</t> |
3898 |
|
<t> |
3899 |
|
<list> |
3900 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
3901 |
|
<t>S: "OK"</t> |
3902 |
|
</list> |
3903 |
|
</t> |
3904 |
|
</section> |
3905 |
|
|
3906 |
|
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3907 |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
<t>The front-end can reset a particular sampler channel by sending the following command:</t> |
3908 |
<t> |
<t> |
3909 |
<list> |
<list> |
3951 |
<section title="Controlling connection"> |
<section title="Controlling connection"> |
3952 |
<t>The following commands are used to control the connection to LinuxSampler.</t> |
<t>The following commands are used to control the connection to LinuxSampler.</t> |
3953 |
|
|
3954 |
<section title="Register front-end for receiving event messages"> |
<section title="Register front-end for receiving event messages" anchor="SUBSCRIBE"> |
3955 |
<t>The front-end can register itself to the LinuxSampler application to |
<t>The front-end can register itself to the LinuxSampler application to |
3956 |
be informed about noteworthy events by sending this command:</t> |
be informed about noteworthy events by sending this command:</t> |
3957 |
<t> |
<t> |
3993 |
</t> |
</t> |
3994 |
</section> |
</section> |
3995 |
|
|
3996 |
<section title="Unregister front-end for not receiving UDP event messages anymore"> |
<section title="Unregister front-end for not receiving event messages" anchor="UNSUBSCRIBE"> |
3997 |
<t>The front-end can unregister itself if it doesn't want to receive event |
<t>The front-end can unregister itself if it doesn't want to receive event |
3998 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
3999 |
<t> |
<t> |
4035 |
</t> |
</t> |
4036 |
</section> |
</section> |
4037 |
|
|
4038 |
<section title="Enable or disable echo of commands"> |
<section title="Enable or disable echo of commands" anchor="SET ECHO"> |
4039 |
<t>To enable or disable back sending of commands to the client the following command can be used:</t> |
<t>To enable or disable back sending of commands to the client the following command can be used:</t> |
4040 |
<t> |
<t> |
4041 |
<list> |
<list> |
4073 |
</t> |
</t> |
4074 |
</section> |
</section> |
4075 |
|
|
4076 |
<section title="Close client connection"> |
<section title="Close client connection" anchor="QUIT"> |
4077 |
<t>The client can close its network connection to LinuxSampler by sending the following command:</t> |
<t>The client can close its network connection to LinuxSampler by sending the following command:</t> |
4078 |
<t> |
<t> |
4079 |
<list> |
<list> |
4088 |
<section title="Global commands"> |
<section title="Global commands"> |
4089 |
<t>The following commands have global impact on the sampler.</t> |
<t>The following commands have global impact on the sampler.</t> |
4090 |
|
|
4091 |
<section title="Reset sampler"> |
<section title="Current number of active voices" anchor="GET TOTAL_VOICE_COUNT"> |
4092 |
|
<t>The front-end can ask for the current number of active voices on |
4093 |
|
the sampler by sending the following command:</t> |
4094 |
|
<t> |
4095 |
|
<list> |
4096 |
|
<t>GET TOTAL_VOICE_COUNT</t> |
4097 |
|
</list> |
4098 |
|
</t> |
4099 |
|
|
4100 |
|
<t>Possible Answers:</t> |
4101 |
|
<t> |
4102 |
|
<list> |
4103 |
|
<t>LinuxSampler will answer by returning the number of all active |
4104 |
|
voices on the sampler.</t> |
4105 |
|
</list> |
4106 |
|
</t> |
4107 |
|
</section> |
4108 |
|
|
4109 |
|
<section title="Maximum amount of active voices" anchor="GET TOTAL_VOICE_COUNT_MAX"> |
4110 |
|
<t>The front-end can ask for the maximum number of active voices |
4111 |
|
by sending the following command:</t> |
4112 |
|
<t> |
4113 |
|
<list> |
4114 |
|
<t>GET TOTAL_VOICE_COUNT_MAX</t> |
4115 |
|
</list> |
4116 |
|
</t> |
4117 |
|
|
4118 |
|
<t>Possible Answers:</t> |
4119 |
|
<t> |
4120 |
|
<list> |
4121 |
|
<t>LinuxSampler will answer by returning the maximum number |
4122 |
|
of active voices.</t> |
4123 |
|
</list> |
4124 |
|
</t> |
4125 |
|
</section> |
4126 |
|
|
4127 |
|
<section title="Current number of active disk streams" anchor="GET TOTAL_STREAM_COUNT"> |
4128 |
|
<t>The front-end can ask for the current number of active disk streams on |
4129 |
|
the sampler by sending the following command:</t> |
4130 |
|
<t> |
4131 |
|
<list> |
4132 |
|
<t>GET TOTAL_STREAM_COUNT</t> |
4133 |
|
</list> |
4134 |
|
</t> |
4135 |
|
|
4136 |
|
<t>Possible Answers:</t> |
4137 |
|
<t> |
4138 |
|
<list> |
4139 |
|
<t>LinuxSampler will answer by returning the number of all active |
4140 |
|
disk streams on the sampler.</t> |
4141 |
|
</list> |
4142 |
|
</t> |
4143 |
|
</section> |
4144 |
|
|
4145 |
|
<section title="Reset sampler" anchor="RESET"> |
4146 |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
<t>The front-end can reset the whole sampler by sending the following command:</t> |
4147 |
<t> |
<t> |
4148 |
<list> |
<list> |
4167 |
</list> |
</list> |
4168 |
</t> |
</t> |
4169 |
</section> |
</section> |
4170 |
|
|
4171 |
|
<section title="General sampler informations" anchor="GET SERVER INFO"> |
4172 |
|
<t>The client can ask for general informations about the LinuxSampler |
4173 |
|
instance by sending the following command:</t> |
4174 |
|
<t> |
4175 |
|
<list> |
4176 |
|
<t>GET SERVER INFO</t> |
4177 |
|
</list> |
4178 |
|
</t> |
4179 |
|
<t>Possible Answers:</t> |
4180 |
|
<t> |
4181 |
|
<list> |
4182 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
4183 |
|
Each answer line begins with the information category name |
4184 |
|
followed by a colon and then a space character <SP> and finally |
4185 |
|
the info character string to that information category. At the |
4186 |
|
moment the following categories are defined: |
4187 |
|
</t> |
4188 |
|
<t> |
4189 |
|
<list> |
4190 |
|
<t>DESCRIPTION - |
4191 |
|
<list> |
4192 |
|
<t>arbitrary textual description about the sampler |
4193 |
|
(note that the character string may contain |
4194 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4195 |
|
</list> |
4196 |
|
</t> |
4197 |
|
<t>VERSION - |
4198 |
|
<list> |
4199 |
|
<t>version of the sampler</t> |
4200 |
|
</list> |
4201 |
|
</t> |
4202 |
|
<t>PROTOCOL_VERSION - |
4203 |
|
<list> |
4204 |
|
<t>version of the LSCP specification the sampler |
4205 |
|
complies with (see <xref target="LSCP versioning" /> for details)</t> |
4206 |
|
</list> |
4207 |
|
</t> |
4208 |
|
<t>INSTRUMENTS_DB_SUPPORT - |
4209 |
|
<list> |
4210 |
|
<t>either yes or no, specifies whether the |
4211 |
|
sampler is build with instruments database support.</t> |
4212 |
|
</list> |
4213 |
|
</t> |
4214 |
|
</list> |
4215 |
|
</t> |
4216 |
|
</list> |
4217 |
|
</t> |
4218 |
|
<t>The mentioned fields above don't have to be in particular order. |
4219 |
|
Other fields might be added in future.</t> |
4220 |
|
</section> |
4221 |
|
|
4222 |
|
<section title="Getting global volume attenuation" anchor="GET VOLUME"> |
4223 |
|
<t>The client can ask for the current global sampler-wide volume |
4224 |
|
attenuation by sending the following command:</t> |
4225 |
|
<t> |
4226 |
|
<list> |
4227 |
|
<t>GET VOLUME</t> |
4228 |
|
</list> |
4229 |
|
</t> |
4230 |
|
<t>Possible Answers:</t> |
4231 |
|
<t> |
4232 |
|
<list> |
4233 |
|
<t>The sampler will always answer by returning the optional |
4234 |
|
dotted floating point coefficient, reflecting the current |
4235 |
|
global volume attenuation. |
4236 |
|
</t> |
4237 |
|
</list> |
4238 |
|
</t> |
4239 |
|
<t>Note: it is up to the respective sampler engine whether to obey |
4240 |
|
that global volume parameter or not, but in general all engines SHOULD |
4241 |
|
use this parameter.</t> |
4242 |
|
</section> |
4243 |
|
|
4244 |
|
<section title="Setting global volume attenuation" anchor="SET VOLUME"> |
4245 |
|
<t>The client can alter the current global sampler-wide volume |
4246 |
|
attenuation by sending the following command:</t> |
4247 |
|
<t> |
4248 |
|
<list> |
4249 |
|
<t>SET VOLUME <volume></t> |
4250 |
|
</list> |
4251 |
|
</t> |
4252 |
|
<t>Where <volume> should be replaced by the optional dotted |
4253 |
|
floating point value, reflecting the new global volume parameter. |
4254 |
|
This value might usually be in the range between 0.0 and 1.0, that |
4255 |
|
is for attenuating the overall volume.</t> |
4256 |
|
|
4257 |
|
<t>Possible Answers:</t> |
4258 |
|
<t> |
4259 |
|
<list> |
4260 |
|
<t>"OK" - |
4261 |
|
<list> |
4262 |
|
<t>on success</t> |
4263 |
|
</list> |
4264 |
|
</t> |
4265 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4266 |
|
<list> |
4267 |
|
<t>if the global volume was set, but there are noteworthy |
4268 |
|
issue(s) related, providing an appropriate warning code and |
4269 |
|
warning message</t> |
4270 |
|
</list> |
4271 |
|
</t> |
4272 |
|
<t>"ERR:<error-code>:<error-message>" - |
4273 |
|
<list> |
4274 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4275 |
|
</list> |
4276 |
|
</t> |
4277 |
|
</list> |
4278 |
|
</t> |
4279 |
|
</section> |
4280 |
|
|
4281 |
|
<section title="Getting global voice limit" anchor="GET VOICES"> |
4282 |
|
<t>The client can ask for the current global sampler-wide limit |
4283 |
|
for maximum voices by sending the following command:</t> |
4284 |
|
<t> |
4285 |
|
<list> |
4286 |
|
<t>GET VOICES</t> |
4287 |
|
</list> |
4288 |
|
</t> |
4289 |
|
<t>Possible Answers:</t> |
4290 |
|
<t> |
4291 |
|
<list> |
4292 |
|
<t>LinuxSampler will answer by returning the number for |
4293 |
|
the current limit of maximum voices.</t> |
4294 |
|
</list> |
4295 |
|
</t> |
4296 |
|
|
4297 |
|
<t>The voice limit setting defines how many voices should maximum |
4298 |
|
be processed by the sampler at the same time. If the user |
4299 |
|
triggers new notes which would exceed that voice limit, the |
4300 |
|
sampler engine will react by stealing old voices for those |
4301 |
|
newly triggered notes. Note that the amount of voices triggered |
4302 |
|
by a new note can be larger than one and is dependent to the |
4303 |
|
respective instrument and probably further criterias.</t> |
4304 |
|
</section> |
4305 |
|
|
4306 |
|
<section title="Setting global voice limit" anchor="SET VOICES"> |
4307 |
|
<t>The client can alter the current global sampler-wide limit |
4308 |
|
for maximum voices by sending the following command:</t> |
4309 |
|
<t> |
4310 |
|
<list> |
4311 |
|
<t>SET VOICES <max-voices></t> |
4312 |
|
</list> |
4313 |
|
</t> |
4314 |
|
<t>Where <max-voices> should be replaced by the integer |
4315 |
|
value, reflecting the new global amount limit of maximum voices. |
4316 |
|
This value has to be larger than 0.</t> |
4317 |
|
|
4318 |
|
<t>Possible Answers:</t> |
4319 |
|
<t> |
4320 |
|
<list> |
4321 |
|
<t>"OK" - |
4322 |
|
<list> |
4323 |
|
<t>on success</t> |
4324 |
|
</list> |
4325 |
|
</t> |
4326 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4327 |
|
<list> |
4328 |
|
<t>if the voice limit was set, but there are noteworthy |
4329 |
|
issue(s) related, providing an appropriate warning code and |
4330 |
|
warning message</t> |
4331 |
|
</list> |
4332 |
|
</t> |
4333 |
|
<t>"ERR:<error-code>:<error-message>" - |
4334 |
|
<list> |
4335 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4336 |
|
</list> |
4337 |
|
</t> |
4338 |
|
</list> |
4339 |
|
</t> |
4340 |
|
|
4341 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4342 |
|
The total amount of maximum voices on the running system might thus |
4343 |
|
be as big as the given value multiplied by the current amount of engine |
4344 |
|
instances.</t> |
4345 |
|
|
4346 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
4347 |
|
adjust the disk stream limit respectively and vice versa.</t> |
4348 |
|
</section> |
4349 |
|
|
4350 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
4351 |
|
<t>The client can ask for the current global sampler-wide limit |
4352 |
|
for maximum disk streams by sending the following command:</t> |
4353 |
|
<t> |
4354 |
|
<list> |
4355 |
|
<t>GET STREAMS</t> |
4356 |
|
</list> |
4357 |
|
</t> |
4358 |
|
<t>Possible Answers:</t> |
4359 |
|
<t> |
4360 |
|
<list> |
4361 |
|
<t>LinuxSampler will answer by returning the number for |
4362 |
|
the current limit of maximum disk streams.</t> |
4363 |
|
</list> |
4364 |
|
</t> |
4365 |
|
|
4366 |
|
<t>The disk stream limit setting defines how many disk streams should |
4367 |
|
maximum be processed by a sampler engine at the same time. The |
4368 |
|
higher this value, the more memory (RAM) will be occupied, since |
4369 |
|
every disk streams allocates a certain buffer size for being able |
4370 |
|
to perform its streaming operations.</t> |
4371 |
|
</section> |
4372 |
|
|
4373 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
4374 |
|
<t>The client can alter the current global sampler-wide limit |
4375 |
|
for maximum disk streams by sending the following command:</t> |
4376 |
|
<t> |
4377 |
|
<list> |
4378 |
|
<t>SET STREAMS <max-streams></t> |
4379 |
|
</list> |
4380 |
|
</t> |
4381 |
|
<t>Where <max-streams> should be replaced by the integer |
4382 |
|
value, reflecting the new global amount limit of maximum disk streams. |
4383 |
|
This value has to be positive.</t> |
4384 |
|
|
4385 |
|
<t>Possible Answers:</t> |
4386 |
|
<t> |
4387 |
|
<list> |
4388 |
|
<t>"OK" - |
4389 |
|
<list> |
4390 |
|
<t>on success</t> |
4391 |
|
</list> |
4392 |
|
</t> |
4393 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4394 |
|
<list> |
4395 |
|
<t>if the disk stream limit was set, but there are noteworthy |
4396 |
|
issue(s) related, providing an appropriate warning code and |
4397 |
|
warning message</t> |
4398 |
|
</list> |
4399 |
|
</t> |
4400 |
|
<t>"ERR:<error-code>:<error-message>" - |
4401 |
|
<list> |
4402 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4403 |
|
</list> |
4404 |
|
</t> |
4405 |
|
</list> |
4406 |
|
</t> |
4407 |
|
|
4408 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4409 |
|
The total amount of maximum disk streams on the running system might |
4410 |
|
thus be as big as the given value multiplied by the current amount of |
4411 |
|
engine instances.</t> |
4412 |
|
|
4413 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
4414 |
|
adjust the voice limit respectively and vice versa.</t> |
4415 |
|
</section> |
4416 |
|
|
4417 |
|
</section> |
4418 |
|
|
4419 |
|
|
4420 |
|
<section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping"> |
4421 |
|
<t>The MIDI protocol provides a way to switch between instruments |
4422 |
|
by sending so called MIDI bank select and MIDI program change |
4423 |
|
messages which are essentially just numbers. The following commands |
4424 |
|
allow to actually map arbitrary MIDI bank select / program change |
4425 |
|
numbers with real instruments.</t> |
4426 |
|
<t>The sampler allows to manage an arbitrary amount of MIDI |
4427 |
|
instrument maps which define which instrument to load on |
4428 |
|
which MIDI program change message.</t> |
4429 |
|
<t>By default, that is when the sampler is launched, there is no |
4430 |
|
map, thus the sampler will simply ignore all program change |
4431 |
|
messages. The front-end has to explicitly create at least one |
4432 |
|
map, add entries to the map and tell the respective sampler |
4433 |
|
channel(s) which MIDI instrument map to use, so the sampler |
4434 |
|
knows how to react on a given program change message on the |
4435 |
|
respective sampler channel, that is by switching to the |
4436 |
|
respectively defined engine type and loading the respective |
4437 |
|
instrument. See command |
4438 |
|
<xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref> |
4439 |
|
for how to assign a MIDI instrument map to a sampler channel.</t> |
4440 |
|
<t>Also note per MIDI specification a bank select message does not |
4441 |
|
cause to switch to another instrument. Instead when receiving a |
4442 |
|
bank select message the bank value will be stored and a subsequent |
4443 |
|
program change message (which may occur at any time) will finally |
4444 |
|
cause the sampler to switch to the respective instrument as |
4445 |
|
reflected by the current MIDI instrument map.</t> |
4446 |
|
|
4447 |
|
<section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT_MAP"> |
4448 |
|
<t>The front-end can add a new MIDI instrument map by sending |
4449 |
|
the following command:</t> |
4450 |
|
<t> |
4451 |
|
<list> |
4452 |
|
<t>ADD MIDI_INSTRUMENT_MAP [<name>]</t> |
4453 |
|
</list> |
4454 |
|
</t> |
4455 |
|
<t>Where <name> is an optional argument allowing to |
4456 |
|
assign a custom name to the new map. MIDI instrument Map |
4457 |
|
names do not have to be unique, but MUST be encapsulated |
4458 |
|
into apostrophes and support escape sequences as described |
4459 |
|
in chapter "<xref target="character_set">Character Set and Escape Sequences</xref>". |
4460 |
|
</t> |
4461 |
|
|
4462 |
|
<t>Possible Answers:</t> |
4463 |
|
<t> |
4464 |
|
<list> |
4465 |
|
<t>"OK[<map>]" - |
4466 |
|
<list> |
4467 |
|
<t>in case a new MIDI instrument map could |
4468 |
|
be added, where <map> reflects the |
4469 |
|
unique ID of the newly created MIDI |
4470 |
|
instrument map</t> |
4471 |
|
</list> |
4472 |
|
</t> |
4473 |
|
<t>"ERR:<error-code>:<error-message>" - |
4474 |
|
<list> |
4475 |
|
<t>when a new map could not be created, which |
4476 |
|
might never occur in practice</t> |
4477 |
|
</list> |
4478 |
|
</t> |
4479 |
|
</list> |
4480 |
|
</t> |
4481 |
|
|
4482 |
|
<t>Examples:</t> |
4483 |
|
<t> |
4484 |
|
<list> |
4485 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t> |
4486 |
|
<t>S: "OK[0]"</t> |
4487 |
|
</list> |
4488 |
|
</t> |
4489 |
|
<t> |
4490 |
|
<list> |
4491 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t> |
4492 |
|
<t>S: "OK[1]"</t> |
4493 |
|
</list> |
4494 |
|
</t> |
4495 |
|
<t> |
4496 |
|
<list> |
4497 |
|
<t>C: "ADD MIDI_INSTRUMENT_MAP"</t> |
4498 |
|
<t>S: "OK[5]"</t> |
4499 |
|
</list> |
4500 |
|
</t> |
4501 |
|
</section> |
4502 |
|
|
4503 |
|
<section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP"> |
4504 |
|
<t>The front-end can delete a particular MIDI instrument map |
4505 |
|
by sending the following command:</t> |
4506 |
|
<t> |
4507 |
|
<list> |
4508 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP <map></t> |
4509 |
|
</list> |
4510 |
|
</t> |
4511 |
|
<t>Where <map> reflects the unique ID of the map to delete |
4512 |
|
as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
4513 |
|
command.</t> |
4514 |
|
<t>The front-end can delete all MIDI instrument maps by |
4515 |
|
sending the following command:</t> |
4516 |
|
<t> |
4517 |
|
<list> |
4518 |
|
<t>REMOVE MIDI_INSTRUMENT_MAP ALL</t> |
4519 |
|
</list> |
4520 |
|
</t> |
4521 |
|
|
4522 |
|
<t>Possible Answers:</t> |
4523 |
|
<t> |
4524 |
|
<list> |
4525 |
|
<t>"OK" - |
4526 |
|
<list> |
4527 |
|
<t>in case the map(s) could be deleted</t> |
4528 |
|
</list> |
4529 |
|
</t> |
4530 |
|
<t>"ERR:<error-code>:<error-message>" - |
4531 |
|
<list> |
4532 |
|
<t>when the given map does not exist</t> |
4533 |
|
</list> |
4534 |
|
</t> |
4535 |
|
</list> |
4536 |
|
</t> |
4537 |
|
|
4538 |
|
<t>Examples:</t> |
4539 |
|
<t> |
4540 |
|
<list> |
4541 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t> |
4542 |
|
<t>S: "OK"</t> |
4543 |
|
</list> |
4544 |
|
</t> |
4545 |
|
<t> |
4546 |
|
<list> |
4547 |
|
<t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t> |
4548 |
|
<t>S: "OK"</t> |
4549 |
|
</list> |
4550 |
|
</t> |
4551 |
|
</section> |
4552 |
|
|
4553 |
|
<section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS"> |
4554 |
|
<t>The front-end can retrieve the current amount of MIDI |
4555 |
|
instrument maps by sending the following command:</t> |
4556 |
|
<t> |
4557 |
|
<list> |
4558 |
|
<t>GET MIDI_INSTRUMENT_MAPS</t> |
4559 |
|
</list> |
4560 |
|
</t> |
4561 |
|
|
4562 |
|
<t>Possible Answers:</t> |
4563 |
|
<t> |
4564 |
|
<list> |
4565 |
|
<t>The sampler will answer by returning the current |
4566 |
|
number of MIDI instrument maps.</t> |
4567 |
|
</list> |
4568 |
|
</t> |
4569 |
|
|
4570 |
|
<t>Example:</t> |
4571 |
|
<t> |
4572 |
|
<list> |
4573 |
|
<t>C: "GET MIDI_INSTRUMENT_MAPS"</t> |
4574 |
|
<t>S: "2"</t> |
4575 |
|
</list> |
4576 |
|
</t> |
4577 |
|
</section> |
4578 |
|
|
4579 |
|
<section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS"> |
4580 |
|
<t>The number of MIDI instrument maps can change on runtime. To get the |
4581 |
|
current list of MIDI instrument maps, the front-end can send the |
4582 |
|
following command:</t> |
4583 |
|
<t> |
4584 |
|
<list> |
4585 |
|
<t>LIST MIDI_INSTRUMENT_MAPS</t> |
4586 |
|
</list> |
4587 |
|
</t> |
4588 |
|
<t>Possible Answers:</t> |
4589 |
|
<t> |
4590 |
|
<list> |
4591 |
|
<t>The sampler will answer by returning a comma separated list |
4592 |
|
with all MIDI instrument maps' numerical IDs.</t> |
4593 |
|
</list> |
4594 |
|
</t> |
4595 |
|
<t>Example:</t> |
4596 |
|
<t> |
4597 |
|
<list> |
4598 |
|
<t>C: "LIST MIDI_INSTRUMENT_MAPS"</t> |
4599 |
|
<t>S: "0,1,5,12"</t> |
4600 |
|
</list> |
4601 |
|
</t> |
4602 |
|
</section> |
4603 |
|
|
4604 |
|
<section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO"> |
4605 |
|
<t>The front-end can ask for the current settings of a MIDI |
4606 |
|
instrument map by sending the following command:</t> |
4607 |
|
<t> |
4608 |
|
<list> |
4609 |
|
<t>GET MIDI_INSTRUMENT_MAP INFO <map></t> |
4610 |
|
</list> |
4611 |
|
</t> |
4612 |
|
<t>Where <map> is the numerical ID of the map the |
4613 |
|
front-end is interested in as returned by the |
4614 |
|
<xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref> |
4615 |
|
command.</t> |
4616 |
|
|
4617 |
|
<t>Possible Answers:</t> |
4618 |
|
<t> |
4619 |
|
<list> |
4620 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
4621 |
|
Each answer line begins with the settings category name |
4622 |
|
followed by a colon and then a space character <SP> and finally |
4623 |
|
the info character string to that setting category. At the |
4624 |
|
moment the following categories are defined:</t> |
4625 |
|
|
4626 |
|
<t> |
4627 |
|
<list> |
4628 |
|
<t>NAME - |
4629 |
|
<list> |
4630 |
|
<t>custom name of the given map, |
4631 |
|
which does not have to be unique |
4632 |
|
(note that this character string may contain |
4633 |
|
<xref target="character_set">escape sequences</xref>)</t> |
4634 |
|
</list> |
4635 |
|
</t> |
4636 |
|
<t>DEFAULT - |
4637 |
|
<list> |
4638 |
|
<t>either true or false, |
4639 |
|
defines whether this map is the default map</t> |
4640 |
|
</list> |
4641 |
|
</t> |
4642 |
|
</list> |
4643 |
|
</t> |
4644 |
|
</list> |
4645 |
|
</t> |
4646 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
4647 |
|
|
4648 |
|
<t>Example:</t> |
4649 |
|
<t> |
4650 |
|
<list> |
4651 |
|
<t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t> |
4652 |
|
<t>S: "NAME: Standard Map"</t> |
4653 |
|
<t> "DEFAULT: true"</t> |
4654 |
|
<t> "."</t> |
4655 |
|
</list> |
4656 |
|
</t> |
4657 |
|
</section> |
4658 |
|
|
4659 |
|
<section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME"> |
4660 |
|
<t>The front-end can alter the custom name of a MIDI |
4661 |
|
instrument map by sending the following command:</t> |
4662 |
|
<t> |
4663 |
|
<list> |
4664 |
|
<t>SET MIDI_INSTRUMENT_MAP NAME <map> <name></t> |
4665 |
|
</list> |
4666 |
|
</t> |
4667 |
|
<t>Where <map> is the numerical ID of the map and |
4668 |
|
<name> the new custom name of the map, which does not |
4669 |
|
have to be unique (name MUST be encapsulated into apostrophes |
4670 |
|
and supports escape sequences as described in chapter |
4671 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"). |
4672 |
|
</t> |
4673 |
|
|
4674 |
|
<t>Possible Answers:</t> |
4675 |
|
<t> |
4676 |
|
<list> |
4677 |
|
<t>"OK" - |
4678 |
|
<list> |
4679 |
|
<t>on success</t> |
4680 |
|
</list> |
4681 |
|
</t> |
4682 |
|
<t>"ERR:<error-code>:<error-message>" - |
4683 |
|
<list> |
4684 |
|
<t>in case the given map does not exist</t> |
4685 |
|
</list> |
4686 |
|
</t> |
4687 |
|
</list> |
4688 |
|
</t> |
4689 |
|
|
4690 |
|
<t>Example:</t> |
4691 |
|
<t> |
4692 |
|
<list> |
4693 |
|
<t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t> |
4694 |
|
<t>S: "OK"</t> |
4695 |
|
</list> |
4696 |
|
</t> |
4697 |
|
</section> |
4698 |
|
|
4699 |
|
<section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT"> |
4700 |
|
<t>The front-end can create a new or replace an existing entry |
4701 |
|
in a sampler's MIDI instrument map by sending the following |
4702 |
|
command:</t> |
4703 |
|
<t> |
4704 |
|
<list> |
4705 |
|
<t>MAP MIDI_INSTRUMENT [NON_MODAL] <map> |
4706 |
|
<midi_bank> <midi_prog> <engine_name> |
4707 |
|
<filename> <instrument_index> <volume_value> |
4708 |
|
[<instr_load_mode>] [<name>]</t> |
4709 |
|
</list> |
4710 |
|
</t> |
4711 |
|
<t>Where <map> is the numeric ID of the map to alter, |
4712 |
|
<midi_bank> is an integer value between |
4713 |
|
0..16383 reflecting the MIDI bank select index, |
4714 |
|
<midi_prog> an |
4715 |
|
integer value between 0..127 reflecting the MIDI program change |
4716 |
|
index, <engine_name> a sampler engine name as returned by |
4717 |
|
the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref> |
4718 |
|
command (not encapsulated into apostrophes), <filename> the name |
4719 |
|
of the instrument's file to be deployed (encapsulated into apostrophes, |
4720 |
|
supporting escape sequences as described in chapter |
4721 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>"), |
4722 |
|
<instrument_index> the index (integer value) of the instrument |
4723 |
|
within the given file, <volume_value> reflects the master |
4724 |
|
volume of the instrument as optionally dotted number (where a |
4725 |
|
value < 1.0 means attenuation and a value > 1.0 means |
4726 |
|
amplification). This parameter easily allows to adjust the |
4727 |
|
volume of all intruments within a custom instrument map |
4728 |
|
without having to adjust their instrument files. The |
4729 |
|
OPTIONAL <instr_load_mode> argument defines the life |
4730 |
|
time of the instrument, that is when the instrument should |
4731 |
|
be loaded, when freed and has exactly the following |
4732 |
|
possibilities:</t> |
4733 |
|
<t> |
4734 |
|
<list> |
4735 |
|
<t>"ON_DEMAND" - |
4736 |
|
<list> |
4737 |
|
<t>The instrument will be loaded when needed, |
4738 |
|
that is when demanded by at least one sampler |
4739 |
|
channel. It will immediately be freed from memory |
4740 |
|
when not needed by any sampler channel anymore.</t> |
4741 |
|
</list> |
4742 |
|
</t> |
4743 |
|
<t>"ON_DEMAND_HOLD" - |
4744 |
|
<list> |
4745 |
|
<t>The instrument will be loaded when needed, |
4746 |
|
that is when demanded by at least one sampler |
4747 |
|
channel. It will be kept in memory even when |
4748 |
|
not needed by any sampler channel anymore. |
4749 |
|
Instruments with this mode are only freed |
4750 |
|
when the sampler is reset or all mapping |
4751 |
|
entries with this mode (and respective |
4752 |
|
instrument) are explicitly changed to |
4753 |
|
"ON_DEMAND" and no sampler channel is using |
4754 |
|
the instrument anymore.</t> |
4755 |
|
</list> |
4756 |
|
</t> |
4757 |
|
<t>"PERSISTENT" - |
4758 |
|
<list> |
4759 |
|
<t>The instrument will immediately be loaded |
4760 |
|
into memory when this mapping |
4761 |
|
command is sent and the instrument is kept all |
4762 |
|
the time. Instruments with this mode are |
4763 |
|
only freed when the sampler is reset or all |
4764 |
|
mapping entries with this mode (and |
4765 |
|
respective instrument) are explicitly |
4766 |
|
changed to "ON_DEMAND" and no sampler |
4767 |
|
channel is using the instrument anymore.</t> |
4768 |
|
</list> |
4769 |
|
</t> |
4770 |
|
<t>not supplied - |
4771 |
|
<list> |
4772 |
|
<t>In case there is no <instr_load_mode> |
4773 |
|
argument given, it will be up to the |
4774 |
|
InstrumentManager to decide which mode to use. |
4775 |
|
Usually it will use "ON_DEMAND" if an entry |
4776 |
|
for the given instrument does not exist in |
4777 |
|
the InstrumentManager's list yet, otherwise |
4778 |
|
if an entry already exists, it will simply |
4779 |
|
stick with the mode currently reflected by |
4780 |
|
the already existing entry, that is it will |
4781 |
|
not change the mode.</t> |
4782 |
|
</list> |
4783 |
|
</t> |
4784 |
|
</list> |
4785 |
|
</t> |
4786 |
|
<t> |
4787 |
|
The <instr_load_mode> argument thus allows to define an |
4788 |
|
appropriate strategy (low memory consumption vs. fast |
4789 |
|
instrument switching) for each instrument individually. Note, the |
4790 |
|
following restrictions apply to this argument: "ON_DEMAND_HOLD" and |
4791 |
|
"PERSISTENT" have to be supported by the respective sampler engine |
4792 |
|
(which is technically the case when the engine provides an |
4793 |
|
InstrumentManager for its format). If this is not the case the |
4794 |
|
argument will automatically fall back to the default value |
4795 |
|
"ON_DEMAND". Also the load mode of one instrument may |
4796 |
|
automatically change the laod mode of other instrument(s), i.e. |
4797 |
|
because the instruments are part of the same file and the |
4798 |
|
engine does not allow a way to manage load modes for them |
4799 |
|
individually. Due to this, in case the frontend shows the |
4800 |
|
load modes of entries, the frontend should retrieve the actual |
4801 |
|
mode by i.e. sending |
4802 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4803 |
|
command(s). Finally the OPTIONAL <name> argument allows to set a custom name |
4804 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
4805 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>") for the |
4806 |
|
mapping entry, useful for frontends for displaying an appropriate name for |
4807 |
|
mapped instruments (using |
4808 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>). |
4809 |
|
</t> |
4810 |
|
<t> |
4811 |
|
By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is |
4812 |
|
completely established in the sampler. The OPTIONAL "NON_MODAL" argument |
4813 |
|
however causes the respective "MAP MIDI_INSTRUMENT" command to return |
4814 |
|
immediately, that is to let the sampler establish the mapping in the |
4815 |
|
background. So this argument might be especially useful for mappings with |
4816 |
|
a "PERSISTENT" type, because these have to load the respective instruments |
4817 |
|
immediately and might thus block for a very long time. It is recommended |
4818 |
|
however to use the OPTIONAL "NON_MODAL" argument only if really necessary, |
4819 |
|
because it has the following drawbacks: as "NON_MODAL" instructions return |
4820 |
|
immediately, they may not necessarily return an error i.e. when the given |
4821 |
|
instrument file turns out to be corrupt, beside that subsequent commands |
4822 |
|
in a LSCP instruction sequence might fail, because mandatory mappings are |
4823 |
|
not yet completed. |
4824 |
|
</t> |
4825 |
|
|
4826 |
|
<t>Possible Answers:</t> |
4827 |
|
<t> |
4828 |
|
<list> |
4829 |
|
<t>"OK" - |
4830 |
|
<list> |
4831 |
|
<t>usually</t> |
4832 |
|
</list> |
4833 |
|
</t> |
4834 |
|
<t>"ERR:<error-code>:<error-message>" - |
4835 |
|
<list> |
4836 |
|
<t>when the given map or engine does not exist or a value |
4837 |
|
is out of range</t> |
4838 |
|
</list> |
4839 |
|
</t> |
4840 |
|
</list> |
4841 |
|
</t> |
4842 |
|
|
4843 |
|
<t>Examples:</t> |
4844 |
|
<t> |
4845 |
|
<list> |
4846 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t> |
4847 |
|
<t>S: "OK"</t> |
4848 |
|
</list> |
4849 |
|
</t> |
4850 |
|
<t> |
4851 |
|
<list> |
4852 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t> |
4853 |
|
<t>S: "OK"</t> |
4854 |
|
</list> |
4855 |
|
</t> |
4856 |
|
<t> |
4857 |
|
<list> |
4858 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t> |
4859 |
|
<t>S: "OK"</t> |
4860 |
|
<t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t> |
4861 |
|
<t>S: "OK"</t> |
4862 |
|
</list> |
4863 |
|
</t> |
4864 |
|
<t> |
4865 |
|
<list> |
4866 |
|
<t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t> |
4867 |
|
<t>S: "OK"</t> |
4868 |
|
</list> |
4869 |
|
</t> |
4870 |
|
</section> |
4871 |
|
|
4872 |
|
<section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS"> |
4873 |
|
<t>The front-end can query the amount of currently existing |
4874 |
|
entries in a MIDI instrument map by sending the following |
4875 |
|
command:</t> |
4876 |
|
<t> |
4877 |
|
<list> |
4878 |
|
<t>GET MIDI_INSTRUMENTS <map></t> |
4879 |
|
</list> |
4880 |
|
</t> |
4881 |
|
<t>The front-end can query the amount of currently existing |
4882 |
|
entries in all MIDI instrument maps by sending the following |
4883 |
|
command:</t> |
4884 |
|
<t> |
4885 |
|
<list> |
4886 |
|
<t>GET MIDI_INSTRUMENTS ALL</t> |
4887 |
|
</list> |
4888 |
|
</t> |
4889 |
|
<t>Possible Answers:</t> |
4890 |
|
<t> |
4891 |
|
<list> |
4892 |
|
<t>The sampler will answer by sending the current number of |
4893 |
|
entries in the MIDI instrument map(s).</t> |
4894 |
|
</list> |
4895 |
|
</t> |
4896 |
|
|
4897 |
|
<t>Example:</t> |
4898 |
|
<t> |
4899 |
|
<list> |
4900 |
|
<t>C: "GET MIDI_INSTRUMENTS 0"</t> |
4901 |
|
<t>S: "234"</t> |
4902 |
|
</list> |
4903 |
|
</t> |
4904 |
|
<t> |
4905 |
|
<list> |
4906 |
|
<t>C: "GET MIDI_INSTRUMENTS ALL"</t> |
4907 |
|
<t>S: "954"</t> |
4908 |
|
</list> |
4909 |
|
</t> |
4910 |
|
</section> |
4911 |
|
|
4912 |
|
<section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS"> |
4913 |
|
<t>The front-end can query a list of all currently existing |
4914 |
|
entries in a certain MIDI instrument map by sending the following |
4915 |
|
command:</t> |
4916 |
|
<t> |
4917 |
|
<list> |
4918 |
|
<t>LIST MIDI_INSTRUMENTS <map></t> |
4919 |
|
</list> |
4920 |
|
</t> |
4921 |
|
<t>Where <map> is the numeric ID of the MIDI instrument map.</t> |
4922 |
|
<t>The front-end can query a list of all currently existing |
4923 |
|
entries of all MIDI instrument maps by sending the following |
4924 |
|
command:</t> |
4925 |
|
<t> |
4926 |
|
<list> |
4927 |
|
<t>LIST MIDI_INSTRUMENTS ALL</t> |
4928 |
|
</list> |
4929 |
|
</t> |
4930 |
|
|
4931 |
|
<t>Possible Answers:</t> |
4932 |
|
<t> |
4933 |
|
<list> |
4934 |
|
<t>The sampler will answer by sending a comma separated |
4935 |
|
list of map ID - MIDI bank - MIDI program triples, where |
4936 |
|
each triple is encapsulated into curly braces. The |
4937 |
|
list is returned in one single line. Each triple |
4938 |
|
just reflects the key of the respective map entry, |
4939 |
|
thus subsequent |
4940 |
|
<xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref> |
4941 |
|
command(s) are necessary to retrieve detailed informations |
4942 |
|
about each entry.</t> |
4943 |
|
</list> |
4944 |
|
</t> |
4945 |
|
|
4946 |
|
<t>Example:</t> |
4947 |
|
<t> |
4948 |
|
<list> |
4949 |
|
<t>C: "LIST MIDI_INSTRUMENTS 0"</t> |
4950 |
|
<t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t> |
4951 |
|
</list> |
4952 |
|
</t> |
4953 |
|
</section> |
4954 |
|
|
4955 |
|
<section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT"> |
4956 |
|
<t>The front-end can delete an entry from a MIDI instrument |
4957 |
|
map by sending the following command:</t> |
4958 |
|
<t> |
4959 |
|
<list> |
4960 |
|
<t>UNMAP MIDI_INSTRUMENT <map> <midi_bank> <midi_prog></t> |
4961 |
|
</list> |
4962 |
|
</t> |
4963 |
|
<t> |
4964 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
4965 |
|
<midi_bank> is an integer value between 0..16383 |
4966 |
|
reflecting the MIDI bank value and |
4967 |
|
<midi_prog> an integer value between |
4968 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
4969 |
|
index triple. |
4970 |
|
</t> |
4971 |
|
|
4972 |
|
<t>Possible Answers:</t> |
4973 |
|
<t> |
4974 |
|
<list> |
4975 |
|
<t>"OK" - |
4976 |
|
<list> |
4977 |
|
<t>usually</t> |
4978 |
|
</list> |
4979 |
|
</t> |
4980 |
|
<t>"ERR:<error-code>:<error-message>" - |
4981 |
|
<list> |
4982 |
|
<t>when index out of bounds</t> |
4983 |
|
</list> |
4984 |
|
</t> |
4985 |
|
</list> |
4986 |
|
</t> |
4987 |
|
|
4988 |
|
<t>Example:</t> |
4989 |
|
<t> |
4990 |
|
<list> |
4991 |
|
<t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t> |
4992 |
|
<t>S: "OK"</t> |
4993 |
|
</list> |
4994 |
|
</t> |
4995 |
|
</section> |
4996 |
|
|
4997 |
|
<section title="Get current settings of MIDI instrument map entry" anchor="GET MIDI_INSTRUMENT INFO"> |
4998 |
|
<t>The front-end can retrieve the current settings of a certain |
4999 |
|
instrument map entry by sending the following command:</t> |
5000 |
|
<t> |
5001 |
|
<list> |
5002 |
|
<t>GET MIDI_INSTRUMENT INFO <map> <midi_bank> <midi_prog></t> |
5003 |
|
</list> |
5004 |
|
</t> |
5005 |
|
<t> |
5006 |
|
Where <map> is the numeric ID of the MIDI instrument map, |
5007 |
|
<midi_bank> is an integer value between 0..16383 |
5008 |
|
reflecting the MIDI bank value, <midi_bank> |
5009 |
|
and <midi_prog> an integer value between |
5010 |
|
0..127 reflecting the MIDI program value of the map's entrie's key |
5011 |
|
index triple. |
5012 |
|
</t> |
5013 |
|
|
5014 |
|
<t>Possible Answers:</t> |
5015 |
|
<t> |
5016 |
|
<list> |
5017 |
|
<t>LinuxSampler will answer by sending a <CRLF> |
5018 |
|
separated list. Each answer line begins with the |
5019 |
|
information category name followed by a colon and then |
5020 |
|
a space character <SP> and finally the info |
5021 |
|
character string to that info category. At the moment |
5022 |
|
the following categories are defined:</t> |
5023 |
|
<t>"NAME" - |
5024 |
|
<list> |
5025 |
|
<t>Name for this MIDI instrument map entry (if defined). |
5026 |
|
This name shall be used by frontends for displaying a |
5027 |
|
name for this mapped instrument. It can be set and |
5028 |
|
changed with the |
5029 |
|
<xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> |
5030 |
|
command and does not have to be unique. |
5031 |
|
(note that this character string may contain |
5032 |
|
<xref target="character_set">escape sequences</xref>)</t> |
5033 |
|
</list> |
5034 |
|
</t> |
5035 |
|
<t>"ENGINE_NAME" - |
5036 |
|
<list> |
5037 |
|
<t>Name of the engine to be deployed for this |
5038 |
|
instrument.</t> |
5039 |
|
</list> |
5040 |
|
</t> |
5041 |
|
<t>"INSTRUMENT_FILE" - |
5042 |
|
<list> |
5043 |
|
<t>File name of the instrument |
5044 |
|
(note that this path may contain |
5045 |
|
<xref target="character_set">escape sequences</xref>).</t> |
5046 |
|
</list> |
5047 |
|
</t> |
5048 |
|
<t>"INSTRUMENT_NR" - |
5049 |
|
<list> |
5050 |
|
<t>Index of the instrument within the file.</t> |
5051 |
|
</list> |
5052 |
|
</t> |
5053 |
|
<t>"INSTRUMENT_NAME" - |
5054 |
|
<list> |
5055 |
|
<t>Name of the loaded instrument as reflected by its file. |
5056 |
|
In contrast to the "NAME" field, the "INSTRUMENT_NAME" field |
5057 |
|
cannot be changed (note that this character string may contain |
5058 |
|
<xref target="character_set">escape sequences</xref>).</t> |
5059 |
|
</list> |
5060 |
|
</t> |
5061 |
|
<t>"LOAD_MODE" - |
5062 |
|
<list> |
5063 |
|
<t>Life time of instrument |
5064 |
|
(see <xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref> for details about this setting).</t> |
5065 |
|
</list> |
5066 |
|
</t> |
5067 |
|
<t>"VOLUME" - |
5068 |
|
<list> |
5069 |
|
<t>master volume of the instrument as optionally |
5070 |
|
dotted number (where a value < 1.0 means attenuation |
5071 |
|
and a value > 1.0 means amplification)</t> |
5072 |
|
</list> |
5073 |
|
</t> |
5074 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5075 |
|
</list> |
5076 |
|
</t> |
5077 |
|
|
5078 |
|
<t>Example:</t> |
5079 |
|
<t> |
5080 |
|
<list> |
5081 |
|
<t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t> |
5082 |
|
<t>S: "NAME: Drums for Foo Song"</t> |
5083 |
|
<t> "ENGINE_NAME: GigEngine"</t> |
5084 |
|
<t> "INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t> |
5085 |
|
<t> "INSTRUMENT_NR: 0"</t> |
5086 |
|
<t> "INSTRUMENT_NAME: Joe's Drumkit"</t> |
5087 |
|
<t> "LOAD_MODE: PERSISTENT"</t> |
5088 |
|
<t> "VOLUME: 1.0"</t> |
5089 |
|
<t> "."</t> |
5090 |
|
</list> |
5091 |
|
</t> |
5092 |
|
</section> |
5093 |
|
|
5094 |
|
<section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS"> |
5095 |
|
<t>The front-end can clear a whole MIDI instrument map, that |
5096 |
|
is delete all its entries by sending the following command:</t> |
5097 |
|
<t> |
5098 |
|
<list> |
5099 |
|
<t>CLEAR MIDI_INSTRUMENTS <map></t> |
5100 |
|
</list> |
5101 |
|
</t> |
5102 |
|
<t>Where <map> is the numeric ID of the map to clear.</t> |
5103 |
|
<t>The front-end can clear all MIDI instrument maps, that |
5104 |
|
is delete all entries of all maps by sending the following |
5105 |
|
command:</t> |
5106 |
|
<t> |
5107 |
|
<list> |
5108 |
|
<t>CLEAR MIDI_INSTRUMENTS ALL</t> |
5109 |
|
</list> |
5110 |
|
</t> |
5111 |
|
<t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the |
5112 |
|
maps, only their entries, thus the map's settings like |
5113 |
|
custom name will be preservevd.</t> |
5114 |
|
|
5115 |
|
<t>Possible Answers:</t> |
5116 |
|
<t> |
5117 |
|
<list> |
5118 |
|
<t>"OK" - |
5119 |
|
<list> |
5120 |
|
<t>always</t> |
5121 |
|
</list> |
5122 |
|
</t> |
5123 |
|
</list> |
5124 |
|
</t> |
5125 |
|
|
5126 |
|
<t>Examples:</t> |
5127 |
|
<t> |
5128 |
|
<list> |
5129 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS 0"</t> |
5130 |
|
<t>S: "OK"</t> |
5131 |
|
</list> |
5132 |
|
</t> |
5133 |
|
<t> |
5134 |
|
<list> |
5135 |
|
<t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t> |
5136 |
|
<t>S: "OK"</t> |
5137 |
|
</list> |
5138 |
|
</t> |
5139 |
|
</section> |
5140 |
|
</section> |
5141 |
|
|
5142 |
|
|
5143 |
|
<section title="Managing Instruments Database" anchor="Managing Instruments Database"> |
5144 |
|
<t>The following commands describe how to use and manage |
5145 |
|
the instruments database.</t> |
5146 |
|
<t>Notice:</t> |
5147 |
|
<t> |
5148 |
|
<list> |
5149 |
|
<t>All command arguments representing a path or |
5150 |
|
instrument/directory name support escape sequences as described in chapter |
5151 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>". |
5152 |
|
</t> |
5153 |
|
<t>All occurrences of a forward slash in instrument and directory |
5154 |
|
names are escaped with its hex (\x2f) or octal (\057) escape sequence. |
5155 |
|
</t> |
5156 |
|
</list> |
5157 |
|
</t> |
5158 |
|
|
5159 |
|
<section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY"> |
5160 |
|
<t>The front-end can add a new instrument directory to the |
5161 |
|
instruments database by sending the following command:</t> |
5162 |
|
<t> |
5163 |
|
<list> |
5164 |
|
<t>ADD DB_INSTRUMENT_DIRECTORY <dir></t> |
5165 |
|
</list> |
5166 |
|
</t> |
5167 |
|
<t>Where <dir> is the absolute path name of the directory |
5168 |
|
to be created (encapsulated into apostrophes).</t> |
5169 |
|
|
5170 |
|
<t>Possible Answers:</t> |
5171 |
|
<t> |
5172 |
|
<list> |
5173 |
|
<t>"OK" - |
5174 |
|
<list> |
5175 |
|
<t>on success</t> |
5176 |
|
</list> |
5177 |
|
</t> |
5178 |
|
<t>"ERR:<error-code>:<error-message>" - |
5179 |
|
<list> |
5180 |
|
<t>when the directory could not be created, which |
5181 |
|
can happen if the directory already exists or the |
5182 |
|
name contains not allowed symbols</t> |
5183 |
|
</list> |
5184 |
|
</t> |
5185 |
|
</list> |
5186 |
|
</t> |
5187 |
|
|
5188 |
|
<t>Examples:</t> |
5189 |
|
<t> |
5190 |
|
<list> |
5191 |
|
<t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t> |
5192 |
|
<t>S: "OK"</t> |
5193 |
|
</list> |
5194 |
|
</t> |
5195 |
|
</section> |
5196 |
|
|
5197 |
|
<section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY"> |
5198 |
|
<t>The front-end can delete a particular instrument directory |
5199 |
|
from the instruments database by sending the following command:</t> |
5200 |
|
<t> |
5201 |
|
<list> |
5202 |
|
<t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] <dir></t> |
5203 |
|
</list> |
5204 |
|
</t> |
5205 |
|
<t>Where <dir> is the absolute path name of the directory |
5206 |
|
to delete. The optional FORCE argument can be used to |
5207 |
|
force the deletion of a non-empty directory and all its content.</t> |
5208 |
|
|
5209 |
|
<t>Possible Answers:</t> |
5210 |
|
<t> |
5211 |
|
<list> |
5212 |
|
<t>"OK" - |
5213 |
|
<list> |
5214 |
|
<t>if the directory is deleted successfully</t> |
5215 |
|
</list> |
5216 |
|
</t> |
5217 |
|
<t>"ERR:<error-code>:<error-message>" - |
5218 |
|
<list> |
5219 |
|
<t>if the given directory does not exist, or |
5220 |
|
if trying to delete a non-empty directory, |
5221 |
|
without using the FORCE argument.</t> |
5222 |
|
</list> |
5223 |
|
</t> |
5224 |
|
</list> |
5225 |
|
</t> |
5226 |
|
|
5227 |
|
<t>Examples:</t> |
5228 |
|
<t> |
5229 |
|
<list> |
5230 |
|
<t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t> |
5231 |
|
<t>S: "OK"</t> |
5232 |
|
</list> |
5233 |
|
</t> |
5234 |
|
</section> |
5235 |
|
|
5236 |
|
<section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES"> |
5237 |
|
<t>The front-end can retrieve the current amount of |
5238 |
|
directories in a specific directory by sending the following command:</t> |
5239 |
|
<t> |
5240 |
|
<list> |
5241 |
|
<t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
5242 |
|
</list> |
5243 |
|
</t> |
5244 |
|
<t>Where <dir> should be replaced by the absolute path |
5245 |
|
name of the directory. If RECURSIVE is specified, the number of |
5246 |
|
all directories, including those located in subdirectories of the |
5247 |
|
specified directory, will be returned.</t> |
5248 |
|
|
5249 |
|
<t>Possible Answers:</t> |
5250 |
|
<t> |
5251 |
|
<list> |
5252 |
|
<t>The current number of instrument directories |
5253 |
|
in the specified directory.</t> |
5254 |
|
<t>"ERR:<error-code>:<error-message>" - |
5255 |
|
<list> |
5256 |
|
<t>if the given directory does not exist.</t> |
5257 |
|
</list> |
5258 |
|
</t> |
5259 |
|
</list> |
5260 |
|
</t> |
5261 |
|
|
5262 |
|
<t>Example:</t> |
5263 |
|
<t> |
5264 |
|
<list> |
5265 |
|
<t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t> |
5266 |
|
<t>S: "2"</t> |
5267 |
|
</list> |
5268 |
|
</t> |
5269 |
|
</section> |
5270 |
|
|
5271 |
|
<section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES"> |
5272 |
|
<t>The front-end can retrieve the current list of directories |
5273 |
|
in specific directory by sending the following command:</t> |
5274 |
|
<t> |
5275 |
|
<list> |
5276 |
|
<t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] <dir></t> |
5277 |
|
</list> |
5278 |
|
</t> |
5279 |
|
<t>Where <dir> should be replaced by the absolute path |
5280 |
|
name of the directory. If RECURSIVE is specified, the absolute path names |
5281 |
|
of all directories, including those located in subdirectories of the |
5282 |
|
specified directory, will be returned.</t> |
5283 |
|
|
5284 |
|
<t>Possible Answers:</t> |
5285 |
|
<t> |
5286 |
|
<list> |
5287 |
|
<t>A comma separated list of all instrument directories |
5288 |
|
(encapsulated into apostrophes) in the specified directory.</t> |
5289 |
|
<t>"ERR:<error-code>:<error-message>" - |
5290 |
|
<list> |
5291 |
|
<t>if the given directory does not exist.</t> |
5292 |
|
</list> |
5293 |
|
</t> |
5294 |
|
</list> |
5295 |
|
</t> |
5296 |
|
<t>Example:</t> |
5297 |
|
<t> |
5298 |
|
<list> |
5299 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t> |
5300 |
|
<t>S: "'Piano Collection','Percussion Collection'"</t> |
5301 |
|
</list> |
5302 |
|
</t> |
5303 |
|
<t> |
5304 |
|
<list> |
5305 |
|
<t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t> |
5306 |
|
<t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t> |
5307 |
|
</list> |
5308 |
|
</t> |
5309 |
|
</section> |
5310 |
|
|
5311 |
|
<section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO"> |
5312 |
|
<t>The front-end can ask for the current settings of an |
5313 |
|
instrument directory by sending the following command:</t> |
5314 |
|
<t> |
5315 |
|
<list> |
5316 |
|
<t>GET DB_INSTRUMENT_DIRECTORY INFO <dir></t> |
5317 |
|
</list> |
5318 |
|
</t> |
5319 |
|
<t>Where <dir> should be replaced by the absolute path |
5320 |
|
name of the directory the front-end is interested in.</t> |
5321 |
|
|
5322 |
|
<t>Possible Answers:</t> |
5323 |
|
<t> |
5324 |
|
<list> |
5325 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5326 |
|
Each answer line begins with the settings category name |
5327 |
|
followed by a colon and then a space character <SP> and finally |
5328 |
|
the info character string to that setting category. At the |
5329 |
|
moment the following categories are defined:</t> |
5330 |
|
|
5331 |
|
<t> |
5332 |
|
<list> |
5333 |
|
<t>DESCRIPTION - |
5334 |
|
<list> |
5335 |
|
<t>A brief description of the directory content. |
5336 |
|
Note that the character string may contain |
5337 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5338 |
|
</list> |
5339 |
|
</t> |
5340 |
|
<t>CREATED - |
5341 |
|
<list> |
5342 |
|
<t>The creation date and time of the directory, |
5343 |
|
represented in "YYYY-MM-DD HH:MM:SS" format</t> |
5344 |
|
</list> |
5345 |
|
</t> |
5346 |
|
<t>MODIFIED - |
5347 |
|
<list> |
5348 |
|
<t>The date and time of the last modification of the |
5349 |
|
directory, represented in "YYYY-MM-DD HH:MM:SS" format</t> |
5350 |
|
</list> |
5351 |
|
</t> |
5352 |
|
</list> |
5353 |
|
</t> |
5354 |
|
</list> |
5355 |
|
</t> |
5356 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5357 |
|
|
5358 |
|
<t>Example:</t> |
5359 |
|
<t> |
5360 |
|
<list> |
5361 |
|
<t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t> |
5362 |
|
<t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t> |
5363 |
|
<t> "CREATED: 2007-02-05 10:23:12"</t> |
5364 |
|
<t> "MODIFIED: 2007-04-07 12:50:21"</t> |
5365 |
|
<t> "."</t> |
5366 |
|
</list> |
5367 |
|
</t> |
5368 |
|
</section> |
5369 |
|
|
5370 |
|
<section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME"> |
5371 |
|
<t>The front-end can alter the name of a specific |
5372 |
|
instrument directory by sending the following command:</t> |
5373 |
|
<t> |
5374 |
|
<list> |
5375 |
|
<t>SET DB_INSTRUMENT_DIRECTORY NAME <dir> <name></t> |
5376 |
|
</list> |
5377 |
|
</t> |
5378 |
|
<t>Where <dir> is the absolute path name of the directory and |
5379 |
|
<name> is the new name for that directory.</t> |
5380 |
|
|
5381 |
|
<t>Possible Answers:</t> |
5382 |
|
<t> |
5383 |
|
<list> |
5384 |
|
<t>"OK" - |
5385 |
|
<list> |
5386 |
|
<t>on success</t> |
5387 |
|
</list> |
5388 |
|
</t> |
5389 |
|
<t>"ERR:<error-code>:<error-message>" - |
5390 |
|
<list> |
5391 |
|
<t>in case the given directory does not exists, |
5392 |
|
or if a directory with name equal to the new |
5393 |
|
name already exists.</t> |
5394 |
|
</list> |
5395 |
|
</t> |
5396 |
|
</list> |
5397 |
|
</t> |
5398 |
|
|
5399 |
|
<t>Example:</t> |
5400 |
|
<t> |
5401 |
|
<list> |
5402 |
|
<t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t> |
5403 |
|
<t>S: "OK"</t> |
5404 |
|
</list> |
5405 |
|
</t> |
5406 |
|
</section> |
5407 |
|
|
5408 |
|
<section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY"> |
5409 |
|
<t>The front-end can move a specific |
5410 |
|
instrument directory by sending the following command:</t> |
5411 |
|
<t> |
5412 |
|
<list> |
5413 |
|
<t>MOVE DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
5414 |
|
</list> |
5415 |
|
</t> |
5416 |
|
<t>Where <dir> is the absolute path name of the directory |
5417 |
|
to move and <dst> is the location where the directory will |
5418 |
|
be moved to.</t> |
5419 |
|
|
5420 |
|
<t>Possible Answers:</t> |
5421 |
|
<t> |
5422 |
|
<list> |
5423 |
|
<t>"OK" - |
5424 |
|
<list> |
5425 |
|
<t>on success</t> |
5426 |
|
</list> |
5427 |
|
</t> |
5428 |
|
<t>"ERR:<error-code>:<error-message>" - |
5429 |
|
<list> |
5430 |
|
<t>in case a given directory does not exists, |
5431 |
|
or if a directory with name equal to the name |
5432 |
|
of the specified directory already exists in |
5433 |
|
the destination directory. Error is also thrown |
5434 |
|
when trying to move a directory to a subdirectory |
5435 |
|
of itself.</t> |
5436 |
|
</list> |
5437 |
|
</t> |
5438 |
|
</list> |
5439 |
|
</t> |
5440 |
|
|
5441 |
|
<t>Example:</t> |
5442 |
|
<t> |
5443 |
|
<list> |
5444 |
|
<t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t> |
5445 |
|
<t>S: "OK"</t> |
5446 |
|
</list> |
5447 |
|
</t> |
5448 |
|
</section> |
5449 |
|
|
5450 |
|
<section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY"> |
5451 |
|
<t>The front-end can copy a specific |
5452 |
|
instrument directory by sending the following command:</t> |
5453 |
|
<t> |
5454 |
|
<list> |
5455 |
|
<t>COPY DB_INSTRUMENT_DIRECTORY <dir> <dst></t> |
5456 |
|
</list> |
5457 |
|
</t> |
5458 |
|
<t>Where <dir> is the absolute path name of the directory |
5459 |
|
to copy and <dst> is the location where the directory will |
5460 |
|
be copied to.</t> |
5461 |
|
|
5462 |
|
<t>Possible Answers:</t> |
5463 |
|
<t> |
5464 |
|
<list> |
5465 |
|
<t>"OK" - |
5466 |
|
<list> |
5467 |
|
<t>on success</t> |
5468 |
|
</list> |
5469 |
|
</t> |
5470 |
|
<t>"ERR:<error-code>:<error-message>" - |
5471 |
|
<list> |
5472 |
|
<t>in case a given directory does not exists, |
5473 |
|
or if a directory with name equal to the name |
5474 |
|
of the specified directory already exists in |
5475 |
|
the destination directory. Error is also thrown |
5476 |
|
when trying to copy a directory to a subdirectory |
5477 |
|
of itself.</t> |
5478 |
|
</list> |
5479 |
|
</t> |
5480 |
|
</list> |
5481 |
|
</t> |
5482 |
|
|
5483 |
|
<t>Example:</t> |
5484 |
|
<t> |
5485 |
|
<list> |
5486 |
|
<t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t> |
5487 |
|
<t>S: "OK"</t> |
5488 |
|
</list> |
5489 |
|
</t> |
5490 |
|
</section> |
5491 |
|
|
5492 |
|
<section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"> |
5493 |
|
<t>The front-end can alter the description of a specific |
5494 |
|
instrument directory by sending the following command:</t> |
5495 |
|
<t> |
5496 |
|
<list> |
5497 |
|
<t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION <dir> <desc></t> |
5498 |
|
</list> |
5499 |
|
</t> |
5500 |
|
<t>Where <dir> is the absolute path name of the directory and |
5501 |
|
<desc> is the new description for the directory |
5502 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5503 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5504 |
|
|
5505 |
|
<t>Possible Answers:</t> |
5506 |
|
<t> |
5507 |
|
<list> |
5508 |
|
<t>"OK" - |
5509 |
|
<list> |
5510 |
|
<t>on success</t> |
5511 |
|
</list> |
5512 |
|
</t> |
5513 |
|
<t>"ERR:<error-code>:<error-message>" - |
5514 |
|
<list> |
5515 |
|
<t>in case the given directory does not exists.</t> |
5516 |
|
</list> |
5517 |
|
</t> |
5518 |
|
</list> |
5519 |
|
</t> |
5520 |
|
|
5521 |
|
<t>Example:</t> |
5522 |
|
<t> |
5523 |
|
<list> |
5524 |
|
<t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t> |
5525 |
|
<t>S: "OK"</t> |
5526 |
|
</list> |
5527 |
|
</t> |
5528 |
|
</section> |
5529 |
|
|
5530 |
|
<section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES"> |
5531 |
|
<t>The front-end can search for directories |
5532 |
|
in specific directory by sending the following command:</t> |
5533 |
|
<t> |
5534 |
|
<list> |
5535 |
|
<t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] <dir> <criteria-list></t> |
5536 |
|
</list> |
5537 |
|
</t> |
5538 |
|
<t>Where <dir> should be replaced by the absolute path |
5539 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
5540 |
|
directories located in subdirectories of the specified directory will not |
5541 |
|
be searched. <criteria-list> is a list of search criterias |
5542 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
5543 |
|
allowed:</t> |
5544 |
|
<t> |
5545 |
|
<t>NAME='<search-string>' |
5546 |
|
<list> |
5547 |
|
<t>Restricts the search to directories, which names |
5548 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
5549 |
|
supporting escape sequences as described in chapter |
5550 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5551 |
|
</list> |
5552 |
|
</t> |
5553 |
|
|
5554 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
5555 |
|
<list> |
5556 |
|
<t>Restricts the search to directories, which creation |
5557 |
|
date satisfies the specified period, where <date-after> |
5558 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
5559 |
|
If <date-after> is omitted the search is restricted to |
5560 |
|
directories created before <date-before>. If |
5561 |
|
<date-before> is omitted, the search is restricted |
5562 |
|
to directories created after <date-after>.</t> |
5563 |
|
</list> |
5564 |
|
</t> |
5565 |
|
|
5566 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
5567 |
|
<list> |
5568 |
|
<t>Restricts the search to directories, which |
5569 |
|
date of last modification satisfies the specified period, where |
5570 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
5571 |
|
format. If <date-after> is omitted the search is restricted to |
5572 |
|
directories, which are last modified before <date-before>. If |
5573 |
|
<date-before> is omitted, the search is restricted to directories, |
5574 |
|
which are last modified after <date-after>.</t> |
5575 |
|
</list> |
5576 |
|
</t> |
5577 |
|
|
5578 |
|
<t>DESCRIPTION='<search-string>' |
5579 |
|
<list> |
5580 |
|
<t>Restricts the search to directories with description |
5581 |
|
that satisfies the supplied search string |
5582 |
|
(encapsulated into apostrophes, supporting escape |
5583 |
|
sequences as described in chapter |
5584 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5585 |
|
</list> |
5586 |
|
</t> |
5587 |
|
</t> |
5588 |
|
|
5589 |
|
<t>Where <search-string> is either a regular expression, or a |
5590 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
5591 |
|
|
5592 |
|
<t>Possible Answers:</t> |
5593 |
|
<t> |
5594 |
|
<list> |
5595 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
5596 |
|
apostrophes) of all directories in the specified directory that satisfy |
5597 |
|
the supplied search criterias.</t> |
5598 |
|
<t>"ERR:<error-code>:<error-message>" - |
5599 |
|
<list> |
5600 |
|
<t>if the given directory does not exist.</t> |
5601 |
|
</list> |
5602 |
|
</t> |
5603 |
|
</list> |
5604 |
|
</t> |
5605 |
|
<t>Example:</t> |
5606 |
|
<t> |
5607 |
|
<list> |
5608 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t> |
5609 |
|
<t>S: "'/Piano Collection'"</t> |
5610 |
|
</list> |
5611 |
|
</t> |
5612 |
|
<t> |
5613 |
|
<list> |
5614 |
|
<t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t> |
5615 |
|
<t>S: "'/Piano Collection','/Percussions'"</t> |
5616 |
|
</list> |
5617 |
|
</t> |
5618 |
|
</section> |
5619 |
|
|
5620 |
|
<section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS"> |
5621 |
|
<t>The front-end can add one or more instruments |
5622 |
|
to the instruments database by sending the following command:</t> |
5623 |
|
<t> |
5624 |
|
<list> |
5625 |
|
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>]</t> |
5626 |
|
</list> |
5627 |
|
</t> |
5628 |
|
<t>Where <db_dir> is the absolute path name of a directory |
5629 |
|
(encapsulated into apostrophes) in the instruments database in which |
5630 |
|
only the new instruments (that are not already in the database) will |
5631 |
|
be added, <file_path> is the absolute path name of a file or |
5632 |
|
directory in the file system (encapsulated into apostrophes). In case |
5633 |
|
an instrument file is supplied, only the instruments in the specified |
5634 |
|
file will be added to the instruments database. If the optional |
5635 |
|
<instr_index> (the index of the instrument within the given file) |
5636 |
|
is supplied too, then only the specified instrument will be added. |
5637 |
|
In case a directory is supplied, the instruments in that directory |
5638 |
|
will be added. The OPTIONAL <mode> argument is only applied |
5639 |
|
when a directory is provided as <file_path> and specifies how the |
5640 |
|
scanning will be done and has exactly the following possibilities:</t> |
5641 |
|
<t> |
5642 |
|
<list> |
5643 |
|
<t>"RECURSIVE" - |
5644 |
|
<list> |
5645 |
|
<t>All instruments will be processed, including those |
5646 |
|
in the subdirectories, and the respective subdirectory |
5647 |
|
tree structure will be recreated in the instruments |
5648 |
|
database</t> |
5649 |
|
</list> |
5650 |
|
</t> |
5651 |
|
<t>"NON_RECURSIVE" - |
5652 |
|
<list> |
5653 |
|
<t>Only the instruments in the specified directory |
5654 |
|
will be added, the instruments in the subdirectories |
5655 |
|
will not be processed.</t> |
5656 |
|
</list> |
5657 |
|
</t> |
5658 |
|
<t>"FLAT" - |
5659 |
|
<list> |
5660 |
|
<t>All instruments will be processed, including those |
5661 |
|
in the subdirectories, but the respective subdirectory |
5662 |
|
structure will not be recreated in the instruments |
5663 |
|
database. All instruments will be added directly in |
5664 |
|
the specified database directory.</t> |
5665 |
|
</list> |
5666 |
|
</t> |
5667 |
|
</list> |
5668 |
|
</t> |
5669 |
|
|
5670 |
|
<t> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5671 |
|
file will be added to a separate directory in the instruments database, which |
5672 |
|
name will be the name of the instrument file with the file extension stripped off. |
5673 |
|
</t> |
5674 |
|
<t>The difference between regular and NON_MODAL versions of the command |
5675 |
|
is that the regular command returns when the scanning is finished |
5676 |
|
while NON_MODAL version returns immediately and a background process is launched. |
5677 |
|
The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5678 |
|
command can be used to monitor the scanning progress.</t> |
5679 |
|
|
5680 |
|
<t>Possible Answers:</t> |
5681 |
|
<t> |
5682 |
|
<list> |
5683 |
|
<t>"OK" - |
5684 |
|
<list> |
5685 |
|
<t>on success when NON_MODAL is not supplied</t> |
5686 |
|
</list> |
5687 |
|
</t> |
5688 |
|
<t>"OK[<job-id>]" - |
5689 |
|
<list> |
5690 |
|
<t>on success when NON_MODAL is supplied, where <job-id> |
5691 |
|
is a numerical ID used to obtain status information about the job progress. |
5692 |
|
See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref> |
5693 |
|
</t> |
5694 |
|
</list> |
5695 |
|
</t> |
5696 |
|
<t>"ERR:<error-code>:<error-message>" - |
5697 |
|
<list> |
5698 |
|
<t>if an invalid path is specified.</t> |
5699 |
|
</list> |
5700 |
|
</t> |
5701 |
|
</list> |
5702 |
|
</t> |
5703 |
|
|
5704 |
|
<t>Examples:</t> |
5705 |
|
<t> |
5706 |
|
<list> |
5707 |
|
<t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t> |
5708 |
|
<t>S: "OK"</t> |
5709 |
|
</list> |
5710 |
|
</t> |
5711 |
|
</section> |
5712 |
|
|
5713 |
|
<section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT"> |
5714 |
|
<t>The front-end can remove a particular instrument |
5715 |
|
from the instruments database by sending the following command:</t> |
5716 |
|
<t> |
5717 |
|
<list> |
5718 |
|
<t>REMOVE DB_INSTRUMENT <instr_path></t> |
5719 |
|
</list> |
5720 |
|
</t> |
5721 |
|
<t>Where <instr_path> is the absolute path name |
5722 |
|
(in the instruments database) of the instrument to remove.</t> |
5723 |
|
|
5724 |
|
<t>Possible Answers:</t> |
5725 |
|
<t> |
5726 |
|
<list> |
5727 |
|
<t>"OK" - |
5728 |
|
<list> |
5729 |
|
<t>if the instrument is removed successfully</t> |
5730 |
|
</list> |
5731 |
|
</t> |
5732 |
|
<t>"ERR:<error-code>:<error-message>" - |
5733 |
|
<list> |
5734 |
|
<t>if the given path does not exist or |
5735 |
|
is a directory.</t> |
5736 |
|
</list> |
5737 |
|
</t> |
5738 |
|
</list> |
5739 |
|
</t> |
5740 |
|
|
5741 |
|
<t>Examples:</t> |
5742 |
|
<t> |
5743 |
|
<list> |
5744 |
|
<t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t> |
5745 |
|
<t>S: "OK"</t> |
5746 |
|
</list> |
5747 |
|
</t> |
5748 |
|
</section> |
5749 |
|
|
5750 |
|
<section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS"> |
5751 |
|
<t>The front-end can retrieve the current amount of |
5752 |
|
instruments in a specific directory by sending the following command:</t> |
5753 |
|
<t> |
5754 |
|
<list> |
5755 |
|
<t>GET DB_INSTRUMENTS [RECURSIVE] <dir></t> |
5756 |
|
</list> |
5757 |
|
</t> |
5758 |
|
<t>Where <dir> should be replaced by the absolute path name |
5759 |
|
of the directory. If RECURSIVE is specified, the number of all |
5760 |
|
instruments, including those located in subdirectories of the |
5761 |
|
specified directory, will be returned.</t> |
5762 |
|
|
5763 |
|
<t>Possible Answers:</t> |
5764 |
|
<t> |
5765 |
|
<list> |
5766 |
|
<t>The current number of instruments |
5767 |
|
in the specified directory.</t> |
5768 |
|
<t>"ERR:<error-code>:<error-message>" - |
5769 |
|
<list> |
5770 |
|
<t>if the given directory does not exist.</t> |
5771 |
|
</list> |
5772 |
|
</t> |
5773 |
|
</list> |
5774 |
|
</t> |
5775 |
|
|
5776 |
|
<t>Example:</t> |
5777 |
|
<t> |
5778 |
|
<list> |
5779 |
|
<t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t> |
5780 |
|
<t>S: "2"</t> |
5781 |
|
</list> |
5782 |
|
</t> |
5783 |
|
</section> |
5784 |
|
|
5785 |
|
<section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS"> |
5786 |
|
<t>The front-end can retrieve the current list of instruments |
5787 |
|
in specific directory by sending the following command:</t> |
5788 |
|
<t> |
5789 |
|
<list> |
5790 |
|
<t>LIST DB_INSTRUMENTS [RECURSIVE] <dir></t> |
5791 |
|
</list> |
5792 |
|
</t> |
5793 |
|
<t>Where <dir> should be replaced by the absolute path |
5794 |
|
name of the directory. If RECURSIVE is specified, the absolute path |
5795 |
|
names of all instruments, including those located in subdirectories |
5796 |
|
of the specified directory, will be returned.</t> |
5797 |
|
|
5798 |
|
<t>Possible Answers:</t> |
5799 |
|
<t> |
5800 |
|
<list> |
5801 |
|
<t>A comma separated list of all instruments |
5802 |
|
(encapsulated into apostrophes) in the specified directory.</t> |
5803 |
|
<t>"ERR:<error-code>:<error-message>" - |
5804 |
|
<list> |
5805 |
|
<t>if the given directory does not exist.</t> |
5806 |
|
</list> |
5807 |
|
</t> |
5808 |
|
</list> |
5809 |
|
</t> |
5810 |
|
<t>Example:</t> |
5811 |
|
<t> |
5812 |
|
<list> |
5813 |
|
<t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t> |
5814 |
|
<t>S: "'Bosendorfer 290','Steinway D'"</t> |
5815 |
|
</list> |
5816 |
|
</t> |
5817 |
|
<t> |
5818 |
|
<list> |
5819 |
|
<t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t> |
5820 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t> |
5821 |
|
</list> |
5822 |
|
</t> |
5823 |
|
</section> |
5824 |
|
|
5825 |
|
<section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO"> |
5826 |
|
<t>The front-end can ask for the current settings of an |
5827 |
|
instrument by sending the following command:</t> |
5828 |
|
<t> |
5829 |
|
<list> |
5830 |
|
<t>GET DB_INSTRUMENT INFO <instr_path></t> |
5831 |
|
</list> |
5832 |
|
</t> |
5833 |
|
<t>Where <instr_path> should be replaced by the absolute path |
5834 |
|
name of the instrument the front-end is interested in.</t> |
5835 |
|
|
5836 |
|
<t>Possible Answers:</t> |
5837 |
|
<t> |
5838 |
|
<list> |
5839 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
5840 |
|
Each answer line begins with the settings category name |
5841 |
|
followed by a colon and then a space character <SP> and finally |
5842 |
|
the info character string to that setting category. At the |
5843 |
|
moment the following categories are defined:</t> |
5844 |
|
|
5845 |
|
<t> |
5846 |
|
<list> |
5847 |
|
<t>INSTRUMENT_FILE - |
5848 |
|
<list> |
5849 |
|
<t>File name of the instrument. |
5850 |
|
Note that the character string may contain |
5851 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5852 |
|
</list> |
5853 |
|
</t> |
5854 |
|
<t>INSTRUMENT_NR - |
5855 |
|
<list> |
5856 |
|
<t>Index of the instrument within the file.</t> |
5857 |
|
</list> |
5858 |
|
</t> |
5859 |
|
<t>FORMAT_FAMILY - |
5860 |
|
<list> |
5861 |
|
<t>The format family of the instrument.</t> |
5862 |
|
</list> |
5863 |
|
</t> |
5864 |
|
<t>FORMAT_VERSION - |
5865 |
|
<list> |
5866 |
|
<t>The format version of the instrument.</t> |
5867 |
|
</list> |
5868 |
|
</t> |
5869 |
|
<t>SIZE - |
5870 |
|
<list> |
5871 |
|
<t>The size of the instrument in bytes.</t> |
5872 |
|
</list> |
5873 |
|
</t> |
5874 |
|
<t>CREATED - |
5875 |
|
<list> |
5876 |
|
<t>The date and time when the instrument is added |
5877 |
|
in the instruments database, represented in |
5878 |
|
"YYYY-MM-DD HH:MM:SS" format</t> |
5879 |
|
</list> |
5880 |
|
</t> |
5881 |
|
<t>MODIFIED - |
5882 |
|
<list> |
5883 |
|
<t>The date and time of the last modification of the |
5884 |
|
instrument's database settings, represented in |
5885 |
|
"YYYY-MM-DD HH:MM:SS" format</t> |
5886 |
|
</list> |
5887 |
|
</t> |
5888 |
|
<t>DESCRIPTION - |
5889 |
|
<list> |
5890 |
|
<t>A brief description of the instrument. |
5891 |
|
Note that the character string may contain |
5892 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5893 |
|
</list> |
5894 |
|
</t> |
5895 |
|
<t>IS_DRUM - |
5896 |
|
<list> |
5897 |
|
<t>either true or false, determines whether the |
5898 |
|
instrument is a drumkit or a chromatic instrument</t> |
5899 |
|
</list> |
5900 |
|
</t> |
5901 |
|
<t>PRODUCT - |
5902 |
|
<list> |
5903 |
|
<t>The product title of the instrument. |
5904 |
|
Note that the character string may contain |
5905 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5906 |
|
</list> |
5907 |
|
</t> |
5908 |
|
<t>ARTISTS - |
5909 |
|
<list> |
5910 |
|
<t>Lists the artist names. |
5911 |
|
Note that the character string may contain |
5912 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5913 |
|
</list> |
5914 |
|
</t> |
5915 |
|
<t>KEYWORDS - |
5916 |
|
<list> |
5917 |
|
<t>Provides a list of keywords that refer to the instrument. |
5918 |
|
Keywords are separated with semicolon and blank. |
5919 |
|
Note that the character string may contain |
5920 |
|
<xref target="character_set">escape sequences</xref>.</t> |
5921 |
|
</list> |
5922 |
|
</t> |
5923 |
|
</list> |
5924 |
|
</t> |
5925 |
|
</list> |
5926 |
|
</t> |
5927 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
5928 |
|
|
5929 |
|
<t>Example:</t> |
5930 |
|
<t> |
5931 |
|
<list> |
5932 |
|
<t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t> |
5933 |
|
<t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t> |
5934 |
|
<t> "INSTRUMENT_NR: 0"</t> |
5935 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
5936 |
|
<t> "FORMAT_VERSION: 2"</t> |
5937 |
|
<t> "SIZE: 2050871870"</t> |
5938 |
|
<t> "CREATED: 2007-02-05 10:23:12"</t> |
5939 |
|
<t> "MODIFIED: 2007-04-07 12:50:21"</t> |
5940 |
|
<t> "DESCRIPTION: "</t> |
5941 |
|
<t> "IS_DRUM: false"</t> |
5942 |
|
<t> "PRODUCT: GRANDIOSO Bosendorfer 290"</t> |
5943 |
|
<t> "ARTISTS: Post Musical Instruments"</t> |
5944 |
|
<t> "KEYWORDS: Bosendorfer"</t> |
5945 |
|
<t> "."</t> |
5946 |
|
</list> |
5947 |
|
</t> |
5948 |
|
</section> |
5949 |
|
|
5950 |
|
<section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME"> |
5951 |
|
<t>The front-end can alter the name of a specific |
5952 |
|
instrument by sending the following command:</t> |
5953 |
|
<t> |
5954 |
|
<list> |
5955 |
|
<t>SET DB_INSTRUMENT NAME <instr> <name></t> |
5956 |
|
</list> |
5957 |
|
</t> |
5958 |
|
<t>Where <instr> is the absolute path name of the instrument and |
5959 |
|
<name> is the new name for that instrument.</t> |
5960 |
|
|
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:<error-code>:<error-message>" - |
5970 |
|
<list> |
5971 |
|
<t>in case the given instrument does not exists, |
5972 |
|
or if an instrument with name equal to the new |
5973 |
|
name already exists.</t> |
5974 |
|
</list> |
5975 |
|
</t> |
5976 |
|
</list> |
5977 |
|
</t> |
5978 |
|
|
5979 |
|
<t>Example:</t> |
5980 |
|
<t> |
5981 |
|
<list> |
5982 |
|
<t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t> |
5983 |
|
<t>S: "OK"</t> |
5984 |
|
</list> |
5985 |
|
</t> |
5986 |
|
</section> |
5987 |
|
|
5988 |
|
<section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT"> |
5989 |
|
<t>The front-end can move a specific instrument to another directory by |
5990 |
|
sending the following command:</t> |
5991 |
|
<t> |
5992 |
|
<list> |
5993 |
|
<t>MOVE DB_INSTRUMENT <instr> <dst></t> |
5994 |
|
</list> |
5995 |
|
</t> |
5996 |
|
<t>Where <instr> is the absolute path name of the instrument |
5997 |
|
to move and <dst> is the directory where the instrument will |
5998 |
|
be moved to.</t> |
5999 |
|
|
6000 |
|
<t>Possible Answers:</t> |
6001 |
|
<t> |
6002 |
|
<list> |
6003 |
|
<t>"OK" - |
6004 |
|
<list> |
6005 |
|
<t>on success</t> |
6006 |
|
</list> |
6007 |
|
</t> |
6008 |
|
<t>"ERR:<error-code>:<error-message>" - |
6009 |
|
<list> |
6010 |
|
<t>in case the given instrument does not exists, |
6011 |
|
or if an instrument with name equal to the name of the |
6012 |
|
specified instrument already exists in the destination |
6013 |
|
directory.</t> |
6014 |
|
</list> |
6015 |
|
</t> |
6016 |
|
</list> |
6017 |
|
</t> |
6018 |
|
|
6019 |
|
<t>Example:</t> |
6020 |
|
<t> |
6021 |
|
<list> |
6022 |
|
<t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t> |
6023 |
|
<t>S: "OK"</t> |
6024 |
|
</list> |
6025 |
|
</t> |
6026 |
|
</section> |
6027 |
|
|
6028 |
|
<section title="Copying instruments" anchor="COPY DB_INSTRUMENT"> |
6029 |
|
<t>The front-end can copy a specific instrument to another directory by |
6030 |
|
sending the following command:</t> |
6031 |
|
<t> |
6032 |
|
<list> |
6033 |
|
<t>COPY DB_INSTRUMENT <instr> <dst></t> |
6034 |
|
</list> |
6035 |
|
</t> |
6036 |
|
<t>Where <instr> is the absolute path name of the instrument |
6037 |
|
to copy and <dst> is the directory where the instrument will |
6038 |
|
be copied to.</t> |
6039 |
|
|
6040 |
|
<t>Possible Answers:</t> |
6041 |
|
<t> |
6042 |
|
<list> |
6043 |
|
<t>"OK" - |
6044 |
|
<list> |
6045 |
|
<t>on success</t> |
6046 |
|
</list> |
6047 |
|
</t> |
6048 |
|
<t>"ERR:<error-code>:<error-message>" - |
6049 |
|
<list> |
6050 |
|
<t>in case the given instrument does not exists, |
6051 |
|
or if an instrument with name equal to the name of the |
6052 |
|
specified instrument already exists in the destination |
6053 |
|
directory.</t> |
6054 |
|
</list> |
6055 |
|
</t> |
6056 |
|
</list> |
6057 |
|
</t> |
6058 |
|
|
6059 |
|
<t>Example:</t> |
6060 |
|
<t> |
6061 |
|
<list> |
6062 |
|
<t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t> |
6063 |
|
<t>S: "OK"</t> |
6064 |
|
</list> |
6065 |
|
</t> |
6066 |
|
</section> |
6067 |
|
|
6068 |
|
<section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION"> |
6069 |
|
<t>The front-end can alter the description of a specific |
6070 |
|
instrument by sending the following command:</t> |
6071 |
|
<t> |
6072 |
|
<list> |
6073 |
|
<t>SET DB_INSTRUMENT DESCRIPTION <instr> <desc></t> |
6074 |
|
</list> |
6075 |
|
</t> |
6076 |
|
<t>Where <instr> is the absolute path name of the instrument and |
6077 |
|
<desc> is the new description for the instrument |
6078 |
|
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
6079 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6080 |
|
|
6081 |
|
<t>Possible Answers:</t> |
6082 |
|
<t> |
6083 |
|
<list> |
6084 |
|
<t>"OK" - |
6085 |
|
<list> |
6086 |
|
<t>on success</t> |
6087 |
|
</list> |
6088 |
|
</t> |
6089 |
|
<t>"ERR:<error-code>:<error-message>" - |
6090 |
|
<list> |
6091 |
|
<t>in case the given instrument does not exists.</t> |
6092 |
|
</list> |
6093 |
|
</t> |
6094 |
|
</list> |
6095 |
|
</t> |
6096 |
|
|
6097 |
|
<t>Example:</t> |
6098 |
|
<t> |
6099 |
|
<list> |
6100 |
|
<t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t> |
6101 |
|
<t>S: "OK"</t> |
6102 |
|
</list> |
6103 |
|
</t> |
6104 |
|
</section> |
6105 |
|
|
6106 |
|
<section title="Finding instruments" anchor="FIND DB_INSTRUMENTS"> |
6107 |
|
<t>The front-end can search for instruments |
6108 |
|
in specific directory by sending the following command:</t> |
6109 |
|
<t> |
6110 |
|
<list> |
6111 |
|
<t>FIND DB_INSTRUMENTS [NON_RECURSIVE] <dir> <criteria-list></t> |
6112 |
|
</list> |
6113 |
|
</t> |
6114 |
|
<t>Where <dir> should be replaced by the absolute path |
6115 |
|
name of the directory to search in. If NON_RECURSIVE is specified, the |
6116 |
|
directories located in subdirectories of the specified directory will not |
6117 |
|
be searched. <criteria-list> is a list of search criterias |
6118 |
|
in form of "key1=val1 key2=val2 ...". The following criterias are |
6119 |
|
allowed:</t> |
6120 |
|
<t> |
6121 |
|
<t>NAME='<search-string>' |
6122 |
|
<list> |
6123 |
|
<t>Restricts the search to instruments, which names |
6124 |
|
satisfy the supplied search string (encapsulated into apostrophes, |
6125 |
|
supporting escape sequences as described in chapter |
6126 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6127 |
|
</list> |
6128 |
|
</t> |
6129 |
|
|
6130 |
|
<t>SIZE=[<min>]..[<max>] |
6131 |
|
<list> |
6132 |
|
<t>Restricts the search to instruments, which |
6133 |
|
size is in the specified range. If <min> is omitted, |
6134 |
|
the search results are restricted to instruments with size less then |
6135 |
|
or equal to <max>. If <max> is omitted, the |
6136 |
|
search is restricted to instruments with size greater then |
6137 |
|
or equal to <min>.</t> |
6138 |
|
</list> |
6139 |
|
</t> |
6140 |
|
|
6141 |
|
<t>CREATED='[<date-after>]..[<date-before>]' |
6142 |
|
<list> |
6143 |
|
<t>Restricts the search to instruments, which creation |
6144 |
|
date satisfies the specified period, where <date-after> |
6145 |
|
and <date-before> are in "YYYY-MM-DD HH:MM:SS" format. |
6146 |
|
If <date-after> is omitted the search is restricted to |
6147 |
|
instruments created before <date-before>. If |
6148 |
|
<date-before> is omitted, the search is restricted |
6149 |
|
to instruments created after <date-after>.</t> |
6150 |
|
</list> |
6151 |
|
</t> |
6152 |
|
|
6153 |
|
<t>MODIFIED='[<date-after>]..[<date-before>]' |
6154 |
|
<list> |
6155 |
|
<t>Restricts the search to instruments, which |
6156 |
|
date of last modification satisfies the specified period, where |
6157 |
|
<date-after> and <date-before> are in "YYYY-MM-DD HH:MM:SS" |
6158 |
|
format. If <date-after> is omitted the search is restricted to |
6159 |
|
instruments, which are last modified before <date-before>. If |
6160 |
|
<date-before> is omitted, the search is restricted to instruments, |
6161 |
|
which are last modified after <date-after>.</t> |
6162 |
|
</list> |
6163 |
|
</t> |
6164 |
|
|
6165 |
|
<t>DESCRIPTION='<search-string>' |
6166 |
|
<list> |
6167 |
|
<t>Restricts the search to instruments with description |
6168 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6169 |
|
supporting escape sequences as described in chapter |
6170 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6171 |
|
</list> |
6172 |
|
</t> |
6173 |
|
|
6174 |
|
<t>PRODUCT='<search-string>' |
6175 |
|
<list> |
6176 |
|
<t>Restricts the search to instruments with product info |
6177 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6178 |
|
supporting escape sequences as described in chapter |
6179 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6180 |
|
</list> |
6181 |
|
</t> |
6182 |
|
|
6183 |
|
<t>ARTISTS='<search-string>' |
6184 |
|
<list> |
6185 |
|
<t>Restricts the search to instruments with artists info |
6186 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6187 |
|
supporting escape sequences as described in chapter |
6188 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6189 |
|
</list> |
6190 |
|
</t> |
6191 |
|
|
6192 |
|
<t>KEYWORDS='<search-string>' |
6193 |
|
<list> |
6194 |
|
<t>Restricts the search to instruments with keyword list |
6195 |
|
that satisfies the supplied search string (encapsulated into apostrophes, |
6196 |
|
supporting escape sequences as described in chapter |
6197 |
|
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
6198 |
|
</list> |
6199 |
|
</t> |
6200 |
|
|
6201 |
|
<t>IS_DRUM=true | false |
6202 |
|
<list> |
6203 |
|
<t>Either true or false. Restricts the search to |
6204 |
|
drum kits or chromatic instruments.</t> |
6205 |
|
</list> |
6206 |
|
</t> |
6207 |
|
|
6208 |
|
<t>FORMAT_FAMILIES='<format-list>' |
6209 |
|
<list> |
6210 |
|
<t>Restricts the search to instruments of the supplied format families, |
6211 |
|
where <format-list> is a comma separated list of format families.</t> |
6212 |
|
</list> |
6213 |
|
</t> |
6214 |
|
</t> |
6215 |
|
|
6216 |
|
<t>Where <search-string> is either a regular expression, or a |
6217 |
|
word list separated with spaces for OR search and with '+' for AND search.</t> |
6218 |
|
|
6219 |
|
<t>Possible Answers:</t> |
6220 |
|
<t> |
6221 |
|
<list> |
6222 |
|
<t>A comma separated list with the absolute path names (encapsulated into |
6223 |
|
apostrophes) of all instruments in the specified directory that satisfy |
6224 |
|
the supplied search criterias.</t> |
6225 |
|
<t>"ERR:<error-code>:<error-message>" - |
6226 |
|
<list> |
6227 |
|
<t>if the given directory does not exist.</t> |
6228 |
|
</list> |
6229 |
|
</t> |
6230 |
|
</list> |
6231 |
|
</t> |
6232 |
|
<t>Example:</t> |
6233 |
|
<t> |
6234 |
|
<list> |
6235 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t> |
6236 |
|
<t>S: "'/Piano Collection/Bosendorfer 290'"</t> |
6237 |
|
</list> |
6238 |
|
</t> |
6239 |
|
<t> |
6240 |
|
<list> |
6241 |
|
<t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t> |
6242 |
|
<t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t> |
6243 |
|
</list> |
6244 |
|
</t> |
6245 |
|
</section> |
6246 |
|
|
6247 |
|
<section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO"> |
6248 |
|
<t>The front-end can ask for the current status of a |
6249 |
|
particular database instruments job by sending the following command:</t> |
6250 |
|
<t> |
6251 |
|
<list> |
6252 |
|
<t>GET DB_INSTRUMENTS_JOB INFO <job-id></t> |
6253 |
|
</list> |
6254 |
|
</t> |
6255 |
|
<t>Where <job-id> should be replaced by the numerical ID |
6256 |
|
of the job the front-end is interested in.</t> |
6257 |
|
|
6258 |
|
<t>Possible Answers:</t> |
6259 |
|
<t> |
6260 |
|
<list> |
6261 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6262 |
|
Each answer line begins with the settings category name |
6263 |
|
followed by a colon and then a space character <SP> and finally |
6264 |
|
the info character string to that setting category. At the |
6265 |
|
moment the following categories are defined:</t> |
6266 |
|
|
6267 |
|
<t> |
6268 |
|
<list> |
6269 |
|
<t>FILES_TOTAL - |
6270 |
|
<list> |
6271 |
|
<t>The total number of files scheduled for scanning</t> |
6272 |
|
</list> |
6273 |
|
</t> |
6274 |
|
<t>FILES_SCANNED - |
6275 |
|
<list> |
6276 |
|
<t>The current number of scanned files</t> |
6277 |
|
</list> |
6278 |
|
</t> |
6279 |
|
<t>SCANNING - |
6280 |
|
<list> |
6281 |
|
<t>The absolute path name of the file which is currently |
6282 |
|
being scanned</t> |
6283 |
|
</list> |
6284 |
|
</t> |
6285 |
|
<t>STATUS - |
6286 |
|
<list> |
6287 |
|
<t>An integer value between 0 and 100 indicating the |
6288 |
|
scanning progress percentage of the file which is |
6289 |
|
currently being scanned</t> |
6290 |
|
</list> |
6291 |
|
</t> |
6292 |
|
</list> |
6293 |
|
</t> |
6294 |
|
</list> |
6295 |
|
</t> |
6296 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6297 |
|
|
6298 |
|
<t>Example:</t> |
6299 |
|
<t> |
6300 |
|
<list> |
6301 |
|
<t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t> |
6302 |
|
<t>S: "FILES_TOTAL: 12"</t> |
6303 |
|
<t> "FILES_SCANNED: 7"</t> |
6304 |
|
<t> "SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t> |
6305 |
|
<t> "STATUS: 42"</t> |
6306 |
|
<t> "."</t> |
6307 |
|
</list> |
6308 |
|
</t> |
6309 |
|
</section> |
6310 |
|
|
6311 |
|
<section title="Formatting the instruments database" anchor="FORMAT INSTRUMENTS_DB"> |
6312 |
|
<t>The front-end can remove all instruments and directories and re-create |
6313 |
|
the instruments database structure (e.g., in case of a database corruption) |
6314 |
|
by sending the following command:</t> |
6315 |
|
<t> |
6316 |
|
<list> |
6317 |
|
<t>FORMAT INSTRUMENTS_DB</t> |
6318 |
|
</list> |
6319 |
|
</t> |
6320 |
|
|
6321 |
|
<t>Possible Answers:</t> |
6322 |
|
<t> |
6323 |
|
<list> |
6324 |
|
<t>"OK" - |
6325 |
|
<list> |
6326 |
|
<t>on success</t> |
6327 |
|
</list> |
6328 |
|
</t> |
6329 |
|
<t>"ERR:<error-code>:<error-message>" - |
6330 |
|
<list> |
6331 |
|
<t>If the formatting of the instruments database |
6332 |
|
failed.</t> |
6333 |
|
</list> |
6334 |
|
</t> |
6335 |
|
</list> |
6336 |
|
</t> |
6337 |
|
</section> |
6338 |
|
|
6339 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6340 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6341 |
|
that don't exist in the filesystem by sending the following command:</t> |
6342 |
|
<t> |
6343 |
|
<list> |
6344 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6345 |
|
</list> |
6346 |
|
</t> |
6347 |
|
|
6348 |
|
<t>Possible Answers:</t> |
6349 |
|
<t> |
6350 |
|
<list> |
6351 |
|
<t>A comma separated list with the absolute path names |
6352 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6353 |
|
<t>"ERR:<error-code>:<error-message>" - |
6354 |
|
<list> |
6355 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6356 |
|
</list> |
6357 |
|
</t> |
6358 |
|
</list> |
6359 |
|
</t> |
6360 |
|
<t>Example:</t> |
6361 |
|
<t> |
6362 |
|
<list> |
6363 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6364 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6365 |
|
</list> |
6366 |
|
</t> |
6367 |
|
</section> |
6368 |
|
|
6369 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6370 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6371 |
|
in the instruments database with a new one by sending the following command:</t> |
6372 |
|
<t> |
6373 |
|
<list> |
6374 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6375 |
|
</list> |
6376 |
|
</t> |
6377 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6378 |
|
to substitute with <new_path>.</t> |
6379 |
|
|
6380 |
|
<t>Possible Answers:</t> |
6381 |
|
<t> |
6382 |
|
<list> |
6383 |
|
<t>"OK" - |
6384 |
|
<list> |
6385 |
|
<t>on success</t> |
6386 |
|
</list> |
6387 |
|
</t> |
6388 |
|
<t>"ERR:<error-code>:<error-message>" - |
6389 |
|
<list> |
6390 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6391 |
|
</list> |
6392 |
|
</t> |
6393 |
|
</list> |
6394 |
|
</t> |
6395 |
|
|
6396 |
|
<t>Example:</t> |
6397 |
|
<t> |
6398 |
|
<list> |
6399 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6400 |
|
<t>S: "OK"</t> |
6401 |
|
</list> |
6402 |
|
</t> |
6403 |
|
</section> |
6404 |
|
|
6405 |
|
</section> |
6406 |
|
|
6407 |
|
|
6408 |
|
|
6409 |
|
<section title="Editing Instruments" anchor="editing_instruments"> |
6410 |
|
<t>The sampler allows to edit instruments while playing with the |
6411 |
|
sampler by spawning an external (3rd party) instrument editor |
6412 |
|
application for a given instrument. The 3rd party instrument |
6413 |
|
editor applications have to place a respective plugin DLL file |
6414 |
|
into the sampler's plugins directory. The sampler will |
6415 |
|
automatically try to load all plugin DLLs in that directory on |
6416 |
|
startup and only on startup!</t> |
6417 |
|
<t>At the moment there is only one command for this feature set, |
6418 |
|
but this will most probably change in future.</t> |
6419 |
|
|
6420 |
|
<section title="Opening an appropriate instrument editor application" anchor="EDIT INSTRUMENT"> |
6421 |
|
<t>The front-end can request to open an appropriate instrument |
6422 |
|
editor application by sending the following command:</t> |
6423 |
|
<t> |
6424 |
|
<list> |
6425 |
|
<t>EDIT CHANNEL INSTRUMENT <sampler-channel></t> |
6426 |
|
</list> |
6427 |
|
</t> |
6428 |
|
<t>Where <sampler-channel> should be replaced by the |
6429 |
|
number of the sampler channel as given by the |
6430 |
|
<xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
6431 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> |
6432 |
|
command.</t> |
6433 |
|
|
6434 |
|
<t>The sampler will try to ask all registered instrument |
6435 |
|
editors (or to be more specific: their sampler plugins) |
6436 |
|
whether they are capable to handle the instrument on the |
6437 |
|
given sampler channel. The sampler will simply use the first |
6438 |
|
instrument editor application which replied with a positive |
6439 |
|
answer and spawn that instrument editor application within |
6440 |
|
the sampler's process and provide that application access |
6441 |
|
to the instrument's data structures, so both applications |
6442 |
|
can share and access the same instruments data at the same |
6443 |
|
time, thus allowing to immediately hear changes with the |
6444 |
|
sampler made by the instrument editor.</t> |
6445 |
|
|
6446 |
|
<t>Note: consequently instrument editors are always spawned |
6447 |
|
locally on the same machine where the sampler is running |
6448 |
|
on!</t> |
6449 |
|
|
6450 |
|
<t>Possible Answers:</t> |
6451 |
|
<t> |
6452 |
|
<list> |
6453 |
|
<t>"OK" - |
6454 |
|
<list> |
6455 |
|
<t>when an appropriate instrument editor was |
6456 |
|
launched</t> |
6457 |
|
</list> |
6458 |
|
</t> |
6459 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6460 |
|
<list> |
6461 |
|
<t>when an appropriate instrument editor was |
6462 |
|
launched, but there are noteworthy issues</t> |
6463 |
|
</list> |
6464 |
|
</t> |
6465 |
|
<t>"ERR:<error-code>:<error-message>" - |
6466 |
|
<list> |
6467 |
|
<t>when an appropriate instrument editor |
6468 |
|
could not be launched</t> |
6469 |
|
</list> |
6470 |
|
</t> |
6471 |
|
</list> |
6472 |
|
</t> |
6473 |
|
|
6474 |
|
<t>Examples:</t> |
6475 |
|
<t> |
6476 |
|
<list> |
6477 |
|
<t>C: "EDIT CHANNEL INSTRUMENT 0"</t> |
6478 |
|
<t>S: "OK"</t> |
6479 |
|
</list> |
6480 |
|
</t> |
6481 |
|
</section> |
6482 |
|
</section> |
6483 |
|
|
6484 |
|
<section title="Managing Files" anchor="file_management"> |
6485 |
|
<t>You can query detailed informations about files located |
6486 |
|
at the same system where the sampler instance is running on. |
6487 |
|
Using this command set allows to retrieve file informations |
6488 |
|
even remotely from another machine.</t> |
6489 |
|
|
6490 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6491 |
|
<t>The front-end can retrieve the amount of instruments |
6492 |
|
within a given instrument file by sending the |
6493 |
|
following command:</t> |
6494 |
|
<t> |
6495 |
|
<list> |
6496 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6497 |
|
</list> |
6498 |
|
</t> |
6499 |
|
<t>Where <filename> is the name of the instrument |
6500 |
|
file (encapsulated into apostrophes, supporting escape |
6501 |
|
sequences as described in chapter |
6502 |
|
"<xref target="character_set">Character Set and Escape |
6503 |
|
Sequences</xref>").</t> |
6504 |
|
|
6505 |
|
<t>The sampler will try to ask all sampler engines, |
6506 |
|
whether they support the given file and ask the first |
6507 |
|
engine with a positive answer for the amount of |
6508 |
|
instruments.</t> |
6509 |
|
|
6510 |
|
<t>Possible Answers:</t> |
6511 |
|
<t> |
6512 |
|
<list> |
6513 |
|
<t>On success, the sampler will answer by |
6514 |
|
returning the amount of instruments. |
6515 |
|
</t> |
6516 |
|
<t>"ERR:<error-code>:<error-message>" - |
6517 |
|
<list> |
6518 |
|
<t>if the file could not be handled</t> |
6519 |
|
</list> |
6520 |
|
</t> |
6521 |
|
</list> |
6522 |
|
</t> |
6523 |
|
|
6524 |
|
<t>Examples:</t> |
6525 |
|
<t> |
6526 |
|
<list> |
6527 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6528 |
|
<t>S: "10"</t> |
6529 |
|
</list> |
6530 |
|
</t> |
6531 |
|
</section> |
6532 |
|
|
6533 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6534 |
|
<t>The front-end can retrieve a list of all instruments |
6535 |
|
within a given instrument file by sending the |
6536 |
|
following command:</t> |
6537 |
|
<t> |
6538 |
|
<list> |
6539 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6540 |
|
</list> |
6541 |
|
</t> |
6542 |
|
<t>Where <filename> is the name of the instrument |
6543 |
|
file (encapsulated into apostrophes, supporting escape |
6544 |
|
sequences as described in chapter |
6545 |
|
"<xref target="character_set">Character Set and Escape |
6546 |
|
Sequences</xref>").</t> |
6547 |
|
|
6548 |
|
<t>The sampler will try to ask all sampler engines, |
6549 |
|
whether they support the given file and ask the first |
6550 |
|
engine with a positive answer for a list of IDs for the |
6551 |
|
instruments in the given file.</t> |
6552 |
|
|
6553 |
|
<t>Possible Answers:</t> |
6554 |
|
<t> |
6555 |
|
<list> |
6556 |
|
<t>On success, the sampler will answer by |
6557 |
|
returning a comma separated list of |
6558 |
|
instrument IDs. |
6559 |
|
</t> |
6560 |
|
<t>"ERR:<error-code>:<error-message>" - |
6561 |
|
<list> |
6562 |
|
<t>if the file could not be handled</t> |
6563 |
|
</list> |
6564 |
|
</t> |
6565 |
|
</list> |
6566 |
|
</t> |
6567 |
|
|
6568 |
|
<t>Examples:</t> |
6569 |
|
<t> |
6570 |
|
<list> |
6571 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6572 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6573 |
|
</list> |
6574 |
|
</t> |
6575 |
|
</section> |
6576 |
|
|
6577 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6578 |
|
<t>The front-end can retrieve detailed informations |
6579 |
|
about a specific instrument within a given instrument |
6580 |
|
file by sending the following command:</t> |
6581 |
|
<t> |
6582 |
|
<list> |
6583 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6584 |
|
<instr-id></t> |
6585 |
|
</list> |
6586 |
|
</t> |
6587 |
|
<t>Where <filename> is the name of the instrument |
6588 |
|
file (encapsulated into apostrophes, supporting escape |
6589 |
|
sequences as described in chapter |
6590 |
|
"<xref target="character_set">Character Set and Escape |
6591 |
|
Sequences</xref>") and <instr-id> is the numeric |
6592 |
|
instrument ID as returned by the |
6593 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6594 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6595 |
|
|
6596 |
|
<t>The sampler will try to ask all sampler engines, |
6597 |
|
whether they support the given file and ask the first |
6598 |
|
engine with a positive answer for informations about the |
6599 |
|
specific instrument in the given file.</t> |
6600 |
|
|
6601 |
|
<t>Possible Answers:</t> |
6602 |
|
<t> |
6603 |
|
<list> |
6604 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6605 |
|
Each answer line begins with the settings category name |
6606 |
|
followed by a colon and then a space character <SP> and finally |
6607 |
|
the info character string to that setting category. At the |
6608 |
|
moment the following categories are defined:</t> |
6609 |
|
|
6610 |
|
<t> |
6611 |
|
<list> |
6612 |
|
<t>NAME - |
6613 |
|
<list> |
6614 |
|
<t>name of the instrument as |
6615 |
|
stored in the instrument file</t> |
6616 |
|
</list> |
6617 |
|
</t> |
6618 |
|
<t>FORMAT_FAMILY - |
6619 |
|
<list> |
6620 |
|
<t>name of the sampler format |
6621 |
|
of the given instrument</t> |
6622 |
|
</list> |
6623 |
|
</t> |
6624 |
|
<t>FORMAT_VERSION - |
6625 |
|
<list> |
6626 |
|
<t>version of the sampler format |
6627 |
|
the instrumen is stored as</t> |
6628 |
|
</list> |
6629 |
|
</t> |
6630 |
|
<t>PRODUCT - |
6631 |
|
<list> |
6632 |
|
<t>official product name of the |
6633 |
|
instrument as stored in the file |
6634 |
|
</t> |
6635 |
|
</list> |
6636 |
|
</t> |
6637 |
|
<t>ARTISTS - |
6638 |
|
<list> |
6639 |
|
<t>artists / sample library |
6640 |
|
vendor of the instrument</t> |
6641 |
|
</list> |
6642 |
|
</t> |
6643 |
|
<t>KEY_BINDINGS - |
6644 |
|
<list> |
6645 |
|
<t>comma separated list of integer values representing |
6646 |
|
the instrument's key mapping in the range between 0 .. 127, |
6647 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6648 |
|
</list> |
6649 |
|
</t> |
6650 |
|
<t>KEYSWITCH_BINDINGS - |
6651 |
|
<list> |
6652 |
|
<t>comma separated list of integer values representing |
6653 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6654 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6655 |
|
</list> |
6656 |
|
</t> |
6657 |
|
</list> |
6658 |
|
</t> |
6659 |
|
</list> |
6660 |
|
</t> |
6661 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6662 |
|
|
6663 |
|
<t>Example:</t> |
6664 |
|
<t> |
6665 |
|
<list> |
6666 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6667 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6668 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6669 |
|
<t> "FORMAT_VERSION: 3"</t> |
6670 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6671 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6672 |
|
<t> "."</t> |
6673 |
|
</list> |
6674 |
|
</t> |
6675 |
|
</section> |
6676 |
|
</section> |
6677 |
|
<section title="Managing Effects" anchor="effects"> |
6678 |
|
<t>Audio effects (e.g. reverb, delay, compression) can be |
6679 |
|
applied to the audio signals generated by the sampler. The |
6680 |
|
sampler usually provides a set of internal audio effects for |
6681 |
|
this task. The exact set of effects depends on the availability |
6682 |
|
of third party effect plugins installed on the system where the |
6683 |
|
sampler runs on.</t> |
6684 |
|
<t>At the moment only "send effects" are supported. Support for |
6685 |
|
"insert effects" and "master effects" is planned to be added at |
6686 |
|
a later point.</t> |
6687 |
|
<t>The following commands allow to retrieve the set of internal |
6688 |
|
effects available to the sampler, detailed informations about |
6689 |
|
those effects and to create and destroy instances of such |
6690 |
|
effects. After an instance of an effect is created, the effect |
6691 |
|
instance can be inserted into the audio signal path of the |
6692 |
|
sampler, e.g. as send effect.</t> |
6693 |
|
<t>The sampler allows to create an arbitrary amount of so called |
6694 |
|
send effect chains. Each effect chain can host an arbitrary |
6695 |
|
amount of effect instances. The output of the first effect |
6696 |
|
instance in an effect chain is fed to the input of the second |
6697 |
|
effect instance of the chain and so on. So effects in one chain |
6698 |
|
are processed sequentially. Send effect chains however are |
6699 |
|
processed in parallel to other send effect chains. Audio signals |
6700 |
|
of sampler channels are fed to send effects by creating FX sends |
6701 |
|
to the respective sampler channel and assigning a destination |
6702 |
|
send effect to that FX by using the |
6703 |
|
<xref target="SET FX_SEND EFFECT">"SET FX_SEND EFFECT"</xref> |
6704 |
|
command. The latter allows to route the FX send to the beginning |
6705 |
|
of a send effect chain, as well as directly to any other |
6706 |
|
position of the send effect chain.</t> |
6707 |
|
|
6708 |
|
<section title="Retrieve amount of available effects" anchor="GET AVAILABLE_EFFECTS"> |
6709 |
|
<t>The front-end can retrieve the amount of internal |
6710 |
|
effects, available to the sampler by sending |
6711 |
|
the following command:</t> |
6712 |
|
<t> |
6713 |
|
<list> |
6714 |
|
<t>GET AVAILABLE_EFFECTS</t> |
6715 |
|
</list> |
6716 |
|
</t> |
6717 |
|
|
6718 |
|
<t>Possible Answers:</t> |
6719 |
|
<t> |
6720 |
|
<list> |
6721 |
|
<t>The sampler will answer by returning the current |
6722 |
|
number of effects available to the sampler.</t> |
6723 |
|
</list> |
6724 |
|
</t> |
6725 |
|
|
6726 |
|
<t>Examples:</t> |
6727 |
|
<t> |
6728 |
|
<list> |
6729 |
|
<t>C: "GET AVAILABLE_EFFECTS"</t> |
6730 |
|
<t>S: "129"</t> |
6731 |
|
</list> |
6732 |
|
</t> |
6733 |
|
</section> |
6734 |
|
|
6735 |
|
<section title="Get list of available effects" anchor="LIST AVAILABLE_EFFECTS"> |
6736 |
|
<t>The set of available internal effects can change at |
6737 |
|
runtime. The front-end can retrieve the list of internal |
6738 |
|
effects, available to the sampler by sending the following |
6739 |
|
command:</t> |
6740 |
|
<t> |
6741 |
|
<list> |
6742 |
|
<t>LIST AVAILABLE_EFFECTS</t> |
6743 |
|
</list> |
6744 |
|
</t> |
6745 |
|
|
6746 |
|
<t>Possible Answers:</t> |
6747 |
|
<t> |
6748 |
|
<list> |
6749 |
|
<t>The sampler will answer by returning a comma |
6750 |
|
separated list with numerical IDs of effects. Note: |
6751 |
|
the numercial ID of an effect is generated by the |
6752 |
|
sampler for the current moment. The numerical ID of |
6753 |
|
the same effect can change at runtime, e.g. when the |
6754 |
|
user requests a rescan of available effect plugins. |
6755 |
|
</t> |
6756 |
|
</list> |
6757 |
|
</t> |
6758 |
|
<t>Example:</t> |
6759 |
|
<t> |
6760 |
|
<list> |
6761 |
|
<t>C: "LIST AVAILABLE_EFFECTS"</t> |
6762 |
|
<t>S: "5,6,7,120,121,122,123,124"</t> |
6763 |
|
</list> |
6764 |
|
</t> |
6765 |
|
</section> |
6766 |
|
|
6767 |
|
<section title="Retrieving general information about an effect" anchor="GET EFFECT INFO"> |
6768 |
|
<t>The front-end can ask for general informations about an |
6769 |
|
effect by sending the following command:</t> |
6770 |
|
<t> |
6771 |
|
<list> |
6772 |
|
<t>GET EFFECT INFO <effect-index></t> |
6773 |
|
</list> |
6774 |
|
</t> |
6775 |
|
<t>Where <effect-index> is the numerical ID of an |
6776 |
|
effect as returned by the |
6777 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
6778 |
|
command.</t> |
6779 |
|
<t>Possible Answers:</t> |
6780 |
|
<t> |
6781 |
|
<list> |
6782 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6783 |
|
Each answer line begins with the effect information |
6784 |
|
category name, followed by a colon and then a space |
6785 |
|
character <SP> and finally the info character |
6786 |
|
string to that effect information category. At the |
6787 |
|
moment the following categories are defined:</t> |
6788 |
|
<t> |
6789 |
|
<list> |
6790 |
|
<t>SYSTEM - |
6791 |
|
<list> |
6792 |
|
<t>name of the effect plugin system |
6793 |
|
the effect is based on |
6794 |
|
(e.g. "LADSPA")</t> |
6795 |
|
</list> |
6796 |
|
</t> |
6797 |
|
<t>MODULE - |
6798 |
|
<list> |
6799 |
|
<t>module of the effect plugin |
6800 |
|
system that contains this effect, |
6801 |
|
the module is usually the |
6802 |
|
dynamic-linked library (DLL) |
6803 |
|
filename of the effect plugin, |
6804 |
|
including full path (note that this |
6805 |
|
filename may contain |
6806 |
|
<xref target="character_set">escape sequences</xref>)</t> |
6807 |
|
</list> |
6808 |
|
</t> |
6809 |
|
<t>NAME - |
6810 |
|
<list> |
6811 |
|
<t>character string defining the |
6812 |
|
unique name of the effect within its |
6813 |
|
module (note that the character |
6814 |
|
string may contain |
6815 |
|
<xref target="character_set">escape sequences</xref>)</t> |
6816 |
|
</list> |
6817 |
|
</t> |
6818 |
|
<t>DESCRIPTION - |
6819 |
|
<list> |
6820 |
|
<t>human readable name of the |
6821 |
|
effect, intended to be displayed in |
6822 |
|
user interfaces (note that the |
6823 |
|
character string may contain |
6824 |
|
<xref target="character_set">escape sequences</xref>)</t> |
6825 |
|
</list> |
6826 |
|
</t> |
6827 |
|
</list> |
6828 |
|
</t> |
6829 |
|
</list> |
6830 |
|
</t> |
6831 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6832 |
|
|
6833 |
|
<t>Example:</t> |
6834 |
|
<t> |
6835 |
|
<list> |
6836 |
|
<t>C: "GET EFFECT INFO 121"</t> |
6837 |
|
<t>S: "SYSTEM: LADSPA"</t> |
6838 |
|
<t> "MODULE: /usr/lib/ladspa/lowpass_iir_1891.so"</t> |
6839 |
|
<t> "NAME: lowpass_iir"</t> |
6840 |
|
<t> "DESCRIPTION: Glame Lowpass Filter"</t> |
6841 |
|
<t> "."</t> |
6842 |
|
</list> |
6843 |
|
</t> |
6844 |
|
</section> |
6845 |
|
|
6846 |
|
<section title="Creating an instance of an effect by its portable ID" anchor="CREATE EFFECT_INSTANCE"> |
6847 |
|
<t>The front-end can spawn an instance of the desired |
6848 |
|
effect by sending the following command:</t> |
6849 |
|
<t> |
6850 |
|
<list> |
6851 |
|
<t>CREATE EFFECT_INSTANCE <effect-system> <module> <effect-name></t> |
6852 |
|
</list> |
6853 |
|
</t> |
6854 |
|
<t>Where <effect-system> is the "SYSTEM" field, |
6855 |
|
<module> the "MODULE" field and <effect-name> |
6856 |
|
the "NAME" field as returned by the |
6857 |
|
<xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref> |
6858 |
|
command. The filename of argument <module> and the |
6859 |
|
character string of argument <effect-name> may contain |
6860 |
|
<xref target="character_set">escape sequences</xref>.</t> |
6861 |
|
|
6862 |
|
<t>The sampler will try to load the requested effect and to |
6863 |
|
create an instance of it. To allow loading the same effect |
6864 |
|
on a different machine, probably even running a completely |
6865 |
|
different operating system (e.g. Linux vs. Windows), the |
6866 |
|
sampler tries to match <module> "softly". That means |
6867 |
|
it first tries to find an effect that exactly matches the |
6868 |
|
given <module> argument. If there is no exact match, |
6869 |
|
the sampler will try to lower the restrictions on matching |
6870 |
|
the <module> argument more and more, e.g. by ignoring |
6871 |
|
upper / lower case differences and by ignoring the path of |
6872 |
|
the DLL filename and file extension. If there is still no |
6873 |
|
match at the end, the sampler will try to ignore the |
6874 |
|
<module> argument completely and as a last resort |
6875 |
|
search for an effect that only matches the given |
6876 |
|
<effect-system> and <effect-name> arguments.</t> |
6877 |
|
|
6878 |
|
<t>Possible Answers:</t> |
6879 |
|
<t> |
6880 |
|
<list> |
6881 |
|
<t>"OK[<effect-instance>]" - |
6882 |
|
<list> |
6883 |
|
<t>in case the effect instance was |
6884 |
|
successfully created, where |
6885 |
|
<effect-instance> is the numerical ID |
6886 |
|
of the new effect instance</t> |
6887 |
|
</list> |
6888 |
|
</t> |
6889 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6890 |
|
<list> |
6891 |
|
<t>in case the effect instance was spawned |
6892 |
|
successfully, but there are noteworthy |
6893 |
|
issue(s) related, providing an appropriate |
6894 |
|
warning code and warning message</t> |
6895 |
|
</list> |
6896 |
|
</t> |
6897 |
|
<t>"ERR:<error-code>:<error-message>" - |
6898 |
|
<list> |
6899 |
|
<t>if the effect could not be instantiated</t> |
6900 |
|
</list> |
6901 |
|
</t> |
6902 |
|
</list> |
6903 |
|
</t> |
6904 |
|
|
6905 |
|
<t>Examples:</t> |
6906 |
|
<t> |
6907 |
|
<list> |
6908 |
|
<t>C: "CREATE EFFECT_INSTANCE LADSPA '/usr/lib/ladspa/mod_delay_1419.so' 'modDelay'"</t> |
6909 |
|
<t>S: "OK[0]"</t> |
6910 |
|
</list> |
6911 |
|
</t> |
6912 |
|
</section> |
6913 |
|
|
6914 |
|
<section title="Creating an instance of an effect by its numerical ID" anchor="CREATE EFFECT_INSTANCE (non-portable)"> |
6915 |
|
<t>The front-end can spawn an instance of the desired |
6916 |
|
effect by sending the following command:</t> |
6917 |
|
<t> |
6918 |
|
<list> |
6919 |
|
<t>CREATE EFFECT_INSTANCE <effect-index></t> |
6920 |
|
</list> |
6921 |
|
</t> |
6922 |
|
<t>Where <effect-index> is the numerical ID of the |
6923 |
|
effect as returned by the |
6924 |
|
<xref target="LIST AVAILABLE_EFFECTS">"LIST AVAILABLE_EFFECTS"</xref> |
6925 |
|
command.</t> |
6926 |
|
|
6927 |
|
<t>The sampler will try to load the requested effect and to |
6928 |
|
create an instance of it.</t> |
6929 |
|
|
6930 |
|
<t>Note: Since the numerical ID of a certain effect can |
6931 |
|
change at any time, you should not use this command in |
6932 |
|
LSCP files to restore a certain effect at a later time! To |
6933 |
|
store a sampler session including all its effects, use the |
6934 |
|
<xref target="CREATE EFFECT_INSTANCE">portable text-based |
6935 |
|
version of "CREATE EFFECT_INSTANCE"</xref> instead! This |
6936 |
|
allows to restore a sampler session with all its effects |
6937 |
|
also on other machines, possibly even running a completely |
6938 |
|
different operating system (e.g. Linux vs. Windows), with |
6939 |
|
different plugin directories or plugin DLL names.</t> |
6940 |
|
|
6941 |
|
<t>Possible Answers:</t> |
6942 |
|
<t> |
6943 |
|
<list> |
6944 |
|
<t>"OK[<effect-instance>]" - |
6945 |
|
<list> |
6946 |
|
<t>in case the effect instance was |
6947 |
|
successfully created, where |
6948 |
|
<effect-instance> is the numerical ID |
6949 |
|
of the new effect instance</t> |
6950 |
|
</list> |
6951 |
|
</t> |
6952 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
6953 |
|
<list> |
6954 |
|
<t>in case the effect instance was spawned |
6955 |
|
successfully, but there are noteworthy |
6956 |
|
issue(s) related, providing an appropriate |
6957 |
|
warning code and warning message</t> |
6958 |
|
</list> |
6959 |
|
</t> |
6960 |
|
<t>"ERR:<error-code>:<error-message>" - |
6961 |
|
<list> |
6962 |
|
<t>if the effect could not be instantiated</t> |
6963 |
|
</list> |
6964 |
|
</t> |
6965 |
|
</list> |
6966 |
|
</t> |
6967 |
|
|
6968 |
|
<t>Examples:</t> |
6969 |
|
<t> |
6970 |
|
<list> |
6971 |
|
<t>C: "CREATE EFFECT_INSTANCE 72"</t> |
6972 |
|
<t>S: "OK[5]"</t> |
6973 |
|
</list> |
6974 |
|
</t> |
6975 |
|
</section> |
6976 |
|
|
6977 |
|
<section title="Destroy an effect instance" anchor="DESTROY EFFECT_INSTANCE"> |
6978 |
|
<t>The front-end can destroy an unusued effect instance and |
6979 |
|
thus freeing it from memory by sending the following command:</t> |
6980 |
|
<t> |
6981 |
|
<list> |
6982 |
|
<t>DESTROY EFFECT_INSTANCE <effect-instance></t> |
6983 |
|
</list> |
6984 |
|
</t> |
6985 |
|
<t>Where <effect-instance> is the numerical ID of the |
6986 |
|
effect instance as returned by the |
6987 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
6988 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
6989 |
|
command.</t> |
6990 |
|
|
6991 |
|
<t>The effect instance can only be destroyed if it's not |
6992 |
|
used in any part of the sampler's audio signal path anymore. |
6993 |
|
If the effect instance is still in use somewhere, trying to |
6994 |
|
destroy the effect instance will result in an error |
6995 |
|
message.</t> |
6996 |
|
|
6997 |
|
<t>Possible Answers:</t> |
6998 |
|
<t> |
6999 |
|
<list> |
7000 |
|
<t>"OK" - |
7001 |
|
<list> |
7002 |
|
<t>in case the effect instance was successfully destroyed</t> |
7003 |
|
</list> |
7004 |
|
</t> |
7005 |
|
<t>"ERR:<error-code>:<error-message>" - |
7006 |
|
<list> |
7007 |
|
<t>in case it failed, providing an appropriate error code and |
7008 |
|
error message</t> |
7009 |
|
</list> |
7010 |
|
</t> |
7011 |
|
</list> |
7012 |
|
</t> |
7013 |
|
|
7014 |
|
<t>Examples:</t> |
7015 |
|
<t> |
7016 |
|
<list> |
7017 |
|
<t>C: "DESTROY EFFECT_INSTANCE 5"</t> |
7018 |
|
<t>S: "OK"</t> |
7019 |
|
</list> |
7020 |
|
</t> |
7021 |
|
</section> |
7022 |
|
|
7023 |
|
<section title="Retrieve amount of effect instances" anchor="GET EFFECT_INSTANCES"> |
7024 |
|
<t>The front-end can retrieve the current amount of effect |
7025 |
|
instances by sending the following command:</t> |
7026 |
|
<t> |
7027 |
|
<list> |
7028 |
|
<t>GET EFFECT_INSTANCES</t> |
7029 |
|
</list> |
7030 |
|
</t> |
7031 |
|
|
7032 |
|
<t>Possible Answers:</t> |
7033 |
|
<t> |
7034 |
|
<list> |
7035 |
|
<t>The sampler will answer by returning the current |
7036 |
|
number of effect instances created and not yet |
7037 |
|
destroyed in the current sampler session.</t> |
7038 |
|
</list> |
7039 |
|
</t> |
7040 |
|
|
7041 |
|
<t>Examples:</t> |
7042 |
|
<t> |
7043 |
|
<list> |
7044 |
|
<t>C: "GET EFFECT_INSTANCES"</t> |
7045 |
|
<t>S: "14"</t> |
7046 |
|
</list> |
7047 |
|
</t> |
7048 |
|
</section> |
7049 |
|
|
7050 |
|
<section title="Get list of effect instances" anchor="LIST EFFECT_INSTANCES"> |
7051 |
|
<t>The front-end can retrieve the current list of effect |
7052 |
|
instances by sending the following command:</t> |
7053 |
|
<t> |
7054 |
|
<list> |
7055 |
|
<t>LIST EFFECT_INSTANCES</t> |
7056 |
|
</list> |
7057 |
|
</t> |
7058 |
|
|
7059 |
|
<t>Possible Answers:</t> |
7060 |
|
<t> |
7061 |
|
<list> |
7062 |
|
<t>The sampler will answer by returning a comma |
7063 |
|
separated list with numerical IDs of effects |
7064 |
|
instances. |
7065 |
|
</t> |
7066 |
|
</list> |
7067 |
|
</t> |
7068 |
|
<t>Example:</t> |
7069 |
|
<t> |
7070 |
|
<list> |
7071 |
|
<t>C: "LIST EFFECT_INSTANCES"</t> |
7072 |
|
<t>S: "9,11,14,15,16,17,25"</t> |
7073 |
|
</list> |
7074 |
|
</t> |
7075 |
|
</section> |
7076 |
|
|
7077 |
|
<section title="Retrieving current information about an effect instance" anchor="GET EFFECT_INSTANCE INFO"> |
7078 |
|
<t>The front-end can ask for the current informations about |
7079 |
|
a particular effect instance by sending the following command:</t> |
7080 |
|
<t> |
7081 |
|
<list> |
7082 |
|
<t>GET EFFECT_INSTANCE INFO <effect-instance></t> |
7083 |
|
</list> |
7084 |
|
</t> |
7085 |
|
<t>Where <effect-instance> is the numerical ID of an |
7086 |
|
effect instance as returned by the |
7087 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7088 |
|
or |
7089 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7090 |
|
command.</t> |
7091 |
|
|
7092 |
|
<t>Possible Answers:</t> |
7093 |
|
<t> |
7094 |
|
<list> |
7095 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7096 |
|
Each answer line begins with the information |
7097 |
|
category name, followed by a colon and then a space |
7098 |
|
character <SP> and finally the info character |
7099 |
|
string to that information category. At the |
7100 |
|
moment the following categories are defined:</t> |
7101 |
|
<t> |
7102 |
|
<list> |
7103 |
|
<t>SYSTEM - |
7104 |
|
<list> |
7105 |
|
<t>name of the effect plugin system |
7106 |
|
the effect is based on |
7107 |
|
(e.g. "LADSPA")</t> |
7108 |
|
</list> |
7109 |
|
</t> |
7110 |
|
<t>MODULE - |
7111 |
|
<list> |
7112 |
|
<t>module of the effect plugin |
7113 |
|
system that contains this effect, |
7114 |
|
the module is usually the |
7115 |
|
dynamic-linked library (DLL) |
7116 |
|
filename of the effect plugin, |
7117 |
|
including full path (note that this |
7118 |
|
filename may contain |
7119 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7120 |
|
</list> |
7121 |
|
</t> |
7122 |
|
<t>NAME - |
7123 |
|
<list> |
7124 |
|
<t>character string defining the |
7125 |
|
unique name of the effect within its |
7126 |
|
module (note that the character |
7127 |
|
string may contain |
7128 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7129 |
|
</list> |
7130 |
|
</t> |
7131 |
|
<t>DESCRIPTION - |
7132 |
|
<list> |
7133 |
|
<t>human readable name of the |
7134 |
|
effect, intended to be displayed in |
7135 |
|
user interfaces (note that the |
7136 |
|
character string may contain |
7137 |
|
<xref target="character_set">escape sequences</xref>)</t> |
7138 |
|
</list> |
7139 |
|
</t> |
7140 |
|
<t>INPUT_CONTROLS - |
7141 |
|
<list> |
7142 |
|
<t>amount of input controls the |
7143 |
|
effect instance provides, to allow |
7144 |
|
controlling the effect parameters in |
7145 |
|
realtime</t> |
7146 |
|
</list> |
7147 |
|
</t> |
7148 |
|
</list> |
7149 |
|
</t> |
7150 |
|
</list> |
7151 |
|
</t> |
7152 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7153 |
|
|
7154 |
|
<t>Example:</t> |
7155 |
|
<t> |
7156 |
|
<list> |
7157 |
|
<t>C: "GET EFFECT_INSTANCE INFO 3"</t> |
7158 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7159 |
|
<t> "MODULE: /usr/lib/ladspa/mod_delay_1419.so"</t> |
7160 |
|
<t> "NAME: modDelay"</t> |
7161 |
|
<t> "DESCRIPTION: Modulatable delay"</t> |
7162 |
|
<t> "INPUT_CONTROLS: 1"</t> |
7163 |
|
<t> "."</t> |
7164 |
|
</list> |
7165 |
|
</t> |
7166 |
|
</section> |
7167 |
|
|
7168 |
|
<section title="Retrieving information about an effect parameter" anchor="GET EFFECT_INSTANCE_INPUT_CONTROL INFO"> |
7169 |
|
<t>Effects typically provide a certain set of effect |
7170 |
|
parameters which can be altered by the user in realtime |
7171 |
|
(e.g. depth of a reverb effect, duration of a delay effect, |
7172 |
|
dry / wet signal ratio). Those controllable effect parameters |
7173 |
|
are called "input controls". The front-end can ask for the |
7174 |
|
current informations of an effect instance's input control |
7175 |
|
by sending the following command:</t> |
7176 |
|
<t> |
7177 |
|
<list> |
7178 |
|
<t>GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-control></t> |
7179 |
|
</list> |
7180 |
|
</t> |
7181 |
|
<t>Where <effect-instance> is the numerical ID of an |
7182 |
|
effect instance as returned by the |
7183 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> |
7184 |
|
or |
7185 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7186 |
|
command and <input-control> is the index of the input |
7187 |
|
control within the numerical bounds as returned by the |
7188 |
|
"INPUT_CONTROLS" field of the |
7189 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7190 |
|
command.</t> |
7191 |
|
|
7192 |
|
<t>Possible Answers:</t> |
7193 |
|
<t> |
7194 |
|
<list> |
7195 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7196 |
|
Each answer line begins with the information |
7197 |
|
category name, followed by a colon and then a space |
7198 |
|
character <SP> and finally the info character |
7199 |
|
string to that information category. There are |
7200 |
|
information categories which are always returned, |
7201 |
|
independent of the respective effect parameter and |
7202 |
|
there are optional information categories |
7203 |
|
which are only shown for certain effect parameters. |
7204 |
|
At the moment the following categories are defined:</t> |
7205 |
|
<t> |
7206 |
|
<list> |
7207 |
|
<t>DESCRIPTION - |
7208 |
|
<list> |
7209 |
|
<t>(always returned) |
7210 |
|
human readable name of the |
7211 |
|
effect parameter, intended to be |
7212 |
|
displayed in user interfaces (note |
7213 |
|
that the character string may |
7214 |
|
contain <xref target="character_set">escape sequences</xref>)</t> |
7215 |
|
</list> |
7216 |
|
</t> |
7217 |
|
<t>VALUE - |
7218 |
|
<list> |
7219 |
|
<t> |
7220 |
|
(always returned) |
7221 |
|
current (optional dotted) |
7222 |
|
floating point value of this effect |
7223 |
|
parameter</t> |
7224 |
|
</list> |
7225 |
|
</t> |
7226 |
|
<t>RANGE_MIN - |
7227 |
|
<list> |
7228 |
|
<t> |
7229 |
|
(optionally returned) |
7230 |
|
minimum allowed value for this |
7231 |
|
effect parameter</t> |
7232 |
|
</list> |
7233 |
|
</t> |
7234 |
|
<t>RANGE_MAX - |
7235 |
|
<list> |
7236 |
|
<t> |
7237 |
|
(optionally returned) |
7238 |
|
maximum allowed value for this |
7239 |
|
effect parameter</t> |
7240 |
|
</list> |
7241 |
|
</t> |
7242 |
|
<t>POSSIBILITIES - |
7243 |
|
<list> |
7244 |
|
<t> |
7245 |
|
(optionally returned) |
7246 |
|
comma separated list of |
7247 |
|
(optional dotted) floating point |
7248 |
|
numbers, reflecting the exact set of |
7249 |
|
possible values for this effect |
7250 |
|
parameter</t> |
7251 |
|
</list> |
7252 |
|
</t> |
7253 |
|
<t>DEFAULT - |
7254 |
|
<list> |
7255 |
|
<t> |
7256 |
|
(optionally returned) |
7257 |
|
default value of this effect |
7258 |
|
parameter</t> |
7259 |
|
</list> |
7260 |
|
</t> |
7261 |
|
</list> |
7262 |
|
</t> |
7263 |
|
</list> |
7264 |
|
</t> |
7265 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7266 |
|
|
7267 |
|
<t>Example:</t> |
7268 |
|
<t> |
7269 |
|
<list> |
7270 |
|
<t>C: "GET EFFECT_INSTANCE_INPUT_CONTROL INFO 1 0"</t> |
7271 |
|
<t>S: "SYSTEM: LADSPA"</t> |
7272 |
|
<t> "DESCRIPTION: Base delay (s)"</t> |
7273 |
|
<t> "VALUE: 0.500"</t> |
7274 |
|
<t> "RANGE_MIN: 0.000"</t> |
7275 |
|
<t> "."</t> |
7276 |
|
</list> |
7277 |
|
</t> |
7278 |
|
</section> |
7279 |
|
|
7280 |
|
<section title="Altering an effect parameter" anchor="SET EFFECT_INSTANCE_INPUT_CONTROL VALUE"> |
7281 |
|
<t>The front-end can alter the current value of an effect |
7282 |
|
parameter by sending the following command:</t> |
7283 |
|
<t> |
7284 |
|
<list> |
7285 |
|
<t>SET EFFECT_INSTANCE_INPUT_CONTROL VALUE <effect-instance> <input-control> <value></t> |
7286 |
|
</list> |
7287 |
|
</t> |
7288 |
|
<t>Where <effect-instance> is the numerical ID of the |
7289 |
|
effect instance as returned by the |
7290 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7291 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7292 |
|
command, <input-control> is the index of the input |
7293 |
|
control within the numerical bounds as returned by the |
7294 |
|
"INPUT_CONTROLS" field of the |
7295 |
|
<xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref> |
7296 |
|
command and <value> is the new (optional dotted) |
7297 |
|
floating point value for this effect parameter.</t> |
7298 |
|
|
7299 |
|
<t>Possible Answers:</t> |
7300 |
|
<t> |
7301 |
|
<list> |
7302 |
|
<t>"OK" - |
7303 |
|
<list> |
7304 |
|
<t>in case the effect was altered successfully</t> |
7305 |
|
</list> |
7306 |
|
</t> |
7307 |
|
<t>"ERR:<error-code>:<error-message>" - |
7308 |
|
<list> |
7309 |
|
<t>in case it failed, providing an appropriate error code and |
7310 |
|
error message</t> |
7311 |
|
</list> |
7312 |
|
</t> |
7313 |
|
</list> |
7314 |
|
</t> |
7315 |
|
|
7316 |
|
<t>Examples:</t> |
7317 |
|
<t> |
7318 |
|
<list> |
7319 |
|
<t>C: "SET EFFECT_INSTANCE_INPUT_CONTROL VALUE 0 1 0.5"</t> |
7320 |
|
<t>S: "OK"</t> |
7321 |
|
</list> |
7322 |
|
</t> |
7323 |
|
</section> |
7324 |
|
|
7325 |
|
<section title="Retrieve amount of send effect chains" anchor="GET SEND_EFFECT_CHAINS"> |
7326 |
|
<t>The front-end can retrieve the current amount of send |
7327 |
|
effect chains of an audio output device by sending the |
7328 |
|
following command:</t> |
7329 |
|
<t> |
7330 |
|
<list> |
7331 |
|
<t>GET SEND_EFFECT_CHAINS <audio-device></t> |
7332 |
|
</list> |
7333 |
|
</t> |
7334 |
|
<t>Where <audio-device> should be replaced by the |
7335 |
|
numerical ID of the audio output device as given by the |
7336 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7337 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7338 |
|
command.</t> |
7339 |
|
|
7340 |
|
<t>Possible Answers:</t> |
7341 |
|
<t> |
7342 |
|
<list> |
7343 |
|
<t>The sampler will answer by returning the current |
7344 |
|
number of send effect chains of the supplied audio |
7345 |
|
output device.</t> |
7346 |
|
</list> |
7347 |
|
</t> |
7348 |
|
|
7349 |
|
<t>Examples:</t> |
7350 |
|
<t> |
7351 |
|
<list> |
7352 |
|
<t>C: "GET SEND_EFFECT_CHAINS 0"</t> |
7353 |
|
<t>S: "4"</t> |
7354 |
|
</list> |
7355 |
|
</t> |
7356 |
|
</section> |
7357 |
|
|
7358 |
|
<section title="Retrieve list of send effect chains" anchor="LIST SEND_EFFECT_CHAINS"> |
7359 |
|
<t>The front-end can retrieve the current list of send |
7360 |
|
effect chains of an audio output device by sending the |
7361 |
|
following command:</t> |
7362 |
|
<t> |
7363 |
|
<list> |
7364 |
|
<t>LIST SEND_EFFECT_CHAINS <audio-device></t> |
7365 |
|
</list> |
7366 |
|
</t> |
7367 |
|
<t>Where <audio-device> should be replaced by the |
7368 |
|
numerical ID of the audio output device as given by the |
7369 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7370 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7371 |
|
command.</t> |
7372 |
|
|
7373 |
|
<t>Possible Answers:</t> |
7374 |
|
<t> |
7375 |
|
<list> |
7376 |
|
<t>The sampler will answer by returning a comma |
7377 |
|
separated list with numerical IDs of send effect |
7378 |
|
chains of the supplied audio output device. |
7379 |
|
</t> |
7380 |
|
</list> |
7381 |
|
</t> |
7382 |
|
|
7383 |
|
<t>Examples:</t> |
7384 |
|
<t> |
7385 |
|
<list> |
7386 |
|
<t>C: "LIST SEND_EFFECT_CHAINS 0"</t> |
7387 |
|
<t>S: "3,4,7"</t> |
7388 |
|
</list> |
7389 |
|
</t> |
7390 |
|
</section> |
7391 |
|
|
7392 |
|
<section title="Add send effect chain" anchor="ADD SEND_EFFECT_CHAIN"> |
7393 |
|
<t>The front-end can add a send effect chain by sending the |
7394 |
|
following command:</t> |
7395 |
|
<t> |
7396 |
|
<list> |
7397 |
|
<t>ADD SEND_EFFECT_CHAIN <audio-device></t> |
7398 |
|
</list> |
7399 |
|
</t> |
7400 |
|
<t>Where <audio-device> should be replaced by the |
7401 |
|
numerical ID of the audio output device as given by the |
7402 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7403 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7404 |
|
command.</t> |
7405 |
|
|
7406 |
|
<t>Possible Answers:</t> |
7407 |
|
<t> |
7408 |
|
<list> |
7409 |
|
<t>"OK[<effect-chain>]" - |
7410 |
|
<list> |
7411 |
|
<t>in case the send effect chain was |
7412 |
|
added successfully, where |
7413 |
|
<effect-chain> is the numerical ID |
7414 |
|
of the new send effect chain</t> |
7415 |
|
</list> |
7416 |
|
</t> |
7417 |
|
<t>"ERR:<error-code>:<error-message>" - |
7418 |
|
<list> |
7419 |
|
<t>if the send effect chain could not be added</t> |
7420 |
|
</list> |
7421 |
|
</t> |
7422 |
|
</list> |
7423 |
|
</t> |
7424 |
|
|
7425 |
|
<t>Examples:</t> |
7426 |
|
<t> |
7427 |
|
<list> |
7428 |
|
<t>C: "ADD SEND_EFFECT_CHAIN 0"</t> |
7429 |
|
<t>S: "OK[2]"</t> |
7430 |
|
</list> |
7431 |
|
</t> |
7432 |
|
</section> |
7433 |
|
|
7434 |
|
<section title="Remove send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN"> |
7435 |
|
<t>The front-end can remove a send effect chain by sending |
7436 |
|
the following command:</t> |
7437 |
|
<t> |
7438 |
|
<list> |
7439 |
|
<t>REMOVE SEND_EFFECT_CHAIN <audio-device> <effect-chain></t> |
7440 |
|
</list> |
7441 |
|
</t> |
7442 |
|
<t>Where <audio-device> should be replaced by the |
7443 |
|
numerical ID of the audio output device as given by the |
7444 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7445 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7446 |
|
command and <effect-chain> by the numerical ID as |
7447 |
|
returned by the |
7448 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7449 |
|
or |
7450 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7451 |
|
command.</t> |
7452 |
|
|
7453 |
|
<t>Possible Answers:</t> |
7454 |
|
<t> |
7455 |
|
<list> |
7456 |
|
<t>"OK" - |
7457 |
|
<list> |
7458 |
|
<t>in case the send effect chain was |
7459 |
|
removed successfully</t> |
7460 |
|
</list> |
7461 |
|
</t> |
7462 |
|
<t>"ERR:<error-code>:<error-message>" - |
7463 |
|
<list> |
7464 |
|
<t>if the send effect chain could not be removed</t> |
7465 |
|
</list> |
7466 |
|
</t> |
7467 |
|
</list> |
7468 |
|
</t> |
7469 |
|
|
7470 |
|
<t>Examples:</t> |
7471 |
|
<t> |
7472 |
|
<list> |
7473 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN 0 2"</t> |
7474 |
|
<t>S: "OK"</t> |
7475 |
|
</list> |
7476 |
|
</t> |
7477 |
|
</section> |
7478 |
|
|
7479 |
|
<section title="Retrieving information about a send effect chain" anchor="GET SEND_EFFECT_CHAIN INFO"> |
7480 |
|
<t>The front-end can ask for informations of a send effect |
7481 |
|
chain by sending the following command:</t> |
7482 |
|
<t> |
7483 |
|
<list> |
7484 |
|
<t>GET SEND_EFFECT_CHAIN INFO <audio-device> <effect-chain></t> |
7485 |
|
</list> |
7486 |
|
</t> |
7487 |
|
<t>Where <audio-device> should be replaced by the |
7488 |
|
numerical ID of the audio output device as given by the |
7489 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7490 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7491 |
|
command and <effect-chain> by the numerical ID as |
7492 |
|
returned by the |
7493 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7494 |
|
or |
7495 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7496 |
|
command.</t> |
7497 |
|
|
7498 |
|
<t>Possible Answers:</t> |
7499 |
|
<t> |
7500 |
|
<list> |
7501 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
7502 |
|
Each answer line begins with the information |
7503 |
|
category name, followed by a colon and then a space |
7504 |
|
character <SP> and finally the info character |
7505 |
|
string to that information category. |
7506 |
|
At the moment the following categories are defined:</t> |
7507 |
|
<t> |
7508 |
|
<list> |
7509 |
|
<t>EFFECT_COUNT - |
7510 |
|
<list> |
7511 |
|
<t>amount of effects in this send |
7512 |
|
effect chain</t> |
7513 |
|
</list> |
7514 |
|
</t> |
7515 |
|
<t>EFFECT_SEQUENCE - |
7516 |
|
<list> |
7517 |
|
<t>comma separated list of the |
7518 |
|
numerical IDs of the effect |
7519 |
|
instances in this send effect chain, |
7520 |
|
in the order as they are procssed in |
7521 |
|
the effect chain</t> |
7522 |
|
</list> |
7523 |
|
</t> |
7524 |
|
</list> |
7525 |
|
</t> |
7526 |
|
</list> |
7527 |
|
</t> |
7528 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
7529 |
|
|
7530 |
|
<t>Example:</t> |
7531 |
|
<t> |
7532 |
|
<list> |
7533 |
|
<t>C: "GET SEND_EFFECT_CHAIN INFO 0 2"</t> |
7534 |
|
<t>S: "EFFECT_COUNT: 3"</t> |
7535 |
|
<t> "EFFECT_SEQUENCE: 31,4,7"</t> |
7536 |
|
<t> "."</t> |
7537 |
|
</list> |
7538 |
|
</t> |
7539 |
|
</section> |
7540 |
|
|
7541 |
|
<section title="Append effect instance to a send effect chain" anchor="APPEND SEND_EFFECT_CHAIN EFFECT"> |
7542 |
|
<t>The front-end can add an unused effect instance to the |
7543 |
|
end of a send effect chain by sending the following command:</t> |
7544 |
|
<t> |
7545 |
|
<list> |
7546 |
|
<t>APPEND SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <effect-instance></t> |
7547 |
|
</list> |
7548 |
|
</t> |
7549 |
|
<t>Where <audio-device> should be replaced by the |
7550 |
|
numerical ID of the audio output device as given by the |
7551 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7552 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7553 |
|
command and <effect-chain> by the numerical ID as |
7554 |
|
returned by the |
7555 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7556 |
|
or |
7557 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7558 |
|
command and <effect-instance> as returned by the |
7559 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7560 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7561 |
|
command.</t> |
7562 |
|
<t>Only unused effect instances can be added to the effect |
7563 |
|
chain. Trying to add an effect instance which is already in |
7564 |
|
use somewhere in the audio signal path of the sampler will |
7565 |
|
result in an error.</t> |
7566 |
|
|
7567 |
|
<t>Possible Answers:</t> |
7568 |
|
<t> |
7569 |
|
<list> |
7570 |
|
<t>"OK" - |
7571 |
|
<list> |
7572 |
|
<t>in case the effect instance was |
7573 |
|
added successfully to the chain</t> |
7574 |
|
</list> |
7575 |
|
</t> |
7576 |
|
<t>"ERR:<error-code>:<error-message>" - |
7577 |
|
<list> |
7578 |
|
<t>if the effect instance could not be added</t> |
7579 |
|
</list> |
7580 |
|
</t> |
7581 |
|
</list> |
7582 |
|
</t> |
7583 |
|
|
7584 |
|
<t>Examples:</t> |
7585 |
|
<t> |
7586 |
|
<list> |
7587 |
|
<t>C: "APPEND SEND_EFFECT_CHAIN EFFECT 0 2 38"</t> |
7588 |
|
<t>S: "OK"</t> |
7589 |
|
</list> |
7590 |
|
</t> |
7591 |
|
</section> |
7592 |
|
|
7593 |
|
<section title="Insert effect instance to a send effect chain" anchor="INSERT SEND_EFFECT_CHAIN EFFECT"> |
7594 |
|
<t>The front-end can add an unused effect instance to a |
7595 |
|
certain position of a send effect chain by sending the |
7596 |
|
following command:</t> |
7597 |
|
<t> |
7598 |
|
<list> |
7599 |
|
<t>INSERT SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos> <effect-instance></t> |
7600 |
|
</list> |
7601 |
|
</t> |
7602 |
|
<t>Where <audio-device> should be replaced by the |
7603 |
|
numerical ID of the audio output device as given by the |
7604 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7605 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7606 |
|
command, <effect-chain> by the numerical ID as |
7607 |
|
returned by the |
7608 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7609 |
|
or |
7610 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7611 |
|
command, <effect-instance> as returned by the |
7612 |
|
<xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref> or |
7613 |
|
<xref target="LIST EFFECT_INSTANCES">"LIST EFFECT_INSTANCES"</xref> |
7614 |
|
command and <chain-pos> the exact position of the |
7615 |
|
effect chain where the supplied effect shall be inserted |
7616 |
|
to.</t> |
7617 |
|
<t>Only unused effect instances can be added to the effect |
7618 |
|
chain. Trying to add an effect instance which is already in |
7619 |
|
use somewhere in the audio signal path of the sampler will |
7620 |
|
result in an error.</t> |
7621 |
|
|
7622 |
|
<t>Possible Answers:</t> |
7623 |
|
<t> |
7624 |
|
<list> |
7625 |
|
<t>"OK" - |
7626 |
|
<list> |
7627 |
|
<t>in case the effect instance was |
7628 |
|
added successfully to the chain</t> |
7629 |
|
</list> |
7630 |
|
</t> |
7631 |
|
<t>"ERR:<error-code>:<error-message>" - |
7632 |
|
<list> |
7633 |
|
<t>if the effect instance could not be added</t> |
7634 |
|
</list> |
7635 |
|
</t> |
7636 |
|
</list> |
7637 |
|
</t> |
7638 |
|
|
7639 |
|
<t>Examples:</t> |
7640 |
|
<t> |
7641 |
|
<list> |
7642 |
|
<t>C: "INSERT SEND_EFFECT_CHAIN EFFECT 0 2 4 38"</t> |
7643 |
|
<t>S: "OK"</t> |
7644 |
|
</list> |
7645 |
|
</t> |
7646 |
|
</section> |
7647 |
|
|
7648 |
|
<section title="Remove effect instance from send effect chain" anchor="REMOVE SEND_EFFECT_CHAIN EFFECT"> |
7649 |
|
<t>The front-end can remove an effect instance from a |
7650 |
|
certain position of a send effect chain by sending the |
7651 |
|
following command:</t> |
7652 |
|
<t> |
7653 |
|
<list> |
7654 |
|
<t>REMOVE SEND_EFFECT_CHAIN EFFECT <audio-device> <effect-chain> <chain-pos></t> |
7655 |
|
</list> |
7656 |
|
</t> |
7657 |
|
<t>Where <audio-device> should be replaced by the |
7658 |
|
numerical ID of the audio output device as given by the |
7659 |
|
<xref target="CREATE AUDIO_OUTPUT_DEVICE">"CREATE AUDIO_OUTPUT_DEVICE"</xref> |
7660 |
|
or <xref target="LIST AUDIO_OUTPUT_DEVICES">"LIST AUDIO_OUTPUT_DEVICES"</xref> |
7661 |
|
command, <effect-chain> by the numerical ID as |
7662 |
|
returned by the |
7663 |
|
<xref target="ADD SEND_EFFECT_CHAIN">"ADD SEND_EFFECT_CHAIN"</xref> |
7664 |
|
or |
7665 |
|
<xref target="LIST SEND_EFFECT_CHAINS">"LIST SEND_EFFECT_CHAINS"</xref> |
7666 |
|
command and <chain-pos> the exact position of the |
7667 |
|
effect instance to be removed from the effect chain.</t> |
7668 |
|
|
7669 |
|
<t>Possible Answers:</t> |
7670 |
|
<t> |
7671 |
|
<list> |
7672 |
|
<t>"OK" - |
7673 |
|
<list> |
7674 |
|
<t>in case the effect instance was |
7675 |
|
removed successfully</t> |
7676 |
|
</list> |
7677 |
|
</t> |
7678 |
|
<t>"ERR:<error-code>:<error-message>" - |
7679 |
|
<list> |
7680 |
|
<t>if the effect instance could not be removed</t> |
7681 |
|
</list> |
7682 |
|
</t> |
7683 |
|
</list> |
7684 |
|
</t> |
7685 |
|
|
7686 |
|
<t>Examples:</t> |
7687 |
|
<t> |
7688 |
|
<list> |
7689 |
|
<t>C: "REMOVE SEND_EFFECT_CHAIN EFFECT 0 2 4"</t> |
7690 |
|
<t>S: "OK"</t> |
7691 |
|
</list> |
7692 |
|
</t> |
7693 |
|
</section> |
7694 |
|
|
7695 |
</section> |
</section> |
7696 |
</section> |
</section> |
7697 |
|
|
7698 |
<section title="Command Syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
7699 |
<t>TODO: will soon automatically included from src/network/lscp.y, |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
7700 |
meanwhile have a look at that file to get the exact definition of |
is defined below using Backus-Naur Form (BNF as described in <xref target="RFC2234"/>) |
7701 |
the command syntax.</t> |
where applicable. |
7702 |
|
</t> |
7703 |
|
<!-- |
7704 |
|
This section is automatically generated by scripts/update_grammar.pl |
7705 |
|
from src/network/lscp.y (yacc input file). Do not modify this section |
7706 |
|
manually ! |
7707 |
|
--> |
7708 |
|
<!-- GRAMMAR_BNF_BEGIN - do NOT delete or modify this line !!! --> |
7709 |
|
|
7710 |
|
<t>input = |
7711 |
|
<list> |
7712 |
|
<t>line LF |
7713 |
|
</t> |
7714 |
|
<t>/ line CR LF |
7715 |
|
</t> |
7716 |
|
</list> |
7717 |
|
</t> |
7718 |
|
<t>line = |
7719 |
|
<list> |
7720 |
|
<t>/* epsilon (empty line ignored) */ |
7721 |
|
</t> |
7722 |
|
<t>/ comment |
7723 |
|
</t> |
7724 |
|
<t>/ command |
7725 |
|
</t> |
7726 |
|
<t>/ error |
7727 |
|
</t> |
7728 |
|
</list> |
7729 |
|
</t> |
7730 |
|
<t>comment = |
7731 |
|
<list> |
7732 |
|
<t>'#' |
7733 |
|
</t> |
7734 |
|
<t>/ comment '#' |
7735 |
|
</t> |
7736 |
|
<t>/ comment SP |
7737 |
|
</t> |
7738 |
|
<t>/ comment number |
7739 |
|
</t> |
7740 |
|
<t>/ comment string |
7741 |
|
</t> |
7742 |
|
</list> |
7743 |
|
</t> |
7744 |
|
<t>command = |
7745 |
|
<list> |
7746 |
|
<t>ADD SP add_instruction |
7747 |
|
</t> |
7748 |
|
<t>/ MAP SP map_instruction |
7749 |
|
</t> |
7750 |
|
<t>/ UNMAP SP unmap_instruction |
7751 |
|
</t> |
7752 |
|
<t>/ GET SP get_instruction |
7753 |
|
</t> |
7754 |
|
<t>/ CREATE SP create_instruction |
7755 |
|
</t> |
7756 |
|
<t>/ DESTROY SP destroy_instruction |
7757 |
|
</t> |
7758 |
|
<t>/ LIST SP list_instruction |
7759 |
|
</t> |
7760 |
|
<t>/ LOAD SP load_instruction |
7761 |
|
</t> |
7762 |
|
<t>/ REMOVE SP remove_instruction |
7763 |
|
</t> |
7764 |
|
<t>/ SET SP set_instruction |
7765 |
|
</t> |
7766 |
|
<t>/ SUBSCRIBE SP subscribe_event |
7767 |
|
</t> |
7768 |
|
<t>/ UNSUBSCRIBE SP unsubscribe_event |
7769 |
|
</t> |
7770 |
|
<t>/ RESET SP reset_instruction |
7771 |
|
</t> |
7772 |
|
<t>/ CLEAR SP clear_instruction |
7773 |
|
</t> |
7774 |
|
<t>/ FIND SP find_instruction |
7775 |
|
</t> |
7776 |
|
<t>/ MOVE SP move_instruction |
7777 |
|
</t> |
7778 |
|
<t>/ COPY SP copy_instruction |
7779 |
|
</t> |
7780 |
|
<t>/ EDIT SP edit_instruction |
7781 |
|
</t> |
7782 |
|
<t>/ FORMAT SP format_instruction |
7783 |
|
</t> |
7784 |
|
<t>/ SEND SP send_instruction |
7785 |
|
</t> |
7786 |
|
<t>/ APPEND SP append_instruction |
7787 |
|
</t> |
7788 |
|
<t>/ INSERT SP insert_instruction |
7789 |
|
</t> |
7790 |
|
<t>/ RESET |
7791 |
|
</t> |
7792 |
|
<t>/ QUIT |
7793 |
|
</t> |
7794 |
|
</list> |
7795 |
|
</t> |
7796 |
|
<t>add_instruction = |
7797 |
|
<list> |
7798 |
|
<t>CHANNEL |
7799 |
|
</t> |
7800 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
7801 |
|
</t> |
7802 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
7803 |
|
</t> |
7804 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
7805 |
|
</t> |
7806 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
7807 |
|
</t> |
7808 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
7809 |
|
</t> |
7810 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
7811 |
|
</t> |
7812 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
7813 |
|
</t> |
7814 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename |
7815 |
|
</t> |
7816 |
|
<t>/ DB_INSTRUMENTS SP db_path SP filename SP instrument_index |
7817 |
|
</t> |
7818 |
|
<t>/ MIDI_INSTRUMENT_MAP |
7819 |
|
</t> |
7820 |
|
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
7821 |
|
</t> |
7822 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index |
7823 |
|
</t> |
7824 |
|
</list> |
7825 |
|
</t> |
7826 |
|
<t>subscribe_event = |
7827 |
|
<list> |
7828 |
|
<t>AUDIO_OUTPUT_DEVICE_COUNT |
7829 |
|
</t> |
7830 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
7831 |
|
</t> |
7832 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
7833 |
|
</t> |
7834 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
7835 |
|
</t> |
7836 |
|
<t>/ CHANNEL_COUNT |
7837 |
|
</t> |
7838 |
|
<t>/ CHANNEL_MIDI |
7839 |
|
</t> |
7840 |
|
<t>/ DEVICE_MIDI |
7841 |
|
</t> |
7842 |
|
<t>/ VOICE_COUNT |
7843 |
|
</t> |
7844 |
|
<t>/ STREAM_COUNT |
7845 |
|
</t> |
7846 |
|
<t>/ BUFFER_FILL |
7847 |
|
</t> |
7848 |
|
<t>/ CHANNEL_INFO |
7849 |
|
</t> |
7850 |
|
<t>/ FX_SEND_COUNT |
7851 |
|
</t> |
7852 |
|
<t>/ FX_SEND_INFO |
7853 |
|
</t> |
7854 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
7855 |
|
</t> |
7856 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
7857 |
|
</t> |
7858 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
7859 |
|
</t> |
7860 |
|
<t>/ MIDI_INSTRUMENT_INFO |
7861 |
|
</t> |
7862 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_COUNT |
7863 |
|
</t> |
7864 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_INFO |
7865 |
|
</t> |
7866 |
|
<t>/ DB_INSTRUMENT_COUNT |
7867 |
|
</t> |
7868 |
|
<t>/ DB_INSTRUMENT_INFO |
7869 |
|
</t> |
7870 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
7871 |
|
</t> |
7872 |
|
<t>/ MISCELLANEOUS |
7873 |
|
</t> |
7874 |
|
<t>/ TOTAL_STREAM_COUNT |
7875 |
|
</t> |
7876 |
|
<t>/ TOTAL_VOICE_COUNT |
7877 |
|
</t> |
7878 |
|
<t>/ GLOBAL_INFO |
7879 |
|
</t> |
7880 |
|
</list> |
7881 |
|
</t> |
7882 |
|
<t>unsubscribe_event = |
7883 |
|
<list> |
7884 |
|
<t>AUDIO_OUTPUT_DEVICE_COUNT |
7885 |
|
</t> |
7886 |
|
<t>/ AUDIO_OUTPUT_DEVICE_INFO |
7887 |
|
</t> |
7888 |
|
<t>/ MIDI_INPUT_DEVICE_COUNT |
7889 |
|
</t> |
7890 |
|
<t>/ MIDI_INPUT_DEVICE_INFO |
7891 |
|
</t> |
7892 |
|
<t>/ CHANNEL_COUNT |
7893 |
|
</t> |
7894 |
|
<t>/ CHANNEL_MIDI |
7895 |
|
</t> |
7896 |
|
<t>/ DEVICE_MIDI |
7897 |
|
</t> |
7898 |
|
<t>/ VOICE_COUNT |
7899 |
|
</t> |
7900 |
|
<t>/ STREAM_COUNT |
7901 |
|
</t> |
7902 |
|
<t>/ BUFFER_FILL |
7903 |
|
</t> |
7904 |
|
<t>/ CHANNEL_INFO |
7905 |
|
</t> |
7906 |
|
<t>/ FX_SEND_COUNT |
7907 |
|
</t> |
7908 |
|
<t>/ FX_SEND_INFO |
7909 |
|
</t> |
7910 |
|
<t>/ MIDI_INSTRUMENT_MAP_COUNT |
7911 |
|
</t> |
7912 |
|
<t>/ MIDI_INSTRUMENT_MAP_INFO |
7913 |
|
</t> |
7914 |
|
<t>/ MIDI_INSTRUMENT_COUNT |
7915 |
|
</t> |
7916 |
|
<t>/ MIDI_INSTRUMENT_INFO |
7917 |
|
</t> |
7918 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_COUNT |
7919 |
|
</t> |
7920 |
|
<t>/ DB_INSTRUMENT_DIRECTORY_INFO |
7921 |
|
</t> |
7922 |
|
<t>/ DB_INSTRUMENT_COUNT |
7923 |
|
</t> |
7924 |
|
<t>/ DB_INSTRUMENT_INFO |
7925 |
|
</t> |
7926 |
|
<t>/ DB_INSTRUMENTS_JOB_INFO |
7927 |
|
</t> |
7928 |
|
<t>/ MISCELLANEOUS |
7929 |
|
</t> |
7930 |
|
<t>/ TOTAL_STREAM_COUNT |
7931 |
|
</t> |
7932 |
|
<t>/ TOTAL_VOICE_COUNT |
7933 |
|
</t> |
7934 |
|
<t>/ GLOBAL_INFO |
7935 |
|
</t> |
7936 |
|
</list> |
7937 |
|
</t> |
7938 |
|
<t>map_instruction = |
7939 |
|
<list> |
7940 |
|
<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 |
7941 |
|
</t> |
7942 |
|
<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 |
7943 |
|
</t> |
7944 |
|
<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 |
7945 |
|
</t> |
7946 |
|
<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 |
7947 |
|
</t> |
7948 |
|
</list> |
7949 |
|
</t> |
7950 |
|
<t>unmap_instruction = |
7951 |
|
<list> |
7952 |
|
<t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog |
7953 |
|
</t> |
7954 |
|
</list> |
7955 |
|
</t> |
7956 |
|
<t>remove_instruction = |
7957 |
|
<list> |
7958 |
|
<t>CHANNEL SP sampler_channel |
7959 |
|
</t> |
7960 |
|
<t>/ MIDI_INSTRUMENT_MAP SP midi_map |
7961 |
|
</t> |
7962 |
|
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
7963 |
|
</t> |
7964 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
7965 |
|
</t> |
7966 |
|
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
7967 |
|
</t> |
7968 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id |
7969 |
|
</t> |
7970 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
7971 |
|
</t> |
7972 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
7973 |
|
</t> |
7974 |
|
<t>/ DB_INSTRUMENT SP db_path |
7975 |
|
</t> |
7976 |
|
</list> |
7977 |
|
</t> |
7978 |
|
<t>get_instruction = |
7979 |
|
<list> |
7980 |
|
<t>AVAILABLE_ENGINES |
7981 |
|
</t> |
7982 |
|
<t>/ AVAILABLE_EFFECTS |
7983 |
|
</t> |
7984 |
|
<t>/ EFFECT_INSTANCES |
7985 |
|
</t> |
7986 |
|
<t>/ EFFECT SP INFO SP effect_index |
7987 |
|
</t> |
7988 |
|
<t>/ EFFECT_INSTANCE SP INFO SP effect_instance |
7989 |
|
</t> |
7990 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
7991 |
|
</t> |
7992 |
|
<t>/ SEND_EFFECT_CHAINS SP device_index |
7993 |
|
</t> |
7994 |
|
<t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
7995 |
|
</t> |
7996 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
7997 |
|
</t> |
7998 |
|
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
7999 |
|
</t> |
8000 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string |
8001 |
|
</t> |
8002 |
|
<t>/ MIDI_INPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
8003 |
|
</t> |
8004 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
8005 |
|
</t> |
8006 |
|
<t>/ AUDIO_OUTPUT_DRIVER SP INFO SP string |
8007 |
|
</t> |
8008 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string |
8009 |
|
</t> |
8010 |
|
<t>/ AUDIO_OUTPUT_DRIVER_PARAMETER SP INFO SP string SP string SP key_val_list |
8011 |
|
</t> |
8012 |
|
<t>/ AUDIO_OUTPUT_DEVICES |
8013 |
|
</t> |
8014 |
|
<t>/ MIDI_INPUT_DEVICES |
8015 |
|
</t> |
8016 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP INFO SP number |
8017 |
|
</t> |
8018 |
|
<t>/ MIDI_INPUT_DEVICE SP INFO SP number |
8019 |
|
</t> |
8020 |
|
<t>/ MIDI_INPUT_PORT SP INFO SP number SP number |
8021 |
|
</t> |
8022 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP INFO SP number SP number SP string |
8023 |
|
</t> |
8024 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP INFO SP number SP number |
8025 |
|
</t> |
8026 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP string |
8027 |
|
</t> |
8028 |
|
<t>/ CHANNELS |
8029 |
|
</t> |
8030 |
|
<t>/ CHANNEL SP INFO SP sampler_channel |
8031 |
|
</t> |
8032 |
|
<t>/ CHANNEL SP BUFFER_FILL SP buffer_size_type SP sampler_channel |
8033 |
|
</t> |
8034 |
|
<t>/ CHANNEL SP STREAM_COUNT SP sampler_channel |
8035 |
|
</t> |
8036 |
|
<t>/ CHANNEL SP VOICE_COUNT SP sampler_channel |
8037 |
|
</t> |
8038 |
|
<t>/ ENGINE SP INFO SP engine_name |
8039 |
|
</t> |
8040 |
|
<t>/ SERVER SP INFO |
8041 |
|
</t> |
8042 |
|
<t>/ TOTAL_STREAM_COUNT |
8043 |
|
</t> |
8044 |
|
<t>/ TOTAL_VOICE_COUNT |
8045 |
|
</t> |
8046 |
|
<t>/ TOTAL_VOICE_COUNT_MAX |
8047 |
|
</t> |
8048 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
8049 |
|
</t> |
8050 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
8051 |
|
</t> |
8052 |
|
<t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog |
8053 |
|
</t> |
8054 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
8055 |
|
</t> |
8056 |
|
<t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map |
8057 |
|
</t> |
8058 |
|
<t>/ FX_SENDS SP sampler_channel |
8059 |
|
</t> |
8060 |
|
<t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id |
8061 |
|
</t> |
8062 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
8063 |
|
</t> |
8064 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
8065 |
|
</t> |
8066 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP db_path |
8067 |
|
</t> |
8068 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
8069 |
|
</t> |
8070 |
|
<t>/ DB_INSTRUMENTS SP db_path |
8071 |
|
</t> |
8072 |
|
<t>/ DB_INSTRUMENT SP INFO SP db_path |
8073 |
|
</t> |
8074 |
|
<t>/ DB_INSTRUMENTS_JOB SP INFO SP number |
8075 |
|
</t> |
8076 |
|
<t>/ VOLUME |
8077 |
|
</t> |
8078 |
|
<t>/ VOICES |
8079 |
|
</t> |
8080 |
|
<t>/ STREAMS |
8081 |
|
</t> |
8082 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8083 |
|
</t> |
8084 |
|
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
8085 |
|
</t> |
8086 |
|
</list> |
8087 |
|
</t> |
8088 |
|
<t>set_instruction = |
8089 |
|
<list> |
8090 |
|
<t>AUDIO_OUTPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
8091 |
|
</t> |
8092 |
|
<t>/ AUDIO_OUTPUT_CHANNEL_PARAMETER SP number SP number SP string '=' param_val_list |
8093 |
|
</t> |
8094 |
|
<t>/ MIDI_INPUT_DEVICE_PARAMETER SP number SP string '=' param_val_list |
8095 |
|
</t> |
8096 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' NONE |
8097 |
|
</t> |
8098 |
|
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
8099 |
|
</t> |
8100 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
8101 |
|
</t> |
8102 |
|
<t>/ CHANNEL SP set_chan_instruction |
8103 |
|
</t> |
8104 |
|
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
8105 |
|
</t> |
8106 |
|
<t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name |
8107 |
|
</t> |
8108 |
|
<t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index |
8109 |
|
</t> |
8110 |
|
<t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl |
8111 |
|
</t> |
8112 |
|
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
8113 |
|
</t> |
8114 |
|
<t>/ FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
8115 |
|
</t> |
8116 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
8117 |
|
</t> |
8118 |
|
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
8119 |
|
</t> |
8120 |
|
<t>/ DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped |
8121 |
|
</t> |
8122 |
|
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
8123 |
|
</t> |
8124 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
8125 |
|
</t> |
8126 |
|
<t>/ ECHO SP boolean |
8127 |
|
</t> |
8128 |
|
<t>/ VOLUME SP volume_value |
8129 |
|
</t> |
8130 |
|
<t>/ VOICES SP number |
8131 |
|
</t> |
8132 |
|
<t>/ STREAMS SP number |
8133 |
|
</t> |
8134 |
|
</list> |
8135 |
|
</t> |
8136 |
|
<t>create_instruction = |
8137 |
|
<list> |
8138 |
|
<t>AUDIO_OUTPUT_DEVICE SP string SP key_val_list |
8139 |
|
</t> |
8140 |
|
<t>/ AUDIO_OUTPUT_DEVICE SP string |
8141 |
|
</t> |
8142 |
|
<t>/ MIDI_INPUT_DEVICE SP string SP key_val_list |
8143 |
|
</t> |
8144 |
|
<t>/ MIDI_INPUT_DEVICE SP string |
8145 |
|
</t> |
8146 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl |
8147 |
|
</t> |
8148 |
|
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
8149 |
|
</t> |
8150 |
|
<t>/ EFFECT_INSTANCE SP effect_index |
8151 |
|
</t> |
8152 |
|
<t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
8153 |
|
</t> |
8154 |
|
</list> |
8155 |
|
</t> |
8156 |
|
<t>reset_instruction = |
8157 |
|
<list> |
8158 |
|
<t>CHANNEL SP sampler_channel |
8159 |
|
</t> |
8160 |
|
</list> |
8161 |
|
</t> |
8162 |
|
<t>clear_instruction = |
8163 |
|
<list> |
8164 |
|
<t>MIDI_INSTRUMENTS SP midi_map |
8165 |
|
</t> |
8166 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
8167 |
|
</t> |
8168 |
|
</list> |
8169 |
|
</t> |
8170 |
|
<t>find_instruction = |
8171 |
|
<list> |
8172 |
|
<t>DB_INSTRUMENTS SP NON_RECURSIVE SP db_path SP query_val_list |
8173 |
|
</t> |
8174 |
|
<t>/ DB_INSTRUMENTS SP db_path SP query_val_list |
8175 |
|
</t> |
8176 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP db_path SP query_val_list |
8177 |
|
</t> |
8178 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
8179 |
|
</t> |
8180 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
8181 |
|
</t> |
8182 |
|
</list> |
8183 |
|
</t> |
8184 |
|
<t>move_instruction = |
8185 |
|
<list> |
8186 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
8187 |
|
</t> |
8188 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
8189 |
|
</t> |
8190 |
|
</list> |
8191 |
|
</t> |
8192 |
|
<t>copy_instruction = |
8193 |
|
<list> |
8194 |
|
<t>DB_INSTRUMENT_DIRECTORY SP db_path SP db_path |
8195 |
|
</t> |
8196 |
|
<t>/ DB_INSTRUMENT SP db_path SP db_path |
8197 |
|
</t> |
8198 |
|
</list> |
8199 |
|
</t> |
8200 |
|
<t>destroy_instruction = |
8201 |
|
<list> |
8202 |
|
<t>AUDIO_OUTPUT_DEVICE SP number |
8203 |
|
</t> |
8204 |
|
<t>/ MIDI_INPUT_DEVICE SP number |
8205 |
|
</t> |
8206 |
|
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
8207 |
|
</t> |
8208 |
|
<t>/ EFFECT_INSTANCE SP number |
8209 |
|
</t> |
8210 |
|
</list> |
8211 |
|
</t> |
8212 |
|
<t>load_instruction = |
8213 |
|
<list> |
8214 |
|
<t>INSTRUMENT SP load_instr_args |
8215 |
|
</t> |
8216 |
|
<t>/ ENGINE SP load_engine_args |
8217 |
|
</t> |
8218 |
|
</list> |
8219 |
|
</t> |
8220 |
|
<t>append_instruction = |
8221 |
|
<list> |
8222 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
8223 |
|
</t> |
8224 |
|
</list> |
8225 |
|
</t> |
8226 |
|
<t>insert_instruction = |
8227 |
|
<list> |
8228 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
8229 |
|
</t> |
8230 |
|
</list> |
8231 |
|
</t> |
8232 |
|
<t>set_chan_instruction = |
8233 |
|
<list> |
8234 |
|
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
8235 |
|
</t> |
8236 |
|
<t>/ AUDIO_OUTPUT_CHANNEL SP sampler_channel SP audio_channel_index SP audio_channel_index |
8237 |
|
</t> |
8238 |
|
<t>/ AUDIO_OUTPUT_TYPE SP sampler_channel SP audio_output_type_name |
8239 |
|
</t> |
8240 |
|
<t>/ MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index SP midi_input_channel_index |
8241 |
|
</t> |
8242 |
|
<t>/ MIDI_INPUT_DEVICE SP sampler_channel SP device_index |
8243 |
|
</t> |
8244 |
|
<t>/ MIDI_INPUT_PORT SP sampler_channel SP midi_input_port_index |
8245 |
|
</t> |
8246 |
|
<t>/ MIDI_INPUT_CHANNEL SP sampler_channel SP midi_input_channel_index |
8247 |
|
</t> |
8248 |
|
<t>/ MIDI_INPUT_TYPE SP sampler_channel SP midi_input_type_name |
8249 |
|
</t> |
8250 |
|
<t>/ VOLUME SP sampler_channel SP volume_value |
8251 |
|
</t> |
8252 |
|
<t>/ MUTE SP sampler_channel SP boolean |
8253 |
|
</t> |
8254 |
|
<t>/ SOLO SP sampler_channel SP boolean |
8255 |
|
</t> |
8256 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map |
8257 |
|
</t> |
8258 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE |
8259 |
|
</t> |
8260 |
|
<t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT |
8261 |
|
</t> |
8262 |
|
</list> |
8263 |
|
</t> |
8264 |
|
<t>edit_instruction = |
8265 |
|
<list> |
8266 |
|
<t>CHANNEL SP INSTRUMENT SP sampler_channel |
8267 |
|
</t> |
8268 |
|
</list> |
8269 |
|
</t> |
8270 |
|
<t>format_instruction = |
8271 |
|
<list> |
8272 |
|
<t>INSTRUMENTS_DB |
8273 |
|
</t> |
8274 |
|
</list> |
8275 |
|
</t> |
8276 |
|
<t>modal_arg = |
8277 |
|
<list> |
8278 |
|
<t>/* epsilon (empty argument) */ |
8279 |
|
</t> |
8280 |
|
<t>/ NON_MODAL SP |
8281 |
|
</t> |
8282 |
|
</list> |
8283 |
|
</t> |
8284 |
|
<t>key_val_list = |
8285 |
|
<list> |
8286 |
|
<t>string '=' param_val_list |
8287 |
|
</t> |
8288 |
|
<t>/ key_val_list SP string '=' param_val_list |
8289 |
|
</t> |
8290 |
|
</list> |
8291 |
|
</t> |
8292 |
|
<t>buffer_size_type = |
8293 |
|
<list> |
8294 |
|
<t>BYTES |
8295 |
|
</t> |
8296 |
|
<t>/ PERCENTAGE |
8297 |
|
</t> |
8298 |
|
</list> |
8299 |
|
</t> |
8300 |
|
<t>list_instruction = |
8301 |
|
<list> |
8302 |
|
<t>AUDIO_OUTPUT_DEVICES |
8303 |
|
</t> |
8304 |
|
<t>/ MIDI_INPUT_DEVICES |
8305 |
|
</t> |
8306 |
|
<t>/ CHANNELS |
8307 |
|
</t> |
8308 |
|
<t>/ AVAILABLE_ENGINES |
8309 |
|
</t> |
8310 |
|
<t>/ AVAILABLE_EFFECTS |
8311 |
|
</t> |
8312 |
|
<t>/ EFFECT_INSTANCES |
8313 |
|
</t> |
8314 |
|
<t>/ SEND_EFFECT_CHAINS SP number |
8315 |
|
</t> |
8316 |
|
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
8317 |
|
</t> |
8318 |
|
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
8319 |
|
</t> |
8320 |
|
<t>/ MIDI_INSTRUMENTS SP midi_map |
8321 |
|
</t> |
8322 |
|
<t>/ MIDI_INSTRUMENTS SP ALL |
8323 |
|
</t> |
8324 |
|
<t>/ MIDI_INSTRUMENT_MAPS |
8325 |
|
</t> |
8326 |
|
<t>/ FX_SENDS SP sampler_channel |
8327 |
|
</t> |
8328 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path |
8329 |
|
</t> |
8330 |
|
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path |
8331 |
|
</t> |
8332 |
|
<t>/ DB_INSTRUMENTS SP RECURSIVE SP db_path |
8333 |
|
</t> |
8334 |
|
<t>/ DB_INSTRUMENTS SP db_path |
8335 |
|
</t> |
8336 |
|
<t>/ FILE SP INSTRUMENTS SP filename |
8337 |
|
</t> |
8338 |
|
</list> |
8339 |
|
</t> |
8340 |
|
<t>send_instruction = |
8341 |
|
<list> |
8342 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
8343 |
|
</t> |
8344 |
|
</list> |
8345 |
|
</t> |
8346 |
|
<t>load_instr_args = |
8347 |
|
<list> |
8348 |
|
<t>filename SP instrument_index SP sampler_channel |
8349 |
|
</t> |
8350 |
|
<t>/ NON_MODAL SP filename SP instrument_index SP sampler_channel |
8351 |
|
</t> |
8352 |
|
</list> |
8353 |
|
</t> |
8354 |
|
<t>load_engine_args = |
8355 |
|
<list> |
8356 |
|
<t>engine_name SP sampler_channel |
8357 |
|
</t> |
8358 |
|
</list> |
8359 |
|
</t> |
8360 |
|
<t>instr_load_mode = |
8361 |
|
<list> |
8362 |
|
<t>ON_DEMAND |
8363 |
|
</t> |
8364 |
|
<t>/ ON_DEMAND_HOLD |
8365 |
|
</t> |
8366 |
|
<t>/ PERSISTENT |
8367 |
|
</t> |
8368 |
|
</list> |
8369 |
|
</t> |
8370 |
|
<t>effect_instance = |
8371 |
|
<list> |
8372 |
|
<t>number |
8373 |
|
</t> |
8374 |
|
</list> |
8375 |
|
</t> |
8376 |
|
<t>device_index = |
8377 |
|
<list> |
8378 |
|
<t>number |
8379 |
|
</t> |
8380 |
|
</list> |
8381 |
|
</t> |
8382 |
|
<t>audio_channel_index = |
8383 |
|
<list> |
8384 |
|
<t>number |
8385 |
|
</t> |
8386 |
|
</list> |
8387 |
|
</t> |
8388 |
|
<t>audio_output_type_name = |
8389 |
|
<list> |
8390 |
|
<t>string |
8391 |
|
</t> |
8392 |
|
</list> |
8393 |
|
</t> |
8394 |
|
<t>midi_input_port_index = |
8395 |
|
<list> |
8396 |
|
<t>number |
8397 |
|
</t> |
8398 |
|
</list> |
8399 |
|
</t> |
8400 |
|
<t>midi_input_channel_index = |
8401 |
|
<list> |
8402 |
|
<t>number |
8403 |
|
</t> |
8404 |
|
<t>/ ALL |
8405 |
|
</t> |
8406 |
|
</list> |
8407 |
|
</t> |
8408 |
|
<t>midi_input_type_name = |
8409 |
|
<list> |
8410 |
|
<t>string |
8411 |
|
</t> |
8412 |
|
</list> |
8413 |
|
</t> |
8414 |
|
<t>midi_map = |
8415 |
|
<list> |
8416 |
|
<t>number |
8417 |
|
</t> |
8418 |
|
</list> |
8419 |
|
</t> |
8420 |
|
<t>midi_bank = |
8421 |
|
<list> |
8422 |
|
<t>number |
8423 |
|
</t> |
8424 |
|
</list> |
8425 |
|
</t> |
8426 |
|
<t>midi_prog = |
8427 |
|
<list> |
8428 |
|
<t>number |
8429 |
|
</t> |
8430 |
|
</list> |
8431 |
|
</t> |
8432 |
|
<t>midi_ctrl = |
8433 |
|
<list> |
8434 |
|
<t>number |
8435 |
|
</t> |
8436 |
|
</list> |
8437 |
|
</t> |
8438 |
|
<t>volume_value = |
8439 |
|
<list> |
8440 |
|
<t>dotnum |
8441 |
|
</t> |
8442 |
|
<t>/ number |
8443 |
|
</t> |
8444 |
|
</list> |
8445 |
|
</t> |
8446 |
|
<t>control_value = |
8447 |
|
<list> |
8448 |
|
<t>real |
8449 |
|
</t> |
8450 |
|
</list> |
8451 |
|
</t> |
8452 |
|
<t>sampler_channel = |
8453 |
|
<list> |
8454 |
|
<t>number |
8455 |
|
</t> |
8456 |
|
</list> |
8457 |
|
</t> |
8458 |
|
<t>instrument_index = |
8459 |
|
<list> |
8460 |
|
<t>number |
8461 |
|
</t> |
8462 |
|
</list> |
8463 |
|
</t> |
8464 |
|
<t>fx_send_id = |
8465 |
|
<list> |
8466 |
|
<t>number |
8467 |
|
</t> |
8468 |
|
</list> |
8469 |
|
</t> |
8470 |
|
<t>engine_name = |
8471 |
|
<list> |
8472 |
|
<t>string |
8473 |
|
</t> |
8474 |
|
</list> |
8475 |
|
</t> |
8476 |
|
<t>filename = |
8477 |
|
<list> |
8478 |
|
<t>path |
8479 |
|
</t> |
8480 |
|
</list> |
8481 |
|
</t> |
8482 |
|
<t>db_path = |
8483 |
|
<list> |
8484 |
|
<t>path |
8485 |
|
</t> |
8486 |
|
</list> |
8487 |
|
</t> |
8488 |
|
<t>map_name = |
8489 |
|
<list> |
8490 |
|
<t>stringval_escaped |
8491 |
|
</t> |
8492 |
|
</list> |
8493 |
|
</t> |
8494 |
|
<t>entry_name = |
8495 |
|
<list> |
8496 |
|
<t>stringval_escaped |
8497 |
|
</t> |
8498 |
|
</list> |
8499 |
|
</t> |
8500 |
|
<t>fx_send_name = |
8501 |
|
<list> |
8502 |
|
<t>stringval_escaped |
8503 |
|
</t> |
8504 |
|
</list> |
8505 |
|
</t> |
8506 |
|
<t>effect_name = |
8507 |
|
<list> |
8508 |
|
<t>stringval_escaped |
8509 |
|
</t> |
8510 |
|
</list> |
8511 |
|
</t> |
8512 |
|
<t>effect_index = |
8513 |
|
<list> |
8514 |
|
<t>number |
8515 |
|
</t> |
8516 |
|
</list> |
8517 |
|
</t> |
8518 |
|
<t>effect_chain = |
8519 |
|
<list> |
8520 |
|
<t>number |
8521 |
|
</t> |
8522 |
|
</list> |
8523 |
|
</t> |
8524 |
|
<t>chain_pos = |
8525 |
|
<list> |
8526 |
|
<t>number |
8527 |
|
</t> |
8528 |
|
</list> |
8529 |
|
</t> |
8530 |
|
<t>input_control = |
8531 |
|
<list> |
8532 |
|
<t>number |
8533 |
|
</t> |
8534 |
|
</list> |
8535 |
|
</t> |
8536 |
|
<t>param_val_list = |
8537 |
|
<list> |
8538 |
|
<t>param_val |
8539 |
|
</t> |
8540 |
|
<t>/ param_val_list','param_val |
8541 |
|
</t> |
8542 |
|
</list> |
8543 |
|
</t> |
8544 |
|
|
8545 |
|
<t>param_val = |
8546 |
|
<list> |
8547 |
|
<t>string |
8548 |
|
</t> |
8549 |
|
<t>/ stringval |
8550 |
|
</t> |
8551 |
|
<t>/ number |
8552 |
|
</t> |
8553 |
|
<t>/ dotnum |
8554 |
|
</t> |
8555 |
|
</list> |
8556 |
|
</t> |
8557 |
|
<t>query_val_list = |
8558 |
|
<list> |
8559 |
|
<t>string '=' query_val |
8560 |
|
</t> |
8561 |
|
<t>/ query_val_list SP string '=' query_val |
8562 |
|
</t> |
8563 |
|
</list> |
8564 |
|
</t> |
8565 |
|
<t>query_val = |
8566 |
|
<list> |
8567 |
|
<t>text_escaped |
8568 |
|
</t> |
8569 |
|
<t>/ stringval_escaped |
8570 |
|
</t> |
8571 |
|
</list> |
8572 |
|
</t> |
8573 |
|
<t>scan_mode = |
8574 |
|
<list> |
8575 |
|
<t>RECURSIVE |
8576 |
|
</t> |
8577 |
|
<t>/ NON_RECURSIVE |
8578 |
|
</t> |
8579 |
|
<t>/ FLAT |
8580 |
|
</t> |
8581 |
|
</list> |
8582 |
|
</t> |
8583 |
|
<t>effect_system = |
8584 |
|
<list> |
8585 |
|
<t>string |
8586 |
|
</t> |
8587 |
|
</list> |
8588 |
|
</t> |
8589 |
|
<t>module = |
8590 |
|
<list> |
8591 |
|
<t>filename |
8592 |
|
</t> |
8593 |
|
</list> |
8594 |
|
</t> |
8595 |
|
|
8596 |
|
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
8597 |
|
|
8598 |
|
<section title="Character Set and Escape Sequences" anchor="character_set"> |
8599 |
|
<t>Older versions of this protocol up to and including v1.1 only |
8600 |
|
supported the standard ASCII character set (ASCII code 0 - 127) |
8601 |
|
<xref target="RFC20"/>, all younger versions of this protocol |
8602 |
|
however support the Extended ASCII character set (ASCII code |
8603 |
|
0 - 255). The same group of younger protocols also support |
8604 |
|
escape sequences, but only for certain, explicitly declared |
8605 |
|
parts of the protocol. The supported escape sequences are |
8606 |
|
defined as follows:</t> |
8607 |
|
<texttable> |
8608 |
|
<ttcol>ASCII Character Sequence</ttcol> |
8609 |
|
<ttcol>Translated into (Name)</ttcol> |
8610 |
|
<c>\n</c> <c>new line</c> |
8611 |
|
<c>\r</c> <c>carriage return</c> |
8612 |
|
<c>\f</c> <c>form feed</c> |
8613 |
|
<c>\t</c> <c>horizontal tab</c> |
8614 |
|
<c>\v</c> <c>vertical tab</c> |
8615 |
|
<c>\'</c> <c>apostrophe</c> |
8616 |
|
<c>\"</c> <c>quotation mark</c> |
8617 |
|
<c>\\</c> <c>backslash</c> |
8618 |
|
<c>\OOO</c> <c>three digit octal ASCII code of the character</c> |
8619 |
|
<c>\xHH</c> <c>two digit hex ASCII code of the character</c> |
8620 |
|
</texttable> |
8621 |
|
<t>Notice: due to the transition of certain parts of the |
8622 |
|
protocol which now support escape sequences, a slight backward |
8623 |
|
incompatibility to protocols version v1.1 and younger has been |
8624 |
|
introduced. The only difference is that in parts of the protocol |
8625 |
|
where escape characters are now supported, a backslash characters |
8626 |
|
MUST be escaped as well (that is as double backslash), whereas |
8627 |
|
in the old versions a single backslash was sufficient.</t> |
8628 |
|
|
8629 |
|
<t>The following LSCP commands support escape sequences as part |
8630 |
|
of their filename / path based arguments and / or may contain |
8631 |
|
a filename / path with escape sequences in their response: |
8632 |
|
<list> |
8633 |
|
<t><xref target="LOAD INSTRUMENT">"LOAD INSTRUMENT"</xref></t> |
8634 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
8635 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
8636 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
8637 |
|
<t><xref target="ADD DB_INSTRUMENT_DIRECTORY">"ADD DB_INSTRUMENT_DIRECTORY"</xref></t> |
8638 |
|
<t><xref target="ADD DB_INSTRUMENTS">"ADD DB_INSTRUMENTS"</xref></t> |
8639 |
|
<t><xref target="REMOVE DB_INSTRUMENT_DIRECTORY">"REMOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
8640 |
|
<t><xref target="REMOVE DB_INSTRUMENT">"REMOVE DB_INSTRUMENT"</xref></t> |
8641 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORIES">"GET DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8642 |
|
<t><xref target="LIST DB_INSTRUMENT_DIRECTORIES">"LIST DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8643 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
8644 |
|
<t><xref target="GET DB_INSTRUMENTS">"GET DB_INSTRUMENTS"</xref></t> |
8645 |
|
<t><xref target="LIST DB_INSTRUMENTS">"LIST DB_INSTRUMENTS"</xref></t> |
8646 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
8647 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
8648 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
8649 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
8650 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
8651 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
8652 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8653 |
|
<t><xref target="MOVE DB_INSTRUMENT">"MOVE DB_INSTRUMENT"</xref></t> |
8654 |
|
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
8655 |
|
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
8656 |
|
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
8657 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
8658 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
8659 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
8660 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
8661 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
8662 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8663 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8664 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8665 |
|
</list> |
8666 |
|
Note that the forward slash character ('/') has a special meaning in |
8667 |
|
filename / path based arguments: it acts as separator of the nodes in |
8668 |
|
the path, thus if a directory- or filename includes a forward slash |
8669 |
|
(not intended as path node separator), you MUST escape that slash |
8670 |
|
either with the respective hex escape sequence ("\x2f") or with the |
8671 |
|
respective octal escape sequence ("\057"). |
8672 |
|
</t> |
8673 |
|
|
8674 |
|
<t> |
8675 |
|
Note for Windows: file path arguments in LSCP are expected |
8676 |
|
to use forward slashes as directory node separator similar |
8677 |
|
to Unix based operating systems. In contrast to Unix however |
8678 |
|
a Windows typical drive character is expected to be |
8679 |
|
prefixed to the path. That is an original Windows file path |
8680 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
8681 |
|
"D:/Sounds/My.gig". |
8682 |
|
</t> |
8683 |
|
|
8684 |
|
<t> |
8685 |
|
The following LSCP commands even support escape sequences as |
8686 |
|
part of at least one of their text-based arguments (i.e. entity name, |
8687 |
|
description) and / or may contain escape sequences in at least one of |
8688 |
|
their text-based fields in their response: |
8689 |
|
<list> |
8690 |
|
<t><xref target="GET SERVER INFO">"GET SERVER INFO"</xref></t> |
8691 |
|
<t><xref target="GET ENGINE INFO">"GET ENGINE INFO"</xref></t> |
8692 |
|
<t><xref target="GET CHANNEL INFO">"GET CHANNEL INFO"</xref></t> |
8693 |
|
<t><xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref></t> |
8694 |
|
<t><xref target="GET FX_SEND INFO">"GET FX_SEND INFO"</xref></t> |
8695 |
|
<t><xref target="SET FX_SEND NAME">"SET FX_SEND NAME"</xref></t> |
8696 |
|
<t><xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref></t> |
8697 |
|
<t><xref target="GET MIDI_INSTRUMENT_MAP INFO">"GET MIDI_INSTRUMENT_MAP INFO"</xref></t> |
8698 |
|
<t><xref target="ADD MIDI_INSTRUMENT_MAP">"ADD MIDI_INSTRUMENT_MAP"</xref></t> |
8699 |
|
<t><xref target="MAP MIDI_INSTRUMENT">"MAP MIDI_INSTRUMENT"</xref></t> |
8700 |
|
<t><xref target="SET MIDI_INSTRUMENT_MAP NAME">"SET MIDI_INSTRUMENT_MAP NAME"</xref></t> |
8701 |
|
<t><xref target="GET DB_INSTRUMENT_DIRECTORY INFO">"GET DB_INSTRUMENT_DIRECTORY INFO"</xref></t> |
8702 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY NAME">"SET DB_INSTRUMENT_DIRECTORY NAME"</xref></t> |
8703 |
|
<t><xref target="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">"SET DB_INSTRUMENT_DIRECTORY DESCRIPTION"</xref></t> |
8704 |
|
<t><xref target="FIND DB_INSTRUMENT_DIRECTORIES">"FIND DB_INSTRUMENT_DIRECTORIES"</xref></t> |
8705 |
|
<t><xref target="GET DB_INSTRUMENT INFO">"GET DB_INSTRUMENT INFO"</xref></t> |
8706 |
|
<t><xref target="SET DB_INSTRUMENT NAME">"SET DB_INSTRUMENT NAME"</xref></t> |
8707 |
|
<t><xref target="SET DB_INSTRUMENT DESCRIPTION">"SET DB_INSTRUMENT DESCRIPTION"</xref></t> |
8708 |
|
<t><xref target="FIND DB_INSTRUMENTS">"FIND DB_INSTRUMENTS"</xref></t> |
8709 |
|
<t><xref target="GET EFFECT INFO">"GET EFFECT INFO"</xref></t> |
8710 |
|
<t><xref target="GET EFFECT_INSTANCE INFO">"GET EFFECT_INSTANCE INFO"</xref></t> |
8711 |
|
<t><xref target="CREATE EFFECT_INSTANCE">"CREATE EFFECT_INSTANCE"</xref></t> |
8712 |
|
</list> |
8713 |
|
Please note that these lists are manually maintained. If you |
8714 |
|
find a command that also supports escape sequences we forgot to |
8715 |
|
mention here, please report it! |
8716 |
|
</t> |
8717 |
|
</section> |
8718 |
</section> |
</section> |
8719 |
|
|
8720 |
<section title="Events"> |
<section title="Events" anchor="events"> |
8721 |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
<t>This chapter will describe all currently defined events supported by LinuxSampler.</t> |
8722 |
|
|
8723 |
<section title="Number of sampler channels changed"> |
<section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT"> |
8724 |
|
<t>Client may want to be notified when the total number of audio output devices on the |
8725 |
|
back-end changes by issuing the following command:</t> |
8726 |
|
<t> |
8727 |
|
<list> |
8728 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t> |
8729 |
|
</list> |
8730 |
|
</t> |
8731 |
|
<t>Server will start sending the following notification messages:</t> |
8732 |
|
<t> |
8733 |
|
<list> |
8734 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:<devices>"</t> |
8735 |
|
</list> |
8736 |
|
</t> |
8737 |
|
<t>where <devices> will be replaced by the new number |
8738 |
|
of audio output devices.</t> |
8739 |
|
</section> |
8740 |
|
|
8741 |
|
<section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO"> |
8742 |
|
<t>Client may want to be notified when changes were made to audio output devices on the |
8743 |
|
back-end by issuing the following command:</t> |
8744 |
|
<t> |
8745 |
|
<list> |
8746 |
|
<t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t> |
8747 |
|
</list> |
8748 |
|
</t> |
8749 |
|
<t>Server will start sending the following notification messages:</t> |
8750 |
|
<t> |
8751 |
|
<list> |
8752 |
|
<t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:<device-id>"</t> |
8753 |
|
</list> |
8754 |
|
</t> |
8755 |
|
<t>where <device-id> will be replaced by the numerical ID of the audio output device, |
8756 |
|
which settings has been changed. The front-end will have to send |
8757 |
|
the respective command to actually get the audio output device info. Because these messages |
8758 |
|
will be triggered by LSCP commands issued by other clients rather than real |
8759 |
|
time events happening on the server, it is believed that an empty notification |
8760 |
|
message is sufficient here.</t> |
8761 |
|
</section> |
8762 |
|
|
8763 |
|
<section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT"> |
8764 |
|
<t>Client may want to be notified when the total number of MIDI input devices on the |
8765 |
|
back-end changes by issuing the following command:</t> |
8766 |
|
<t> |
8767 |
|
<list> |
8768 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t> |
8769 |
|
</list> |
8770 |
|
</t> |
8771 |
|
<t>Server will start sending the following notification messages:</t> |
8772 |
|
<t> |
8773 |
|
<list> |
8774 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:<devices>"</t> |
8775 |
|
</list> |
8776 |
|
</t> |
8777 |
|
<t>where <devices> will be replaced by the new number |
8778 |
|
of MIDI input devices.</t> |
8779 |
|
</section> |
8780 |
|
|
8781 |
|
<section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO"> |
8782 |
|
<t>Client may want to be notified when changes were made to MIDI input devices on the |
8783 |
|
back-end by issuing the following command:</t> |
8784 |
|
<t> |
8785 |
|
<list> |
8786 |
|
<t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t> |
8787 |
|
</list> |
8788 |
|
</t> |
8789 |
|
<t>Server will start sending the following notification messages:</t> |
8790 |
|
<t> |
8791 |
|
<list> |
8792 |
|
<t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:<device-id>"</t> |
8793 |
|
</list> |
8794 |
|
</t> |
8795 |
|
<t>where <device-id> will be replaced by the numerical ID of the MIDI input device, |
8796 |
|
which settings has been changed. The front-end will have to send |
8797 |
|
the respective command to actually get the MIDI input device info. Because these messages |
8798 |
|
will be triggered by LSCP commands issued by other clients rather than real |
8799 |
|
time events happening on the server, it is believed that an empty notification |
8800 |
|
message is sufficient here.</t> |
8801 |
|
</section> |
8802 |
|
|
8803 |
|
<section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT"> |
8804 |
<t>Client may want to be notified when the total number of channels on the |
<t>Client may want to be notified when the total number of channels on the |
8805 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
8806 |
<t> |
<t> |
8807 |
<list> |
<list> |
8808 |
<t>SUBSCRIBE CHANNELS</t> |
<t>SUBSCRIBE CHANNEL_COUNT</t> |
8809 |
</list> |
</list> |
8810 |
</t> |
</t> |
8811 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
8812 |
<t> |
<t> |
8813 |
<list> |
<list> |
8814 |
<t>"NOTIFY:CHANNELS:<channels>"</t> |
<t>"NOTIFY:CHANNEL_COUNT:<channels>"</t> |
8815 |
</list> |
</list> |
8816 |
</t> |
</t> |
8817 |
<t>where <channels> will be replaced by the new number |
<t>where <channels> will be replaced by the new number |
8818 |
of sampler channels.</t> |
of sampler channels.</t> |
8819 |
</section> |
</section> |
8820 |
|
|
8821 |
<section title="Number of active voices changed"> |
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
8822 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
8823 |
|
back-end side, by issuing the following command:</t> |
8824 |
|
<t> |
8825 |
|
<list> |
8826 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
8827 |
|
</list> |
8828 |
|
</t> |
8829 |
|
<t>Server will start sending one of the the following notification messages:</t> |
8830 |
|
<t> |
8831 |
|
<list> |
8832 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
8833 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
8834 |
|
</list> |
8835 |
|
</t> |
8836 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
8837 |
|
data arrived. <note> and <velocity> are integer values in the range between |
8838 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
8839 |
|
</t> |
8840 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
8841 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
8842 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
8843 |
|
thread unaffected by this feature.</t> |
8844 |
|
</section> |
8845 |
|
|
8846 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
8847 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
8848 |
|
<t> |
8849 |
|
<list> |
8850 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
8851 |
|
</list> |
8852 |
|
</t> |
8853 |
|
<t>Server will start sending one of the the following notification messages:</t> |
8854 |
|
<t> |
8855 |
|
<list> |
8856 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
8857 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
8858 |
|
</list> |
8859 |
|
</t> |
8860 |
|
<t>where <device-id> <port-id> will be replaced |
8861 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
8862 |
|
data arrived. <note> and <velocity> are integer values in the range between |
8863 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
8864 |
|
</t> |
8865 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
8866 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
8867 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
8868 |
|
thread unaffected by this feature.</t> |
8869 |
|
</section> |
8870 |
|
|
8871 |
|
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
8872 |
<t>Client may want to be notified when the number of voices on the |
<t>Client may want to be notified when the number of voices on the |
8873 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
8874 |
<t> |
<t> |
8879 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
8880 |
<t> |
<t> |
8881 |
<list> |
<list> |
8882 |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>></t> |
<t>"NOTIFY:VOICE_COUNT:<sampler-channel> <voices>"</t> |
8883 |
</list> |
</list> |
8884 |
</t> |
</t> |
8885 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
8886 |
voice count change occurred and <voices>> by the new number of |
voice count change occurred and <voices> by the new number of |
8887 |
active voices on that channel.</t> |
active voices on that channel.</t> |
8888 |
</section> |
</section> |
8889 |
|
|
8890 |
<section title="Number of active disk streams changed"> |
<section title="Number of active disk streams changed" anchor="SUBSCRIBE STREAM_COUNT"> |
8891 |
<t>Client may want to be notified when the number of streams on the back-end |
<t>Client may want to be notified when the number of streams on the back-end |
8892 |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
changes by issuing the following command: SUBSCRIBE STREAM_COUNT</t> |
8893 |
<t> |
<t> |
8906 |
active disk streams on that channel.</t> |
active disk streams on that channel.</t> |
8907 |
</section> |
</section> |
8908 |
|
|
8909 |
<section title="Disk stream buffer fill state changed"> |
<section title="Disk stream buffer fill state changed" anchor="SUBSCRIBE BUFFER_FILL"> |
8910 |
<t>Client may want to be notified when the number of streams on the back-end |
<t>Client may want to be notified when the buffer fill state of a disk stream |
8911 |
changes by issuing the following command:</t> |
on the back-end changes by issuing the following command:</t> |
8912 |
<t> |
<t> |
8913 |
<list> |
<list> |
8914 |
<t>SUBSCRIBE BUFFER_FILL</t> |
<t>SUBSCRIBE BUFFER_FILL</t> |
8921 |
</list> |
</list> |
8922 |
</t> |
</t> |
8923 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
8924 |
buffer fill state change occurred and <fill-data> will be replaced by the |
buffer fill state change occurred on and <fill-data> will be replaced by the |
8925 |
buffer fill data for this channel as described in 4.4.12 as if the |
buffer fill data for this channel as described in <xref target="GET CHANNEL BUFFER_FILL" /> |
8926 |
"GET CHANNEL BUFFER_FILL PERCENTAGE" was issued on this channel.</t> |
as if the <xref target="GET CHANNEL BUFFER_FILL"> |
8927 |
|
"GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t> |
8928 |
</section> |
</section> |
8929 |
|
|
8930 |
<section title="Channel information changed"> |
<section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO"> |
8931 |
<t>Client may want to be notified when changes were made to sampler channels on the |
<t>Client may want to be notified when changes were made to sampler channels on the |
8932 |
back-end changes by issuing the following command:</t> |
back-end by issuing the following command:</t> |
8933 |
<t> |
<t> |
8934 |
<list> |
<list> |
8935 |
<t>SUBSCRIBE INFO</t> |
<t>SUBSCRIBE CHANNEL_INFO</t> |
8936 |
</list> |
</list> |
8937 |
</t> |
</t> |
8938 |
<t>Server will start sending the following notification messages:</t> |
<t>Server will start sending the following notification messages:</t> |
8939 |
<t> |
<t> |
8940 |
<list> |
<list> |
8941 |
<t>"NOTIFY:INFO:<sampler-channel>"</t> |
<t>"NOTIFY:CHANNEL_INFO:<sampler-channel>"</t> |
8942 |
</list> |
</list> |
8943 |
</t> |
</t> |
8944 |
<t>where <sampler-channel> will be replaced by the sampler channel the |
<t>where <sampler-channel> will be replaced by the sampler channel the |
8949 |
message is sufficient here.</t> |
message is sufficient here.</t> |
8950 |
</section> |
</section> |
8951 |
|
|
8952 |
<section title="Miscellaneous and debugging events"> |
<section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT"> |
8953 |
|
<t>Client may want to be notified when the number of effect sends on |
8954 |
|
a particular sampler channel is changed by issuing the following command:</t> |
8955 |
|
<t> |
8956 |
|
<list> |
8957 |
|
<t>SUBSCRIBE FX_SEND_COUNT</t> |
8958 |
|
</list> |
8959 |
|
</t> |
8960 |
|
<t>Server will start sending the following notification messages:</t> |
8961 |
|
<t> |
8962 |
|
<list> |
8963 |
|
<t>"NOTIFY:FX_SEND_COUNT:<channel-id> <fx-sends>"</t> |
8964 |
|
</list> |
8965 |
|
</t> |
8966 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
8967 |
|
channel, on which the effect sends number is changed and <fx-sends> will |
8968 |
|
be replaced by the new number of effect sends on that channel.</t> |
8969 |
|
</section> |
8970 |
|
|
8971 |
|
<section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO"> |
8972 |
|
<t>Client may want to be notified when changes were made to effect sends on a |
8973 |
|
a particular sampler channel by issuing the following command:</t> |
8974 |
|
<t> |
8975 |
|
<list> |
8976 |
|
<t>SUBSCRIBE FX_SEND_INFO</t> |
8977 |
|
</list> |
8978 |
|
</t> |
8979 |
|
<t>Server will start sending the following notification messages:</t> |
8980 |
|
<t> |
8981 |
|
<list> |
8982 |
|
<t>"NOTIFY:FX_SEND_INFO:<channel-id> <fx-send-id>"</t> |
8983 |
|
</list> |
8984 |
|
</t> |
8985 |
|
<t>where <channel-id> will be replaced by the numerical ID of the sampler |
8986 |
|
channel, on which an effect send entity is changed and <fx-send-id> will |
8987 |
|
be replaced by the numerical ID of the changed effect send.</t> |
8988 |
|
</section> |
8989 |
|
|
8990 |
|
<section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT"> |
8991 |
|
<t>Client may want to be notified when the total number of voices on the |
8992 |
|
back-end changes by issuing the following command:</t> |
8993 |
|
<t> |
8994 |
|
<list> |
8995 |
|
<t>SUBSCRIBE TOTAL_VOICE_COUNT</t> |
8996 |
|
</list> |
8997 |
|
</t> |
8998 |
|
<t>Server will start sending the following notification messages:</t> |
8999 |
|
<t> |
9000 |
|
<list> |
9001 |
|
<t>"NOTIFY:TOTAL_VOICE_COUNT:<voices>"</t> |
9002 |
|
</list> |
9003 |
|
</t> |
9004 |
|
<t>where <voices> will be replaced by the new number of |
9005 |
|
all currently active voices.</t> |
9006 |
|
</section> |
9007 |
|
|
9008 |
|
<section title="Total number of active disk streams changed" anchor="SUBSCRIBE TOTAL_STREAM_COUNT"> |
9009 |
|
<t>Client may want to be notified when the total number of disk streams on the |
9010 |
|
back-end changes by issuing the following command:</t> |
9011 |
|
<t> |
9012 |
|
<list> |
9013 |
|
<t>SUBSCRIBE TOTAL_STREAM_COUNT</t> |
9014 |
|
</list> |
9015 |
|
</t> |
9016 |
|
<t>Server will start sending the following notification messages:</t> |
9017 |
|
<t> |
9018 |
|
<list> |
9019 |
|
<t>"NOTIFY:TOTAL_STREAM_COUNT:<streams>"</t> |
9020 |
|
</list> |
9021 |
|
</t> |
9022 |
|
<t>where <streams> will be replaced by the new number of |
9023 |
|
all currently active disk streams.</t> |
9024 |
|
</section> |
9025 |
|
|
9026 |
|
<section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT"> |
9027 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
9028 |
|
back-end changes by issuing the following command:</t> |
9029 |
|
<t> |
9030 |
|
<list> |
9031 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t> |
9032 |
|
</list> |
9033 |
|
</t> |
9034 |
|
<t>Server will start sending the following notification messages:</t> |
9035 |
|
<t> |
9036 |
|
<list> |
9037 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:<maps>"</t> |
9038 |
|
</list> |
9039 |
|
</t> |
9040 |
|
<t>where <maps> will be replaced by the new number |
9041 |
|
of MIDI instrument maps.</t> |
9042 |
|
</section> |
9043 |
|
|
9044 |
|
<section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO"> |
9045 |
|
<t>Client may want to be notified when changes were made to MIDI instrument maps on the |
9046 |
|
back-end by issuing the following command:</t> |
9047 |
|
<t> |
9048 |
|
<list> |
9049 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t> |
9050 |
|
</list> |
9051 |
|
</t> |
9052 |
|
<t>Server will start sending the following notification messages:</t> |
9053 |
|
<t> |
9054 |
|
<list> |
9055 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:<map-id>"</t> |
9056 |
|
</list> |
9057 |
|
</t> |
9058 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
9059 |
|
for which information changes occurred. The front-end will have to send |
9060 |
|
the respective command to actually get the MIDI instrument map info. Because these messages |
9061 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9062 |
|
time events happening on the server, it is believed that an empty notification |
9063 |
|
message is sufficient here.</t> |
9064 |
|
</section> |
9065 |
|
|
9066 |
|
<section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT"> |
9067 |
|
<t>Client may want to be notified when the number of MIDI instrument maps on the |
9068 |
|
back-end changes by issuing the following command:</t> |
9069 |
|
<t> |
9070 |
|
<list> |
9071 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t> |
9072 |
|
</list> |
9073 |
|
</t> |
9074 |
|
<t>Server will start sending the following notification messages:</t> |
9075 |
|
<t> |
9076 |
|
<list> |
9077 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_COUNT:<map-id> <instruments>"</t> |
9078 |
|
</list> |
9079 |
|
</t> |
9080 |
|
<t>where <map-id> is the numerical ID of the MIDI instrument map, in which |
9081 |
|
the nuber of instruments has changed and <instruments> will be replaced by |
9082 |
|
the new number of MIDI instruments in the specified map.</t> |
9083 |
|
</section> |
9084 |
|
|
9085 |
|
<section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO"> |
9086 |
|
<t>Client may want to be notified when changes were made to MIDI instruments on the |
9087 |
|
back-end by issuing the following command:</t> |
9088 |
|
<t> |
9089 |
|
<list> |
9090 |
|
<t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t> |
9091 |
|
</list> |
9092 |
|
</t> |
9093 |
|
<t>Server will start sending the following notification messages:</t> |
9094 |
|
<t> |
9095 |
|
<list> |
9096 |
|
<t>"NOTIFY:MIDI_INSTRUMENT_INFO:<map-id> <bank> <program>"</t> |
9097 |
|
</list> |
9098 |
|
</t> |
9099 |
|
<t>where <map-id> will be replaced by the numerical ID of the MIDI instrument map, |
9100 |
|
in which a MIDI instrument is changed. <bank> and <program> specifies |
9101 |
|
the location of the changed MIDI instrument in the map. The front-end will have to send |
9102 |
|
the respective command to actually get the MIDI instrument info. Because these messages |
9103 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9104 |
|
time events happening on the server, it is believed that an empty notification |
9105 |
|
message is sufficient here.</t> |
9106 |
|
</section> |
9107 |
|
|
9108 |
|
<section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO"> |
9109 |
|
<t>Client may want to be notified when changes to the global settings |
9110 |
|
of the sampler were made by issuing the following command:</t> |
9111 |
|
<t> |
9112 |
|
<list> |
9113 |
|
<t>SUBSCRIBE GLOBAL_INFO</t> |
9114 |
|
</list> |
9115 |
|
</t> |
9116 |
|
<t>Server will start sending the following types of notification messages:</t> |
9117 |
|
<t> |
9118 |
|
<list> |
9119 |
|
<t>"NOTIFY:GLOBAL_INFO:VOLUME <volume>" - Notifies that the |
9120 |
|
golbal volume of the sampler is changed, where <volume> will be |
9121 |
|
replaced by the optional dotted floating point value, reflecting the |
9122 |
|
new global volume parameter.</t> |
9123 |
|
</list> |
9124 |
|
<list> |
9125 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
9126 |
|
golbal limit of the sampler for maximum voices is changed, where |
9127 |
|
<max-voices> will be an integer value, reflecting the |
9128 |
|
new global voice limit parameter.</t> |
9129 |
|
</list> |
9130 |
|
<list> |
9131 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
9132 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
9133 |
|
<max-streams> will be an integer value, reflecting the |
9134 |
|
new global disk streams limit parameter.</t> |
9135 |
|
</list> |
9136 |
|
</t> |
9137 |
|
</section> |
9138 |
|
|
9139 |
|
<section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT"> |
9140 |
|
<t>Client may want to be notified when the number of instrument |
9141 |
|
directories in a particular directory in the instruments database |
9142 |
|
is changed by issuing the following command:</t> |
9143 |
|
<t> |
9144 |
|
<list> |
9145 |
|
<t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t> |
9146 |
|
</list> |
9147 |
|
</t> |
9148 |
|
<t>Server will start sending the following notification messages:</t> |
9149 |
|
<t> |
9150 |
|
<list> |
9151 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:<dir-path>"</t> |
9152 |
|
</list> |
9153 |
|
</t> |
9154 |
|
<t>where <dir-path> will be replaced by the absolute path |
9155 |
|
name of the directory in the instruments database, |
9156 |
|
in which the number of directories is changed.</t> |
9157 |
|
<t>Note that when a non-empty directory is removed, this event |
9158 |
|
is not sent for the subdirectories in that directory.</t> |
9159 |
|
</section> |
9160 |
|
|
9161 |
|
<section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO"> |
9162 |
|
<t>Client may want to be notified when changes were made to directories |
9163 |
|
in the instruments database by issuing the following command:</t> |
9164 |
|
<t> |
9165 |
|
<list> |
9166 |
|
<t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t> |
9167 |
|
</list> |
9168 |
|
</t> |
9169 |
|
<t>Server will start sending the following notification messages:</t> |
9170 |
|
<t> |
9171 |
|
<list> |
9172 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:<dir-path>"</t> |
9173 |
|
</list> |
9174 |
|
</t> |
9175 |
|
<t>where <dir-path> will be replaced by the absolute path name |
9176 |
|
of the directory, for which information changes occurred. The front-end will have to send |
9177 |
|
the respective command to actually get the updated directory info. Because these messages |
9178 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9179 |
|
time events happening on the server, it is believed that an empty notification |
9180 |
|
message is sufficient here.</t> |
9181 |
|
<t> |
9182 |
|
<list> |
9183 |
|
<t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME <old-dir-path> <new-name>"</t> |
9184 |
|
</list> |
9185 |
|
</t> |
9186 |
|
<t>where <old-dir-path> is the old absolute path name of the directory |
9187 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
9188 |
|
the new name of the directory, encapsulated into apostrophes.</t> |
9189 |
|
</section> |
9190 |
|
|
9191 |
|
<section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT"> |
9192 |
|
<t>Client may want to be notified when the number of instruments |
9193 |
|
in a particular directory in the instruments database |
9194 |
|
is changed by issuing the following command:</t> |
9195 |
|
<t> |
9196 |
|
<list> |
9197 |
|
<t>SUBSCRIBE DB_INSTRUMENT_COUNT</t> |
9198 |
|
</list> |
9199 |
|
</t> |
9200 |
|
<t>Server will start sending the following notification messages:</t> |
9201 |
|
<t> |
9202 |
|
<list> |
9203 |
|
<t>"NOTIFY:DB_INSTRUMENT_COUNT:<dir-path>"</t> |
9204 |
|
</list> |
9205 |
|
</t> |
9206 |
|
<t>where <dir-path> will be replaced by the absolute path |
9207 |
|
name of the directory in the instruments database, |
9208 |
|
in which the number of instruments is changed.</t> |
9209 |
|
<t>Note that when a non-empty directory is removed, this event |
9210 |
|
is not sent for the instruments in that directory.</t> |
9211 |
|
</section> |
9212 |
|
|
9213 |
|
<section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO"> |
9214 |
|
<t>Client may want to be notified when changes were made to instruments |
9215 |
|
in the instruments database by issuing the following command:</t> |
9216 |
|
<t> |
9217 |
|
<list> |
9218 |
|
<t>SUBSCRIBE DB_INSTRUMENT_INFO</t> |
9219 |
|
</list> |
9220 |
|
</t> |
9221 |
|
<t>Server will start sending the following notification messages:</t> |
9222 |
|
<t> |
9223 |
|
<list> |
9224 |
|
<t>"NOTIFY:DB_INSTRUMENT_INFO:<instr-path>"</t> |
9225 |
|
</list> |
9226 |
|
</t> |
9227 |
|
<t>where <instr-path> will be replaced by the absolute path name |
9228 |
|
of the instrument, which settings are changed. The front-end will have to send |
9229 |
|
the respective command to actually get the updated directory info. Because these messages |
9230 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9231 |
|
time events happening on the server, it is believed that an empty notification |
9232 |
|
message is sufficient here.</t> |
9233 |
|
<t> |
9234 |
|
<list> |
9235 |
|
<t>"NOTIFY:DB_INSTRUMENT_INFO:NAME <old-instr-path> <new-name>"</t> |
9236 |
|
</list> |
9237 |
|
</t> |
9238 |
|
<t>where <old-instr-path> is the old absolute path name of the instrument |
9239 |
|
(encapsulated into apostrophes), which name is changes and <new-name> is |
9240 |
|
the new name of the instrument, encapsulated into apostrophes.</t> |
9241 |
|
</section> |
9242 |
|
|
9243 |
|
<section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO"> |
9244 |
|
<t>Client may want to be notified when the status of particular database |
9245 |
|
instruments job is changed by issuing the following command:</t> |
9246 |
|
<t> |
9247 |
|
<list> |
9248 |
|
<t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t> |
9249 |
|
</list> |
9250 |
|
</t> |
9251 |
|
<t>Server will start sending the following notification messages:</t> |
9252 |
|
<t> |
9253 |
|
<list> |
9254 |
|
<t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:<job-id>"</t> |
9255 |
|
</list> |
9256 |
|
</t> |
9257 |
|
<t>where <job-id> will be replaced by the numerical ID of the job, |
9258 |
|
which status is changed. The front-end will have to send the respective |
9259 |
|
command to actually get the status info. Because these messages |
9260 |
|
will be triggered by LSCP commands issued by other clients rather than real |
9261 |
|
time events happening on the server, it is believed that an empty notification |
9262 |
|
message is sufficient here.</t> |
9263 |
|
</section> |
9264 |
|
|
9265 |
|
<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS"> |
9266 |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
<t>Client may want to be notified of miscellaneous and debugging events occurring at |
9267 |
the server by issuing the following command:</t> |
the server by issuing the following command:</t> |
9268 |
<t> |
<t> |
9298 |
<t>Rui Nuno Capela</t> |
<t>Rui Nuno Capela</t> |
9299 |
<t>Vladimir Senkov</t> |
<t>Vladimir Senkov</t> |
9300 |
<t>Mark Knecht</t> |
<t>Mark Knecht</t> |
9301 |
|
<t>Grigor Iliev</t> |
9302 |
</list> |
</list> |
9303 |
</t> |
</t> |
9304 |
</section> |
</section> |
9306 |
</middle> |
</middle> |
9307 |
|
|
9308 |
<back> |
<back> |
9309 |
<references>&rfc2119;</references> |
<references> |
9310 |
|
<reference anchor="RFC2119"> |
9311 |
|
<front> |
9312 |
|
<title>Key words for use in RFCs to Indicate Requirement Levels</title> |
9313 |
|
<author initials="S." surname="Bradner" fullname="Scott Bradner"> |
9314 |
|
<organization>Harvard University</organization> |
9315 |
|
</author> |
9316 |
|
<date year="1997"></date> |
9317 |
|
</front> |
9318 |
|
<seriesInfo name="RFC" value="2119" /> |
9319 |
|
</reference> |
9320 |
|
<reference anchor="RFC793"> |
9321 |
|
<front> |
9322 |
|
<title>TRANSMISSION CONTROL PROTOCOL</title> |
9323 |
|
<author> |
9324 |
|
<organization>Defense Advanced Research Projects Agency</organization> |
9325 |
|
</author> |
9326 |
|
<date year="1981"></date> |
9327 |
|
</front> |
9328 |
|
<seriesInfo name="RFC" value="793" /> |
9329 |
|
</reference> |
9330 |
|
<reference anchor="RFC2234"> |
9331 |
|
<front> |
9332 |
|
<title>Augmented BNF for Syntax Specifications</title> |
9333 |
|
<author initials="D.H." surname="Crocker" fullname="David H. Crocker"> |
9334 |
|
<organization>Internet Mail Consortium</organization> |
9335 |
|
</author> |
9336 |
|
<author initials="P." surname="Overell" fullname="Paul Overell"> |
9337 |
|
<organization>Demon Internet Ltd</organization> |
9338 |
|
</author> |
9339 |
|
<date year="1997"></date> |
9340 |
|
</front> |
9341 |
|
<seriesInfo name="RFC" value="2234" /> |
9342 |
|
</reference> |
9343 |
|
<reference anchor="RFC20"> |
9344 |
|
<front> |
9345 |
|
<title>ASCII format for Network Interchange</title> |
9346 |
|
<author> |
9347 |
|
<organization>UCLA</organization> |
9348 |
|
</author> |
9349 |
|
<date year="1969"></date> |
9350 |
|
</front> |
9351 |
|
<seriesInfo name="RFC" value="20" /> |
9352 |
|
</reference> |
9353 |
|
</references> |
9354 |
</back> |
</back> |
9355 |
|
|
9356 |
</rfc> |
</rfc> |