31 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
32 |
</address> |
</address> |
33 |
</author> |
</author> |
34 |
<date month="June" year="2004"/> |
<date month="Apr" year="2005"/> |
35 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
36 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
37 |
<abstract> |
<abstract> |
122 |
referred in this document as "sampler channels". The channels |
referred in this document as "sampler channels". The channels |
123 |
are in such way virtual as they can be connected to an |
are in such way virtual as they can be connected to an |
124 |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
arbitrary MIDI input method and arbitrary MIDI channel (e.g. |
125 |
sampler channel 17 could be connected to an Alsa sequencer |
sampler channel 17 could be connected to an ALSA sequencer |
126 |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
device 64:0 and listening to MIDI channel 1 there). Each sampler |
127 |
engine will be assigned an own instance of one of the available |
engine will be assigned an own instance of one of the available |
128 |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
sampler engines (e.g. GigEngine, DLSEngine). The audio output of |
129 |
each sampler channel can be routed to an arbitrary audio output |
each sampler channel can be routed to an arbitrary audio output |
130 |
method (Alsa / Jack) and an arbitrary audio output channel |
method (ALSA / JACK) and an arbitrary audio output channel |
131 |
there.</t> |
there.</t> |
132 |
</section> |
</section> |
133 |
|
|
216 |
<warning-message> and <error-message> are |
<warning-message> and <error-message> are |
217 |
human readable descriptions of the warning or error |
human readable descriptions of the warning or error |
218 |
respectively.</t> |
respectively.</t> |
219 |
|
<t>Examples:</t> |
220 |
|
<t> |
221 |
|
<list> |
222 |
|
<t>C: "LOAD INSTRUMENT '/home/me/Boesendorfer24bit.gig" 0 0</t> |
223 |
|
<t>S: "WRN:32:This is a 24 bit patch which is not supported natively yet."</t> |
224 |
|
</list> |
225 |
|
</t> |
226 |
|
<t> |
227 |
|
<list> |
228 |
|
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA EAR"</t> |
229 |
|
<t>S: "ERR:3456:Audio output driver 'ALSA' does not have a parameter 'EAR'."</t> |
230 |
|
</list> |
231 |
|
</t> |
232 |
|
<t> |
233 |
|
<list> |
234 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 123456"</t> |
235 |
|
<t>S: "ERR:9:There is no audio output device with index 123456."</t> |
236 |
|
</list> |
237 |
|
</t> |
238 |
<t>Normal result sets could be:</t> |
<t>Normal result sets could be:</t> |
239 |
<t> |
<t> |
240 |
<list style="numbers"> |
<list style="numbers"> |
253 |
<t>"OK"</t> |
<t>"OK"</t> |
254 |
</list> |
</list> |
255 |
</t> |
</t> |
256 |
|
<t>Example:</t> |
257 |
|
<t> |
258 |
|
<list> |
259 |
|
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 CHANNELS=4"</t> |
260 |
|
<t>S: "OK"</t> |
261 |
|
</list> |
262 |
|
</t> |
263 |
<t>Single line result sets are command specific. One |
<t>Single line result sets are command specific. One |
264 |
example of a single line result set is an empty line. |
example of a single line result set is an empty line. |
265 |
Multi-line result sets are command specific and may |
Multi-line result sets are command specific and may |
270 |
<t>"."</t> |
<t>"."</t> |
271 |
</list> |
</list> |
272 |
</t> |
</t> |
273 |
|
<t>Example:</t> |
274 |
|
<t> |
275 |
|
<list> |
276 |
|
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
277 |
|
<t>S: "DRIVER: ALSA"</t> |
278 |
|
<t> "CHANNELS: 2"</t> |
279 |
|
<t> "SAMPLERATE: 44100"</t> |
280 |
|
<t> "ACTIVE: true"</t> |
281 |
|
<t> "FRAGMENTS: 2"</t> |
282 |
|
<t> "FRAGMENTSIZE: 128"</t> |
283 |
|
<t> "CARD: '0,0'"</t> |
284 |
|
<t> "."</t> |
285 |
|
</list> |
286 |
|
</t> |
287 |
<t>In addition to above mentioned formats, warnings and |
<t>In addition to above mentioned formats, warnings and |
288 |
empty result sets MAY be indexed. In this case, they |
empty result sets MAY be indexed. In this case, they |
289 |
have the following formats respectively:</t> |
have the following formats respectively:</t> |
298 |
related to or other integer value.</t> |
related to or other integer value.</t> |
299 |
<t>Each line of the result set MUST end with |
<t>Each line of the result set MUST end with |
300 |
<CRLF>.</t> |
<CRLF>.</t> |
301 |
|
<t>Examples:</t> |
302 |
|
<t> |
303 |
|
<list> |
304 |
|
<t>C: "ADD CHANNEL"</t> |
305 |
|
<t>S: "OK[12]"</t> |
306 |
|
</list> |
307 |
|
</t> |
308 |
|
<t> |
309 |
|
<list> |
310 |
|
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA SAMPLERATE=96000"</t> |
311 |
|
<t>S: "WRN[0]:32:Sample rate not supported, using 44100 instead."</t> |
312 |
|
</list> |
313 |
|
</t> |
314 |
</section> |
</section> |
315 |
</section> |
</section> |
316 |
<section title="Subscribe/notify communication method"> |
<section title="Subscribe/notify communication method"> |
443 |
<section title="Configuring audio drivers"> |
<section title="Configuring audio drivers"> |
444 |
<t>Instances of drivers in LinuxSampler are called devices. |
<t>Instances of drivers in LinuxSampler are called devices. |
445 |
You can use multiple audio devices simultaneously, e.g. to |
You can use multiple audio devices simultaneously, e.g. to |
446 |
output the sound of one sampler channel using the Alsa audio |
output the sound of one sampler channel using the ALSA audio |
447 |
output driver, and on another sampler channel you might want |
output driver, and on another sampler channel you might want |
448 |
to use the Jack audio output driver. For particular audio |
to use the JACK audio output driver. For particular audio |
449 |
output systems it's also possible to create several devices |
output systems it's also possible to create several devices |
450 |
of the same audio output driver, e.g. two separate Alsa |
of the same audio output driver, e.g. two separate ALSA |
451 |
audio output devices for using two different sound cards at |
audio output devices for using two different sound cards at |
452 |
the same time. This chapter describes all commands to |
the same time. This chapter describes all commands to |
453 |
configure LinuxSampler's audio output devices and their |
configure LinuxSampler's audio output devices and their |
493 |
<t> |
<t> |
494 |
<list> |
<list> |
495 |
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
<t>C: "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS"</t> |
496 |
<t>S: "Alsa,Jack"</t> |
<t>S: "ALSA,JACK"</t> |
497 |
</list> |
</list> |
498 |
</t> |
</t> |
499 |
</section> |
</section> |
559 |
<t>Example:</t> |
<t>Example:</t> |
560 |
<t> |
<t> |
561 |
<list> |
<list> |
562 |
<t>C: "GET AUDIO_OUTPUT_DRIVER INFO Alsa"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER INFO ALSA"</t> |
563 |
<t>S: "DESCRIPTION: Advanced Linux Sound |
<t>S: "DESCRIPTION: Advanced Linux Sound |
564 |
Architecture"</t> |
Architecture"</t> |
565 |
<t> "VERSION: 1.0"</t> |
<t> "VERSION: 1.0"</t> |
566 |
<t> "PARAMETERS: |
<t> "PARAMETERS: |
567 |
driver,channels,samplerate,active,fragments, |
DRIVER,CHANNELS,SAMPLERATE,ACTIVE,FRAGMENTS, |
568 |
fragmentsize,card"</t> |
FRAGMENTSIZE,CARD"</t> |
569 |
<t> "."</t> |
<t> "."</t> |
570 |
</list> |
</list> |
571 |
</t> |
</t> |
595 |
<t> |
<t> |
596 |
<list> |
<list> |
597 |
<t>LinuxSampler will answer by sending a |
<t>LinuxSampler will answer by sending a |
598 |
&lz;CRLF> separated list. |
<CRLF> separated list. |
599 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
600 |
followed by a colon and then a space character <SP> and |
followed by a colon and then a space character <SP> and |
601 |
finally |
finally |
659 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
660 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
661 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
662 |
driver (like the Alsa driver) offers parameters 'card' |
driver (like the ALSA driver) offers parameters 'card' |
663 |
and 'samplerate' then parameter 'samplerate' would |
and 'samplerate' then parameter 'samplerate' would |
664 |
depend on 'card' because the possible values for |
depend on 'card' because the possible values for |
665 |
'samplerate' depends on the sound card which can be |
'samplerate' depends on the sound card which can be |
700 |
</list> |
</list> |
701 |
</t> |
</t> |
702 |
|
|
703 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
704 |
<list> |
<list> |
705 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
706 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
716 |
<t>Examples:</t> |
<t>Examples:</t> |
717 |
<t> |
<t> |
718 |
<list> |
<list> |
719 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa card"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA CARD"</t> |
720 |
<t>S: "DESCRIPTION: sound card to be used"</t> |
<t>S: "DESCRIPTION: sound card to be used"</t> |
721 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
722 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
723 |
<t> "FIX: true"</t> |
<t> "FIX: true"</t> |
724 |
<t> "MULTIPLICITY: false"</t> |
<t> "MULTIPLICITY: false"</t> |
725 |
<t> "DEFAULT: '0,0'"</t> |
<t> "DEFAULT: '0,0'"</t> |
726 |
<t> "POSSIBILITES: '0,0','1,0','2,0'"</t> |
<t> "POSSIBILITIES: '0,0','1,0','2,0'"</t> |
727 |
<t> "."</t> |
<t> "."</t> |
728 |
</list> |
</list> |
729 |
</t> |
</t> |
730 |
<t> |
<t> |
731 |
<list> |
<list> |
732 |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO Alsa samplerate"</t> |
<t>C: "GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO ALSA SAMPLERATE"</t> |
733 |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
734 |
<t> "TYPE: INT"</t> |
<t> "TYPE: INT"</t> |
735 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
742 |
</t> |
</t> |
743 |
<t> |
<t> |
744 |
<list> |
<list> |
745 |
<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> |
746 |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
<t>S: "DESCRIPTION: output sample rate in Hz"</t> |
747 |
<t> "TYPE: INT"</t> |
<t> "TYPE: INT"</t> |
748 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
803 |
<t>Examples:</t> |
<t>Examples:</t> |
804 |
<t> |
<t> |
805 |
<list> |
<list> |
806 |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE Alsa"</t> |
<t>C: "CREATE AUDIO_OUTPUT_DEVICE ALSA"</t> |
807 |
<t>S: "OK[0]"</t> |
<t>S: "OK[0]"</t> |
808 |
</list> |
</list> |
809 |
</t> |
</t> |
810 |
<t> |
<t> |
811 |
<list> |
<list> |
812 |
<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> |
813 |
<t>S: "OK[1]"</t> |
<t>S: "OK[1]"</t> |
814 |
</list> |
</list> |
815 |
</t> |
</t> |
912 |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
<t>GET AUDIO_OUTPUT_DEVICE INFO <device-id></t> |
913 |
</list> |
</list> |
914 |
</t> |
</t> |
915 |
<t>Where <device-id> should be replaced by be numerical ID |
<t>Where <device-id> should be replaced by numerical ID |
916 |
of the audio output device as e.g. returned by the |
of the audio output device as e.g. returned by the |
917 |
"GET AUDIO_OUTPUT_DEVICES" command.</t> |
"LIST AUDIO_OUTPUT_DEVICES" command.</t> |
918 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
919 |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
920 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
925 |
information categories are defined (independently of device):</t> |
information categories are defined (independently of device):</t> |
926 |
<t> |
<t> |
927 |
<list> |
<list> |
928 |
<t>driver - |
<t>DRIVER - |
929 |
<list> |
<list> |
930 |
<t>identifier of the used audio output driver, as also |
<t>identifier of the used audio output driver, as also |
931 |
returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" |
returned by the "GET AVAILABLE_AUDIO_OUTPUT_DRIVERS" |
932 |
command</t> |
command</t> |
933 |
</list> |
</list> |
934 |
</t> |
</t> |
935 |
<t>channels - |
<t>CHANNELS - |
936 |
<list> |
<list> |
937 |
<t>amount of audio output channels this device currently |
<t>amount of audio output channels this device currently |
938 |
offers</t> |
offers</t> |
939 |
</list> |
</list> |
940 |
</t> |
</t> |
941 |
<t>samplerate - |
<t>SAMPLERATE - |
942 |
<list> |
<list> |
943 |
<t>playback sample rate the device uses</t> |
<t>playback sample rate the device uses</t> |
944 |
</list> |
</list> |
945 |
</t> |
</t> |
946 |
<t>active - |
<t>ACTIVE - |
947 |
<list> |
<list> |
948 |
<t>either true or false, if false then the audio device is |
<t>either true or false, if false then the audio device is |
949 |
inactive and doesn't output any sound, nor do the |
inactive and doesn't output any sound, nor do the |
963 |
<t> |
<t> |
964 |
<list> |
<list> |
965 |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
<t>C: "GET AUDIO_OUTPUT_DEVICE INFO 0"</t> |
966 |
<t>S: "driver: Alsa"</t> |
<t>S: "DRIVER: ALSA"</t> |
967 |
<t> "channels: 2"</t> |
<t> "CHANNELS: 2"</t> |
968 |
<t> "samplerate: 44100"</t> |
<t> "SAMPLERATE: 44100"</t> |
969 |
<t> "active: true"</t> |
<t> "ACTIVE: true"</t> |
970 |
<t> "fragments: 2"</t> |
<t> "FRAGMENTS: 2"</t> |
971 |
<t> "fragmentsize: 128"</t> |
<t> "FRAGMENTSIZE: 128"</t> |
972 |
<t> "card: '0,0'"</t> |
<t> "CARD: '0,0'"</t> |
973 |
<t> "."</t> |
<t> "."</t> |
974 |
</list> |
</list> |
975 |
</t> |
</t> |
1012 |
<t>Example:</t> |
<t>Example:</t> |
1013 |
<t> |
<t> |
1014 |
<list> |
<list> |
1015 |
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 fragmentsize=128"</t> |
<t>C: "SET AUDIO_OUTPUT_DEVICE_PARAMETER 0 FRAGMENTSIZE=128"</t> |
1016 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1017 |
</list> |
</list> |
1018 |
</t> |
</t> |
1056 |
</t> |
</t> |
1057 |
<t>MIX_CHANNEL_DESTINATION - |
<t>MIX_CHANNEL_DESTINATION - |
1058 |
<list> |
<list> |
1059 |
<t>reflects the real audio channel (of the same audio |
<t>numerical ID (positive integer including 0) |
1060 |
|
which reflects the real audio channel (of the same audio |
1061 |
output device) this mix channel refers to, means where |
output device) this mix channel refers to, means where |
1062 |
the audio signal actually will be routed / added to |
the audio signal actually will be routed / added to |
1063 |
(only returned in case the audio channel is mix channel)</t> |
(only returned in case the audio channel is mix channel)</t> |
1110 |
<t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t> |
<t>C: "GET AUDIO_OUTPUT_CHANNEL INFO 1 0"</t> |
1111 |
<t>S: "NAME: 'ardour (left)'"</t> |
<t>S: "NAME: 'ardour (left)'"</t> |
1112 |
<t> "IS_MIX_CHANNEL: false"</t> |
<t> "IS_MIX_CHANNEL: false"</t> |
1113 |
<t> "jack_bindings: 'ardour:0'"</t> |
<t> "JACK_BINDINGS: 'ardour:0'"</t> |
1114 |
<t> "."</t> |
<t> "."</t> |
1115 |
</list> |
</list> |
1116 |
</t> |
</t> |
1191 |
parameter)</t> |
parameter)</t> |
1192 |
</list> |
</list> |
1193 |
</t> |
</t> |
1194 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1195 |
<list> |
<list> |
1196 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1197 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1208 |
<t>Example:</t> |
<t>Example:</t> |
1209 |
<t> |
<t> |
1210 |
<list> |
<list> |
1211 |
<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> |
1212 |
<t>S: "DESCRIPTION: bindings to other Jack clients"</t> |
<t>S: "DESCRIPTION: bindings to other JACK clients"</t> |
1213 |
<t> "TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
1214 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
1215 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
1216 |
<t> "POSSIBILITES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
<t> "POSSIBILITIES: 'PCM:0','PCM:1','ardour:0','ardour:1'"</t> |
1217 |
<t> "."</t> |
<t> "."</t> |
1218 |
</list> |
</list> |
1219 |
</t> |
</t> |
1255 |
<t>Example:</t> |
<t>Example:</t> |
1256 |
<t> |
<t> |
1257 |
<list> |
<list> |
1258 |
<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> |
1259 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1260 |
</list> |
</list> |
1261 |
</t> |
</t> |
1271 |
<section title="Configuring MIDI input drivers"> |
<section title="Configuring MIDI input drivers"> |
1272 |
<t>Instances of drivers in LinuxSampler are called devices. You can use |
<t>Instances of drivers in LinuxSampler are called devices. You can use |
1273 |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
multiple MIDI devices simultaneously, e.g. to use MIDI over ethernet as |
1274 |
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 |
1275 |
channel. For particular MIDI input systems it's also possible to create |
channel. For particular MIDI input systems it's also possible to create |
1276 |
several devices of the same MIDI input type. This chapter describes all |
several devices of the same MIDI input type. This chapter describes all |
1277 |
commands to configure LinuxSampler's MIDI input devices and their parameters.</t> |
commands to configure LinuxSampler's MIDI input devices and their parameters.</t> |
1314 |
<t> |
<t> |
1315 |
<list> |
<list> |
1316 |
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
<t>C: "GET AVAILABLE_MIDI_INPUT_DRIVERS"</t> |
1317 |
<t>S: "Alsa,Jack"</t> |
<t>S: "ALSA,JACK"</t> |
1318 |
</list> |
</list> |
1319 |
</t> |
</t> |
1320 |
</section> |
</section> |
1364 |
|
|
1365 |
<t> |
<t> |
1366 |
<list> |
<list> |
1367 |
<t>C: "GET MIDI_INPUT_DRIVER INFO Alsa"</t> |
<t>C: "GET MIDI_INPUT_DRIVER INFO ALSA"</t> |
1368 |
<t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t> |
<t>S: "DESCRIPTION: Advanced Linux Sound Architecture"</t> |
1369 |
<t> "VERSION: 1.0"</t> |
<t> "VERSION: 1.0"</t> |
1370 |
<t> "PARAMETERS: driver,active"</t> |
<t> "PARAMETERS: DRIVER,ACTIVE"</t> |
1371 |
<t> "."</t> |
<t> "."</t> |
1372 |
</list> |
</list> |
1373 |
</t> |
</t> |
1454 |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
on, means the values for fields 'DEFAULT', 'RANGE_MIN', |
1455 |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
'RANGE_MAX' and 'POSSIBILITIES' might depend on these |
1456 |
listed parameters, for example assuming that an audio |
listed parameters, for example assuming that an audio |
1457 |
driver (like the Alsa driver) offers parameters 'card' |
driver (like the ALSA driver) offers parameters 'card' |
1458 |
and 'samplerate' then parameter 'samplerate' would |
and 'samplerate' then parameter 'samplerate' would |
1459 |
depend on 'card' because the possible values for |
depend on 'card' because the possible values for |
1460 |
'samplerate' depends on the sound card which can be |
'samplerate' depends on the sound card which can be |
1495 |
</list> |
</list> |
1496 |
</t> |
</t> |
1497 |
|
|
1498 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1499 |
<list> |
<list> |
1500 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1501 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1511 |
<t>Example:</t> |
<t>Example:</t> |
1512 |
<t> |
<t> |
1513 |
<list> |
<list> |
1514 |
<t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO Alsa active"</t> |
<t>C: "GET MIDI_INPUT_DRIVER_PARAMETER INFO ALSA ACTIVE"</t> |
1515 |
<t>S: "DESCRIPTION: Whether device is enabled"</t> |
<t>S: "DESCRIPTION: Whether device is enabled"</t> |
1516 |
<t> "TYPE: BOOL"</t> |
<t> "TYPE: BOOL"</t> |
1517 |
<t> "MANDATORY: false"</t> |
<t> "MANDATORY: false"</t> |
1565 |
<t>Example:</t> |
<t>Example:</t> |
1566 |
<t> |
<t> |
1567 |
<list> |
<list> |
1568 |
<t>C: "CREATE MIDI_INPUT_DEVICE Alsa"</t> |
<t>C: "CREATE MIDI_INPUT_DEVICE ALSA"</t> |
1569 |
<t>S: "OK[0]"</t> |
<t>S: "OK[0]"</t> |
1570 |
</list> |
</list> |
1571 |
</t> |
</t> |
1717 |
<t> |
<t> |
1718 |
<list> |
<list> |
1719 |
<t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t> |
<t>C: "GET MIDI_INPUT_DEVICE INFO 0"</t> |
1720 |
<t>S: "driver: Alsa"</t> |
<t>S: "DRIVER: ALSA"</t> |
1721 |
<t> "active: true"</t> |
<t> "ACTIVE: true"</t> |
1722 |
<t> "."</t> |
<t> "."</t> |
1723 |
</list> |
</list> |
1724 |
</t> |
</t> |
1725 |
</section> |
</section> |
1726 |
|
|
1727 |
<section title="Changing settings of audio output devices"> |
<section title="Changing settings of MIDI input devices"> |
1728 |
<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> |
1729 |
<t> |
<t> |
1730 |
<list> |
<list> |
1761 |
<t>Example:</t> |
<t>Example:</t> |
1762 |
<t> |
<t> |
1763 |
<list> |
<list> |
1764 |
<t>C: "SET MIDI_INPUT_DEVICE PARAMETER 0 ACTIVE=false"</t> |
<t>C: "SET MIDI_INPUT_DEVICE_PARAMETER 0 ACTIVE=false"</t> |
1765 |
<t>S: "OK"</t> |
<t>S: "OK"</t> |
1766 |
</list> |
</list> |
1767 |
</t> |
</t> |
1802 |
<t> |
<t> |
1803 |
<list> |
<list> |
1804 |
<t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t> |
<t>C: "GET MIDI_INPUT_PORT INFO 0 0"</t> |
1805 |
<t>S: "name: 'Masterkeyboard'"</t> |
<t>S: "NAME: 'Masterkeyboard'"</t> |
1806 |
<t> "alsa_seq_bindings: '64:0'"</t> |
<t> "ALSA_SEQ_BINDINGS: '64:0'"</t> |
1807 |
<t> "."</t> |
<t> "."</t> |
1808 |
</list> |
</list> |
1809 |
</t> |
</t> |
1818 |
</t> |
</t> |
1819 |
|
|
1820 |
<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 |
1821 |
by the "GET MIDI_INPUT_DEVICES" command, <port> the MIDI port number and |
by the "LIST MIDI_INPUT_DEVICES" command, <port> the MIDI port number and |
1822 |
<param> a specific port parameter name for which information should be |
<param> a specific port parameter name for which information should be |
1823 |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
obtained (as returned by the "GET MIDI_INPUT_PORT INFO" command).</t> |
1824 |
|
|
1883 |
parameter)</t> |
parameter)</t> |
1884 |
</list> |
</list> |
1885 |
</t> |
</t> |
1886 |
<t>POSSIBILITES - |
<t>POSSIBILITIES - |
1887 |
<list> |
<list> |
1888 |
<t>comma separated list of possible values for this |
<t>comma separated list of possible values for this |
1889 |
parameter, character strings are encapsulated into |
parameter, character strings are encapsulated into |
1900 |
<t>Example:</t> |
<t>Example:</t> |
1901 |
<t> |
<t> |
1902 |
<list> |
<list> |
1903 |
<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> |
1904 |
<t>S: "DESCRIPTION: bindings to other Alsa sequencer clients"</t> |
<t>S: "DESCRIPTION: bindings to other ALSA sequencer clients"</t> |
1905 |
<t>"TYPE: STRING"</t> |
<t> "TYPE: STRING"</t> |
1906 |
<t> "FIX: false"</t> |
<t> "FIX: false"</t> |
1907 |
<t> "MULTIPLICITY: true"</t> |
<t> "MULTIPLICITY: true"</t> |
1908 |
<t> "POSSIBILITES: '64:0','68:0','68:1'"</t> |
<t> "POSSIBILITIES: '64:0','68:0','68:1'"</t> |
1909 |
<t> "."</t> |
<t> "."</t> |
1910 |
</list> |
</list> |
1911 |
</t> |
</t> |
1915 |
<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> |
1916 |
<t> |
<t> |
1917 |
<list> |
<list> |
1918 |
<t>SET MIDI_INPUT_PORT PARAMETER <device-id> <port> <key>=<value></t> |
<t>SET MIDI_INPUT_PORT_PARAMETER <device-id> <port> <key>=<value></t> |
1919 |
</list> |
</list> |
1920 |
</t> |
</t> |
1921 |
|
|
2024 |
</list> |
</list> |
2025 |
</t> |
</t> |
2026 |
|
|
2027 |
<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 |
2028 |
implementation and <sampler-channel> the sampler channel the |
"GET AVAILABLE_ENGINES" command and <sampler-channel> the sampler channel the |
2029 |
deployed engine should be assigned to. Even if the respective |
deployed engine should be assigned to. Even if the respective |
2030 |
sampler channel has already a deployed engine with that engine |
sampler channel has already a deployed engine with that engine |
2031 |
name, a new engine instance will be assigned to the sampler channel.</t> |
name, a new engine instance will be assigned to the sampler channel.</t> |
2216 |
<t> |
<t> |
2217 |
<list> |
<list> |
2218 |
<t>LinuxSampler will answer by sending a comma separated character |
<t>LinuxSampler will answer by sending a comma separated character |
2219 |
string of the engines' C++ class names.</t> |
string of the engines' names. Engine names can consist of lower and |
2220 |
|
upper cases, digits and underlines ("_" character).</t> |
2221 |
</list> |
</list> |
2222 |
</t> |
</t> |
2223 |
<t>Example:</t> |
<t>Example:</t> |
2237 |
<t>GET ENGINE INFO <engine-name></t> |
<t>GET ENGINE INFO <engine-name></t> |
2238 |
</list> |
</list> |
2239 |
</t> |
</t> |
2240 |
<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 |
2241 |
|
"GET AVAILABLE_ENGINES" command.</t> |
2242 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2243 |
<t> |
<t> |
2244 |
<list> |
<list> |
2245 |
<t>LinuxSampler will answer by sending <> separated list. |
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
2246 |
Each answer line begins with the information category name |
Each answer line begins with the information category name |
2247 |
followed by a colon and then a space character <SP> and finally |
followed by a colon and then a space character <SP> and finally |
2248 |
the info character string to that info category. At the moment |
the info character string to that info category. At the moment |
2342 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument</t> |
2343 |
</list> |
</list> |
2344 |
</t> |
</t> |
2345 |
|
<t>INSTRUMENT_NAME - |
2346 |
|
<list> |
2347 |
|
<t>the instrument name of the loaded instrument</t> |
2348 |
|
</list> |
2349 |
|
</t> |
2350 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2351 |
<list> |
<list> |
2352 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
2397 |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
<t> "AUDIO_OUTPUT_ROUTING: 0,1"</t> |
2398 |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
<t> "INSTRUMENT_FILE: /home/joe/FazioliPiano.gig"</t> |
2399 |
<t> "INSTRUMENT_NR: 0"</t> |
<t> "INSTRUMENT_NR: 0"</t> |
2400 |
|
<t> "INSTRUMENT_NAME: Fazioli Piano"</t> |
2401 |
<t> "INSTRUMENT_STATUS: 100"</t> |
<t> "INSTRUMENT_STATUS: 100"</t> |
2402 |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
<t> "MIDI_INPUT_DEVICE: 0"</t> |
2403 |
<t> "MIDI_INPUT_PORT: 0"</t> |
<t> "MIDI_INPUT_PORT: 0"</t> |
2562 |
<t>SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type></t> |
<t>SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type></t> |
2563 |
</list> |
</list> |
2564 |
</t> |
</t> |
2565 |
<t>Where <audio-output-type> is currently either "Alsa" or "Jack" and |
<t>Where <audio-output-type> is currently either "ALSA" or "JACK" and |
2566 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
2567 |
|
|
2568 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2688 |
<t>SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type></t> |
<t>SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type></t> |
2689 |
</list> |
</list> |
2690 |
</t> |
</t> |
2691 |
<t>Where <midi-input-type> is currently only "Alsa" and |
<t>Where <midi-input-type> is currently only "ALSA" and |
2692 |
<sampler-channel> is the respective sampler channel number.</t> |
<sampler-channel> is the respective sampler channel number.</t> |
2693 |
|
|
2694 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
2938 |
</t> |
</t> |
2939 |
</section> |
</section> |
2940 |
|
|
2941 |
<section title="Unregister front-end for not receiving UDP event messages anymore"> |
<section title="Unregister front-end for not receiving event messages"> |
2942 |
<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 |
2943 |
messages anymore by sending the following command:</t> |
messages anymore by sending the following command:</t> |
2944 |
<t> |
<t> |
3029 |
LinuxSampler than really useful for a front-end implementation.</t> |
LinuxSampler than really useful for a front-end implementation.</t> |
3030 |
</section> |
</section> |
3031 |
</section> |
</section> |
3032 |
|
|
3033 |
|
<section title="Global commands"> |
3034 |
|
<t>The following commands have global impact on the sampler.</t> |
3035 |
|
|
3036 |
|
<section title="Reset sampler"> |
3037 |
|
<t>The front-end can reset the whole sampler by sending the following command:</t> |
3038 |
|
<t> |
3039 |
|
<list> |
3040 |
|
<t>RESET</t> |
3041 |
|
</list> |
3042 |
|
</t> |
3043 |
|
|
3044 |
|
<t>Possible Answers:</t> |
3045 |
|
<t> |
3046 |
|
<list> |
3047 |
|
<t>"OK" - |
3048 |
|
<list> |
3049 |
|
<t>always</t> |
3050 |
|
</list> |
3051 |
|
</t> |
3052 |
|
</list> |
3053 |
|
</t> |
3054 |
|
<t>Examples:</t> |
3055 |
|
<t> |
3056 |
|
<list> |
3057 |
|
<t></t> |
3058 |
|
</list> |
3059 |
|
</t> |
3060 |
|
</section> |
3061 |
|
</section> |
3062 |
</section> |
</section> |
3063 |
|
|
3064 |
<section title="Command Syntax"> |
<section title="Command Syntax"> |
3065 |
<t>TODO: will soon automatically included from src/network/lscp.y</t> |
<t>TODO: will soon automatically included from src/network/lscp.y, |
3066 |
|
meanwhile have a look at that file to get the exact definition of |
3067 |
|
the command syntax.</t> |
3068 |
</section> |
</section> |
3069 |
|
|
3070 |
<section title="Events"> |
<section title="Events"> |