16 |
to an annoying "missing Normative/Informative References" error message --> |
to an annoying "missing Normative/Informative References" error message --> |
17 |
<?rfc strict="no" ?> |
<?rfc strict="no" ?> |
18 |
|
|
19 |
<rfc category="std" ipr="full3978" docName="LSCP 1.2"> |
<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="October" year="2007"/> |
<date month="November" year="2009"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
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> |
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> |
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> |
</list> |
2550 |
</t> |
</t> |
2551 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
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 - |
3718 |
</t> |
</t> |
3719 |
</section> |
</section> |
3720 |
|
|
3721 |
|
<section title="Sending MIDI messages to sampler channel" anchor="SEND CHANNEL MIDI_DATA"> |
3722 |
|
<t>The front-end can send MIDI events to a specific sampler channel |
3723 |
|
by sending the following command:</t> |
3724 |
|
<t> |
3725 |
|
<list> |
3726 |
|
<t>SEND CHANNEL MIDI_DATA <midi-msg> <sampler-chan> <arg1> <arg2></t> |
3727 |
|
</list> |
3728 |
|
</t> |
3729 |
|
<t>Where <sampler-chan> is the sampler channel number |
3730 |
|
as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref> |
3731 |
|
or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, |
3732 |
|
<arg1> and <arg2> arguments depend on the <midi-msg> argument, which |
3733 |
|
specifies the MIDI message type. Currently, the following MIDI messages are supported:</t> |
3734 |
|
<t> |
3735 |
|
<list> |
3736 |
|
<t>"NOTE_ON" - |
3737 |
|
<list> |
3738 |
|
<t>For turning on MIDI notes, where <arg1> |
3739 |
|
specifies the key number and <arg2> the velocity |
3740 |
|
as described in the MIDI specification.</t> |
3741 |
|
</list> |
3742 |
|
</t> |
3743 |
|
<t>"NOTE_OFF" - |
3744 |
|
<list> |
3745 |
|
<t>For turning a currently playing MIDI note off, where <arg1> |
3746 |
|
specifies the key number and <arg2> the velocity |
3747 |
|
as described in the MIDI specification.</t> |
3748 |
|
</list> |
3749 |
|
</t> |
3750 |
|
<t>"CC" - |
3751 |
|
<list> |
3752 |
|
<t>For changing a MIDI controller, where <arg1> |
3753 |
|
specifies the controller number and <arg2> the |
3754 |
|
new value of the controller as described in the Control |
3755 |
|
Change section of the MIDI specification.</t> |
3756 |
|
</list> |
3757 |
|
</t> |
3758 |
|
</list> |
3759 |
|
</t> |
3760 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
3761 |
|
and no realtime guarantee whatsoever will be made!</t> |
3762 |
|
<t>Possible Answers:</t> |
3763 |
|
<t> |
3764 |
|
<list> |
3765 |
|
<t>"OK" - |
3766 |
|
<list> |
3767 |
|
<t>on success</t> |
3768 |
|
</list> |
3769 |
|
</t> |
3770 |
|
<t>"ERR:<error-code>:<error-message>" - |
3771 |
|
<list> |
3772 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3773 |
|
</list> |
3774 |
|
</t> |
3775 |
|
</list> |
3776 |
|
</t> |
3777 |
|
<t>Example:</t> |
3778 |
|
<t> |
3779 |
|
<list> |
3780 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
3781 |
|
<t>S: "OK"</t> |
3782 |
|
</list> |
3783 |
|
</t> |
3784 |
|
</section> |
3785 |
|
|
3786 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3787 |
<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> |
3788 |
<t> |
<t> |
4157 |
</list> |
</list> |
4158 |
</t> |
</t> |
4159 |
</section> |
</section> |
4160 |
|
|
4161 |
|
<section title="Getting global voice limit" anchor="GET VOICES"> |
4162 |
|
<t>The client can ask for the current global sampler-wide limit |
4163 |
|
for maximum voices by sending the following command:</t> |
4164 |
|
<t> |
4165 |
|
<list> |
4166 |
|
<t>GET VOICES</t> |
4167 |
|
</list> |
4168 |
|
</t> |
4169 |
|
<t>Possible Answers:</t> |
4170 |
|
<t> |
4171 |
|
<list> |
4172 |
|
<t>LinuxSampler will answer by returning the number for |
4173 |
|
the current limit of maximum voices.</t> |
4174 |
|
</list> |
4175 |
|
</t> |
4176 |
|
|
4177 |
|
<t>The voice limit setting defines how many voices should maximum |
4178 |
|
be processed by the sampler at the same time. If the user |
4179 |
|
triggers new notes which would exceed that voice limit, the |
4180 |
|
sampler engine will react by stealing old voices for those |
4181 |
|
newly triggered notes. Note that the amount of voices triggered |
4182 |
|
by a new note can be larger than one and is dependent to the |
4183 |
|
respective instrument and probably further criterias.</t> |
4184 |
|
</section> |
4185 |
|
|
4186 |
|
<section title="Setting global voice limit" anchor="SET VOICES"> |
4187 |
|
<t>The client can alter the current global sampler-wide limit |
4188 |
|
for maximum voices by sending the following command:</t> |
4189 |
|
<t> |
4190 |
|
<list> |
4191 |
|
<t>SET VOICES <max-voices></t> |
4192 |
|
</list> |
4193 |
|
</t> |
4194 |
|
<t>Where <max-voices> should be replaced by the integer |
4195 |
|
value, reflecting the new global amount limit of maximum voices. |
4196 |
|
This value has to be larger than 0.</t> |
4197 |
|
|
4198 |
|
<t>Possible Answers:</t> |
4199 |
|
<t> |
4200 |
|
<list> |
4201 |
|
<t>"OK" - |
4202 |
|
<list> |
4203 |
|
<t>on success</t> |
4204 |
|
</list> |
4205 |
|
</t> |
4206 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4207 |
|
<list> |
4208 |
|
<t>if the voice limit was set, but there are noteworthy |
4209 |
|
issue(s) related, providing an appropriate warning code and |
4210 |
|
warning message</t> |
4211 |
|
</list> |
4212 |
|
</t> |
4213 |
|
<t>"ERR:<error-code>:<error-message>" - |
4214 |
|
<list> |
4215 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4216 |
|
</list> |
4217 |
|
</t> |
4218 |
|
</list> |
4219 |
|
</t> |
4220 |
|
|
4221 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4222 |
|
The total amount of maximum voices on the running system might thus |
4223 |
|
be as big as the given value multiplied by the current amount of engine |
4224 |
|
instances.</t> |
4225 |
|
|
4226 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
4227 |
|
adjust the disk stream limit respectively and vice versa.</t> |
4228 |
|
</section> |
4229 |
|
|
4230 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
4231 |
|
<t>The client can ask for the current global sampler-wide limit |
4232 |
|
for maximum disk streams by sending the following command:</t> |
4233 |
|
<t> |
4234 |
|
<list> |
4235 |
|
<t>GET STREAMS</t> |
4236 |
|
</list> |
4237 |
|
</t> |
4238 |
|
<t>Possible Answers:</t> |
4239 |
|
<t> |
4240 |
|
<list> |
4241 |
|
<t>LinuxSampler will answer by returning the number for |
4242 |
|
the current limit of maximum disk streams.</t> |
4243 |
|
</list> |
4244 |
|
</t> |
4245 |
|
|
4246 |
|
<t>The disk stream limit setting defines how many disk streams should |
4247 |
|
maximum be processed by a sampler engine at the same time. The |
4248 |
|
higher this value, the more memory (RAM) will be occupied, since |
4249 |
|
every disk streams allocates a certain buffer size for being able |
4250 |
|
to perform its streaming operations.</t> |
4251 |
|
</section> |
4252 |
|
|
4253 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
4254 |
|
<t>The client can alter the current global sampler-wide limit |
4255 |
|
for maximum disk streams by sending the following command:</t> |
4256 |
|
<t> |
4257 |
|
<list> |
4258 |
|
<t>SET STREAMS <max-streams></t> |
4259 |
|
</list> |
4260 |
|
</t> |
4261 |
|
<t>Where <max-streams> should be replaced by the integer |
4262 |
|
value, reflecting the new global amount limit of maximum disk streams. |
4263 |
|
This value has to be positive.</t> |
4264 |
|
|
4265 |
|
<t>Possible Answers:</t> |
4266 |
|
<t> |
4267 |
|
<list> |
4268 |
|
<t>"OK" - |
4269 |
|
<list> |
4270 |
|
<t>on success</t> |
4271 |
|
</list> |
4272 |
|
</t> |
4273 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4274 |
|
<list> |
4275 |
|
<t>if the disk stream limit was set, but there are noteworthy |
4276 |
|
issue(s) related, providing an appropriate warning code and |
4277 |
|
warning message</t> |
4278 |
|
</list> |
4279 |
|
</t> |
4280 |
|
<t>"ERR:<error-code>:<error-message>" - |
4281 |
|
<list> |
4282 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4283 |
|
</list> |
4284 |
|
</t> |
4285 |
|
</list> |
4286 |
|
</t> |
4287 |
|
|
4288 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4289 |
|
The total amount of maximum disk streams on the running system might |
4290 |
|
thus be as big as the given value multiplied by the current amount of |
4291 |
|
engine instances.</t> |
4292 |
|
|
4293 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
4294 |
|
adjust the voice limit respectively and vice versa.</t> |
4295 |
|
</section> |
4296 |
|
|
4297 |
</section> |
</section> |
4298 |
|
|
4299 |
|
|
5502 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5503 |
<t> |
<t> |
5504 |
<list> |
<list> |
5505 |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>] <db_dir> <file_path> [<instr_index>]</t> |
<t>ADD DB_INSTRUMENTS [NON_MODAL] [<mode>[ FILE_AS_DIR]] <db_dir> <file_path> [<instr_index>]</t> |
5506 |
</list> |
</list> |
5507 |
</t> |
</t> |
5508 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5547 |
</list> |
</list> |
5548 |
</t> |
</t> |
5549 |
|
|
5550 |
|
<t> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5551 |
|
file will be added to a separate directory in the instruments database, which |
5552 |
|
name will be the name of the instrument file with the file extension stripped off. |
5553 |
|
</t> |
5554 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
5555 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
5556 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
5954 |
</list> |
</list> |
5955 |
</t> |
</t> |
5956 |
<t>Where <instr> is the absolute path name of the instrument and |
<t>Where <instr> is the absolute path name of the instrument and |
5957 |
<desc> is the new description for the instrument |
<desc> is the new description for the instrument |
5958 |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
(encapsulated into apostrophes, supporting escape sequences as described in chapter |
5959 |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
"<xref target="character_set">Character Set and Escape Sequences</xref>").</t> |
5960 |
|
|
6197 |
<t>FORMAT INSTRUMENTS_DB</t> |
<t>FORMAT INSTRUMENTS_DB</t> |
6198 |
</list> |
</list> |
6199 |
</t> |
</t> |
6200 |
|
|
6201 |
<t>Possible Answers:</t> |
<t>Possible Answers:</t> |
6202 |
<t> |
<t> |
6203 |
<list> |
<list> |
6216 |
</t> |
</t> |
6217 |
</section> |
</section> |
6218 |
|
|
6219 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6220 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6221 |
|
that don't exist in the filesystem by sending the following command:</t> |
6222 |
|
<t> |
6223 |
|
<list> |
6224 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6225 |
|
</list> |
6226 |
|
</t> |
6227 |
|
|
6228 |
|
<t>Possible Answers:</t> |
6229 |
|
<t> |
6230 |
|
<list> |
6231 |
|
<t>A comma separated list with the absolute path names |
6232 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6233 |
|
<t>"ERR:<error-code>:<error-message>" - |
6234 |
|
<list> |
6235 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6236 |
|
</list> |
6237 |
|
</t> |
6238 |
|
</list> |
6239 |
|
</t> |
6240 |
|
<t>Example:</t> |
6241 |
|
<t> |
6242 |
|
<list> |
6243 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6244 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6245 |
|
</list> |
6246 |
|
</t> |
6247 |
|
</section> |
6248 |
|
|
6249 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6250 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6251 |
|
in the instruments database with a new one by sending the following command:</t> |
6252 |
|
<t> |
6253 |
|
<list> |
6254 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6255 |
|
</list> |
6256 |
|
</t> |
6257 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6258 |
|
to substitute with <new_path>.</t> |
6259 |
|
|
6260 |
|
<t>Possible Answers:</t> |
6261 |
|
<t> |
6262 |
|
<list> |
6263 |
|
<t>"OK" - |
6264 |
|
<list> |
6265 |
|
<t>on success</t> |
6266 |
|
</list> |
6267 |
|
</t> |
6268 |
|
<t>"ERR:<error-code>:<error-message>" - |
6269 |
|
<list> |
6270 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6271 |
|
</list> |
6272 |
|
</t> |
6273 |
|
</list> |
6274 |
|
</t> |
6275 |
|
|
6276 |
|
<t>Example:</t> |
6277 |
|
<t> |
6278 |
|
<list> |
6279 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6280 |
|
<t>S: "OK"</t> |
6281 |
|
</list> |
6282 |
|
</t> |
6283 |
|
</section> |
6284 |
|
|
6285 |
</section> |
</section> |
6286 |
|
|
6287 |
|
|
6360 |
</t> |
</t> |
6361 |
</section> |
</section> |
6362 |
</section> |
</section> |
|
</section> |
|
6363 |
|
|
6364 |
|
<section title="Managing Files" anchor="file_management"> |
6365 |
|
<t>You can query detailed informations about files located |
6366 |
|
at the same system where the sampler instance is running on. |
6367 |
|
Using this command set allows to retrieve file informations |
6368 |
|
even remotely from another machine.</t> |
6369 |
|
|
6370 |
|
<section title="Retrieving amount of instruments of a file" anchor="GET FILE INSTRUMENTS"> |
6371 |
|
<t>The front-end can retrieve the amount of instruments |
6372 |
|
within a given instrument file by sending the |
6373 |
|
following command:</t> |
6374 |
|
<t> |
6375 |
|
<list> |
6376 |
|
<t>GET FILE INSTRUMENTS <filename></t> |
6377 |
|
</list> |
6378 |
|
</t> |
6379 |
|
<t>Where <filename> is the name of the instrument |
6380 |
|
file (encapsulated into apostrophes, supporting escape |
6381 |
|
sequences as described in chapter |
6382 |
|
"<xref target="character_set">Character Set and Escape |
6383 |
|
Sequences</xref>").</t> |
6384 |
|
|
6385 |
|
<t>The sampler will try to ask all sampler engines, |
6386 |
|
whether they support the given file and ask the first |
6387 |
|
engine with a positive answer for the amount of |
6388 |
|
instruments.</t> |
6389 |
|
|
6390 |
|
<t>Possible Answers:</t> |
6391 |
|
<t> |
6392 |
|
<list> |
6393 |
|
<t>On success, the sampler will answer by |
6394 |
|
returning the amount of instruments. |
6395 |
|
</t> |
6396 |
|
<t>"ERR:<error-code>:<error-message>" - |
6397 |
|
<list> |
6398 |
|
<t>if the file could not be handled</t> |
6399 |
|
</list> |
6400 |
|
</t> |
6401 |
|
</list> |
6402 |
|
</t> |
6403 |
|
|
6404 |
|
<t>Examples:</t> |
6405 |
|
<t> |
6406 |
|
<list> |
6407 |
|
<t>C: "GET FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6408 |
|
<t>S: "10"</t> |
6409 |
|
</list> |
6410 |
|
</t> |
6411 |
|
</section> |
6412 |
|
|
6413 |
|
<section title="Retrieving all instruments of a file" anchor="LIST FILE INSTRUMENTS"> |
6414 |
|
<t>The front-end can retrieve a list of all instruments |
6415 |
|
within a given instrument file by sending the |
6416 |
|
following command:</t> |
6417 |
|
<t> |
6418 |
|
<list> |
6419 |
|
<t>LIST FILE INSTRUMENTS <filename></t> |
6420 |
|
</list> |
6421 |
|
</t> |
6422 |
|
<t>Where <filename> is the name of the instrument |
6423 |
|
file (encapsulated into apostrophes, supporting escape |
6424 |
|
sequences as described in chapter |
6425 |
|
"<xref target="character_set">Character Set and Escape |
6426 |
|
Sequences</xref>").</t> |
6427 |
|
|
6428 |
|
<t>The sampler will try to ask all sampler engines, |
6429 |
|
whether they support the given file and ask the first |
6430 |
|
engine with a positive answer for a list of IDs for the |
6431 |
|
instruments in the given file.</t> |
6432 |
|
|
6433 |
|
<t>Possible Answers:</t> |
6434 |
|
<t> |
6435 |
|
<list> |
6436 |
|
<t>On success, the sampler will answer by |
6437 |
|
returning a comma separated list of |
6438 |
|
instrument IDs. |
6439 |
|
</t> |
6440 |
|
<t>"ERR:<error-code>:<error-message>" - |
6441 |
|
<list> |
6442 |
|
<t>if the file could not be handled</t> |
6443 |
|
</list> |
6444 |
|
</t> |
6445 |
|
</list> |
6446 |
|
</t> |
6447 |
|
|
6448 |
|
<t>Examples:</t> |
6449 |
|
<t> |
6450 |
|
<list> |
6451 |
|
<t>C: "LIST FILE INSTRUMENTS 'D:/Sounds/Foo.gig'"</t> |
6452 |
|
<t>S: "0,1,2,3,4,5,6,7,8,9"</t> |
6453 |
|
</list> |
6454 |
|
</t> |
6455 |
|
</section> |
6456 |
|
|
6457 |
|
<section title="Retrieving informations about one instrument in a file" anchor="GET FILE INSTRUMENT INFO"> |
6458 |
|
<t>The front-end can retrieve detailed informations |
6459 |
|
about a specific instrument within a given instrument |
6460 |
|
file by sending the following command:</t> |
6461 |
|
<t> |
6462 |
|
<list> |
6463 |
|
<t>GET FILE INSTRUMENT INFO <filename> |
6464 |
|
<instr-id></t> |
6465 |
|
</list> |
6466 |
|
</t> |
6467 |
|
<t>Where <filename> is the name of the instrument |
6468 |
|
file (encapsulated into apostrophes, supporting escape |
6469 |
|
sequences as described in chapter |
6470 |
|
"<xref target="character_set">Character Set and Escape |
6471 |
|
Sequences</xref>") and <instr-id> is the numeric |
6472 |
|
instrument ID as returned by the |
6473 |
|
<xref target="LIST FILE INSTRUMENTS"> |
6474 |
|
"LIST FILE INSTRUMENTS"</xref> command.</t> |
6475 |
|
|
6476 |
|
<t>The sampler will try to ask all sampler engines, |
6477 |
|
whether they support the given file and ask the first |
6478 |
|
engine with a positive answer for informations about the |
6479 |
|
specific instrument in the given file.</t> |
6480 |
|
|
6481 |
|
<t>Possible Answers:</t> |
6482 |
|
<t> |
6483 |
|
<list> |
6484 |
|
<t>LinuxSampler will answer by sending a <CRLF> separated list. |
6485 |
|
Each answer line begins with the settings category name |
6486 |
|
followed by a colon and then a space character <SP> and finally |
6487 |
|
the info character string to that setting category. At the |
6488 |
|
moment the following categories are defined:</t> |
6489 |
|
|
6490 |
|
<t> |
6491 |
|
<list> |
6492 |
|
<t>NAME - |
6493 |
|
<list> |
6494 |
|
<t>name of the instrument as |
6495 |
|
stored in the instrument file</t> |
6496 |
|
</list> |
6497 |
|
</t> |
6498 |
|
<t>FORMAT_FAMILY - |
6499 |
|
<list> |
6500 |
|
<t>name of the sampler format |
6501 |
|
of the given instrument</t> |
6502 |
|
</list> |
6503 |
|
</t> |
6504 |
|
<t>FORMAT_VERSION - |
6505 |
|
<list> |
6506 |
|
<t>version of the sampler format |
6507 |
|
the instrumen is stored as</t> |
6508 |
|
</list> |
6509 |
|
</t> |
6510 |
|
<t>PRODUCT - |
6511 |
|
<list> |
6512 |
|
<t>official product name of the |
6513 |
|
instrument as stored in the file |
6514 |
|
</t> |
6515 |
|
</list> |
6516 |
|
</t> |
6517 |
|
<t>ARTISTS - |
6518 |
|
<list> |
6519 |
|
<t>artists / sample library |
6520 |
|
vendor of the instrument</t> |
6521 |
|
</list> |
6522 |
|
</t> |
6523 |
|
<t>KEY_BINDINGS - |
6524 |
|
<list> |
6525 |
|
<t>comma separated list of integer values representing |
6526 |
|
the instrument's key mapping in the range between 0 .. 127, |
6527 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6528 |
|
</list> |
6529 |
|
</t> |
6530 |
|
<t>KEYSWITCH_BINDINGS - |
6531 |
|
<list> |
6532 |
|
<t>comma separated list of integer values representing |
6533 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6534 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6535 |
|
</list> |
6536 |
|
</t> |
6537 |
|
</list> |
6538 |
|
</t> |
6539 |
|
</list> |
6540 |
|
</t> |
6541 |
|
<t>The mentioned fields above don't have to be in particular order.</t> |
6542 |
|
|
6543 |
|
<t>Example:</t> |
6544 |
|
<t> |
6545 |
|
<list> |
6546 |
|
<t>C: "GET FILE INSTRUMENT INFO 'D:/Sounds/Foo.gig' 0"</t> |
6547 |
|
<t>S: "NAME: Lunatic Loops"</t> |
6548 |
|
<t> "FORMAT_FAMILY: GIG"</t> |
6549 |
|
<t> "FORMAT_VERSION: 3"</t> |
6550 |
|
<t> "PRODUCT: The Backbone Bongo Beats"</t> |
6551 |
|
<t> "ARTISTS: Jimmy the Fish"</t> |
6552 |
|
<t> "."</t> |
6553 |
|
</list> |
6554 |
|
</t> |
6555 |
|
</section> |
6556 |
|
</section> |
6557 |
|
</section> |
6558 |
|
|
6559 |
<section title="Command Syntax" anchor="command_syntax"> |
<section title="Command Syntax" anchor="command_syntax"> |
6560 |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
<t>The grammar of the control protocol as descibed in <xref target="control_commands"/> |
6642 |
</t> |
</t> |
6643 |
<t>/ FORMAT SP format_instruction |
<t>/ FORMAT SP format_instruction |
6644 |
</t> |
</t> |
6645 |
|
<t>/ SEND SP send_instruction |
6646 |
|
</t> |
6647 |
|
<t>/ APPEND SP append_instruction |
6648 |
|
</t> |
6649 |
|
<t>/ INSERT SP insert_instruction |
6650 |
|
</t> |
6651 |
<t>/ RESET |
<t>/ RESET |
6652 |
</t> |
</t> |
6653 |
<t>/ QUIT |
<t>/ QUIT |
6662 |
</t> |
</t> |
6663 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename |
6664 |
</t> |
</t> |
6665 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
6666 |
|
</t> |
6667 |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6668 |
</t> |
</t> |
6669 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
6670 |
|
</t> |
6671 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6672 |
</t> |
</t> |
6673 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename SP instrument_index |
6680 |
</t> |
</t> |
6681 |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP map_name |
6682 |
</t> |
</t> |
6683 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index |
6684 |
|
</t> |
6685 |
</list> |
</list> |
6686 |
</t> |
</t> |
6687 |
<t>subscribe_event = |
<t>subscribe_event = |
6696 |
</t> |
</t> |
6697 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6698 |
</t> |
</t> |
6699 |
|
<t>/ CHANNEL_MIDI |
6700 |
|
</t> |
6701 |
|
<t>/ DEVICE_MIDI |
6702 |
|
</t> |
6703 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6704 |
</t> |
</t> |
6705 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6752 |
</t> |
</t> |
6753 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6754 |
</t> |
</t> |
6755 |
|
<t>/ CHANNEL_MIDI |
6756 |
|
</t> |
6757 |
|
<t>/ DEVICE_MIDI |
6758 |
|
</t> |
6759 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6760 |
</t> |
</t> |
6761 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6822 |
</t> |
</t> |
6823 |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
<t>/ MIDI_INSTRUMENT_MAP SP ALL |
6824 |
</t> |
</t> |
6825 |
|
<t>/ SEND_EFFECT_CHAIN SP device_index SP effect_chain |
6826 |
|
</t> |
6827 |
|
<t>/ SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos |
6828 |
|
</t> |
6829 |
|
<t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id |
6830 |
|
</t> |
6831 |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path |
6832 |
</t> |
</t> |
6833 |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
<t>/ DB_INSTRUMENT_DIRECTORY SP db_path |
6840 |
<list> |
<list> |
6841 |
<t>AVAILABLE_ENGINES |
<t>AVAILABLE_ENGINES |
6842 |
</t> |
</t> |
6843 |
|
<t>/ AVAILABLE_EFFECTS |
6844 |
|
</t> |
6845 |
|
<t>/ EFFECT_INSTANCES |
6846 |
|
</t> |
6847 |
|
<t>/ EFFECT SP INFO SP effect_index |
6848 |
|
</t> |
6849 |
|
<t>/ EFFECT_INSTANCE SP INFO SP effect_instance |
6850 |
|
</t> |
6851 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP INFO SP effect_instance SP input_control |
6852 |
|
</t> |
6853 |
|
<t>/ SEND_EFFECT_CHAINS SP device_index |
6854 |
|
</t> |
6855 |
|
<t>/ SEND_EFFECT_CHAIN SP INFO SP device_index SP effect_chain |
6856 |
|
</t> |
6857 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
6858 |
</t> |
</t> |
6859 |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
<t>/ MIDI_INPUT_DRIVER SP INFO SP string |
6936 |
</t> |
</t> |
6937 |
<t>/ VOLUME |
<t>/ VOLUME |
6938 |
</t> |
</t> |
6939 |
|
<t>/ VOICES |
6940 |
|
</t> |
6941 |
|
<t>/ STREAMS |
6942 |
|
</t> |
6943 |
<t>/ FILE SP INSTRUMENTS SP filename |
<t>/ FILE SP INSTRUMENTS SP filename |
6944 |
</t> |
</t> |
6945 |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6958 |
</t> |
</t> |
6959 |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
<t>/ MIDI_INPUT_PORT_PARAMETER SP number SP number SP string '=' param_val_list |
6960 |
</t> |
</t> |
6961 |
|
<t>/ EFFECT_INSTANCE_INPUT_CONTROL SP VALUE SP effect_instance SP input_control SP control_value |
6962 |
|
</t> |
6963 |
<t>/ CHANNEL SP set_chan_instruction |
<t>/ CHANNEL SP set_chan_instruction |
6964 |
</t> |
</t> |
6965 |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
<t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name |
6972 |
</t> |
</t> |
6973 |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
<t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value |
6974 |
</t> |
</t> |
6975 |
|
<t>/ FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos |
6976 |
|
</t> |
6977 |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped |
6978 |
</t> |
</t> |
6979 |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped |
6982 |
</t> |
</t> |
6983 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6984 |
</t> |
</t> |
6985 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
6986 |
|
</t> |
6987 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6988 |
</t> |
</t> |
6989 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
6990 |
</t> |
</t> |
6991 |
|
<t>/ VOICES SP number |
6992 |
|
</t> |
6993 |
|
<t>/ STREAMS SP number |
6994 |
|
</t> |
6995 |
</list> |
</list> |
6996 |
</t> |
</t> |
6997 |
<t>create_instruction = |
<t>create_instruction = |
7008 |
</t> |
</t> |
7009 |
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
<t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name |
7010 |
</t> |
</t> |
7011 |
|
<t>/ EFFECT_INSTANCE SP effect_index |
7012 |
|
</t> |
7013 |
|
<t>/ EFFECT_INSTANCE SP effect_system SP module SP effect_name |
7014 |
|
</t> |
7015 |
</list> |
</list> |
7016 |
</t> |
</t> |
7017 |
<t>reset_instruction = |
<t>reset_instruction = |
7038 |
</t> |
</t> |
7039 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
7040 |
</t> |
</t> |
7041 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
7042 |
|
</t> |
7043 |
</list> |
</list> |
7044 |
</t> |
</t> |
7045 |
<t>move_instruction = |
<t>move_instruction = |
7066 |
</t> |
</t> |
7067 |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
<t>/ FX_SEND SP sampler_channel SP fx_send_id |
7068 |
</t> |
</t> |
7069 |
|
<t>/ EFFECT_INSTANCE SP number |
7070 |
|
</t> |
7071 |
</list> |
</list> |
7072 |
</t> |
</t> |
7073 |
<t>load_instruction = |
<t>load_instruction = |
7078 |
</t> |
</t> |
7079 |
</list> |
</list> |
7080 |
</t> |
</t> |
7081 |
|
<t>append_instruction = |
7082 |
|
<list> |
7083 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP effect_instance |
7084 |
|
</t> |
7085 |
|
</list> |
7086 |
|
</t> |
7087 |
|
<t>insert_instruction = |
7088 |
|
<list> |
7089 |
|
<t>SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos SP effect_instance |
7090 |
|
</t> |
7091 |
|
</list> |
7092 |
|
</t> |
7093 |
<t>set_chan_instruction = |
<t>set_chan_instruction = |
7094 |
<list> |
<list> |
7095 |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
<t>AUDIO_OUTPUT_DEVICE SP sampler_channel SP device_index |
7168 |
</t> |
</t> |
7169 |
<t>/ AVAILABLE_ENGINES |
<t>/ AVAILABLE_ENGINES |
7170 |
</t> |
</t> |
7171 |
|
<t>/ AVAILABLE_EFFECTS |
7172 |
|
</t> |
7173 |
|
<t>/ EFFECT_INSTANCES |
7174 |
|
</t> |
7175 |
|
<t>/ SEND_EFFECT_CHAINS SP number |
7176 |
|
</t> |
7177 |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
<t>/ AVAILABLE_MIDI_INPUT_DRIVERS |
7178 |
</t> |
</t> |
7179 |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
<t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS |
7198 |
</t> |
</t> |
7199 |
</list> |
</list> |
7200 |
</t> |
</t> |
7201 |
|
<t>send_instruction = |
7202 |
|
<list> |
7203 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
7204 |
|
</t> |
7205 |
|
</list> |
7206 |
|
</t> |
7207 |
<t>load_instr_args = |
<t>load_instr_args = |
7208 |
<list> |
<list> |
7209 |
<t>filename SP instrument_index SP sampler_channel |
<t>filename SP instrument_index SP sampler_channel |
7228 |
</t> |
</t> |
7229 |
</list> |
</list> |
7230 |
</t> |
</t> |
7231 |
|
<t>effect_instance = |
7232 |
|
<list> |
7233 |
|
<t>number |
7234 |
|
</t> |
7235 |
|
</list> |
7236 |
|
</t> |
7237 |
<t>device_index = |
<t>device_index = |
7238 |
<list> |
<list> |
7239 |
<t>number |
<t>number |
7304 |
</t> |
</t> |
7305 |
</list> |
</list> |
7306 |
</t> |
</t> |
7307 |
|
<t>control_value = |
7308 |
|
<list> |
7309 |
|
<t>real |
7310 |
|
</t> |
7311 |
|
</list> |
7312 |
|
</t> |
7313 |
<t>sampler_channel = |
<t>sampler_channel = |
7314 |
<list> |
<list> |
7315 |
<t>number |
<t>number |
7337 |
<t>filename = |
<t>filename = |
7338 |
<list> |
<list> |
7339 |
<t>path |
<t>path |
|
#if WIN32 |
|
|
$$ = $1.toWindows(); |
|
|
#else |
|
|
|
|
|
$$ = $1.toPosix(); |
|
|
#endif |
|
|
|
|
7340 |
</t> |
</t> |
7341 |
</list> |
</list> |
7342 |
</t> |
</t> |
7364 |
</t> |
</t> |
7365 |
</list> |
</list> |
7366 |
</t> |
</t> |
7367 |
|
<t>effect_name = |
7368 |
|
<list> |
7369 |
|
<t>stringval_escaped |
7370 |
|
</t> |
7371 |
|
</list> |
7372 |
|
</t> |
7373 |
|
<t>effect_index = |
7374 |
|
<list> |
7375 |
|
<t>number |
7376 |
|
</t> |
7377 |
|
</list> |
7378 |
|
</t> |
7379 |
|
<t>effect_chain = |
7380 |
|
<list> |
7381 |
|
<t>number |
7382 |
|
</t> |
7383 |
|
</list> |
7384 |
|
</t> |
7385 |
|
<t>chain_pos = |
7386 |
|
<list> |
7387 |
|
<t>number |
7388 |
|
</t> |
7389 |
|
</list> |
7390 |
|
</t> |
7391 |
|
<t>input_control = |
7392 |
|
<list> |
7393 |
|
<t>number |
7394 |
|
</t> |
7395 |
|
</list> |
7396 |
|
</t> |
7397 |
<t>param_val_list = |
<t>param_val_list = |
7398 |
<list> |
<list> |
7399 |
<t>param_val |
<t>param_val |
7441 |
</t> |
</t> |
7442 |
</list> |
</list> |
7443 |
</t> |
</t> |
7444 |
|
<t>effect_system = |
7445 |
|
<list> |
7446 |
|
<t>string |
7447 |
|
</t> |
7448 |
|
</list> |
7449 |
|
</t> |
7450 |
|
<t>module = |
7451 |
|
<list> |
7452 |
|
<t>filename |
7453 |
|
</t> |
7454 |
|
</list> |
7455 |
|
</t> |
7456 |
|
|
7457 |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
<!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! --> |
7458 |
|
|
7515 |
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
<t><xref target="MOVE DB_INSTRUMENT_DIRECTORY">"MOVE DB_INSTRUMENT_DIRECTORY"</xref></t> |
7516 |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7517 |
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT_DIRECTORY">"COPY DB_INSTRUMENT_DIRECTORY"</xref></t> |
7518 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
7519 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
7520 |
|
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7521 |
|
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7522 |
|
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7523 |
</list> |
</list> |
7524 |
Note that the forward slash character ('/') has a special meaning in |
Note that the forward slash character ('/') has a special meaning in |
7525 |
filename / path based arguments: it acts as separator of the nodes in |
filename / path based arguments: it acts as separator of the nodes in |
7530 |
</t> |
</t> |
7531 |
|
|
7532 |
<t> |
<t> |
7533 |
|
Note for Windows: file path arguments in LSCP are expected |
7534 |
|
to use forward slashes as directory node separator similar |
7535 |
|
to Unix based operating systems. In contrast to Unix however |
7536 |
|
a Windows typical drive character is expected to be |
7537 |
|
prefixed to the path. That is an original Windows file path |
7538 |
|
like "D:\Sounds\My.gig" would become in LSCP: |
7539 |
|
"D:/Sounds/My.gig". |
7540 |
|
</t> |
7541 |
|
|
7542 |
|
<t> |
7543 |
The following LSCP commands even support escape sequences as |
The following LSCP commands even support escape sequences as |
7544 |
part of at least one of their text-based arguments (i.e. entity name, |
part of at least one of their text-based arguments (i.e. entity name, |
7545 |
description) and / or may contain escape sequences in at least one of |
description) and / or may contain escape sequences in at least one of |
7673 |
of sampler channels.</t> |
of sampler channels.</t> |
7674 |
</section> |
</section> |
7675 |
|
|
7676 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
7677 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
7678 |
|
back-end side, by issuing the following command:</t> |
7679 |
|
<t> |
7680 |
|
<list> |
7681 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
7682 |
|
</list> |
7683 |
|
</t> |
7684 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7685 |
|
<t> |
7686 |
|
<list> |
7687 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
7688 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
7689 |
|
</list> |
7690 |
|
</t> |
7691 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
7692 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7693 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7694 |
|
</t> |
7695 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7696 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7697 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7698 |
|
thread unaffected by this feature.</t> |
7699 |
|
</section> |
7700 |
|
|
7701 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
7702 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
7703 |
|
<t> |
7704 |
|
<list> |
7705 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
7706 |
|
</list> |
7707 |
|
</t> |
7708 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7709 |
|
<t> |
7710 |
|
<list> |
7711 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
7712 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
7713 |
|
</list> |
7714 |
|
</t> |
7715 |
|
<t>where <device-id> <port-id> will be replaced |
7716 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
7717 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7718 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7719 |
|
</t> |
7720 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7721 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7722 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7723 |
|
thread unaffected by this feature.</t> |
7724 |
|
</section> |
7725 |
|
|
7726 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
7727 |
<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 |
7728 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7976 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
7977 |
new global volume parameter.</t> |
new global volume parameter.</t> |
7978 |
</list> |
</list> |
7979 |
|
<list> |
7980 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
7981 |
|
golbal limit of the sampler for maximum voices is changed, where |
7982 |
|
<max-voices> will be an integer value, reflecting the |
7983 |
|
new global voice limit parameter.</t> |
7984 |
|
</list> |
7985 |
|
<list> |
7986 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
7987 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
7988 |
|
<max-streams> will be an integer value, reflecting the |
7989 |
|
new global disk streams limit parameter.</t> |
7990 |
|
</list> |
7991 |
</t> |
</t> |
7992 |
</section> |
</section> |
7993 |
|
|