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.3"> |
<rfc category="std" ipr="full3978" docName="LSCP 1.4"> |
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="December" year="2007"/> |
<date month="December" year="2008"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
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 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 |
|
</list> |
3751 |
|
</t> |
3752 |
|
<t>CAUTION: This command is provided for implementations of virtual MIDI keyboards |
3753 |
|
and no realtime guarantee whatsoever will be made!</t> |
3754 |
|
<t>Possible Answers:</t> |
3755 |
|
<t> |
3756 |
|
<list> |
3757 |
|
<t>"OK" - |
3758 |
|
<list> |
3759 |
|
<t>on success</t> |
3760 |
|
</list> |
3761 |
|
</t> |
3762 |
|
<t>"ERR:<error-code>:<error-message>" - |
3763 |
|
<list> |
3764 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
3765 |
|
</list> |
3766 |
|
</t> |
3767 |
|
</list> |
3768 |
|
</t> |
3769 |
|
<t>Example:</t> |
3770 |
|
<t> |
3771 |
|
<list> |
3772 |
|
<t>C: "SEND CHANNEL MIDI_DATA NOTE_ON 0 56 112"</t> |
3773 |
|
<t>S: "OK"</t> |
3774 |
|
</list> |
3775 |
|
</t> |
3776 |
|
</section> |
3777 |
|
|
3778 |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
<section title="Resetting a sampler channel" anchor="RESET CHANNEL"> |
3779 |
<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> |
3780 |
<t> |
<t> |
4149 |
</list> |
</list> |
4150 |
</t> |
</t> |
4151 |
</section> |
</section> |
4152 |
|
|
4153 |
|
<section title="Getting global voice limit" anchor="GET VOICES"> |
4154 |
|
<t>The client can ask for the current global sampler-wide limit |
4155 |
|
for maximum voices by sending the following command:</t> |
4156 |
|
<t> |
4157 |
|
<list> |
4158 |
|
<t>GET VOICES</t> |
4159 |
|
</list> |
4160 |
|
</t> |
4161 |
|
<t>Possible Answers:</t> |
4162 |
|
<t> |
4163 |
|
<list> |
4164 |
|
<t>LinuxSampler will answer by returning the number for |
4165 |
|
the current limit of maximum voices.</t> |
4166 |
|
</list> |
4167 |
|
</t> |
4168 |
|
|
4169 |
|
<t>The voice limit setting defines how many voices should maximum |
4170 |
|
be processed by the sampler at the same time. If the user |
4171 |
|
triggers new notes which would exceed that voice limit, the |
4172 |
|
sampler engine will react by stealing old voices for those |
4173 |
|
newly triggered notes. Note that the amount of voices triggered |
4174 |
|
by a new note can be larger than one and is dependent to the |
4175 |
|
respective instrument and probably further criterias.</t> |
4176 |
|
</section> |
4177 |
|
|
4178 |
|
<section title="Setting global voice limit" anchor="SET VOICES"> |
4179 |
|
<t>The client can alter the current global sampler-wide limit |
4180 |
|
for maximum voices by sending the following command:</t> |
4181 |
|
<t> |
4182 |
|
<list> |
4183 |
|
<t>SET VOICES <max-voices></t> |
4184 |
|
</list> |
4185 |
|
</t> |
4186 |
|
<t>Where <max-voices> should be replaced by the integer |
4187 |
|
value, reflecting the new global amount limit of maximum voices. |
4188 |
|
This value has to be larger than 0.</t> |
4189 |
|
|
4190 |
|
<t>Possible Answers:</t> |
4191 |
|
<t> |
4192 |
|
<list> |
4193 |
|
<t>"OK" - |
4194 |
|
<list> |
4195 |
|
<t>on success</t> |
4196 |
|
</list> |
4197 |
|
</t> |
4198 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4199 |
|
<list> |
4200 |
|
<t>if the voice limit was set, but there are noteworthy |
4201 |
|
issue(s) related, providing an appropriate warning code and |
4202 |
|
warning message</t> |
4203 |
|
</list> |
4204 |
|
</t> |
4205 |
|
<t>"ERR:<error-code>:<error-message>" - |
4206 |
|
<list> |
4207 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4208 |
|
</list> |
4209 |
|
</t> |
4210 |
|
</list> |
4211 |
|
</t> |
4212 |
|
|
4213 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4214 |
|
The total amount of maximum voices on the running system might thus |
4215 |
|
be as big as the given value multiplied by the current amount of engine |
4216 |
|
instances.</t> |
4217 |
|
|
4218 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
4219 |
|
adjust the disk stream limit respectively and vice versa.</t> |
4220 |
|
</section> |
4221 |
|
|
4222 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
4223 |
|
<t>The client can ask for the current global sampler-wide limit |
4224 |
|
for maximum disk streams by sending the following command:</t> |
4225 |
|
<t> |
4226 |
|
<list> |
4227 |
|
<t>GET STREAMS</t> |
4228 |
|
</list> |
4229 |
|
</t> |
4230 |
|
<t>Possible Answers:</t> |
4231 |
|
<t> |
4232 |
|
<list> |
4233 |
|
<t>LinuxSampler will answer by returning the number for |
4234 |
|
the current limit of maximum disk streams.</t> |
4235 |
|
</list> |
4236 |
|
</t> |
4237 |
|
|
4238 |
|
<t>The disk stream limit setting defines how many disk streams should |
4239 |
|
maximum be processed by a sampler engine at the same time. The |
4240 |
|
higher this value, the more memory (RAM) will be occupied, since |
4241 |
|
every disk streams allocates a certain buffer size for being able |
4242 |
|
to perform its streaming operations.</t> |
4243 |
|
</section> |
4244 |
|
|
4245 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
4246 |
|
<t>The client can alter the current global sampler-wide limit |
4247 |
|
for maximum disk streams by sending the following command:</t> |
4248 |
|
<t> |
4249 |
|
<list> |
4250 |
|
<t>SET STREAMS <max-streams></t> |
4251 |
|
</list> |
4252 |
|
</t> |
4253 |
|
<t>Where <max-streams> should be replaced by the integer |
4254 |
|
value, reflecting the new global amount limit of maximum disk streams. |
4255 |
|
This value has to be positive.</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 disk stream limit 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 |
|
|
4280 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4281 |
|
The total amount of maximum disk streams on the running system might |
4282 |
|
thus be as big as the given value multiplied by the current amount of |
4283 |
|
engine instances.</t> |
4284 |
|
|
4285 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
4286 |
|
adjust the voice limit respectively and vice versa.</t> |
4287 |
|
</section> |
4288 |
|
|
4289 |
</section> |
</section> |
4290 |
|
|
4291 |
|
|
5494 |
to the instruments database by sending the following command:</t> |
to the instruments database by sending the following command:</t> |
5495 |
<t> |
<t> |
5496 |
<list> |
<list> |
5497 |
<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> |
5498 |
</list> |
</list> |
5499 |
</t> |
</t> |
5500 |
<t>Where <db_dir> is the absolute path name of a directory |
<t>Where <db_dir> is the absolute path name of a directory |
5539 |
</list> |
</list> |
5540 |
</t> |
</t> |
5541 |
|
|
5542 |
|
<t> If FILE_AS_DIR argument is supplied, all instruments in an instrument |
5543 |
|
file will be added to a separate directory in the instruments database, which |
5544 |
|
name will be the name of the instrument file with the file extension stripped off. |
5545 |
|
</t> |
5546 |
<t>The difference between regular and NON_MODAL versions of the command |
<t>The difference between regular and NON_MODAL versions of the command |
5547 |
is that the regular command returns when the scanning is finished |
is that the regular command returns when the scanning is finished |
5548 |
while NON_MODAL version returns immediately and a background process is launched. |
while NON_MODAL version returns immediately and a background process is launched. |
6208 |
</t> |
</t> |
6209 |
</section> |
</section> |
6210 |
|
|
6211 |
|
<section title="Checking for lost instrument files" anchor="FIND LOST DB_INSTRUMENT_FILES"> |
6212 |
|
<t>The front-end can retrieve the list of all instrument files in the instruments database |
6213 |
|
that don't exist in the filesystem by sending the following command:</t> |
6214 |
|
<t> |
6215 |
|
<list> |
6216 |
|
<t>FIND LOST DB_INSTRUMENT_FILES</t> |
6217 |
|
</list> |
6218 |
|
</t> |
6219 |
|
|
6220 |
|
<t>Possible Answers:</t> |
6221 |
|
<t> |
6222 |
|
<list> |
6223 |
|
<t>A comma separated list with the absolute path names |
6224 |
|
(encapsulated into apostrophes) of all lost instrument files.</t> |
6225 |
|
<t>"ERR:<error-code>:<error-message>" - |
6226 |
|
<list> |
6227 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6228 |
|
</list> |
6229 |
|
</t> |
6230 |
|
</list> |
6231 |
|
</t> |
6232 |
|
<t>Example:</t> |
6233 |
|
<t> |
6234 |
|
<list> |
6235 |
|
<t>C: "FIND LOST DB_INSTRUMENT_FILES"</t> |
6236 |
|
<t>S: "'/gigs/Bosendorfer 290.gig','/gigs/Steinway D.gig','/gigs/Free Piano.gig'"</t> |
6237 |
|
</list> |
6238 |
|
</t> |
6239 |
|
</section> |
6240 |
|
|
6241 |
|
<section title="Replacing an instrument file" anchor="SET DB_INSTRUMENT FILE_PATH"> |
6242 |
|
<t>The front-end can substitute all occurrences of an instrument file |
6243 |
|
in the instruments database with a new one by sending the following command:</t> |
6244 |
|
<t> |
6245 |
|
<list> |
6246 |
|
<t>SET DB_INSTRUMENT FILE_PATH <old_path> <new_path></t> |
6247 |
|
</list> |
6248 |
|
</t> |
6249 |
|
<t>Where <old_path> is the absolute path name of the instrument file |
6250 |
|
to substitute with <new_path>.</t> |
6251 |
|
|
6252 |
|
<t>Possible Answers:</t> |
6253 |
|
<t> |
6254 |
|
<list> |
6255 |
|
<t>"OK" - |
6256 |
|
<list> |
6257 |
|
<t>on success</t> |
6258 |
|
</list> |
6259 |
|
</t> |
6260 |
|
<t>"ERR:<error-code>:<error-message>" - |
6261 |
|
<list> |
6262 |
|
<t>in case it failed, providing an appropriate error code and error message.</t> |
6263 |
|
</list> |
6264 |
|
</t> |
6265 |
|
</list> |
6266 |
|
</t> |
6267 |
|
|
6268 |
|
<t>Example:</t> |
6269 |
|
<t> |
6270 |
|
<list> |
6271 |
|
<t>C: "SET DB_INSTRUMENT FILE_PATH '/gigs/Bosendorfer 290.gig' '/gigs/pianos/Bosendorfer 290.gig'"</t> |
6272 |
|
<t>S: "OK"</t> |
6273 |
|
</list> |
6274 |
|
</t> |
6275 |
|
</section> |
6276 |
|
|
6277 |
</section> |
</section> |
6278 |
|
|
6279 |
|
|
6512 |
vendor of the instrument</t> |
vendor of the instrument</t> |
6513 |
</list> |
</list> |
6514 |
</t> |
</t> |
6515 |
|
<t>KEY_BINDINGS - |
6516 |
|
<list> |
6517 |
|
<t>comma separated list of integer values representing |
6518 |
|
the instrument's key mapping in the range between 0 .. 127, |
6519 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6520 |
|
</list> |
6521 |
|
</t> |
6522 |
|
<t>KEYSWITCH_BINDINGS - |
6523 |
|
<list> |
6524 |
|
<t>comma separated list of integer values representing |
6525 |
|
the instrument's keyswitch mapping in the range between 0 .. 127, |
6526 |
|
reflecting the analog meaning of the MIDI specification.</t> |
6527 |
|
</list> |
6528 |
|
</t> |
6529 |
</list> |
</list> |
6530 |
</t> |
</t> |
6531 |
</list> |
</list> |
6634 |
</t> |
</t> |
6635 |
<t>/ FORMAT SP format_instruction |
<t>/ FORMAT SP format_instruction |
6636 |
</t> |
</t> |
6637 |
|
<t>/ SEND SP send_instruction |
6638 |
|
</t> |
6639 |
<t>/ RESET |
<t>/ RESET |
6640 |
</t> |
</t> |
6641 |
<t>/ QUIT |
<t>/ QUIT |
6650 |
</t> |
</t> |
6651 |
<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 |
6652 |
</t> |
</t> |
6653 |
|
<t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
6654 |
|
</t> |
6655 |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP scan_mode SP db_path SP filename |
6656 |
</t> |
</t> |
6657 |
|
<t>/ DB_INSTRUMENTS SP scan_mode SP FILE_AS_DIR SP db_path SP filename |
6658 |
|
</t> |
6659 |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
<t>/ DB_INSTRUMENTS SP NON_MODAL SP db_path SP filename |
6660 |
</t> |
</t> |
6661 |
<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 |
6682 |
</t> |
</t> |
6683 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6684 |
</t> |
</t> |
6685 |
|
<t>/ CHANNEL_MIDI |
6686 |
|
</t> |
6687 |
|
<t>/ DEVICE_MIDI |
6688 |
|
</t> |
6689 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6690 |
</t> |
</t> |
6691 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6738 |
</t> |
</t> |
6739 |
<t>/ CHANNEL_COUNT |
<t>/ CHANNEL_COUNT |
6740 |
</t> |
</t> |
6741 |
|
<t>/ CHANNEL_MIDI |
6742 |
|
</t> |
6743 |
|
<t>/ DEVICE_MIDI |
6744 |
|
</t> |
6745 |
<t>/ VOICE_COUNT |
<t>/ VOICE_COUNT |
6746 |
</t> |
</t> |
6747 |
<t>/ STREAM_COUNT |
<t>/ STREAM_COUNT |
6902 |
</t> |
</t> |
6903 |
<t>/ VOLUME |
<t>/ VOLUME |
6904 |
</t> |
</t> |
6905 |
|
<t>/ VOICES |
6906 |
|
</t> |
6907 |
|
<t>/ STREAMS |
6908 |
|
</t> |
6909 |
<t>/ FILE SP INSTRUMENTS SP filename |
<t>/ FILE SP INSTRUMENTS SP filename |
6910 |
</t> |
</t> |
6911 |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6944 |
</t> |
</t> |
6945 |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
<t>/ DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped |
6946 |
</t> |
</t> |
6947 |
|
<t>/ DB_INSTRUMENT SP FILE_PATH SP filename SP filename |
6948 |
|
</t> |
6949 |
<t>/ ECHO SP boolean |
<t>/ ECHO SP boolean |
6950 |
</t> |
</t> |
6951 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
6952 |
</t> |
</t> |
6953 |
|
<t>/ VOICES SP number |
6954 |
|
</t> |
6955 |
|
<t>/ STREAMS SP number |
6956 |
|
</t> |
6957 |
</list> |
</list> |
6958 |
</t> |
</t> |
6959 |
<t>create_instruction = |
<t>create_instruction = |
6996 |
</t> |
</t> |
6997 |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
<t>/ DB_INSTRUMENT_DIRECTORIES SP db_path SP query_val_list |
6998 |
</t> |
</t> |
6999 |
|
<t>/ LOST SP DB_INSTRUMENT_FILES |
7000 |
|
</t> |
7001 |
</list> |
</list> |
7002 |
</t> |
</t> |
7003 |
<t>move_instruction = |
<t>move_instruction = |
7136 |
</t> |
</t> |
7137 |
</list> |
</list> |
7138 |
</t> |
</t> |
7139 |
|
<t>send_instruction = |
7140 |
|
<list> |
7141 |
|
<t>CHANNEL SP MIDI_DATA SP string SP sampler_channel SP number SP number |
7142 |
|
</t> |
7143 |
|
</list> |
7144 |
|
</t> |
7145 |
<t>load_instr_args = |
<t>load_instr_args = |
7146 |
<list> |
<list> |
7147 |
<t>filename SP instrument_index SP sampler_channel |
<t>filename SP instrument_index SP sampler_channel |
7399 |
<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> |
7400 |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
<t><xref target="COPY DB_INSTRUMENT">"COPY DB_INSTRUMENT"</xref></t> |
7401 |
<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> |
7402 |
|
<t><xref target="FIND LOST DB_INSTRUMENT_FILES">"FIND LOST DB_INSTRUMENT_FILES"</xref></t> |
7403 |
|
<t><xref target="SET DB_INSTRUMENT FILE_PATH">"SET DB_INSTRUMENT FILE_PATH"</xref></t> |
7404 |
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
<t><xref target="GET FILE INSTRUMENTS">"GET FILE INSTRUMENTS"</xref></t> |
7405 |
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
<t><xref target="LIST FILE INSTRUMENTS">"LIST FILE INSTRUMENTS"</xref></t> |
7406 |
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
<t><xref target="GET FILE INSTRUMENT INFO">"GET FILE INSTRUMENT INFO"</xref></t> |
7557 |
of sampler channels.</t> |
of sampler channels.</t> |
7558 |
</section> |
</section> |
7559 |
|
|
7560 |
|
<section title="MIDI data on a sampler channel arrived" anchor="SUBSCRIBE CHANNEL_MIDI"> |
7561 |
|
<t>Client may want to be notified when MIDI data arrive on sampler channels on |
7562 |
|
back-end side, by issuing the following command:</t> |
7563 |
|
<t> |
7564 |
|
<list> |
7565 |
|
<t>SUBSCRIBE CHANNEL_MIDI</t> |
7566 |
|
</list> |
7567 |
|
</t> |
7568 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7569 |
|
<t> |
7570 |
|
<list> |
7571 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_ON <note> <velocity>"</t> |
7572 |
|
<t>"NOTIFY:CHANNEL_MIDI:<channel-id> NOTE_OFF <note> <velocity>"</t> |
7573 |
|
</list> |
7574 |
|
</t> |
7575 |
|
<t>where <channel-id> will be replaced by the ID of the sampler channel where the MIDI |
7576 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7577 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7578 |
|
</t> |
7579 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7580 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7581 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7582 |
|
thread unaffected by this feature.</t> |
7583 |
|
</section> |
7584 |
|
|
7585 |
|
<section title="MIDI data on a MIDI input device arrived" anchor="SUBSCRIBE DEVICE_MIDI"> |
7586 |
|
<t>Client may want to be notified when MIDI data arrive on MIDI input devices by issuing the following command:</t> |
7587 |
|
<t> |
7588 |
|
<list> |
7589 |
|
<t>SUBSCRIBE DEVICE_MIDI</t> |
7590 |
|
</list> |
7591 |
|
</t> |
7592 |
|
<t>Server will start sending one of the the following notification messages:</t> |
7593 |
|
<t> |
7594 |
|
<list> |
7595 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_ON <note> <velocity>"</t> |
7596 |
|
<t>"NOTIFY:DEVICE_MIDI:<device-id> <port-id> NOTE_OFF <note> <velocity>"</t> |
7597 |
|
</list> |
7598 |
|
</t> |
7599 |
|
<t>where <device-id> <port-id> will be replaced |
7600 |
|
by the IDs of the respective MIDI input device and the device's MIDI port where the MIDI |
7601 |
|
data arrived. <note> and <velocity> are integer values in the range between |
7602 |
|
0 .. 127, reflecting the analog meaning of the MIDI specification. |
7603 |
|
</t> |
7604 |
|
<t>CAUTION: no guarantee whatsoever will be made that MIDI events are actually all |
7605 |
|
delivered by this mechanism! With other words: events could be lost at any time! |
7606 |
|
This restriction was made to keep the RT-safeness of the backend's MIDI and audio |
7607 |
|
thread unaffected by this feature.</t> |
7608 |
|
</section> |
7609 |
|
|
7610 |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
<section title="Number of active voices changed" anchor="SUBSCRIBE VOICE_COUNT"> |
7611 |
<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 |
7612 |
back-end changes by issuing the following command:</t> |
back-end changes by issuing the following command:</t> |
7860 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
7861 |
new global volume parameter.</t> |
new global volume parameter.</t> |
7862 |
</list> |
</list> |
7863 |
|
<list> |
7864 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
7865 |
|
golbal limit of the sampler for maximum voices is changed, where |
7866 |
|
<max-voices> will be an integer value, reflecting the |
7867 |
|
new global voice limit parameter.</t> |
7868 |
|
</list> |
7869 |
|
<list> |
7870 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
7871 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
7872 |
|
<max-streams> will be an integer value, reflecting the |
7873 |
|
new global disk streams limit parameter.</t> |
7874 |
|
</list> |
7875 |
</t> |
</t> |
7876 |
</section> |
</section> |
7877 |
|
|